View a markdown version of this page

NCryptGetProperty com o provedor de armazenamento de chaves (KSP) - AWS CloudHSM

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

NCryptGetProperty com o provedor de armazenamento de chaves (KSP)

A função NCryptGetProperty recupera os valores das propriedades de um objeto de armazenamento de chaves.

Parâmetros

hObject [in]

O identificador do objeto cuja propriedade você deseja recuperar. Você pode usar:

  • Um identificador de provedor (NCRYPT_PROV_HANDLE)

  • Um identificador de chave (NCRYPT_KEY_HANDLE)

pszProperty [in]

Um ponteiro para uma string Unicode terminada em nulo contendo o nome da propriedade a ser recuperada.

Ao usarNCRYPT_PROV_HANDLE, o AWS CloudHSM Key Storage Provider (KSP) oferece suporte aos seguintes identificadores KSP:

Identificador/Valor Description

NCRYPT_IMPL_TYPE_PROPERTY

L"Impl Type"

Um DWORD contendo sinalizadores que definem detalhes de implementação do provedor

NCRYPT_MAX_NAME_LENGTH_PROPERTY

L"Max Name Length"

Um DWORD contendo o tamanho máximo (em caracteres) de um nome de chave persistente.

NCRYPT_NAME_PROPERTY

L"Name"

Um ponteiro para uma string Unicode terminada em nulo contendo o nome do KSP.

NCRYPT_VERSION_PROPERTY

L"Version"

Um DWORD contendo a versão do provedor (palavra em maiúsculas: versão principal; palavra em minúsculas: versão secundária).

NCRYPT_USE_CONTEXT_PROPERTY

L"Use Context"

Um ponteiro para uma string Unicode terminada em nulo descrevendo o contexto da operação.

NCRYPT_SECURITY_DESCR_SUPPORT_PROPERTY

L"Security Descr Support"

Indica se o provedor oferece suporte a descritores de segurança para chaves.

Ao usarNCRYPT_KEY_HANDLE, o AWS CloudHSM Key Storage Provider (KSP) oferece suporte aos seguintes identificadores KSP:

Identificador/Valor Description

NCRYPT_ALGORITHM_PROPERTY

L"Algorithm Name"

Um ponteiro para uma string Unicode terminada em nulo contendo o nome do algoritmo da chave.

NCRYPT_BLOCK_LENGTH_PROPERTY

L"Block Length"

Um DWORD contendo o tamanho do bloco de criptografia em bytes.

NCRYPT_EXPORT_POLICY_PROPERTY

L"Export Policy"

Um DWORD contendo sinalizadores que especificam a política de exportação da chave persistente.

NCRYPT_KEY_USAGE_PROPERTY

L"Key Usage"

Um DWORD contendo sinalizadores que definem detalhes de uso da chave.

NCRYPT_KEY_TYPE_PROPERTY

L"Key Type"

Um DWORD contendo sinalizadores que definem o tipo de chave.

NCRYPT_LENGTH_PROPERTY

L"Length"

Um DWORD contendo o comprimento da chave em bits.

NCRYPT_LENGTHS_PROPERTY

L"Lengths"

Um ponteiro para uma estrutura NCRYPT_SUPPORTED_LENGTHS contendo tamanhos de chave compatíveis.

NCRYPT_NAME_PROPERTY

L"Name"

Um ponteiro para uma string Unicode terminada em nulo contendo o nome da chave.

NCRYPT_SECURITY_DESCR_PROPERTY

L"Security Descr"

Um ponteiro para uma estrutura SECURITY_DESCRIPTOR contendo as principais informações de controle de acesso.

NCRYPT_ALGORITHM_GROUP_PROPERTY

L"Algorithm Group"

Uma string Unicode terminada em nulo contendo o nome do grupo de algoritmos do objeto.

NCRYPT_UNIQUE_NAME_PROPERTY

L"Unique Name"

Um ponteiro para uma string Unicode terminada em nulo contendo o nome exclusivo da chave.

nota

Os valores são literais de string largos, conforme indicado pelo L antes do literal.

pbOutput [out]

O endereço de um buffer para armazenar o valor da propriedade. Especifique o tamanho do buffer usando cbOutput.

Para determinar o tamanho do buffer necessário, defina esse parâmetro como NULL. A função armazena o tamanho necessário (em bytes) no local apontado por pcbResult.

cbOutput [in]

O tamanho em bytes do buffer pbOutput.

pcbResult [out]

Um ponteiro para uma variável DWORD que armazena o número de bytes copiados para o buffer pbOutput.

Se pbOutput for NULL, isso armazenará o tamanho necessário (em bytes).

dwFlags [in]

Sinalizadores para modificar o comportamento da função. Você pode usar zero ou:

Valor Significado

NCRYPT_SILENT_FLAG

Esse sinalizador não tem efeito.

Quando pszProperty for NCRYPT_SECURITY_DESCR_PROPERTY, use um ou uma combinação de:

Valor Significado

OWNER_SECURITY_INFORMATION

Esse sinalizador não tem efeito.

GROUP_SECURITY_INFORMATION

Esse sinalizador não tem efeito.

DACL_SECURITY_INFORMATION

Esse sinalizador não tem efeito.

LABEL_SECURITY_INFORMATION

Esse sinalizador não tem efeito.

SACL_SECURITY_INFORMATION

Esse sinalizador não tem efeito.

Valor de retorno

A função retorna um código de status para indicar êxito ou falha.

Os códigos de retorno comuns incluem:

Código de retorno Description

ERROR_SUCCESS

A operação foi concluída com êxito.

NTE_INVALID_PARAMETER

Um ou mais parâmetros não são válidos.

NTE_FAIL

A operação não foi concluída.

NTE_BAD_FLAGS

O parâmetro dwFlags contém um valor inválido.

NTE_NOT_SUPPORTED

O parâmetro pszAlgId contém um valor que não é suportado.

NTE_INVALID_HANDLE

O identificador em hObject não é válido.

NTE_BUFFER_TOO_SMALL

O parâmetro cbOutput é muito pequeno para valores de retorno.