NCryptSecretAgreement 関数 (ncrypt.h)

  • [アーティクル]

NCryptSecretAgreement 関数は、秘密キーと公開キーから秘密契約値を作成します。

構文

SECURITY_STATUS NCryptSecretAgreement(
  [in]  NCRYPT_KEY_HANDLE    hPrivKey,
  [in]  NCRYPT_KEY_HANDLE    hPubKey,
  [out] NCRYPT_SECRET_HANDLE *phAgreedSecret,
  [in]  DWORD                dwFlags
);

パラメーター

[in] hPrivKey

秘密契約値の作成に使用する 秘密キー のハンドル。 このキーと hPubKey キーは、同じキー ストレージ プロバイダーから取得する必要があります。

[in] hPubKey

秘密契約値の作成に使用する 公開キー のハンドル。 このキーと hPrivKey キーは、同じキー ストレージ プロバイダーから取得する必要があります。

[out] phAgreedSecret

シークレット アグリーメント 値を表 すハンドルを受け取るNCRYPT_SECRET_HANDLE変数へのポインター。 このハンドルが不要になったら、 NCryptFreeObject 関数に渡して解放します。

[in] dwFlags

関数の動作を変更するフラグ。 これは、0 または次の値の 1 つ以上の組み合わせにすることができます。 有効なフラグのセットは、各キー ストレージ プロバイダーに固有です。 次のフラグは、すべてのプロバイダーに適用されます。

値 意味
NCRYPT_SILENT_FLAG
 キー サービス プロバイダー (KSP) にユーザー インターフェイスが表示されないことを要求します。 プロバイダーが操作する UI を表示する必要がある場合、呼び出しは失敗し、KSP は NTE_SILENT_CONTEXT エラー コードを最後のエラーとして設定する必要があります。

戻り値

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

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

リターン コード 説明
ERROR_SUCCESS
 関数は成功しました。
NTE_INVALID_HANDLE
 hPrivKey パラメーターまたは hPubKey パラメーターが無効です。
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

こちらもご覧ください

NCryptFreeObject