Descripción detallada

OATHAutenticación estándar .

Véase Documentación técnica de HSM sobre detalles de funcionamiento, especificaciones utilizadas, licencias e nombre comercial del módulo.

Funciones
int AAP_API	DOATHIssueBlob (HSESSIONCTX hSession, char szMasterKeyId, DWORD dwParamBlobType, void pvParamBlob, DWORD dwParamBlobLen, BYTE pbOTPBlob, DWORD pdwOTPBlobLen, DWORD dwFlags)

int AAP_API	DOATHCheckOTP (HSESSIONCTX hSession, char szMasterKeyId, char szOTP, BYTE pbOATHBlob, DWORD pdwOATHBlobLen, DWORD dwFlags)

int AAP_API	DOATHGetNextOTP (HSESSIONCTX hSession, char szMasterKeyId, BYTE bOTPLen, BYTE pbOATHBlob, DWORD dwOATHBlobLen, char *szOTP, DWORD dwFlags)

int AAP_API	DOATHGetBlobInfo (const HSESSIONCTX hSession, char szMasterKey, BYTE pbInBlob, DWORD dwInBlobLen, DWORD dwOutBlobType, BYTE pbOutInfo, DWORD pdwOutInfoLen, DWORD dwParam)

int AAP_API	DOATHBlobResync (HSESSIONCTX hSession, char szMasterKeyId, char szOTP1, char szOTP2, BYTE pbOATHBlob, DWORD *pdwOATHBlobLen, DWORD dwFlags)

int AAP_API	DOATHPskcTranslate (HSESSIONCTX hSession, char szMasterKey, BYTE pbPSK, BYTE bPSKLen, BYTE pbPSKC, DWORD dwPSKCLen, void pvBlobList, DWORD pdwBlobListQuantity, DWORD dwParam)

Funciones

◆ DOATHIssueBlob()

int AAP_API DOATHIssueBlob	(	HSESSIONCTX	hSession,
		char *	szMasterKeyId,
		DWORD	dwParamBlobType,
		void *	pvParamBlob,
		DWORD	dwParamBlobLen,
		BYTE *	pbOTPBlob,
		DWORD *	pdwOTPBlobLen,
		DWORD	dwFlags )

#include <dinamo.h>

OATH Genera o importa un blob para su uso en HSM.

Parámetros

[in] hSession Contexto adquirido a través de la función DOpenSession().

[in] szMasterKeyId Nombre de la clave maestra, utilizada para proteger los blobs, de tamaño máximo MAX_OBJ_ID_FQN_LEN.

[in]

dwParamBlobType

Se acepta la siguiente tabla.

valor	Significado
ISSUE_OATH_GENERATE_HOTP	Tipo de `pvParamBlob:` estructura ISSUE_OTP_BLOB. Genera un blob HOTP en el HSM. La semilla se genera dentro del HSM. Deben rellenarse los siguientes parámetros de la estructura: `bSeedLen` y `bTruncationOffset`. Los demás deben ponerse a cero.
ISSUE_OATH_GENERATE_TOTP	Tipo de `pvParamBlob:` estructura ISSUE_OTP_BLOB. Genera un blob TOTP en el HSM. La semilla se genera dentro del HSM. Deben rellenarse los siguientes parámetros de la estructura: `bSeedLen`, `bTruncationOffset`, `wTimeStep` y `otT0`. Los demás deben ponerse a cero.
ISSUE_OATH_IMPORT_HOTP	Tipo de `pvParamBlob:` estructura ISSUE_OTP_BLOB. Importa un blob HOTP. La semilla se pasa por parámetro. Los siguientes parámetros de la estructura deben rellenarse: `bSeedLen`, `pbSeed` y `bTruncationOffset`. Los demás deben ponerse a cero.
ISSUE_OATH_IMPORT_TOTP	Tipo de `pvParamBlob:` estructura ISSUE_OTP_BLOB. Importa un blob TOTP. La semilla se pasa por parámetro. Deben rellenarse los siguientes parámetros de la estructura: `bUseDefaultMovingFactor`, `bSeedLen`, `pbSeed`, `bTruncationOffset`, `wTimeStep` y `otT0`. Los demás deben ponerse a cero.

[in] pvParamBlob Puntero a los datos o estructuras especificados en dwParamBlobType.

[in] dwParamBlobLen Tamaño de los datos o estructura especificados en dwParamBlobType.

[out] pbOTPBlob Buffer de tamaño mínimo de ISSUE_OATH_OUTPUT_MAX_BLOB_LEN que contendrá el blob generado.

[in,out] pdwOTPBlobLen Tamaño del buffer apuntado por pbOTPBlob. A la entrada debe contener el tamaño del búfer pbOTPBlob a la salida contendrá el tamaño del blob escrito en el búfer asignado.

[in] dwFlags Reservado para uso futuro (debe ser 0).

Devolución: 0 (CERO) si la función tiene éxito.
Consulte la sección Códigos de retorno para conocer otros valores.

Ejemplos: gen_check_oath.c.

◆ DOATHCheckOTP()

int AAP_API DOATHCheckOTP	(	HSESSIONCTX	hSession,
		char *	szMasterKeyId,
		char *	szOTP,
		BYTE *	pbOATHBlob,
		DWORD *	pdwOATHBlobLen,
		DWORD	dwFlags )

#include <dinamo.h>

OATHComprueba un valor OTP para un blob dado .

Parámetros

[in] hSession Contexto adquirido a través de la función DOpenSession().

[in] szMasterKeyId Nombre de la clave maestra, utilizada para proteger los blobs, de tamaño máximo MAX_OBJ_ID_FQN_LEN.

[in] szOTP OTP para comprobar el tamaño mínimo ISSUE_OATH_MIN_OTP_LEN y el máximo ISSUE_OATH_MAX_OTP_LEN.

[in,out] pbOATHBlob Puntero a un buffer que contiene el blob que tendrá el OTP comprobado. Este búfer se reescribirá con el búfer actualizado.

[in,out] pdwOATHBlobLen Tamaño del búfer de pbOATHBlob. La entrada contiene el tamaño de pbOATHBlob y la salida contiene el tamaño de los datos escritos en pbOATHBlob.

[in]

dwFlags

A partir de la versión de firmware 4.0.2, el tamaño de la ventana de espera de autenticación se puede establecer en este parámetro. El valor por defecto es de 10 intervalos más o menos. En el caso de tokens HOTP, los intervalos se contarán por número de eventos; en el caso de tokens TOTP, se contarán por número de pasos de tiempo.

Valor	Significado
0	Utiliza el valor por defecto de 10 intervalos.
1 a MAX_OTP_LOOK_AHEAD_INTERVAL	Establece el valor de la ventana de espera de autenticación.

OATH OATH También puedes pasar la bandera _UPDATE_BLOB en este parámetro, para permitir que se actualice el formato del blob. OATH OATH Cuando se utiliza el indicador _UPDATE_BLOB, el blob actual en pbOATHBlob debe pasarse a un búfer lo suficientemente grande como para contener el blob actualizado. pdwOATHBlobLen debe contener el valor del tamaño del búfer pasado en pbOATHBlob. El tamaño de pbOATHBlob requerido se devuelve en pdwOATHBlobLen en la llamada en la que se devuelve el error D_OATH_BLOB_UPDATE. La actualización sólo necesita hacerse después de recibir el error D_OATH_BLOB_UPDATE. Ver Notas para más detalles.

Devolución: 0 (CERO) si la función tiene éxito.
Consulte la sección Códigos de retorno para conocer otros valores.

Notas: OATH Si se devuelve el error D_OATH_BLOB_UPDATE, la función devolverá en pdwOATHBlobLen el tamaño del búfer que debería utilizarse para actualizar el blob en una llamada posterior.OATH Véanse los detalles en la especificación de _UPDATE_BLOB.

Ejemplos: gen_check_oath.c.

◆ DOATHGetNextOTP()

int AAP_API DOATHGetNextOTP	(	HSESSIONCTX	hSession,
		char *	szMasterKeyId,
		BYTE	bOTPLen,
		BYTE *	pbOATHBlob,
		DWORD	dwOATHBlobLen,
		char *	szOTP,
		DWORD	dwFlags )

#include <dinamo.h>

OATHGenera el siguiente OTP a partir de un blob . OATH El blob no se modificará.

Parámetros

[in]	hSession	Contexto adquirido a través de la función DOpenSession().
[in]	szMasterKeyId	Nombre de la clave maestra, utilizada para proteger los blobs, de tamaño máximo MAX_OBJ_ID_FQN_LEN.
[in]	bOTPLen	Tamaño de la OTP a generar, que puede ser un valor comprendido entre ISSUE_OATH_MIN_OTP_LEN e ISSUE_OATH_MAX_OTP_LEN.
[in]	pbOATHBlob	Puntero a un búfer que contiene el blob que se utilizará para generar el OTP. Este búfer no se modificará.
[in]	dwOATHBlobLen	Tamaño del búfer `pbOATHBlob`.
[out]	szOTP	Buffer que contiene el OTP generado. Debe tener un tamaño mínimo de `bOTPLen` + 1 (terminador nulo).
[in]	dwFlags	Reservado para uso futuro (debe ser 0).

Devolución: 0 (CERO) si la función tiene éxito.
Consulte la sección Códigos de retorno para conocer otros valores.

Ejemplos: gen_check_oath.c.

◆ DOATHGetBlobInfo()

int AAP_API DOATHGetBlobInfo	(	const HSESSIONCTX	hSession,
		char *	szMasterKey,
		BYTE *	pbInBlob,
		DWORD	dwInBlobLen,
		DWORD	dwOutBlobType,
		BYTE *	pbOutInfo,
		DWORD *	pdwOutInfoLen,
		DWORD	dwParam )

#include <dinamo.h>

OATHRecupera la información interna de una mancha .

Parámetros

[in] hSession Contexto adquirido a través de la función DOpenSession().

[in] szMasterKey Nombre de la clave maestra, utilizada para proteger los blobs, de tamaño máximo MAX_OBJ_ID_FQN_LEN.

[in] pbInBlob Puntero a un búfer que contiene el blob para extraer la información.

[in] dwInBlobLen Tamaño del búfer pbInBlob.

[in]

dwOutBlobType

Indica el tipo de datos de salida. Se acepta la siguiente tabla.

Valor	Significado
OATH_ISSUE_OATH_BLOB_t	Tipo de pbOutInfo: ISSUE_OATH_BLOB_t. El búfer pbInBlob debe ser un blob de tipo V1 con tamaño ISSUE_OATH_OUTPUT_BLOB_V1_LEN.
OATH_ISSUE_OATH_INFO_t	Tipo de pbOutInfo: ISSUE_OATH_INFO_t. Esta opción acepta blobs de tipo V1 y V2 con tamaños ISSUE_OATH_OUTPUT_BLOB_V1_LEN e ISSUE_OATH_OUTPUT_BLOB_V2_LEN, respectivamente.

[out] pbOutInfo Puntero a un búfer que recibirá la información blob. Debe ser como se describe en dwOutBlobType.

[in,out] pdwOutInfoLen Tamaño del buffer apuntado por pdwOutInfoLen.

[in] dwParam Reservado para uso futuro (debe ser 0).

Devolución: 0 (CERO) si la función tiene éxito.
Consulte la sección Códigos de retorno para conocer otros valores.

◆ DOATHBlobResync()

int AAP_API DOATHBlobResync	(	HSESSIONCTX	hSession,
		char *	szMasterKeyId,
		char *	szOTP1,
		char *	szOTP2,
		BYTE *	pbOATHBlob,
		DWORD *	pdwOATHBlobLen,
		DWORD	dwFlags )

#include <dinamo.h>

OATH Resincroniza una nota mostrando dos valores continuos de OTP. Sólo para HOTP (OTP por evento).

Parámetros

[in]	hSession	Contexto adquirido a través de la función DOpenSession().
[in]	szMasterKeyId	Nombre de la clave maestra, utilizada para proteger los blobs, de tamaño máximo MAX_OBJ_ID_FQN_LEN.
[in]	szOTP1	OTP para comprobar el tamaño mínimo ISSUE_OATH_MIN_OTP_LEN y el máximo ISSUE_OATH_MAX_OTP_LEN.
[in]	szOTP2	Segunda OTP a comprobar para tamaño mínimo ISSUE_OATH_MIN_OTP_LEN y máximo ISSUE_OATH_MAX_OTP_LEN.
[in,out]	pbOATHBlob	Puntero a un búfer que contiene la nota que se va a sincronizar. Este búfer se reescribirá con el búfer sincronizado.
[in,out]	pdwOATHBlobLen	Tamaño del búfer de `pbOATHBlob`. La entrada contiene el tamaño de `pbOATHBlob` y la salida contiene el tamaño de los datos escritos en `pbOATHBlob`.
[in]	dwFlags	OATH OATH Acepta la bandera _UPDATE_BLOB, para permitir que se actualice el formato del blob. OATH OATH Cuando se utiliza la bandera _UPDATE_BLOB, el blob actual en `pbOATHBlob` debe pasarse en un búfer lo suficientemente grande como para contener el blob actualizado. `pdwOATHBlobLen` debe contener el valor del tamaño del búfer pasado en `pbOATHBlob`. El tamaño de `pbOATHBlob` requerido se devuelve en `pdwOATHBlobLen` en la llamada en la que se devuelve el error D_OATH_BLOB_UPDATE. La actualización sólo necesita hacerse después de recibir el error D_OATH_BLOB_UPDATE. Ver Notas para más detalles.

Devolución: 0 (CERO) si la función tiene éxito.
Consulte la sección Códigos de retorno para conocer otros valores.

Notas: A partir de la versión de firmware 4.0.2, la ventana se ampliará hasta 200 intervalos. En el caso de tokens HOTP los intervalos se contarán por número de eventos, en el caso de tokens TOTP se contarán por número de time-steps. OATH Si se devuelve el error D_OATH_BLOB_UPDATE, la función devolverá en pdwOATHBlobLen el tamaño del búfer que debe utilizarse para actualizar el blob en una llamada posterior.OATH Véanse los detalles en la especificación para _UPDATE_BLOB.

◆ DOATHPskcTraducir()

int AAP_API DOATHPskcTranslate	(	HSESSIONCTX	hSession,
		char *	szMasterKey,
		BYTE *	pbPSK,
		BYTE	bPSKLen,
		BYTE *	pbPSKC,
		DWORD	dwPSKCLen,
		void **	pvBlobList,
		DWORD *	pdwBlobListQuantity,
		DWORD	dwParam )

#include <dinamo.h>

Importa semillas envueltas en el estándar PSKC(Portable Symmetric Key Container), RFC 6030.

Parámetros

[in]	hSession	Contexto adquirido a través de la función DOpenSession().
[in]	szMasterKey	Nombre de la clave maestra, utilizada para proteger los blobs, de tamaño máximo de salida MAX_OBJ_ID_FQN_LEN.
[in]	pbPSK	OATHBúfer de tamaño máximo _MAX_PSK_LEN que contiene la clave de transporte que protege las semillas notificadas en `pbPSKC`.
[in]	bPSKLen	Tamaño del búfer pbPSK.
[in]	pbPSKC	Búfer PSKC que contiene las semillas que se transformarán en blobs en formato HSM.
[in]	dwPSKCLen	Tamaño del búfer pbPSKC.
[out]	pvBlobList	Ponteiro para ponteiro que apontará para um buffer alocado internamente contendo um array de estruturas OATH_PSKC_TRANSLATE_OUTPUT. Esta estrutura conterá internamente os blobs das sementes traduzidas para o formato do HSM e o identificador de cada semente como na tag "<pskc:Key Id=>".
[out]	pdwBlobListQuantity	Puntero al número de blobs devueltos en el buffer `pvBlobList`.
[in]	dwParam	Reservado para uso futuro (debe ser 0).

Devolución: 0 (CERO) si la función tiene éxito.
Consulte la sección Códigos de retorno para conocer otros valores.