View a markdown version of this page

NCryptSetProperty 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á.

NCryptSetProperty com o provedor de armazenamento de chaves (KSP)

A função NCryptSetProperty define os valores das propriedades para um objeto de armazenamento de chaves.

Parâmetros

hObject [in]

O identificador do objeto cuja propriedade você deseja definir. 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_USE_CONTEXT_PROPERTY

L"Use Context"

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

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

Identificador/Valor Description

NCRYPT_KEY_USAGE_PROPERTY

L"Key Usage"

Um DWORD contendo um conjunto de sinalizadores que definem os detalhes de uso da chave. Essa propriedade só se aplica às chaves. Isso pode conter nenhuma ou uma combinação de um ou mais dos valores a seguir.

NCRYPT_ALLOW_DECRYPT_FLAG (0x00000001)

NCRYPT_ALLOW_SIGNING_FLAG (0x00000002)

NCRYPT_LENGTH_PROPERTY

L"Length"

Um DWORD contendo o comprimento da chave em bits.

NCRYPT_EXPORT_POLICY_PROPERTY

L"Export Policy"

Um DWORD contendo sinalizadores que especificam a política de exportação da chave persistente. Isso pode conter nenhuma ou uma combinação de um ou mais dos valores a seguir.

NCRYPT_ALLOW_EXPORT_FLAG (0x00000001)

nota

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

pbInput [in]

O endereço de um buffer que contém o novo valor da propriedade. cbInput contém o tamanho do buffer.

cbInput [in]

O tamanho em bytes do buffer pbInput.

dwFlags [in]

Sinalizadores que modificam o comportamento da função. Nenhum sinalizador está definido para essa função.

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 pszProperty contém um valor que não é suportado.

NTE_INVALID_HANDLE

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

NTE_BAD_DATA

Os dados apontados por pbInput e cbInput não são válidos.