SPB

Descripción detallada

Operaciones de codificación y descodificación según la norma SPB.

Consulte la documentación técnica del HSM.

Funciones
void	SPBActivateCertificate (String szDomain, byte bCA, String szSN) lanza una TacException
	Activa un certificado ya importado en HSM.
void	SPBActivateCertificate (String szDomain, byte bCA, String szSN, int dwParam) throws TacException
	Activa un certificado ya importado en HSM.
void	SPBSetISPBMap (String strISPB, String strKeyId, String strCertId) lanza una TacException
	Crea un mapa con la clave y el certificado de la institución en una ranura.
byte[]	SPBGenerateCSR (String sPrivateKeyName, String sRazaoSocial, String sISPB, String sSISBACEN, int iSequencial, boolean bProducao, String sCidade, String sUF) throws TacException
	Genera una nueva CSR basada en una clave existente (RSA 2048).
byte[]	SPBGenerateCSR (String sPrivateKeyName, String sSubject) throws TacException
	Genera una nueva CSR basada en una clave existente (RSA 2048).
byte[]	generatePKCS10CSR (String szKeyId, String szDN, int dwOutType) throws TacException
	Generar un CSR.
void	SPBImportCertificate (String szDomain, byte[] bCertificate) lanza una TacException
	Importar un certificado a un espacio de nombres HSM.
void	SPBImportCertificate (String szDomain, byte[] bCertificate, boolean isActive) lanza una TacException
	Importar un certificado a un espacio de nombres HSM.
void	SPBImportCertificate (String szDomain, byte[] bCertificate, boolean isActive, int dwParam) throws TacException
	Importar un certificado a un espacio de nombres HSM.
void	SPBImportPKCS12 (String path, String pass, String domain, boolean isActivate, int dwFlags) lanza una TacException
	Importa un certificado desde un contenedor PKCS#12 al HSM.
byte[]	SPBGetCertificate (String strIdCertificate) lanza una TacException
	Recupera un certificado almacenado en un espacio de nombres del HSM.
byte[]	SPBDecode (String szSrcISPB, String szDstISPB, byte[] pbMsgIn, boolean bAcceptExpiredCert, boolean bAutoUpdateCert) throws TacSPBException, IOException
	Descifra un mensaje en el estándar SPB, comprobando las firmas, descifrando, pero no comprueba la codificación.
byte[]	SPBDecode (String szSrcISPB, String szDstISPB, byte[] pbMsgIn, boolean bAcceptExpiredCert, boolean bAutoUpdateCert, boolean bEncodingCheck) throws TacSPBException, IOException
	Descifra un mensaje en el estándar SPB, comprobando las firmas y descifrando.
byte[]	SPBDecode (String szSrcISPB, String szDstISPB, byte[] pbMsgIn, boolean bAcceptExpiredCert, boolean bAutoUpdateCert, boolean bEncodingCheck, int dwFlags) throws TacSPBException, IOException
	Descifra un mensaje en el estándar SPB, comprobando las firmas y descifrando.
byte[]	SPBDecode (String szSrcISPB, String szDstISPB, byte[] pbMsgIn) throws TacException, IOException
byte[]	SPBEncode (String szSrcISPB, String szDstISPB, byte[] pbMsgIn, byte bSpecialTreatment) throws TacException
	Codifica un mensaje con la cabecera SPB, firmando, cifrando e incluyendo todos los campos de cabecera definidos en el manual de seguridad RSFN.
byte[]	SPBEncode (String szSrcISPB, String szDstISPB, byte[] pbMsgIn, byte bSpecialTreatment, int dwFlags) throws TacException
	Codifica un mensaje con la cabecera SPB, firmando, cifrando e incluyendo todos los campos de cabecera definidos en el manual de seguridad RSFN.

Funciones

SPBActivateCertificate() [1/2]

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

Activa un certificado ya importado en HSM.

Si hay otro certificado activo, se desactivará. Sólo permanecerá activo un certificado por institución, por dominio dentro de un espacio de nombres HSM.

Parámetros

szDomain	Dominio operativo SPB
bCA	número de la CA que emitió el certificado
szSN	Número de serie del certificado a activar.

Excepciones

TacException

SPBActivateCertificate() [2/2]

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

Activa un certificado ya importado en HSM.

Si hay otro certificado activo, se desactivará. Sólo permanecerá activo un certificado por institución, por dominio dentro de un espacio de nombres HSM.

Parámetros

szDomain	Dominio operativo SPB
bCA	número de la CA que emitió el certificado
szSN	Número de serie del certificado a activar.
dwParam	Se admite la siguiente tabla de banderas. Valor Significado 0 Utiliza el estándar SPB (Sistema Brasileño de Pagos). TacNDJavaLib.ND_SPB_USE_CIP1 Utiliza el estándar CIP(Cámara Interbancaria de Pagamentos)/C3 Nuclea.

Excepciones

TacException

SPBSetISPBMap()

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

Crea un mapa con la clave y el certificado de la institución en una ranura.

Parámetros

strISPB	- Identificación del mapa (puede ser ISPB)
strKeyId	- Identificación de claves
strCertId	- Identificación del certificado

Excepciones

TacException

Lanza una excepción en caso de error de firma

SPBGenerarCSR() [1/2]

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

Genera una nueva CSR basada en una clave existente (RSA 2048).

Parámetros

sPrivateKeyName	Id de clave en el HSM.
sRazaoSocial	Nombre de la razón social de la organización, de conformidad con el Manual de Seguridad de RSFN.
sISPB	Código ISPB (08 dígitos). Es el número de base del CNPJ de la institución.
sSISBACEN	Código SISBACEN de la institución (05 caracteres).
iSequencial	Numeración secuencial única para generar el par de claves, de conformidad con el Manual de Seguridad de RSFN.
bProducao	Verdadero para indicar un certificado ambiental de producción y falso para indicar un certificado ambiental de homologación.
sCidade	Nombre de la ciudad. Parámetro opcional, puede indicar NUL.
sUF	Nombre del estado (02 caracteres). Parámetro opcional, puede indicar NUL.

Devolución

Matriz de bytes con CSR. Sólo tienes que dirigir a un archivo.

Excepciones

TacException

SPBGenerateCSR() [2/2]

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

Genera una nueva CSR basada en una clave existente (RSA 2048).

Parámetros

sPrivateKeyName	Id de clave en el HSM.
sSubject	DN (Dinstinguished Name) del CSR para generar el campo Asunto del certificado. Los campos DN deben estar separados por '/'.

Devolución

Matriz de bytes con CSR. Sólo tienes que dirigir a un archivo.

Excepciones

TacException

generarPKCS10CSR()

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

Generar un CSR.

Parámetros

szKeyId	nombre clave
szDN	Cadena terminada en cero de longitud máxima CORE_P10_CSR_DN_MAX_LEN, que contiene el DN (Dinstinguished Name) para generar el CSR. Los campos DN deben estar separados por "/".
dwOutType	Formato de salida P10_CSR_DER(1) o P10_CSR_PEM(2)

Excepciones

TacException

SPBImportCertificate() [1/3]

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

Importar un certificado a un espacio de nombres HSM.

Parámetros

szDomain	nombre del dominio al que se importará el certificado
bCertificate	matriz de bytes que contiene el certificado (formato PEM o DER)

Excepciones

TacException

SPBImportCertificate() [2/3]

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

Importar un certificado a un espacio de nombres HSM.

Parámetros

szDomain	nombre del dominio al que se importará el certificado
bCertificate	matriz de bytes que contiene el certificado (formato PEM o DER)
isActive	activa el certificado tras la importación

Excepciones

TacException

SPBImportCertificate() [3/3]

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

Importar un certificado a un espacio de nombres HSM.

Parámetros

szDomain	nombre del dominio al que se importará el certificado
bCertificate	matriz de bytes que contiene el certificado (formato PEM o DER)
isActive	activa el certificado tras la importación
dwParam	Se admite la siguiente tabla de banderas. Valor Significado 0 Utiliza el estándar SPB (Sistema Brasileño de Pagos). TacNDJavaLib.ND_SPB_USE_CIP1 Utiliza el estándar CIP(Cámara Interbancaria de Pagamentos)/C3 Nuclea. TacNDJavaLib.ND_SPB_USE_ANY Acepta el estándar CIP/C3 Nuclea y SPB. La detección se realiza internamente.

Excepciones

TacException

SPBImportPKCS12()

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

Importa un certificado desde un contenedor PKCS#12 al HSM.

Parámetros

path	Ruta del archivo
pass	Contraseña
dwFlags	Parámetros clave adicionales. Valor Significado TacNDJavaLib.NONEXPORTABLE_KEY La llave no puede salir del HSM. TacNDJavaLib.EXPORTABLE_KEY La clave puede exportarse desde el HSM. TacNDJavaLib.TEMPORARY_KEY La clave sólo existirá mientras la sesión esté activa. Se destruirá una vez cerrada la sesión.
domain	Dominio de importación
isActivate	Activa el certificado durante la importación

Excepciones

TacException

SPBGetCertificate()

byte[] SPBGetCertificate

(

String

strIdCertificate

)

throws TacException

Recupera un certificado almacenado en un espacio de nombres del HSM.

Parámetros

strIdCertificate

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

Devolución

Excepciones

TacException

SPBDecode() [1/4]

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

Descifra un mensaje en el estándar SPB, comprobando las firmas, descifrando, pero no comprueba la codificación.

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	mensaje codificado en el estándar SPB pasado como una matriz de bytes
bAcceptExpiredCert	true si el HSM debe aceptar certificados caducados en los mensajes de intercambio de certificados
bAutoUpdateCert	true para indicar que el HSM debe actualizar automáticamente el certificado de la institución que envió un mensaje de intercambio de certificados SPB

Devolución

Matriz de bytes con el mensaje descodificado.

Excepciones

TacException	Error en el funcionamiento del HSM.
IOException	Error de escritura en la memoria de descodificación (secuencias).

SPBDecode() [2/4]

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

Descifra un mensaje en el estándar SPB, comprobando las firmas y descifrando.

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	mensaje codificado en el estándar SPB pasado como una matriz de bytes
bAcceptExpiredCert	true si el HSM debe aceptar certificados caducados en los mensajes de intercambio de certificados
bAutoUpdateCert	true para indicar que el HSM debe actualizar automáticamente el certificado de la institución que envió un mensaje de intercambio de certificados SPB
bEncodingCheck	activar la validación de la gama de codificación

Devolución

Matriz de bytes con el mensaje descodificado.

Excepciones

TacException	Error en el funcionamiento del HSM.
IOException	Error de escritura en la memoria de descodificación (secuencias).

SPBDecode() [3/4]

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

Descifra un mensaje en el estándar SPB, comprobando las firmas y descifrando.

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	mensaje codificado en el estándar SPB pasado como una matriz de bytes
bAcceptExpiredCert	true si el HSM debe aceptar certificados caducados en los mensajes de intercambio de certificados
bAutoUpdateCert	true para indicar que el HSM debe actualizar automáticamente el certificado de la institución que envió un mensaje de intercambio de certificados SPB
bEncodingCheck	activar la validación de la gama de codificación
dwFlags	Define los detalles de descodificación y puede adoptar los siguientes valores descritos en la tabla siguiente. Valor Significado TacNDJavaLib.ND_SPB_OUT_NO_PADDING Elimina el relleno del final del mensaje SPB tras el descifrado. TacNDJavaLib.ND_SPB_OUT_WITH_PADDING Mantiene el relleno al final del mensaje SPB tras el descifrado. TacNDJavaLib.ND_SPB_USE_CIP1 Utiliza el estándar CIP(Camara Interbancaria de Pagamentos)/C3 Nuclea. Cuando este indicador no está activado, se utiliza el estándar SPB (Sistema Brasileño de Pagos). TacNDJavaLib.ND_SPB_RAW Modo sin comprobaciones específicas de SPB. Sólo acepta el uso del nombre MAP como parámetros para szSrcISPB e szDstISPB.

Devolución

Matriz de bytes con el mensaje descodificado.

Excepciones

TacException	Error en el funcionamiento del HSM.
IOException	Error de escritura en la memoria de descodificación (secuencias).

SPBDecode() [4/4]

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

Este es un método que se proporciona por comodidad. Difiere del método anterior únicamente en la lista de argumentos que deben utilizarse.

SPBEncode() [1/2]

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

Codifica un mensaje con la cabecera SPB, firmando, cifrando e incluyendo todos los campos de cabecera definidos en el manual de seguridad 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	Mensaje pasado como matriz de bytes. HSM no realiza conversiones automáticas de formato. En el estándar SPB, el formato definido es UTF16-BE, y corresponde a quien llama a la API asegurarse de que el mensaje utiliza el formato correcto.
bSpecialTreatment	Indicador de tratamiento especial. Punto 5.6 del manual de cabecera de seguridad RSFN.

Devolución

Excepciones

TacException

SPBEncode() [2/2]

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

Codifica un mensaje con la cabecera SPB, firmando, cifrando e incluyendo todos los campos de cabecera definidos en el manual de seguridad 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	Mensaje pasado como matriz de bytes. HSM no realiza conversiones automáticas de formato. En el estándar SPB, el formato definido es UTF16-BE, y corresponde a quien llama a la API asegurarse de que el mensaje utiliza el formato correcto.
bSpecialTreatment	Indicador de tratamiento especial. Punto 5.6 del manual de cabecera de seguridad RSFN.
dwFlags	Define los detalles de descodificación y puede adoptar los siguientes valores descritos en la tabla siguiente. Valor Significado TacNDJavaLib.ND_SPB_ENCODE_GEN_01 Genera un mensaje GEN 01. TacNDJavaLib.ND_SPB_USE_CIP1 Utiliza el estándar CIP(Camara Interbancaria de Pagamentos)/C3 Nuclea. Cuando este indicador no está activado, se utiliza el estándar SPB (Sistema Brasileño de Pagos). TacNDJavaLib.ND_SPB_ENCODE_HEADER_V3 Codifica el mensaje utilizando la cabecera de seguridad versión 3. En el futuro, esta opción estará activada por defecto. La cabecera V3 está disponible a partir de la versión 5.0.16 del firmware del HSM. TacNDJavaLib.ND_SPB_RAW Modo sin comprobaciones específicas de SPB. Sólo acepta el uso del nombre MAP como parámetros para szSrcISPB e szDstISPB.

Devolución

Excepciones

TacException