DOpenSession

Estabelece uma sessão com o Pocket e retorna um contexto que deverá ser usado por todas outras funções.

HSESSIONCTX* phSession,

DWORD dwParam,

BYTE* pbData,

DWORD dwDataLen,

DWORD dwFlags

[out] Ponteiro para o contexto da sessão. Depois do seu uso deverá ser liberado com a função DCloseSession.

[in] Especifica como a autenticação da sessão será feita e por conseqüência a estrutura de dados passada no parâmetro pbData.

Valor	Significado
SS_ANONYMOUS	Tipo de pbData: HSM_ADDR Sem autenticação. Todos os campos da estrutura devem ser preenchidos. Ainda não suportado.
SS_USER_PWD	Tipo de pbData: AUTH_PWD Autenticação por usuário e senha. Todos os campos da estrutura devem ser preenchidos.
SS_CERTIFICATE	Tipo de pbData: char * Autenticação através de certificação digital. pbData deve ser um ponteiro para uma string terminada em zero que indica o caminho do arquivo contendo o certificado digital do usuário e a sua chave privada. Ainda não suportado.

Valor	Significado
ENCRYPTED_CONN	Estabelece uma sessão criptografada (TLS v1.0). Os dados trafegarão abertos se essa flag não for especificada.
USER_INTERACTIVE	Apresenta um diálogo para que o usuário entre com o seu identificador (ID) e a sua senha ou o caminho do arquivo contendo a sua chave privada e o seu certificado digital. Ainda não suportada.
LB_BYPASS	Ignora as configurações de balanceamento de carga. Estabelecendo sessão no endereço do HSM indicado por intermédio de pbData.
CACHE_BYPASS	Ignora as configurações de cache de sessões e abre esta sessão sem passar pelo cache de sessões.

Consulte a seção Códigos de Retorno sobre outros valores de códigos de retorno.

O contexto retornado por essa função deverá ser usado em todas outras chamadas subseqüentes ao HSM e liberado através da função DCloseSession após o seu uso. Uma conexão TCP é estabelecida nessa chamada e encerrada quando o contexto é liberado.

A sessão é estabelecida em aberto (sem criptografia) se a flag ENCRYPTED_CONN não for especificada, caso contrário, um túnel TLS v1.0 é fechado entre as duas pontas do canal.

O Pocket apresenta nativamente um sistema de balanceamento de carga e cache de sessões. Caso o balanceamento de carga esteja ativo e seja necessário garantir uma abertura de sessão em endereço IP específico, utilize o flag LB_BYPASS. Com LB_BYPASS a função DOpenSession irá ignorar a lista de endereços do balanceamento de carga. Não é possível desabilitar ou ignorar por intermédio desta ou outra função de API o cache de sessões do equipamento.

Quando a senha de um usuário estiver expirada a função retornará D_ERR_PWD_EXPIRED. Neste caso, será retornado um handle de sessão válido que poderá ser utilizado apenas para a troca de senha do usuário autenticado. Caso a troca de senha seja feita com sucesso a sessão terá as outras funções habilitadas, caso falhe a troca de senha ou tente fazer qualquer outra operação a sessão será desconectada pelo servidor.