Descripción detallada

Gestión de HSM.

Enumeraciones
enum	TOKEN_TYPE : int { TIME = 1 , EVENT = 2 , CHAP = 3 , NTP = 4 }

Funciones
cadena	GetErrorString (Int32 _errorCode)
	Devuelve el mensaje con la descripción del error.

FechaHora	GetHSMDate ()
	Devuelve la fecha/hora del HSM.

void	SetHSMDateTime (DateTime stDateTime)
	Establece la fecha/hora del HSM.

DinamoApi.SYS_COUNTER_INFO	GetHSMCounterInfo ()
	Recupera información de los contadores del sistema HSM.

void	GetHSMHardwareInfo ()
	Recupera información de hardware del HSM.

void	Copia de seguridad (cadena DestFile, cadena Pin)
	Recuperar una copia de seguridad HSM.

void	Restore (string SourceFile, string Pin, bool IncludeNetworkParameters)
	Restaurar una copia de seguridad en HSM.

int	GetLogSize ()
	Recupera el tamaño de los registros del HSM.

byte[]	DGetStatLog ()
	Recuperar los registros del HSM.

byte[]	DGetStatLog (int StartPos, int BytesToRead)
	Recuperar los registros del HSM.

int	IPFilterOperationStatus ()
	Recupera el estado del filtro IP del HSM.

int	IPFilterOperationAdd (cadena szUser, cadena szIP)
	Añade un conjunto de IP/usuario a la lista blanca de IP del HSM.

int	IPFilterOperationRemove (cadena szUser, cadena szIP)
	Elimina un conjunto de IP/usuario de la lista blanca de IP del HSM.

int	IPFilterSetStatus (bool bStatus)
	Establece el estado del filtro IP del HSM.

int	IPFilterOptList (DinamoApi.ListIpFilterCallback filterIpCallBack, IntPtr param)
	Recupera la lista del filtro IP del HSM.

void	SaveLog (cadena fileName)
	Guarda los registros del HSM en un archivo.

void	ClearLog ()
	Borra los registros del HSM.

cadena	EmitAuthenticationToken (DateTime expirationDate)

cadena	IssueAToken (caducidad ulong)
	Esta funcionalidad es adecuada para el control granular de la autenticación de aplicaciones, donde la emisión detokens es gestionada por el responsable de seguridad. Las Claves de Acceso caducadas se borran en 2 etapas: Cuando un usuario que tiene Access Tokens caducados inicia sesión utilizando Access Tokens. Se limpian sólo las propias Access Tokens caducadas. Utilizando la función RunATokenGC(). Borra todas las Access Tokens caducadas del HSM.

cadena	IssueAToken (caducidad larga)
	/sobrecarga void IssueAToken(ulong expiration)

cadena	IssueAToken (DateTime expiration)
	/sobrecarga void IssueAToken(ulong expiration)

void	RevokeAToken (cadena aToken)
	Revocar un token de autenticación HSM.

void	RevokeAuthenticationToken (cadena strToken)

DinamoApi.DN_A_TOKEN_FULL[]	ListATokenFull ()
	Enumera los tokens de acceso del usuario en el HSM.

void	RunATokenGC ()
	Ejecuta el recolector de basura para tokens de sesión HSM. Este método limpia los tokens de acceso HSM que ya no son válidos. 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 del GC debe programarse teniendo en cuenta las horas de mayor carga de trabajo del HSM.

uint	GetATokenCounter ()
	Recupera el contador de tokens de acceso de todo el HSM.

Enumeraciones

◆ TIPO_TOKEN

enum TOKEN_TYPE: int

Enumeradores
TIEMPO
EVENTO
CHAP
NTP

Funciones

◆ GetErrorString()

cadena GetErrorString ( Int32 CódigoError )

en línea

Devuelve el mensaje con la descripción del error.

Parámetros

CódigoError Código de error.

Devolución: Descripción del error.

◆ GetHSMDate()

DateTime GetHSMDate ( )

en línea

Devuelve la fecha/hora del HSM.

Devolución: Fecha en formato DateTime

Excepciones

DinamoException Lanza una excepción en caso de error.

Ejemplos: get_date.cs.

◆ SetHSMDateTime()

void SetHSMDateTime ( FechaHora stDateTime )

en línea

Establece la fecha/hora del HSM.

Parámetros

stDateTime Fecha en formato DateTime

Excepciones

DinamoException Lanza una excepción en caso de error.

◆ GetHSMCounterInfo()

DinamoApi.SYS_COUNTER_INFO GetHSMCounterInfo ( )

en línea

Recupera información de los contadores del sistema HSM.

Devolución: Información del contador del sistema HSM.

Excepciones

DinamoException Lanza una excepción en caso de error.

Ejemplos: get_counter_info.cs.

◆ GetHSMHardwareInfo()

void GetHSMHardwareInfo ( )

en línea

Recupera información de hardware del HSM.

Excepciones

DinamoException Lanza una excepción en caso de error.

◆ Copia de seguridad()

void Copia de seguridad	(	cadena	DestFile,
		cadena	Pin )

en línea

Recuperar una copia de seguridad HSM.

Parámetros

DestFile	Nombre del archivo de destino de la copia de seguridad.
Pin	Contraseña para proteger el archivo de copia de seguridad. Deben ser caracteres ASCII. La longitud debe estar comprendida entre DinamoApi .MIN_BACKUP_PIN_LEN y DinamoApi.MAX_BACKUP_PIN_LEN.

Excepciones

DinamoException Lanza una excepción en caso de error.

◆ Restaurar()

void Restaurar	(	cadena	FuenteArchivo,
		cadena	Pin,
		bool	IncludeNetworkParameters )

en línea

Restaurar una copia de seguridad en HSM.

Parámetros

ArchivoFuente	Nombre del archivo de copia de seguridad.
Pin	Contraseña para proteger el archivo de copia de seguridad. Deben ser caracteres ASCII. La longitud debe estar comprendida entre DinamoApi .MIN_BACKUP_PIN_LEN y DinamoApi.MAX_BACKUP_PIN_LEN.
IncludeNetworkParameters	Si es verdadero, incluye la configuración de red en la restauración del HSM.

Excepciones

DinamoException Lanza una excepción en caso de error.

◆ GetLogSize()

int GetLogSize ( )

en línea

Recupera el tamaño de los registros del HSM.

Excepciones

DinamoException Lanza una excepción en caso de error.

◆ DGetStatLog() [1/2]

byte[] DGetStatLog ( )

en línea

Recuperar los registros del HSM.

Devolución: Registros completos de HSM.

Excepciones

DinamoException Lanza una excepción en caso de error.

◆ DGetStatLog() [2/2]

byte[] DGetStatLog	(	int	StartPos,
		int	BytesToRead )

en línea

Recuperar los registros del HSM.

Parámetros

StartPos	Posición inicial, en bytes, del registro a recuperar. Para recibir el contenido completo del registro, introduzca DinamoApi.GET_LOG_START_FULL.
BytesToRead	Cantidad, en bytes, que se recuperará desde la posición inicial indicada por `dwStart`. Para recibir todo el contenido del registro, indique DinamoApi.GET_LOG_END_FULL.

Devolución: Registros HSM.

Excepciones

DinamoException Lanza una excepción en caso de error.

◆ IPFilterOperationStatus()

int IPFilterOperationStatus ( )

en línea

Recupera el estado del filtro IP del HSM.

Devolución: Estado del filtro IP.

Excepciones

DinamoException Lanza una excepción en caso de error.

◆ IPFilterOperationAdd()

int IPFilterOperationAdd	(	cadena	szUsuario,
		cadena	szIP )

en línea

Añade un conjunto de IP/usuario a la lista blanca de IP del HSM.

Parámetros

szUsuario	Nombre de usuario.
szIP	IP

Devolución: Estado del filtro IP.

Excepciones

DinamoException Lanza una excepción en caso de error.

◆ IPFilterOperationRemove()

int IPFilterOperationRemove	(	cadena	szUsuario,
		cadena	szIP )

en línea

Elimina un conjunto de IP/usuario de la lista blanca de IP del HSM.

Parámetros

szUsuario	Nombre de usuario.
szIP	IP

Devolución: Estado del filtro IP.

Excepciones

DinamoException Lanza una excepción en caso de error.

◆ IPFilterSetStatus()

int IPFilterSetStatus ( bool bEstado )

en línea

Establece el estado del filtro IP del HSM.

Parámetros

bEstado true para activado y false para desactivado.

Devolución: Estado del filtro IP.

Excepciones

DinamoException Lanza una excepción en caso de error.

◆ IPFilterOptList()

int IPFilterOptList	(	DinamoApi.ListIpFilterCallback	filterIpCallBack,
		IntPtr	param )

en línea

Recupera la lista del filtro IP del HSM.

Parámetros

filterIpCallBack	Devolución de llamada de listado IP.
stop	Parámetro de devolución de llamada.

Devolución: Estado del filtro IP.

Excepciones

DinamoException Lanza una excepción en caso de error.

◆ GuardarLog()

void SaveLog ( cadena fileName )

en línea

Guarda los registros del HSM en un archivo.

Parámetros

fileName Nombre del archivo en el que se guardarán los registros.

Excepciones

DinamoException Lanza una excepción en caso de error.

◆ BorrarLog()

void ClearLog ( )

en línea

Borra los registros del HSM.

Excepciones

DinamoException Lanza una excepción en caso de error.

◆ EmitAuthenticationToken()

cadena EmitAuthenticationToken ( FechaHora fecha de expiración )

en línea

Obsoleto: Utilice IssueAToken().

◆ EmitirAToken() [1/3]

cadena IssueAToken ( ulong caducidad )

en línea

Esta funcionalidad es adecuada para el control granular de la autenticación de aplicaciones, donde la emisión detokens es gestionada por el responsable de seguridad.
Las Claves de Acceso caducadas se borran en 2 etapas:
Cuando un usuario que tiene Access Tokens caducados inicia sesión utilizando Access Tokens. Se limpian sólo las propias Access Tokens caducadas.
Utilizando la función RunATokenGC(). Borra todas las Access Tokens caducadas del HSM.

El límite máximo de tokens de acceso 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 3.17 del firmware 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

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

Devolución: AToken para su uso en Connect().

Excepciones

DinamoException Lanza una excepción en caso de error.

Ejemplos: atoken.cs.

◆ EmitirAToken() [2/3]

cadena IssueAToken ( largo caducidad )

en línea

/sobrecarga void IssueAToken(ulong expiration)

◆ EmitirAToken() [3/3]

cadena IssueAToken ( FechaHora caducidad )

en línea

/sobrecarga void IssueAToken(ulong expiration)

◆ RevocarAToken()

void RevokeAToken ( cadena aToken )

en línea

Revocar un token de autenticación HSM.

Parámetros

aToken Token de autenticación a revocar.

Excepciones

DinamoException Lanza una excepción en caso de error.

Ejemplos: atoken.cs.

◆ RevokeAuthenticationToken()

void RevokeAuthenticationToken ( cadena strToken )

en línea

Obsoleto: Utilice RevokeAToken().

◆ ListaATokenFull()

DinamoApi.DN_A_TOKEN_FULL[] ListATokenFull ( )

en línea

Enumera los tokens de acceso del usuario en el HSM.

Devolución: Lista de ATokens de usuario.

Excepciones

DinamoException

Ejemplos: atoken.cs.

◆ EjecutarATokenGC()

void RunATokenGC ( )

en línea

Ejecuta el recolector de basura para tokens de sesión HSM. Este método limpia los tokens de acceso HSM que ya no son válidos.
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 del GC debe programarse teniendo en cuenta las horas de mayor carga de trabajo del HSM.

Excepciones

DinamoException

Ejemplos: atoken.cs.

◆ GetATokenContador()

uint GetATokenCounter ( )

en línea

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

Devolución: Total de fichas de acceso para todo el HSM.

Excepciones

DinamoException

Ejemplos: atoken.cs.