Gestión

Descripción detallada

Gestión de HSM.

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

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.

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.