Descrição detalhada

Gerência de usuários do HSM.

Estruturas de Dados
struct	DinamoClient.UserTrustInfo

Funções
void	ChangePasswordUser (string szPassword)

void	ChangeUserPassword (string szPassword)
	Altera a senha do usuário corrente.

void	AssignEventToken (string szUserId, byte[] byKey)
	Associa um token OTP de evento padrão OATH a um usuário. Após esta chamada o usuário fará autenticação apenas com usuário, senha e OTP.

void	AssignTimeToken (string szUserId, byte[] byKey, UInt64 iInitialTime, Int16 iStep)
	Associa um token OTP de tempo padrão OATH a um usuário. Após esta chamada o usuário fará autenticação apenas com usuário, senha e OTP.

void	UnassignToken (string szUserId)
	Desassocia a autenticação com OTP de um usuário. Após esta chamada o usuário fará autenticação apenas com usuário e senha.

void	OATHResync (string szUser, string szOTP1, string szOTP2)
	Re-sincroniza um token de eventos, padrão OATH, associado a um usuário do HSM. Recebe dois OTPs consecutivos, gerados pelo token, para sincronizar o estado do token no usuário do HSM.

int	GetUserAuthMask (string szUserName)
	Recupera a máscara de autorizações do usuário.

UserTrustInfo[]	ListUserTrusts (string user, byte bType)
	Recupera as relações de confiança do usuário.

string[]	ListUsers ()
	Lista os usuários do HSM.

void	BlockUser (string szUserName, bool bBlock)
	Bloqueia ou desbloqueia um usuário.

void	SetUserAuthMask (string szUserName, int iACL)
	Define a máscara de autorização de um usuário.

int	GetUserInvalidLoginAttempts (string szUserName)
	Recupera a quantidade de tentativas de logins inválidos desde a última autenticação com sucesso.

bool	IsUserBlocked (string szUserName)
	Verifica se um usuário está bloqueado.

void	CreateUser (string UserId, string Password)
	Cria um usuário comum, sem permissões de sistema.

void	RemoveUser (string UserId)
	Remove um usuário.

Funções

◆ ChangePasswordUser()

void ChangePasswordUser ( string szPassword )

inline

Obsoleto(a): API descontinuada. Por favor, usar ChangeUserPassword.

◆ ChangeUserPassword()

void ChangeUserPassword ( string szPassword )

inline

Altera a senha do usuário corrente.

Parâmetros

szPassword Nova senha.

Exceções

DinamoException Lança exceção em caso de erro.

◆ AssignEventToken()

void AssignEventToken	(	string	szUserId,
		byte[]	byKey )

inline

Associa um token OTP de evento padrão OATH a um usuário. Após esta chamada o usuário fará autenticação apenas com usuário, senha e OTP.

Parâmetros

szUserId	Nome do usuário.
byKey	Chave(semente) utilizado para definição do OTP padrão OATH.

Exceções

DinamoException Lança exceção em caso de erro.

◆ AssignTimeToken()

void AssignTimeToken	(	string	szUserId,
		byte[]	byKey,
		UInt64	iInitialTime,
		Int16	iStep )

inline

Associa um token OTP de tempo padrão OATH a um usuário. Após esta chamada o usuário fará autenticação apenas com usuário, senha e OTP.

Parâmetros

szUserId Nome do usuário.

byKey Chave(semente) utilizado para definição do OTP padrão OATH.

iInitialTime

T0 utilizado pelo token. Definido em segundos.

Valor	Significado
DinamoApi.OATH_SA_v2_default_T0_Epoch	Utilizar valor padrão do HSM.

Parâmetros

iStep

Valor do time step em segundos. Além de definir o time step em segundos para blobs TOTP os seguinte valore também é suportado.

Valor	Significado
DinamoApi.OATH_SA_v2_default_TIME_STEP	Utilizar o valor padrão de time step do HSM, atualmente 30 segs.

Exceções

DinamoException Lança exceção em caso de erro.

Anotações: A partir da versão 4.0.2 do firmware o tamanho da janela de look-ahead de autenticação é definida com o padrão de de 10 intervalos para mais ou para menos.No caso de tokens HOTP os intervalos serão contados por quantidade de eventos, no caso dos tokens TOTP serão contados por quantidade de time-steps.

◆ UnassignToken()

void UnassignToken ( string szUserId )

inline

Desassocia a autenticação com OTP de um usuário. Após esta chamada o usuário fará autenticação apenas com usuário e senha.

Parâmetros

szUserId Nome do usuário.

Exceções

DinamoException Lança exceção em caso de erro.

◆ OATHResync()

void OATHResync	(	string	szUser,
		string	szOTP1,
		string	szOTP2 )

inline

Re-sincroniza um token de eventos, padrão OATH, associado a um usuário do HSM. Recebe dois OTPs consecutivos, gerados pelo token, para sincronizar o estado do token no usuário do HSM.

Parâmetros

szUser	Nome do usuário.
szOTP1	Primeiro OTP, para sincronização, gerado pelo token.
szOTP2	Segundo OTP, para sincronização, gerado pelo token.

Exceções

DinamoException Lança exceção em caso de erro.

◆ GetUserAuthMask()

int GetUserAuthMask ( string szUserName )

inline

Recupera a máscara de autorizações do usuário.

Parâmetros

szUserName Nome do usuário.

Retorna: Máscara de autorizações do usuário.

Exceções

DinamoException Lança exceção em caso de erro.

◆ ListUserTrusts()

UserTrustInfo[] ListUserTrusts	(	string	user,
		byte	bType )

inline

Recupera as relações de confiança do usuário.

Parâmetros

user	Nome do usuário.
bType	Tipo da operação: DinamoApi.OP_LST_USR_TRUSTERS para listar os usuários que confiam no usuário especificado. DinamoApi.OP_LST_USR_TRUSTEES para listar os usuários que o usuário corrente confia.

Retorna: Máscara de autorizações do usuário.

Exceções

DinamoException Lança exceção em caso de erro.

◆ ListUsers()

string[] ListUsers ( )

inline

Lista os usuários do HSM.

Retorna: Array de string contendo os nomes de usuários.

Exceções

DinamoException Lança exceção em caso de erro.

◆ BlockUser()

void BlockUser	(	string	szUserName,
		bool	bBlock )

inline

Bloqueia ou desbloqueia um usuário.

Parâmetros

szUserName	Nome do usuário.
bBlock	true para bloquear e false para desbloquear.

Exceções

DinamoException Lança exceção em caso de erro.

◆ SetUserAuthMask()

void SetUserAuthMask	(	string	szUserName,
		int	iACL )

inline

Define a máscara de autorização de um usuário.

Parâmetros

szUserName Nome do usuário.

iACL

A máscara de autorização do usuário, deverá ser montada a partir da concatenação dos valores abaixo:

Valor	Significado
DinamoApi.ACL_NOP	Usuário apenas com autorizações ordinárias.
DinamoApi.ACL_OBJ_CREATE	Permissão para criar objetos. A permissão de leitura (DinamoApi.ACL_OBJ_READ) é atribuída implicitamente.
DinamoApi.ACL_OBJ_DEL	Permissão para remover objetos. A permissão de leitura (DinamoApi.ACL_OBJ_READ) é atribuída implicitamente.
DinamoApi.ACL_OBJ_READ	Permissão para ler o conteúdo de objetos.
DinamoApi.ACL_OBJ_UPDATE DinamoApi.ACL_OBJ_WRITE	Permissão para atualizar atributos dos objetos. DinamoApi.ACL_OBJ_UPDATE = DinamoApi.ACL_OBJ_WRITE
DinamoApi.ACL_USR_CREATE DinamoApi.ACL_USR_DELETE	Permissão para criar e remover usuários. DinamoApi.ACL_USR_CREATE = DinamoApi.ACL_USR_DELETE
DinamoApi.ACL_USR_REMOTE_INFO	Permissão para receber notificações de log remota.
DinamoApi.ACL_USR_LIST	Permissão para listar usuários.
DinamoApi.ACL_SYS_OPERATOR	Permissão para operar como o usuário ‘master’.
DinamoApi.ACL_SYS_BACKUP DinamoApi.ACL_SYS_RESTORE	Permissão para criar e restaurar cópias de segurança dos dados do HSM. DinamoApi.ACL_SYS_BACKUP = DinamoApi.ACL_SYS_RESTORE
DinamoApi.ACL_SYS_UDATE_HSM	Permissão para atualizar o firmware.

Exceções

DinamoException Lança exceção em caso de erro.

◆ GetUserInvalidLoginAttempts()

int GetUserInvalidLoginAttempts ( string szUserName )

inline

Recupera a quantidade de tentativas de logins inválidos desde a última autenticação com sucesso.

Parâmetros

szUserName Nome do usuário.

Retorna: Número de tentativas inválidas de login.

Exceções

DinamoException Lança exceção em caso de erro.

◆ IsUserBlocked()

bool IsUserBlocked ( string szUserName )

inline

Verifica se um usuário está bloqueado.

Parâmetros

szUserName Nome do usuário.

Retorna: Estado de bloqueio.

Exceções

DinamoException Lança exceção em caso de erro.

◆ CreateUser()

void CreateUser	(	string	UserId,
		string	Password )

inline

Cria um usuário comum, sem permissões de sistema.

Parâmetros

UserId	Nome do usuário. Deve ser único, composto de caracteres alfanuméricos. Caracteres maiúsculos e minúsculos são diferenciados (case-sensitive). Tamanho máximo de DinamoApi.MAX_USR_LEN
Password	Senha do usuário. Caracteres maiúsculos e minúsculos são diferenciados (case-sensitive). Tamanho máximo de DinamoApi.MAX_USR_PWD

Exceções

DinamoException Lança exceção em caso de erro.

◆ RemoveUser()

void RemoveUser ( string UserId )

inline

Remove um usuário.

Parâmetros

UserId Nome do usuário.

Exceções

DinamoException Lança exceção em caso de erro.

Descrição detalhada

Estruturas de Dados

Funções

Funções

◆ ChangePasswordUser()

◆ ChangeUserPassword()

◆ AssignEventToken()

◆ AssignTimeToken()

◆ UnassignToken()

◆ OATHResync()

◆ GetUserAuthMask()

◆ ListUserTrusts()

◆ ListUsers()

◆ BlockUser()

◆ SetUserAuthMask()

◆ GetUserInvalidLoginAttempts()

◆ IsUserBlocked()

◆ CreateUser()

◆ RemoveUser()