View a markdown version of this page

キーストレージプロバイダー (KSP) を使用した NCryptSetProperty - AWS CloudHSM

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

キーストレージプロバイダー (KSP) を使用した NCryptSetProperty

NCryptSetProperty 関数は、キーストレージオブジェクトのプロパティ値を設定します。

パラメータ

hObject [in]

プロパティを設定する対象のオブジェクトのハンドル。次を使用できます。

  • プロバイダーハンドル (NCRYPT_PROV_HANDLE)

  • キーハンドル (NCRYPT_KEY_HANDLE)

pszProperty [in]

取得するプロパティ名を含む null 終端 Unicode 文字列へのポインタ。

を使用する場合NCRYPT_PROV_HANDLE、 AWS CloudHSM キーストレージプロバイダー (KSP) は次の KSP 識別子をサポートします。

識別子/値 説明

NCRYPT_USE_CONTEXT_PROPERTY

L"Use Context"

オペレーションコンテキストを示す、null 終端された Unicode 文字列へのポインタ。

を使用する場合NCRYPT_KEY_HANDLE、 AWS CloudHSM キーストレージプロバイダー (KSP) は次の KSP 識別子をサポートします。

識別子/値 説明

NCRYPT_KEY_USAGE_PROPERTY

L"Key Usage"

キー使用に関する詳細を定義するフラグのセットを含む DWORD。このプロパティは、キーにのみ適用されます。これは、0 個、または以下の値の 1 つ以上の組み合わせを含めることができます。

NCRYPT_ALLOW_DECRYPT_FLAG (0x00000001)

NCRYPT_ALLOW_SIGNING_FLAG (0x00000002)

NCRYPT_LENGTH_PROPERTY

L"Length"

キー長 (ビット数) を含む DWORD。

NCRYPT_EXPORT_POLICY_PROPERTY

L"Export Policy"

永続化されたキーのエクスポートポリシーを指定するフラグを含む DWORD。これは、0 個、または以下の値の 1 つ以上の組み合わせを含めることができます。

NCRYPT_ALLOW_EXPORT_FLAG (0x00000001)

注記

値は、リテラルの前に L が付いていることからわかるように、ワイド文字列リテラルです。

pbInput [in]

新しいプロパティ値を含むバッファのアドレス。cbInput にはバッファのサイズが含まれます。

cbInput [in]

pbInput バッファのサイズ (バイト単位)。

dwFlags [in]

関数の動作を変更するフラグ。この関数にはフラグが定義されていません。

戻り値

この関数は、成功または失敗を示すステータスコードを返します。

一般的なリターンコードは次のとおりです。

リターンコード 説明

ERROR_SUCCESS

オペレーションが正常に完了しました。

NTE_INVALID_PARAMETER

1 つ以上のパラメータが無効です。

NTE_FAIL

オペレーションを完了できませんでした。

NTE_BAD_FLAGS

dwFlags パラメータに無効な値が含まれています。

NTE_NOT_SUPPORTED

pszProperty パラメータには、サポートされていない値が含まれています。

NTE_INVALID_HANDLE

hObject のハンドルが無効です。

NTE_BAD_DATA

pbInput および cbInput が指すデータは有効ではありません。