Gestión HSM

Descripción detallada

Gestión administrativa del HSM.

Véase Documentación técnica de HSM.

Gestión administrativa del HSM. Más...

Funciones
TacAccessToken	issueAToken (long lExpiration) throws TacException
	Emite un token de acceso para la sesión del usuario en el HSM.
void	revokeAToken(TacAccessToken accessToken) throws TacException
	Revoca la sesión de Access Token de un usuario en el HSM.
TacAccessToken[]	listAToken () throws TacException
	Enumera los tokens de acceso del usuario en el HSM.
int	getATokenCounter () lanza una TacException
	Recupera el contador de tokens de acceso de todo el HSM.
void	runATokenGC () throws TacException
	Ejecuta el recolector de basura para los tokens de sesión HSM.
HSMStatInfo	getStatInfo () lanza una TacException
	Recupera las estadísticas del HSM, como las cifras de uso de sesión, CPU y memoria.
HSMAllInfo	getHSMInfo () lanza una TacException
	Recupera información sobre el estado del HSM.
Cadena	getHSMStringInfo () throws TacException
	Recupera información sobre el estado del HSM.
Cadena	getFirmwareVersion () lanza una TacException
	Recupera la versión de firmware del HSM.
Cadena	getModel () throws TacException
	Recuperar el modelo HSM.
Cadena	getSerialNumber () throws TacException
	Recupera el número de serie del HSM.
void	backup (String file, String password) throws TacException
	Crea una copia de seguridad de los objetos (claves, certificados, etc.) almacenados internamente en el archivo Dinamo.
void	restoreWithoutNetConfig (String file, String password) throws TacException
	Restaura la copia de seguridad de los objetos (claves, certificados, etc.) almacenados internamente en el Dinamo.
void	restoreWithNetConfig (String file, String password) throws TacException
	Restaura la copia de seguridad de los objetos (claves, certificados, etc.) almacenados internamente en el Dinamo.
void	backupData (String file, String password, int direction) throws TacException
	Crea o restaura la copia de seguridad de los objetos (claves, certificados, etc.) almacenados internamente en la base de datos de Dinamo.
void	setTlsBundle (String szKey, String szCert) throws TacException
	Define la clave y el certificado que utilizará el HSM al establecer el túnel TLS.
void	nsAuthSetState (int acl, int state, SvmkShadow[] shadows) throws TacException
	Establece el estado de autorización M de N de la partición (NSAuth).
SvmkShadow	scReadShadow (String pin) throws TacException
	Lee el código M de N de la tarjeta inteligente insertada en el lector.
ScInfo	scGetInfo () lanza una excepción TacException
	Recupera la información de la tarjeta inteligente insertada en el lector.
booleano	scIsLibLoaded ()
	Comprueba si la biblioteca de acceso al lector de tarjetas inteligentes está cargada.
void	scChangePIN (String currentPin, String newPin) throws TacException
	Cambia el PIN de la tarjeta Smart-card M de N Dinamo insertada en el lector.
void	scWriteShadow (SvmkShadow shadow, String pin, boolean overwrite) throws TacException
	Escribe una «shadow M de N» en la tarjeta inteligente insertada en el lector.
void	scErase (String pin) lanza una excepción TacException
	Borra la información de una tarjeta inteligente M de N Dinamo insertada en el lector.
void	scSetLabel (String pin, String label) throws TacException
	Define la etiqueta de la tarjeta inteligente M de N Dinamo insertada en el lector.
Cadena	scGetLabel (String pin) throws TacException
	Recupera la etiqueta de la tarjeta inteligente M de N Dinamo insertada en el lector.

Funciones

issueAToken()

TacAccessToken issueAToken

(

long

lExpiration

)

throws TacException

Emite un token de acceso para la sesión del usuario en el HSM.

Esta funcionalidad es adecuada para el control granular de la autenticación de aplicaciones, donde la emisión de tokens es gestionada por el responsable de seguridad.
La limpieza de las Access Tokens caducadas tiene lugar en 2 etapas:
Cuando un usuario que tiene Access Tokens caducados inicia sesión utilizando Access Tokens. Limpiando sólo las propias Access Tokens caducadas.
Utilizando la función revokeAToken(). Borra todas las Access Tokens caducadas del HSM.

El límite máximo de Access Tokens emitidos por HSM puede verse en la siguiente tabla.

Modelo	Límite máximo
Pocket	1024
XP	1 millón
ST	1 millón

Notas: Los Access Tokens se guardan de forma volátil, por lo que se borran al reiniciar el HSM. A pesar de ser volátiles, los Access Tokens se replican entre los HSM.

Esta operación está disponible a partir de la versión 3.17 del firmware del HSM. La implementación de Access Tokens anterior a la versión de firmware 3.17 es heredada. Las aplicaciones que utilicen esta funcionalidad deben actualizar el cliente HSM a la versión 3.2.18 o superior, junto con el firmware HSM a la versión 3.17 o superior. No existe compatibilidad entre las versiones nuevas y antiguas del cliente HSM y del firmware.

Parámetros

lExpiration

Caducidad del token. Equivalente a time_t. Medido en segundos desde EPOCH(00:00, Jan 1 1970 UTC). Utilice TacNDJavaLib.DN_A_TOKEN_INFINITE para tokens sin caducidad.

Devolución

AToken para su uso en openSession.

Excepciones

TacException

Se ejecuta cuando se produce un error en la generación del código de acceso.

revokeAToken()

void revokeAToken

(

TacAccessToken

accessToken

)

throws TacException

Revoca la sesión de Access Token de un usuario en el HSM.

Parámetros

accessToken

Identificador de acceso que debe revocarse.

Excepciones

TacException

Se ejecuta cuando se produce un error al revocar el código de acceso.

listAToken()

TacAccessToken[] listAToken

(

)

throws TacException

Enumera los tokens de acceso del usuario en el HSM.

Devolución

Lista de ATokens de usuario.

Excepciones

TacException

Se ejecuta cuando se produce un error al revocar el código de acceso.

getATokenContador()

int getATokenCounter

(

)

throws TacException

Recupera el contador de tokens de acceso de todo el HSM.

Devolución

Total de fichas de acceso para todo el HSM.

Excepciones

TacException

Publicado en caso de error.

runATokenGC()

void runATokenGC

(

)

throws TacException

Ejecuta el recolector de basura para los tokens de sesión HSM.

Este método limpia las credenciales de acceso en el HSM que ya no son válidas.
El GC debe ser llamado periódicamente por la aplicación para mantener los niveles de caché de Access Token bajo control. El horario de ejecución de la GC debe programarse teniendo en cuenta las horas de mayor carga de trabajo del HSM.

Excepciones

TacException

Publicado en caso de error.

getStatInfo()

HSMStatInfo getStatInfo

(

)

throws TacException

Recupera las estadísticas del HSM, como las cifras de uso de sesión, CPU y memoria.

Devolución

Información estadística.

Excepciones

TacException

Se publica cuando se produce un error en la recuperación de información.

getHSMInfo()

HSMAllInfo getHSMInfo

(

)

throws TacException

Recupera información sobre el estado del HSM.

Devolución

Información estadística.

Excepciones

TacException

Se publica cuando se produce un error en la recuperación de información.

getHSMStringInfo()

String getHSMStringInfo

(

)

throws TacException

Recupera información sobre el estado del HSM.

Devolución

Información sobre el estado de HSM.

Excepciones

TacException

Se publica cuando se produce un error en la recuperación de información.

getFirmwareVersion()

String getFirmwareVersion

(

)

throws TacException

Recupera la versión de firmware del HSM.

Devolución

Versión del firmware del HSM o null si esta información no está disponible.

Excepciones

TacException

Se publica cuando se produce un error en la recuperación de información.

getModel()

String getModel

(

)

throws TacException

Recuperar el modelo HSM.

Devolución

Modelo de HSM o null si esta información no está disponible.

Excepciones

TacException

Se publica cuando se produce un error en la recuperación de información.

getSerialNumber()

String getSerialNumber

(

)

throws TacException

Recupera el número de serie del HSM.

Devolución

Número de serie del HSM o null si no existe tal información.

Excepciones

TacException

Se publica cuando se produce un error en la recuperación de información.

copia de seguridad()

void backup	(	String	file,
		String	password ) throws TacException

Crea una copia de seguridad de los objetos (claves, certificados, etc.) almacenados internamente en el archivo Dinamo.

Se creará el archivo de copia de seguridad, si existe, se sobrescribirá.

Parámetros

file	Ruta del archivo de copia de seguridad.
password	Contraseña de seguridad.

Excepciones

TacException

Se ejecuta cuando se produce un error al crear la copia de seguridad.

restoreWithoutNetConfig()

void restoreWithoutNetConfig	(	String	file,
		String	password ) throws TacException

Restaura la copia de seguridad de los objetos (claves, certificados, etc.) almacenados internamente en el Dinamo.

Sin configuración de red.

Parámetros

file	Ruta del archivo de copia de seguridad.
password	Contraseña de seguridad.

Excepciones

TacException

Se ejecuta cuando se produce un error al restaurar la copia de seguridad.

restoreWithNetConfig()

void restoreWithNetConfig	(	String	file,
		String	password ) throws TacException

Restaura la copia de seguridad de los objetos (claves, certificados, etc.) almacenados internamente en el Dinamo.

Con la configuración de red.

Parámetros

file	Ruta del archivo de copia de seguridad.
password	Contraseña de seguridad.

Excepciones

TacException

Se ejecuta cuando se produce un error al restaurar la copia de seguridad.

backupData()

void backupData	(	String	file,
		String	password,
		int	direction ) throws TacException

Crea o restaura la copia de seguridad de los objetos (claves, certificados, etc.) almacenados internamente en la base de datos de Dinamo.

Parámetros

file	Ruta del archivo de copia de seguridad o restauración.
password	Copia de seguridad o restaurar contraseña.
direction	Especifica la acción a realizar. Valor Significado TacNDJavaLib.MAKE_BACKUP Se creará el archivo de copia de seguridad, si existe, se sobrescribirá. TacNDJavaLib.MAKE_RESTORE_WITHOUT_NET_CONFIG Se restaurarán los datos de copia de seguridad existentes, sin incluir los parámetros de red, en el archivo indicado por archivo. TacNDJavaLib.MAKE_RESTORE_WITH_NET_CONFIG Se restaurarán los datos de copia de seguridad existentes, incluidos los parámetros de red, en el archivo indicado por archivo. TacNDJavaLib.MAKE_USE_WIN_CREDENTIAL Utiliza las credenciales de Windows para la autenticación. Esta opción debe utilizarse con una de las otras opciones. Introduzca el destino de las credenciales en el campo de contraseña.

Excepciones

TacException

Se ejecuta cuando se produce un error al crear o restaurar la copia de seguridad.

setTlsBundle()

void setTlsBundle	(	String	szKey,
		String	szCert ) throws TacException

Define la clave y el certificado que utilizará el HSM al establecer el túnel TLS.

Al pasar cadenas vacías a szKey y szCert, se restablecen la clave y el certificado predeterminados del HSM.

Parámetros

szKey	Identificador de la clave (formato usuario/clave) que se utilizará en el TLS del HSM. Pasa una cadena vacía para utilizar la clave predeterminada.
szCert	Identificador del certificado (formato usuario/cert) que se utilizará en el TLS del HSM. Pasa una cadena vacía para utilizar el certificado predeterminado.

Excepciones

TacException

Se lanza cuando se produce un error en la operación.

nsAuthSetState()

void nsAuthSetState	(	int	acl,
		int	state,
		SvmkShadow[]	shadows ) throws TacException

Establece el estado de autorización M de N de la partición (NSAuth).

Se utiliza para asociar el HSM a una partición M de N y definir el nivel de acceso a los objetos mediante sombras de tarjetas inteligentes Dinamo. La sesión debe estar autenticada.

Estados disponibles (@iliteral{code} state @endiliteral )

Estado	Significado	acl
TacNDJavaLib#DN_S_NSAUTH_ASSOC	Establece el estado asociado. Indique la ACL deseada en acl.	combinación de NSAUTH_ACL_*
TacNDJavaLib#DN_S_NSAUTH_RESET	Restablece el estado NSAuth (no asociado y no autorizado).	TacNDJavaLib#NSAUTH_ACL_NOP
TacNDJavaLib#DN_S_NSAUTH_AUTH	Establece el estado autorizado. Aún no disponible.	TacNDJavaLib#NSAUTH_ACL_NOP
TacNDJavaLib#DN_S_NSAUTH_eAUTH	Establece la sesión como autorizada. La ACL debe haberse definido previamente mediante TacNDJavaLib#DN_S_NSAUTH_ASSOC.	TacNDJavaLib#NSAUTH_ACL_NOP
TacNDJavaLib#DN_S_NSAUTH_CHECK	Comprueba el conjunto de sombras. No modifica el estado de NSAuth.	TacNDJavaLib#NSAUTH_ACL_NOP

Parámetros

acl	Permisos de acceso a objetos (combinación de indicadores NSAUTH_ACL_*). Solo es relevante para TacNDJavaLib#DN_S_NSAUTH_ASSOC; pasar TacNDJavaLib#NSAUTH_ACL_NOP en los demás estados.
state	Estado por determinar. Véase la tabla anterior.
shadows	Sombras de las tarjetas inteligentes de la partición M de N. Puede ser nulo o estar vacío para estados que no requieran sombras (p. ej. TacNDJavaLib#DN_S_NSAUTH_RESET, TacNDJavaLib#DN_S_NSAUTH_eAUTH).

Excepciones

TacException

scReadShadow()

SvmkShadow scReadShadow

(

String

pin

)

throws TacException

Lee el código M de N de la tarjeta inteligente insertada en el lector.

Esta operación accede a la tarjeta directamente a través del lector USB/CCID y no requiere una sesión HSM. Comprueba la disponibilidad de la biblioteca con scIsLibLoaded().

Parámetros

pin	PIN de la tarjeta. Longitud máxima TacNDJavaLib#DN_SC_MAX_PIN_LEN.

Devolución

Shadow maneja la tarjeta.

Excepciones

TacException

scGetInfo()

ScInfo scGetInfo

(

)

throws TacException

Recupera la información de la tarjeta inteligente insertada en el lector.

Esta operación accede a la tarjeta directamente a través de un lector USB/CCID y no requiere una sesión HSM.

Devolución

Estructura con los datos de la tarjeta.

Excepciones

TacException

scIsLibLoaded()

boolean scIsLibLoaded

(

)

Comprueba si la biblioteca de acceso al lector de tarjetas inteligentes está cargada.

Devolución

true si la biblioteca está disponible; false en caso contrario.

scChangePIN()

void scChangePIN	(	String	currentPin,
		String	newPin ) throws TacException

Cambia el PIN de la tarjeta Smart-card M de N Dinamo insertada en el lector.

Esta operación accede a la tarjeta directamente a través de un lector USB/CCID y no requiere una sesión HSM.

Parámetros

currentPin	PIN actual de la tarjeta. Longitud máxima TacNDJavaLib#DN_SC_MAX_PIN_LEN.
newPin	Nuevo PIN de la tarjeta. Longitud máxima TacNDJavaLib#DN_SC_MAX_PIN_LEN.

Excepciones

TacException

scWriteShadow()

void scWriteShadow	(	SvmkShadow	shadow,
		String	pin,
		boolean	overwrite ) throws TacException

Escribe una «shadow M de N» en la tarjeta inteligente insertada en el lector.

Esta operación accede a la tarjeta directamente a través de un lector USB/CCID y no requiere una sesión HSM.

Parámetros

shadow	Shadow se está grabando en la tarjeta.
pin	PIN de la tarjeta. Longitud máxima TacNDJavaLib#DN_SC_MAX_PIN_LEN.
overwrite	true para sobrescribir una sombra existente.

Excepciones

TacException

scErase()

void scErase

(

String

pin

)

throws TacException

Borra la información de una tarjeta inteligente M de N Dinamo insertada en el lector.

Esta operación accede a la tarjeta directamente a través de un lector USB/CCID y no requiere una sesión HSM.

Parámetros

pin	PIN de la tarjeta. Longitud máxima TacNDJavaLib#DN_SC_MAX_PIN_LEN.

Excepciones

TacException

scSetLabel()

void scSetLabel	(	String	pin,
		String	label ) throws TacException

Define la etiqueta de la tarjeta inteligente M de N Dinamo insertada en el lector.

Esta operación accede a la tarjeta directamente a través de un lector USB/CCID y no requiere una sesión HSM.

Parámetros

pin	PIN de la tarjeta. Longitud máxima TacNDJavaLib#DN_SC_MAX_PIN_LEN.
label	Etiqueta ASCII. Tamaño máximo TacNDJavaLib#DN_SC_MAX_LABEL_LEN.

Excepciones

TacException

scGetLabel()

String scGetLabel

(

String

pin

)

throws TacException

Recupera la etiqueta de la tarjeta inteligente M de N Dinamo insertada en el lector.

Esta operación accede a la tarjeta directamente a través de un lector USB/CCID y no requiere una sesión HSM.

Parámetros

pin	PIN de la tarjeta. Longitud máxima TacNDJavaLib#DN_SC_MAX_PIN_LEN.

Devolución

Etiqueta de la tarjeta en formato ASCII.

Excepciones

TacException