NCryptSignHash 関数 (ncrypt.h)

  • [アーティクル]

NCryptSignHash 関数は、ハッシュ値のシグネチャを作成します。

構文

SECURITY_STATUS NCryptSignHash(
  [in]           NCRYPT_KEY_HANDLE hKey,
  [in, optional] VOID              *pPaddingInfo,
  [in]           PBYTE             pbHashValue,
  [in]           DWORD             cbHashValue,
  [out]          PBYTE             pbSignature,
  [in]           DWORD             cbSignature,
  [out]          DWORD             *pcbResult,
  [in]           DWORD             dwFlags
);

パラメーター

[in] hKey

ハッシュの署名に使用するキーのハンドル。

[in, optional] pPaddingInfo

埋め込み情報を含む構造体へのポインター。 このパラメーターが指す構造体の実際の型は、 dwFlags パラメーターの値によって異なります。 このパラメーターは非対称キーでのみ使用され、それ以外の場合は NULL である 必要があります。

[in] pbHashValue

署名するハッシュ値を含むバッファーへのポインター。 cbInput パラメーターには、このバッファーのサイズが含まれています。

[in] cbHashValue

署名する pbHashValue バッファー内のバイト数。

[out] pbSignature

この関数によって生成される署名を受け取るバッファーのアドレス。 cbSignature パラメーターには、このバッファーのサイズが含まれています。

このパラメーターが NULL の場合、この関数はシグネチャに必要なサイズを計算し、 pcbResult パラメーターが指す位置のサイズを返します。

[in] cbSignature

pbSignature バッファーのサイズ (バイト単位)。 pbSignature パラメーターが NULL の場合、このパラメーターは無視されます。

[out] pcbResult

pbSignature バッファーにコピーされたバイト数を受け取る DWORD 変数へのポインター。

pbSignature が NULL の場合、署名に必要なサイズ (バイト単位) を受け取ります。

[in] dwFlags

関数の動作を変更するフラグ。 許可されるフラグのセットは、 hKey パラメーターで指定されたキーの種類によって異なります。

キーが対称キーの場合、このパラメーターは使用されず、ゼロに設定する必要があります。

キーが非対称キーの場合は、次のいずれかの値を指定できます。

値 意味
BCRYPT_PAD_PKCS1
 PKCS1 パディング スキームを使用します。 pPaddingInfo パラメーターは、BCRYPT_PKCS1_PADDING_INFO構造体へのポインターです。
BCRYPT_PAD_PSS
 確率論的署名スキーム (PSS) パディング スキームを使用します。 pPaddingInfo パラメーターは、BCRYPT_PSS_PADDING_INFO構造体へのポインターです。
NCRYPT_SILENT_FLAG
 キー サービス プロバイダー (KSP) にユーザー インターフェイスが表示されないことを要求します。 プロバイダーが操作する UI を表示する必要がある場合、呼び出しは失敗し、KSP は NTE_SILENT_CONTEXT エラー コードを最後のエラーとして設定する必要があります。

戻り値

関数の成功または失敗を示す状態コードを返します。

可能なリターン コードには、次のものが含まれますが、これらに限定されません。

リターン コード 説明
ERROR_SUCCESS
 関数は成功しました。
NTE_BAD_ALGID
 hKey パラメーターで表されるキーは、署名をサポートしていません。
NTE_BAD_FLAGS
 dwFlags パラメーターに無効な値が含まれています。
NTE_INVALID_HANDLE
 hKey パラメーターが無効です。
NTE_INVALID_PARAMETER
 1 つ以上のパラメーターが無効です。
NTE_NO_MEMORY
 メモリ割り当てエラーが発生しました。

注釈

サービスは 、StartService 関数からこの関数を呼び出してはなりません。 サービスが StartService 関数からこの関数を呼び出すと、デッドロックが発生し、サービスが応答を停止する可能性があります。

要件

要件 値
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ | UWP アプリ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリ | UWP アプリ]
対象プラットフォーム Windows
ヘッダー ncrypt.h
Library Ncrypt.lib
[DLL] Ncrypt.dll