NCryptGetProperty con el proveedor de almacenamiento de claves (KSP) - AWS CloudHSM

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

NCryptGetProperty con el proveedor de almacenamiento de claves (KSP)

La función NCryptGetProperty recupera valores de propiedades de un objeto de almacenamiento de claves.

Parameters

hObject [entrada]

El identificador del objeto cuya propiedad desea recuperar. Puede usar:

  • Un identificador de proveedor (NCRYPT_PROV_HANDLE)

  • Un identificador de clave (NCRYPT_KEY_HANDLE)

pszProperty [entrada]

Un puntero a una cadena Unicode terminada en nulo que contiene el nombre de la propiedad que se va a recuperar.

Cuando se utilizaNCRYPT_PROV_HANDLE, el proveedor de almacenamiento de AWS CloudHSM claves (KSP) admite los siguientes identificadores de KSP:

Identificador/Valor Description (Descripción)

NCRYPT_IMPL_TYPE_PROPERTY

L"Impl Type"

Un DWORD que contiene indicadores que definen los detalles de implementación del proveedor

NCRYPT_MAX_NAME_LENGTH_PROPERTY

L"Max Name Length"

Un DWORD que contiene la longitud máxima (en caracteres) del nombre de una clave persistente.

NCRYPT_NAME_PROPERTY

L"Name"

Un puntero a una cadena Unicode terminada en nulo que contiene el nombre del KSP.

NCRYPT_VERSION_PROPERTY

L"Version"

Un DWORD que contiene la versión del proveedor (palabra alta: versión principal; palabra baja: versión secundaria).

NCRYPT_USE_CONTEXT_PROPERTY

L"Use Context"

Un puntero a una cadena Unicode terminada en nulo que describe el contexto de la operación.

NCRYPT_SECURITY_DESCR_SUPPORT_PROPERTY

L"Security Descr Support"

Indica si el proveedor admite descriptores de seguridad para las claves.

Cuando se utilizaNCRYPT_KEY_HANDLE, el proveedor de almacenamiento de AWS CloudHSM claves (KSP) admite los siguientes identificadores de KSP:

Identificador/Valor Description (Descripción)

NCRYPT_ALGORITHM_PROPERTY

L"Algorithm Name"

Una cadena Unicode terminada en nulo que contiene el nombre del algoritmo de la clave.

NCRYPT_BLOCK_LENGTH_PROPERTY

L"Block Length"

Un DWORD que contiene la longitud del bloque de cifrado en bytes.

NCRYPT_EXPORT_POLICY_PROPERTY

L"Export Policy"

Un DWORD que contiene indicadores que especifican la política de exportación de la clave persistente.

NCRYPT_KEY_USAGE_PROPERTY

L"Key Usage"

Un DWORD que contiene indicadores que definen los detalles de uso de la clave.

NCRYPT_KEY_TYPE_PROPERTY

L"Key Type"

Un DWORD que contiene indicadores que definen el tipo de clave.

NCRYPT_LENGTH_PROPERTY

L"Length"

Un DWORD que contiene la longitud de la clave en bits.

NCRYPT_LENGTHS_PROPERTY

L"Lengths"

Un puntero a una estructura NCRYPT_SUPPORTED_LENGTHS que contiene los tamaños de clave admitidos.

NCRYPT_NAME_PROPERTY

L"Name"

Un puntero a una cadena Unicode terminada en nulo que contiene el nombre de la clave.

NCRYPT_SECURITY_DESCR_PROPERTY

L"Security Descr"

Un puntero a una estructura SECURITY_DESCRIPTOR que contiene la información de control de acceso de la clave.

NCRYPT_ALGORITHM_GROUP_PROPERTY

L"Algorithm Group"

Una cadena Unicode terminada en nulo que contiene el nombre del grupo de algoritmos del objeto.

NCRYPT_UNIQUE_NAME_PROPERTY

L"Unique Name"

Un puntero a una cadena Unicode terminada en nulo que contiene el nombre único de la clave.

nota

Los valores son literales de cadena de caracteres anchos, como lo indica la L antes del literal.

pbOutput [salida]

La dirección de un búfer para almacenar el valor de la propiedad. Especifique el tamaño del búfer mediante cbOutput.

Para determinar el tamaño de búfer requerido, establezca este parámetro en NULL. La función almacena el tamaño requerido (en bytes) en la ubicación a la que apunta pcbResult.

cbOutput [entrada]

El tamaño del búfer pbOutput en bytes.

pcbResult [salida]

Un puntero a una variable DWORD que almacena el número de bytes copiados en el búfer pbOutput.

Si pbOutput es NULL, se almacena el tamaño requerido (en bytes).

dwFlags [entrada]

Indicadores para modificar el comportamiento de la función. Puede usar cero o:

Valor Significado

NCRYPT_SILENT_FLAG

Este indicador no tiene efecto.

Cuando pszProperty es NCRYPT_SECURITY_DESCR_PROPERTY, use uno o una combinación de los siguientes valores:

Valor Significado

OWNER_SECURITY_INFORMATION

Este indicador no tiene efecto.

GROUP_SECURITY_INFORMATION

Este indicador no tiene efecto.

DACL_SECURITY_INFORMATION

Este indicador no tiene efecto.

LABEL_SECURITY_INFORMATION

Este indicador no tiene efecto.

SACL_SECURITY_INFORMATION

Este indicador no tiene efecto.

Valor de retorno

La función devuelve un código de estado para indicar si la operación se realizó correctamente o si se produjo un error.

Los códigos de retorno comunes incluyen:

Código de retorno Description (Descripción)

ERROR_SUCCESS

La operación se completó correctamente.

NTE_INVALID_PARAMETER

Uno o más parámetros no son válidos.

NTE_FAIL

La operación no se pudo completar.

NTE_BAD_FLAGS

El parámetro dwFlags contiene un valor que no es válido.

NTE_NOT_SUPPORTED

El parámetro pszAlgId contiene un valor que no se admite.

NTE_INVALID_HANDLE

El identificador en hObject no es válido.

NTE_BUFFER_TOO_SMALL

El parámetro cbOutput es demasiado pequeño para los valores de retorno.