SPB

Descrição detalhada

Operações de Encode e Decode conforme o padrão SPB.

Consulte a documentação técnica do HSM.

Funções
void	SPBActivateCertificate (String szDomain, byte bCA, String szSN) throws TacException
	Ativa um certificado que já foi importado para o HSM.
void	SPBActivateCertificate (String szDomain, byte bCA, String szSN, int dwParam) throws TacException
	Ativa um certificado que já foi importado para o HSM.
void	SPBSetISPBMap (String strISPB, String strKeyId, String strCertId) throws TacException
	Cria um mapa com a chave e certificado da instituição em um slot.
byte[]	SPBGenerateCSR (String sPrivateKeyName, String sRazaoSocial, String sISPB, String sSISBACEN, int iSequencial, boolean bProducao, String sCidade, String sUF) throws TacException
	Gera uma nova CSR baseada em uma chave existente (RSA 2048).
byte[]	SPBGenerateCSR (String sPrivateKeyName, String sSubject) throws TacException
	Gera uma nova CSR baseada em uma chave existente (RSA 2048).
byte[]	generatePKCS10CSR (String szKeyId, String szDN, int dwOutType) throws TacException
	Gera um CSR.
void	SPBImportCertificate (String szDomain, byte[] bCertificate) throws TacException
	Importa um certificado para um namespace do HSM.
void	SPBImportCertificate (String szDomain, byte[] bCertificate, boolean isActive) throws TacException
	Importa um certificado para um namespace do HSM.
void	SPBImportCertificate (String szDomain, byte[] bCertificate, boolean isActive, int dwParam) throws TacException
	Importa um certificado para um namespace do HSM.
void	SPBImportPKCS12 (String path, String pass, String domain, boolean isActivate, int dwFlags) throws TacException
	Importa um certificado de um container PKCS#12 para o HSM.
byte[]	SPBGetCertificate (String strIdCertificate) throws TacException
	Recupera um certificado armazenado em um namespace no HSM.
byte[]	SPBDecode (String szSrcISPB, String szDstISPB, byte[] pbMsgIn, boolean bAcceptExpiredCert, boolean bAutoUpdateCert) throws TacSPBException, IOException
	Decodifica uma mensagem no padrão SPB, checando as assinaturas, decriptografando porem não faz a checagem de encoding.
byte[]	SPBDecode (String szSrcISPB, String szDstISPB, byte[] pbMsgIn, boolean bAcceptExpiredCert, boolean bAutoUpdateCert, boolean bEncodingCheck) throws TacSPBException, IOException
	Decodifica uma mensagem no padrão SPB, checando as assinaturas e decriptografando.
byte[]	SPBDecode (String szSrcISPB, String szDstISPB, byte[] pbMsgIn, boolean bAcceptExpiredCert, boolean bAutoUpdateCert, boolean bEncodingCheck, int dwFlags) throws TacSPBException, IOException
	Decodifica uma mensagem no padrão SPB, checando as assinaturas e decriptografando.
byte[]	SPBDecode (String szSrcISPB, String szDstISPB, byte[] pbMsgIn) throws TacException, IOException
byte[]	SPBEncode (String szSrcISPB, String szDstISPB, byte[] pbMsgIn, byte bSpecialTreatment) throws TacException
	Codifica uma mensagem com o cabeçalho do SPB, assinando, criptografando e incluindo todos os campos de cabeçalhos definidos no manual de segurança da RSFN.
byte[]	SPBEncode (String szSrcISPB, String szDstISPB, byte[] pbMsgIn, byte bSpecialTreatment, int dwFlags) throws TacException
	Codifica uma mensagem com o cabeçalho do SPB, assinando, criptografando e incluindo todos os campos de cabeçalhos definidos no manual de segurança da RSFN.

Funções

SPBActivateCertificate() [1/2]

void SPBActivateCertificate	(	String	szDomain,
		byte	bCA,
		String	szSN ) throws TacException

Ativa um certificado que já foi importado para o HSM.

Se houver um outro certificado ativo, ele será inativado. Somente um certificado permanecerá ativo por instituição, por domínio dentro de um namespace do HSM.

Parâmetros

szDomain	dominio de operação do SPB
bCA	número da CA que emitiu o certificado
szSN	Número de série do certificado que será ativado.

Exceções

TacException

SPBActivateCertificate() [2/2]

void SPBActivateCertificate	(	String	szDomain,
		byte	bCA,
		String	szSN,
		int	dwParam ) throws TacException

Ativa um certificado que já foi importado para o HSM.

Se houver um outro certificado ativo, ele será inativado. Somente um certificado permanecerá ativo por instituição, por domínio dentro de um namespace do HSM.

Parâmetros

szDomain	dominio de operação do SPB
bCA	número da CA que emitiu o certificado
szSN	Número de série do certificado que será ativado.
dwParam	A seguinte tabela de flags é suportada. Valor Significado 0 Utiliza o padrão SPB(Sistema de Pagamentos Brasileiro). TacNDJavaLib.ND_SPB_USE_CIP1 Utiliza o padrão CIP(Camara Interbancaria de Pagamentos)/C3 Nuclea.

Exceções

TacException

SPBSetISPBMap()

void SPBSetISPBMap	(	String	strISPB,
		String	strKeyId,
		String	strCertId ) throws TacException

Cria um mapa com a chave e certificado da instituição em um slot.

Parâmetros

strISPB	- Identificação do mapa (pode ser o ISPB)
strKeyId	- Identificação da chave
strCertId	- Identificação do certificado

Exceções

TacException

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

SPBGenerateCSR() [1/2]

byte[] SPBGenerateCSR	(	String	sPrivateKeyName,
		String	sRazaoSocial,
		String	sISPB,
		String	sSISBACEN,
		int	iSequencial,
		boolean	bProducao,
		String	sCidade,
		String	sUF ) throws TacException

Gera uma nova CSR baseada em uma chave existente (RSA 2048).

Parâmetros

sPrivateKeyName	Id da chave no HSM.
sRazaoSocial	Nome da Razão Social da Entidade, conforme o Manual de Segurança da RSFN.
sISPB	Código ISPB (08 dígitos). É o número base do CNPJ da instituição.
sSISBACEN	Código SISBACEN da instituição.(05 caracteres).
iSequencial	Numeração sequencial única de geração do par de chaves, conforme o Manual de Segurança da RSFN.
bProducao	Verdadeiro (true) para indicar certificado de ambiente de produção e falso (false) para indicar certificado de ambiente de homologação.
sCidade	Nome da Cidade. Parâmetro opcional, pode indicar NUL.
sUF	Nome do Estado (02 caracteres). Parâmetro opcional, pode indicar NUL.

Retorna

Array de bytes com a CSR. Basta direcionar para um arquivo.

Exceções

TacException

SPBGenerateCSR() [2/2]

byte[] SPBGenerateCSR	(	String	sPrivateKeyName,
		String	sSubject ) throws TacException

Gera uma nova CSR baseada em uma chave existente (RSA 2048).

Parâmetros

sPrivateKeyName	Id da chave no HSM.
sSubject	DN (Dinstinguished Name) do CSR para a geração do campo Subject do certificado. Os campos de DN deverão ser separados por '/'.

Retorna

Array de bytes com a CSR. Basta direcionar para um arquivo.

Exceções

TacException

generatePKCS10CSR()

byte[] generatePKCS10CSR	(	String	szKeyId,
		String	szDN,
		int	dwOutType ) throws TacException

Gera um CSR.

Parâmetros

szKeyId	nome da chave
szDN	String terminada em zero de tamanho máximo CORE_P10_CSR_DN_MAX_LEN, contendo o DN (Dinstinguished Name) para a geração do CSR. Os campos de DN deverão ser separados por '/'.
dwOutType	Formato de Saída P10_CSR_DER(1) ou P10_CSR_PEM(2)

Exceções

TacException

SPBImportCertificate() [1/3]

void SPBImportCertificate	(	String	szDomain,
		byte[]	bCertificate ) throws TacException

Importa um certificado para um namespace do HSM.

Parâmetros

szDomain	nome do domínio que o certificado será importado
bCertificate	array de bytes contendo o certificado (formato PEM ou DER)

Exceções

TacException

SPBImportCertificate() [2/3]

void SPBImportCertificate	(	String	szDomain,
		byte[]	bCertificate,
		boolean	isActive ) throws TacException

Importa um certificado para um namespace do HSM.

Parâmetros

szDomain	nome do domínio que o certificado será importado
bCertificate	array de bytes contendo o certificado (formato PEM ou DER)
isActive	ativa certificado após importação

Exceções

TacException

SPBImportCertificate() [3/3]

void SPBImportCertificate	(	String	szDomain,
		byte[]	bCertificate,
		boolean	isActive,
		int	dwParam ) throws TacException

Importa um certificado para um namespace do HSM.

Parâmetros

szDomain	nome do domínio que o certificado será importado
bCertificate	array de bytes contendo o certificado (formato PEM ou DER)
isActive	ativa certificado após importação
dwParam	A seguinte tabela de flags é suportada. Valor Significado 0 Utiliza o padrão SPB(Sistema de Pagamentos Brasileiro). TacNDJavaLib.ND_SPB_USE_CIP1 Utiliza o padrão CIP(Camara Interbancaria de Pagamentos)/C3 Nuclea. TacNDJavaLib.ND_SPB_USE_ANY Aceita o padrão CIP/C3 Nuclea e SPB. A detecção é feita internamente.

Exceções

TacException

SPBImportPKCS12()

void SPBImportPKCS12	(	String	path,
		String	pass,
		String	domain,
		boolean	isActivate,
		int	dwFlags ) throws TacException

Importa um certificado de um container PKCS#12 para o HSM.

Parâmetros

path	Caminho do arquivo
pass	Senha
dwFlags	Parâmetros adicionais da chave. Valor Significado TacNDJavaLib.NONEXPORTABLE_KEY A chave Não poderá sair do HSM. TacNDJavaLib.EXPORTABLE_KEY A chave poderá ser exportada do HSM. TacNDJavaLib.TEMPORARY_KEY A chave somente existirá enquanto a sessão estiver ativa. Ela será destruída após o encerramento da sessão.
domain	Dominio para a importação
isActivate	Ativa o certificado durante a importação

Exceções

TacException

SPBGetCertificate()

byte[] SPBGetCertificate

(

String

strIdCertificate

)

throws TacException

Recupera um certificado armazenado em um namespace no HSM.

Parâmetros

strIdCertificate

identificação do certificado no formato "<ISPB>@<Dominio>". Por exemplo: "11223344@SPR".

Retorna

Exceções

TacException

SPBDecode() [1/4]

byte[] SPBDecode	(	String	szSrcISPB,
		String	szDstISPB,
		byte[]	pbMsgIn,
		boolean	bAcceptExpiredCert,
		boolean	bAutoUpdateCert ) throws TacSPBException, IOException

Decodifica uma mensagem no padrão SPB, checando as assinaturas, decriptografando porem não faz a checagem de encoding.

Parâmetros

szSrcISPB	identificação do ISPB de origem no formato "<ISPB>@<Dominio>". Por exemplo: "11223344@SPR".
szDstISPB	identificação do ISPB de destino no formato "<ISPB>@<Dominio>". Por exemplo: "11223344@SPR".
pbMsgIn	mensagem codificada no padrão SPB passada como um array de bytes
bAcceptExpiredCert	verdadeiro (true) se o HSM deve aceitar certificados expirados nas mensagens de troca de certificado
bAutoUpdateCert	verdadeiro (true) para indicar que o HSM deve atualizar automaticamente o certificado da instituição que enviou uma mensagem SPB de troca de certificado

Retorna

Array de bytes com a mensagem decodificada.

Exceções

TacException	Erro na operaçãoo com o HSM.
IOException	Erro de escrita na memória (streams) de decodificação.

SPBDecode() [2/4]

byte[] SPBDecode	(	String	szSrcISPB,
		String	szDstISPB,
		byte[]	pbMsgIn,
		boolean	bAcceptExpiredCert,
		boolean	bAutoUpdateCert,
		boolean	bEncodingCheck ) throws TacSPBException, IOException

Decodifica uma mensagem no padrão SPB, checando as assinaturas e decriptografando.

Parâmetros

szSrcISPB	identificação do ISPB de origem no formato "<ISPB>@<Dominio>". Por exemplo: "11223344@SPR".
szDstISPB	identificação do ISPB de destino no formato "<ISPB>@<Dominio>". Por exemplo: "11223344@SPR".
pbMsgIn	mensagem codificada no padrão SPB passada como um array de bytes
bAcceptExpiredCert	verdadeiro (true) se o HSM deve aceitar certificados expirados nas mensagens de troca de certificado
bAutoUpdateCert	verdadeiro (true) para indicar que o HSM deve atualizar automaticamente o certificado da instituição que enviou uma mensagem SPB de troca de certificado
bEncodingCheck	liga a validação de range de codificação

Retorna

Array de bytes com a mensagem decodificada.

Exceções

TacException	Erro na operaçãoo com o HSM.
IOException	Erro de escrita na memória (streams) de decodificação.

SPBDecode() [3/4]

byte[] SPBDecode	(	String	szSrcISPB,
		String	szDstISPB,
		byte[]	pbMsgIn,
		boolean	bAcceptExpiredCert,
		boolean	bAutoUpdateCert,
		boolean	bEncodingCheck,
		int	dwFlags ) throws TacSPBException, IOException

Decodifica uma mensagem no padrão SPB, checando as assinaturas e decriptografando.

Parâmetros

szSrcISPB	identificação do ISPB de origem no formato "<ISPB>@<Dominio>". Por exemplo: "11223344@SPR". Também pode ser passado o nome do map correspondente, fora do padrão de nomenclatura do módulo SPB em casos específicos, ver dwFlags.
szDstISPB	identificação do ISPB de destino no formato "<ISPB>@<Dominio>". Por exemplo: "11223344@SPR". Também pode ser passado o nome do map correspondente, fora do padrão de nomenclatura do módulo SPB em casos específicos, ver dwFlags.
pbMsgIn	mensagem codificada no padrão SPB passada como um array de bytes
bAcceptExpiredCert	verdadeiro (true) se o HSM deve aceitar certificados expirados nas mensagens de troca de certificado
bAutoUpdateCert	verdadeiro (true) para indicar que o HSM deve atualizar automaticamente o certificado da instituição que enviou uma mensagem SPB de troca de certificado
bEncodingCheck	liga a validação de range de codificação
dwFlags	Define detalhes da decodificação, podendo assumir os seguintes valores descritos na tabela abaixo. Valor Signficado TacNDJavaLib.ND_SPB_OUT_NO_PADDING Retira o padding do final da mensagem SPB após a decriptação. TacNDJavaLib.ND_SPB_OUT_WITH_PADDING Mantem o padding no final da mensagem SPB após a decriptação. TacNDJavaLib.ND_SPB_USE_CIP1 Utiliza o padrão CIP(Camara Interbancaria de Pagamentos)/C3 Nuclea. Quando esta flag não está definida o padrão SPB(Sistema de Pagamentos Brasileiro) é utilizado. TacNDJavaLib.ND_SPB_RAW Modo sem verificações específicas de SPB. Aceita apenas o uso do nome do MAP como parâmetros de szSrcISPB e szDstISPB.

Retorna

Array de bytes com a mensagem decodificada.

Exceções

TacException	Erro na operaçãoo com o HSM.
IOException	Erro de escrita na memória (streams) de decodificação.

SPBDecode() [4/4]

byte[] SPBDecode	(	String	szSrcISPB,
		String	szDstISPB,
		byte[]	pbMsgIn ) throws TacException, IOException

Esse é um método provido por conveniência. Ele difere do método acima apenas na lista de argumentos que devem ser utilizados.

SPBEncode() [1/2]

byte[] SPBEncode	(	String	szSrcISPB,
		String	szDstISPB,
		byte[]	pbMsgIn,
		byte	bSpecialTreatment ) throws TacException

Codifica uma mensagem com o cabeçalho do SPB, assinando, criptografando e incluindo todos os campos de cabeçalhos definidos no manual de segurança da RSFN.

Parâmetros

szSrcISPB	identificação do ISPB de origem no formato "<ISPB>@<Dominio>". Por exemplo: "11223344@SPR".
szDstISPB	identificação do ISPB de destino no formato "<ISPB>@<Dominio>". Por exemplo: "11223344@SPR".
pbMsgIn	Mensagem passada como um array de bytes. O HSM Não faz conversão automática de formato. No padrão do SPB o formato definido é o UTF16-BE, e cabe ao chamador da API garantir que a mensagem esteja usando o formato correto.
bSpecialTreatment	Indicador de tratamento especial. Item 5.6 do manual do cabeçalho de segurança da RSFN.

Retorna

Exceções

TacException

SPBEncode() [2/2]

byte[] SPBEncode	(	String	szSrcISPB,
		String	szDstISPB,
		byte[]	pbMsgIn,
		byte	bSpecialTreatment,
		int	dwFlags ) throws TacException

Codifica uma mensagem com o cabeçalho do SPB, assinando, criptografando e incluindo todos os campos de cabeçalhos definidos no manual de segurança da RSFN.

Parâmetros

szSrcISPB	identificação do ISPB de origem no formato "<ISPB>@<Dominio>". Por exemplo: "11223344@SPR". Também pode ser passado o nome do map correspondente, fora do padrão de nomenclatura do módulo SPB em casos específicos, ver dwFlags.
szDstISPB	identificação do ISPB de destino no formato "<ISPB>@<Dominio>". Por exemplo: "11223344@SPR". Também pode ser passado o nome do map correspondente, fora do padrão de nomenclatura do módulo SPB em casos específicos, ver dwFlags.
pbMsgIn	Mensagem passada como um array de bytes. O HSM Não faz conversão automática de formato. No padrão do SPB o formato definido é o UTF16-BE, e cabe ao chamador da API garantir que a mensagem esteja usando o formato correto.
bSpecialTreatment	Indicador de tratamento especial. Item 5.6 do manual do cabeçalho de segurança da RSFN.
dwFlags	Define detalhes da decodificação, podendo assumir os seguintes valores descritos na tabela abaixo. Valor Signficado TacNDJavaLib.ND_SPB_ENCODE_GEN_01 Gera uma mensagem GEN 01. TacNDJavaLib.ND_SPB_USE_CIP1 Utiliza o padrão CIP(Camara Interbancaria de Pagamentos)/C3 Nuclea. Quando esta flag não está definida o padrão SPB(Sistema de Pagamentos Brasileiro) é utilizado. TacNDJavaLib.ND_SPB_ENCODE_HEADER_V3 Codifica a mensagem utilizando o cabeçalho de segurança versão 3. No futuro esta opção será definida por padrão. O cabeçalho V3 está disponível a partir da versão 5.0.16 do firmware do HSM. TacNDJavaLib.ND_SPB_RAW Modo sem verificações específicas de SPB. Aceita apenas o uso do nome do MAP como parâmetros de szSrcISPB e szDstISPB.

Retorna

Exceções

TacException