Códigos de Retorno da Biblioteca
Código | Valor | Descrição | Detalhes |
---|---|---|---|
D_SOCKET_FAILED | -10 | Falha ao criar socket. | A criação do socket falhou. Possíveis causas: erro de sistema. Ver logs para mais detalhes. |
D_GETHOSTNAME_FAILED | -11 | Falha ao resolver endereço do HSM. | O endereço do HSM não pôde ser resolvido. Verificar o endereço do HSM informado. Se estiver utilizando balanceamento de carga, verificar os endereços no arquivo de configuração. Se o endereço estiver correto, ver logs para mais detalhes. |
D_CONNECT_FAILED | -12 | Falha ao se conectar ao HSM. | A abertura de sessão com o HSM falhou. Possíveis casos para esse erro são: rede/HSM indisponível; falha no subsistema de rede. Outras causas menos prováveis são: conexão rejeitada pelo HSM; erro interno de socket. Ver logs para mais detalhes. |
D_SEND_FAILED | -13 | Falha ao enviar dados. | O Cliente não conseguiu enviar dados com sucesso. Causas mais prováveis para esse erro são: rimeout na sessão (do lado do cliente ou do servidor); rede/HSM indisponível; falha no subsistema de rede. Outras causas menos prováveis são: erro interno de socket. Ver logs para mais detalhes. |
D_RECV_FAILED | -14 | Falha ao receber dados. | O Cliente não conseguiu receber os dados com sucesso. Causas mais prováveis para esse erro são: timeout na sessão (do lado do cliente ou do servidor); rede/HSM indisponível; falha no subsistema de rede. Outras causas menos prováveis são: erro interno de socket. Ver logs para mais detalhes. |
D_INVALID_PACKAGE_SIZE | -15 | Tamanho de pacote inválido. | O tamanho do pacote de dados recebido é diferente do esperado. Ver logs para mais detalhes. |
D_SETSOCKOPT_FAILED | -16 | Falha ao definir opções de socket. | A definição de opções de socket falhou. As prováveis causas são: parâmetro inválido; falha no subsistema de rede; timeout da conexão; falha interna no socket. Ver logs para mais detalhes. |
D_GETSOCKOPT_FAILED | -17 | Falha ao recuperar opções de socket. | A definição de opções de socket falhou. As prováveis causas são: tamanho de buffer de parâmetro inválido; falha no subsistema de rede; falha interna no socket. Ver logs para mais detalhes. |
D_ALL_LOAD_BALANCE_HSM_FAILED | -18 | Todos os HSMs da lista de balanceamento de carga estão indisponíveis. | Os HSMs da lista de balanceamento de carga estão todos indisponíveis. Após tentar se acessar todos os HSMs listados na lista de balanceamento de carga sem sucesso este erro é retornado. Neste caso específico, após este erro ser retornado, todos os endereços cadastrados no balanceamento de carga ficam disponíveis para novas tentativas de acesso sem passar pelo tempo de suspensão. Possíveis causas: falha de rede na máquina cliente; falha ao acessar a rede dos HSMs; falha em todos os HSMs. |
D_SSL_CTX_NEW_FAILED | 1 | Falha ao criar contexto SSL. | A criação do contexto SSL falhou. Possíveis causas: falhas de sistema ou internas. Ver logs para mais detalhes. |
D_SSL_NEW_FAILED | 2 | Falha ao criar estrutura TLS. | A criação da estrutura da conexão TLS falhou. Possíveis causas: falhas de sistema ou internas. Ver logs para mais detalhes. |
D_SSL_CONNECT_FAILED | 3 | Falha ao iniciar handshake TLS com HSM. | O handshake TLS com o HSM falhou. Neste momento a conexão socket com o HSM já está estabelecida e ocorreu a falha no momento do handshake TLS. Possíveis causas: falha no handshake TLS, utilização de HSM antigo (versões muito antigas) com biblioteca cliente nova (ou vice versa), falha em nível de protocolo, Falha de conexão. Ver logs para mais detalhes. |
D_WSASTARTUP | 2001 | Versão da Winsock (Windows Socket) DLL inválida. | A versão da biblioteca Winsock não é suportada pela biblioteca cliente do HSM. Verificar requisitos mínimos de instalação em máquinas Windows. Este erro só é aplicável para plataforma Windows. |
D_MEMORY_ALLOC | 2002 | Falha na alocação de memória. | Não foi possível alocar a memória solicitada. Verificar a memória disponível para o processo e a máquina. |
D_INVALID_PARAM | 1001 | Parâmetro inválido passado para a API. | O parâmetro passado para a API está inválido. Verificar parâmetros passados (Ex.: Passar um parâmetro flag inválido, não passar um handle de chave ao criar um HMAC em DCreateHash, etc.) . Ver logs para mais detalhes. |
D_INVALID_TYPE | 1002 | Tipo inválido de parâmetro passado para a API. | O tipo de parâmetro passado para a API é inválido. Este erro é genérico. Pode estar relacionado a tipos de dados, chaves, blobs passados em parâmetros das APIs em determinadas situações. (ex.: Usar uma chave simétrica em uma operação simétrica, tipo de dado de saída não suportado, etc.). Ver logs para mais detalhes. |
D_INVALID_STATE | 1003 | O estado do handle é invalido. | O handle utilizado está com o estado inválido. Este erro pode ocorrer quando o handle é utilizado sem estar devidamente inicializado ou em uso diferente. (ex.: Uma sessão não pode executar outras operações quando em log remoto.). Ver logs para mais detalhes. |
D_LOGGING_NOT_STARTED | 1004 | Log não inicializado. | Atualmente não utilizado. |
D_MORE_DATA | 1005 | Mais dados são necessários. | O buffer passado como parâmetro na API não é grande o suficiente para receber os dados de saída. Verifique a documentação da API chamada no manual e se a API retornou o tamanho necessário para o buffer buffer de saída. Ver logs para mais detalhes. |
D_INVALID_RESPONSE | 1006 | Resposta do HSM inválida. | A resposta da requisição enviada ao HSM não é reconhecida. Uma possível causa é a versão da biblioteca cliente estar desatualizada em relação ao HSM. Neste caso, baixe a última versão da biblioteca cliente. Outra possibilidade é uma falha no HSM (raro). Neste caso, por favor, entrar em contato com o suporte. |
D_INVALID_CONTEXT | 1007 | Contexto inválido. | O contexto (handle de sessão, handle de chave, etc.) passado para a API é inválido. Na maioria dos casos é o contexto de sessão. Verificar se o contexto é válido, não NULO e inicializado apropriadamente. |
D_KEY_GEN_ERROR | 1008 | Falha na geração da chave. | Atualmente não utilizado. |
D_KEY_DEL_ERROR | 1009 | Falha ao remover chave. | Atualmente não utilizado. |
D_KEY_NOT_EXISTS | 1010 | A chave não existe. | Atualmente não utilizado. |
D_INVALID_DATA_LENGTH | 1011 | Tamanho de dado de entrada inválido. | O tamanho do dado/buffer de entrada é inválido. Verificar na documentação da API chamada o tamanho necessário. Ver logs para mais detalhes. |
D_INVALID_KEY_ALG | 1012 | Algoritmo de chave inválido. | O algoritimo da chave utilizada é inválida para esta operação. Possíveis causas: usar chave simétrica para operações assimétricas (vice versa), etc. Verificar o tipo de chave passada, a documentação da API chamada e fundamentos de criptografia para o correto uso das chaves. Ver logs para mais detalhes. |
D_INVALID_PADDING | 1013 | Padding inválido. | O tipo de padding requisitado para a API é inválido/não reconhecido. Verificar o tipo de padding passado e a documentação para os tipos de padding aceitos pela API. Ver logs para mais detalhes. |
D_INVALID_KEY | 1014 | Chave inválida. | A chave passada para a API não é válida ou não é apropriada para este uso. Verificar se: o contexto da chave não é NULO, o contexto da chave está inicializado corretamente, algoritmo condiz com a operação. Ver a documentação da API chamada sobre os tipos de chaves aceitos. Ver logs para mais detalhes. |
D_BAD_DATA | 1015 | Dados de entrada inválidos. | Os dados de entrada são inválidos ou estão corrompidos. Ver documentação da API chamada para dados de entrada aceitos. Ver logs para mais detalhes. |
D_INVALID_PUBKEY | 1016 | Chave pública inválida. | A chave pública utilizada nesta operação é inválida ou não pôde ser usada. Possíveis causas: formato de chave inválido, chave pública indisponível, chave inconsistente/corrompida, etc. Ver logs para mais detalhes. |
D_INVALID_ALG_ID | 1017 | Algoritmo inválido. | O algoritmo utilizado é inválido para esta operação. O algoritmo pode ser qualquer objeto aceito pelo HSM. O algoritmo pode ser válido, mas inválido para determinada operação. Ver documentação da API chamada para saber os tipos de algoritmos aceitos. Ver logs para mais detalhes. |
D_INVALID_HASH | 1018 | Hash inválido. | O handle do hash passado para a API é inválido. Possíveis causas: handle de hash NULO, hash não inicializado, etc. |
D_INIT_HASH_FAILED | 1019 | Falha ao iniciar operação de hash. | A operação de inicialização do hash falhou (raro). Ver logs para mais detalhes. Contatar suporte. |
D_INVALID_HASH_STATE | 1020 | Estado de hash inválido. | O hash está com o estado inválido. O hash funciona em operações definidas do em início/meio/fim. Operações que saiam desta sequência podem falhar por este erro. (ex.: Finalizar um hash que não foi inicializado ou que já foi finalizado, etc.). Ver documentação para uso correto da API chamada. Ver logs para mais detalhes. |
D_END_HASH_FAILED | 1021 | Falha ao finalizar operação de hash. | A operação de hash falhou na finalização. Possíveis causas: erro interno ou no servidor. Ver logs da biblioteca cliente e do HSM para mais detalhes. |
D_GET_INFO_ERROR | 1022 | Falha ao recuperar informações do HSM. | O cliente falhou ao tentar recuperar informações do servidor. Possíveis causas: erro no servidor. Ver logs do HSM para mais detalhes. |
D_INVALID_PIN_LEN | 1023 | Tamanho de PIN inválido. | O PIN tem um tamanho inválido. (ex.: Tamanho do PIN do backup maior ou menor do que o permitido.). Ver documentação da API chamada para mais detalhes de formato. Ver logs para mais detalhes. |
D_OPEN_FILE_FAILED | 1025 | Falha ao abrir arquivo na máquina local. | O nome/caminho do arquivo passado como parâmetro não pôde ser aberto/criado. Possíveis causas: permissões de acesso, caminho, etc. Ver logs para mais detalhes. |
D_BACKUP_FAILED | 1026 | Falha ao fazer o backup do HSM. | A operação de backup do HSM falhou. Possíveis causas: falha no HSM. Ver logs do HSM e biblioteca cliente para mais detalhes. |
D_RESTORE_FAILED | 1027 | Falha ao restaurar HSM. | Atualmente não utilizado. |
D_INVALID_CALLBACK | 1028 | Função de callback inválida. | A função de callback é inválida. Ver documentação da API chamada. Verificar se não é NULA. Ver logs para mais detalhes. |
D_NOT_IMPLEMENTED | 1029 | Funcionalidade não implementada. | A funcionalidade requisitada não está implementada. Verificar se a última biblioteca cliente está instalada. Ver documentação da API chamada. |
D_AUTH_FAILED | 1030 | Falha na autenticação. | A autenticação nesta operação falhou. Verificar usuário/senha/OTP, ou qualquer senha ou credendial passada para esta chamada de função. Ver logs do HSM e da biblioteca cliente para mais detalhes. |
D_INVALID_CLEAR_OP | 1031 | Operação em sessão aberta inválida. | Esta operação não pode ser executada em uma sessão aberta (insegura). Reinicie esta operação utilizando uma sessão encriptada (segura). |
D_CHANGE_PWD_ERROR | 1032 | Falha ao alterar senha do usuário. | A operação de alteração de senha do usuário falhou. Possíveis causas: senha não compatível com política do HSM etc. Ver logs do HSM para mais detalhes. |
D_PWD_SIZE_ERROR | 1033 | Tamanho da senha inválido. | A senha passada tem o tamanho inválido. Ver documentação sobre o tamanho permitido de senha. Ver logs para mais detalhes. |
D_IMPORT_KEY_ERROR | 1034 | Falha ao importar chave. | Atualmente não utilizado. |
D_INVALID_KEY_ID | 1035 | Nome de chave inválido. | O nome de chave passado é inválido. Nomes de chave devem seguir o padrão descrito no manual do HSM. |
D_INVALID_FLAG | 1036 | Flag inválida passada para a API. | A flag passada para a API é inválida. Possíveis causas: versão antiga da biblioteca cliente que não suporta a flag, flag inválida etc. Ver documentação da API chamada para detalhes das flags. Ver logs para mais detalhes. |
D_INVALID_SIGNATURE | 1037 | Assinatura inválida. | A verificação da assinatura falhou. A chave pública foi encontrada e utilizada mas a verificação do conteúdo da assinatura não correspondeu com o esperado. Ver logs para mais detalhes. |
D_INVALID_PUB_KEY | 1038 | Chave pública inválida. | Atualmente não utilizada. |
D_INVALID_KEY_STATE | 1039 | Estado da chave inválido. | O estado da chave é inválido para a operação requisitada. Ver logs para mais detalhes. |
D_CREATE_USER_ERROR | 1040 | Falha na criação do usuário. | Atualmente não utilizado. |
D_NO_MORE_OBJECT | 1041 | Não há mais objetos a serem recebidos pelo HSM. | Erro interno. Por favor, contatar o suporte. |
D_PUT_ENV_VAR_FAILED | 1042 | Falha ao definir variável de ambiente. | A criação da variável de ambiente falhou. Ver logs para mais detalhes. |
D_INVALID_FILE_SIZE | 1043 | Tamanho do arquivo é inválido. | O tamanho do arquivo passado é inválido para a operação. Ex.: Ao passar um arquivo maior do que o permitido para escrita no HSM, este erro será retornado. Ver logs para mais detalhes. |
D_INVALID_TEXT_SIZE | 1044 | Tamanho do texto inválido. | Atualmente não utilizado. |
D_FILE_ACCESS_ERROR | 1045 | Falha ao acessar arquivo. | O acesso ao arquivo falhou. Verificar permissões de acesso. Ver logs para mais detalhes. |
D_INVALID_COUNTER | 1046 | Contador inválido. | Atualmente não utilizado. |
D_INVALID_MODE | 1047 | Modo de encriptação inválido. | O modo de encriptação utilizado é inválido para esta operação. Verificar se o modo de encriptação é coerente com a operação utilizada. Ver documentação da API chamada para modos aceitos. Ver logs para mais detalhes. |
D_INVALID_STRUCT_ID | 1048 | ID de estrutura inválido. | Atualmente não utilizado. |
D_INVALID_IP_ADDRESS | 1049 | Endereço IP inválido. | Atualmente não utilizado. |
D_GET_PEER_IP_ERROR | 1050 | Falha ao recuperar endereço IP do par. | Atualmente não utilizado. |
D_CERTIFICATE_PARSE_FAILED | 1051 | Falha ao decodificar certificado. | A decodificação do certificado falhou. Esta falha pode ocorrer na decodificação no nível X.509 ou em dados específicos esperados (ex.: Certificado SPB onde campos específicos são necessários.). Verificar a documentação da API chamada para saber os tipos aceitos. Verificar logs para mais detalhes. |
D_INVALID_KEY_PART_1 | 1052 | Parte 1 da chave é inválida. | A primeira parte da chave é inválida. A verificação do KCV (Key Check Value) do primeiro componente da chave ZCMK (Zone Control Master Key) Visa é inválido. Verificar digitação da chave ou KCV. |
D_INVALID_KEY_PART_2 | 1053 | Parte 2 da chave é inválida. | A segunda parte da chave é inválida. A verificação do KCV (Key Check Value) do segundo componente da chave ZCMK (Zone Control Master Key) Visa é inválido. Verificar digitação da chave ou KCV. |
D_INVALID_KEY_PART_3 | 1054 | Parte 3 da chave é inválida. | A terceira parte da chave é inválida. A verificação do KCV (Key Check Value) do terceiro componente da chave ZCMK (Zone Control Master Key) Visa é inválido. Verificar digitação da chave ou KCV. |
D_VERIFY_DAC_FAILED | 1055 | Falha ao verificar DAC. | Falha ao verificar DAC (Data Authentication Code). O DAC passado não é o esperado. Ver documentação da API chamada para mais detalhes. |
D_DEPRECATED | 1056 | Esta funcionalidade está descontinuada. | A funcionalidade requisitada não é mais suportada. |
D_NO_MATCHING_KEY_FOUND | 1057 | Nenhuma chave correspondente foi encontrada. | Atualmente não utilizada. |
D_CALLBACK_ERROR | 1058 | Falha na função de callback. | Atualmente não utilizada. |
D_INTERNAL_ERROR | 1059 | Falha interna. | Esta falha pode ocorrer por vários motivos internos. Ver logs para mais detalhes. |
D_KEY_NOT_EXPORTABLE_ERROR | 1060 | A chave não é exportável. | A operação requisitada está tentando exportar uma chave não exportável. |
INVALID_SPB_ID | 1062 | O SPB ID é inválido. | O SPB ID passado é inválido. Por favor, verifique o formato apropriado na documentação da API. |
JSON_PARSE_ERROR | 1063 | O parse do JSON falhou. | Falha ao fazer o parse do JSON. Ver logs para mais detalhes. |
JSON_PARSE_WRONG_TYPE_ERROR | 1064 | O parse do JSON falhou por causa de uma requisição de um tipo inválido. | Falha ao fazer o parse do JSON. O tipo de dado é diferente do tipo esperado pela operação requisitada. Ex.: Requisitando uma string de um dado do tipo inteiro. Ver logs para mais detalhes. |
JSON_SET_VALUE_ERROR | 1065 | O JSON falhou ao tentar definir um novo valor a um objeto. | Falha ao definir um valor ao objeto JSON. Ver logs para mais detalhes. |
JSON_UNSET_VALUE_ERROR | 1066 | O JSON falhou ao tentar remover um valor de um objeto. | Falha ao remover um valor do objeto JSON. Ver logs para mais detalhes. |
JSON_VALUE_NOT_FOUND | 1067 | O JSON não encontrou o valor dentro do objeto pedido. | Falha encontrar o valor dentro do objeto JSON. Ver logs para mais detalhes. |
JSON_OBJ_CREATE_ERROR | 1068 | O JSON pôde criar o objeto pedido. | Falha ao criar o objeto JSON. Ver logs para mais detalhes. |
SLP_PARSE_ERROR | 1069 | Falha ao fazer o parse da resposta SLP do servidor. | A reposta SLP do servidor não pode ser parseada como esperado. Ver logs para mais detalhes. |
SLP_INTERNAL_ERROR | 1070 | Falha ao executar operação SLP. | A operação SLP não foi executada com sucesso. Ver logs para mais detalhes. |
SLP_TOO_MANY_SERVERS_ERROR | 1071 | Falha por excesso de respostas de servidores HSM. | O número de repostas SLP de servidores HSM excedeu os limites. Ver logs para mais detalhes. |
INVALID_SERVER_VERSION | 1072 | A versão do servidor não é compatível com a operação. | Esta operação falhou porque o servidor não tem uma versão de firmware compatível. Ver logs para mais detalhes. |
GENERATE_PKCS12_ERROR | 1073 | Falha ao gerar o arquivo PKCS#12. | A geração do pacote PKCS#12 falhou. Ver logs para mais detalhes. |
SET_LOAD_BALANCE_LIST_ERROR | 1074 | Falha ao definir a lista de load balance. | A definição da lista de balanceamento falhou. Ver logs para mais detalhes. |
D_KEEP_ALIVE_ERROR | 3001 | Falha no keep alive. | Atualmente não utilizado. |
D_RECEIVE_LOG_ERROR | 3002 | Falha ao receber logs. | O recebimento dos logs de monitoramento remoto falharam. Possíveis causas: erro no HSM. Ver logs do HSM para mais detalhes. |
D_ERROR_NOTIFY | 3003 | Notificação de falha do servidor. | Este erro é genérico. Ver logs para mais detalhes. |