ホーム › Security.Cryptography › NCryptSecretAgreement

NCryptSecretAgreement

関数

秘密鍵と公開鍵から共有秘密を生成する鍵合意を行う。

DLLncrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// ncrypt.dll
#include <windows.h>

HRESULT NCryptSecretAgreement(
    NCRYPT_KEY_HANDLE hPrivKey,
    NCRYPT_KEY_HANDLE hPubKey,
    NCRYPT_SECRET_HANDLE* phAgreedSecret,
    NCRYPT_FLAGS dwFlags
);

パラメーター

名前

型

方向

説明

hPrivKey

NCRYPT_KEY_HANDLE

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

hPubKey

NCRYPT_KEY_HANDLE

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

phAgreedSecret

NCRYPT_SECRET_HANDLE*

out

秘密合意値を表すハンドルを受け取る NCRYPT_SECRET_HANDLE 変数へのポインター。このハンドルが不要になったら、NCryptFreeObject 関数に渡して解放してください。

dwFlags

NCRYPT_FLAGS

関数の動作を変更するフラグ。0、または次の値のうち 1 つ以上の組み合わせを指定できます。有効なフラグの集合はキーストレージプロバイダーごとに異なります。次のフラグはすべてのプロバイダーに適用されます。

値	意味
NCRYPT_SILENT_FLAG	キーストレージプロバイダー (KSP) にユーザーインターフェイスを表示しないよう要求します。プロバイダーが処理を行うために UI を表示する必要がある場合、呼び出しは失敗し、KSP は最後のエラーとして NTE_SILENT_CONTEXT エラーコードを設定する必要があります。

戻り値の型: HRESULT

公式ドキュメント

秘密鍵と公開鍵から秘密合意値 (secret agreement value) を作成します。(NCryptSecretAgreement)

戻り値

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

返される可能性のあるコードには、次のものが含まれますが、これらに限定されません。

戻り値	説明
ERROR_SUCCESS	関数は成功しました。
NTE_INVALID_HANDLE	hPrivKey または hPubKey パラメーターが無効です。
NTE_INVALID_PARAMETER	1 つ以上のパラメーターが無効です。
NTE_NO_MEMORY	メモリの割り当てに失敗しました。

解説(Remarks)

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// ncrypt.dll
#include <windows.h>

HRESULT NCryptSecretAgreement(
    NCRYPT_KEY_HANDLE hPrivKey,
    NCRYPT_KEY_HANDLE hPubKey,
    NCRYPT_SECRET_HANDLE* phAgreedSecret,
    NCRYPT_FLAGS dwFlags
);

[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int NCryptSecretAgreement(
    UIntPtr hPrivKey,   // NCRYPT_KEY_HANDLE
    UIntPtr hPubKey,   // NCRYPT_KEY_HANDLE
    out UIntPtr phAgreedSecret,   // NCRYPT_SECRET_HANDLE* out
    uint dwFlags   // NCRYPT_FLAGS
);

<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function NCryptSecretAgreement(
    hPrivKey As UIntPtr,   ' NCRYPT_KEY_HANDLE
    hPubKey As UIntPtr,   ' NCRYPT_KEY_HANDLE
    <Out> ByRef phAgreedSecret As UIntPtr,   ' NCRYPT_SECRET_HANDLE* out
    dwFlags As UInteger   ' NCRYPT_FLAGS
) As Integer
End Function

' hPrivKey : NCRYPT_KEY_HANDLE
' hPubKey : NCRYPT_KEY_HANDLE
' phAgreedSecret : NCRYPT_SECRET_HANDLE* out
' dwFlags : NCRYPT_FLAGS
Declare PtrSafe Function NCryptSecretAgreement Lib "ncrypt" ( _
    ByVal hPrivKey As LongPtr, _
    ByVal hPubKey As LongPtr, _
    ByRef phAgreedSecret As LongPtr, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NCryptSecretAgreement = ctypes.windll.ncrypt.NCryptSecretAgreement
NCryptSecretAgreement.restype = ctypes.c_int
NCryptSecretAgreement.argtypes = [
    ctypes.c_size_t,  # hPrivKey : NCRYPT_KEY_HANDLE
    ctypes.c_size_t,  # hPubKey : NCRYPT_KEY_HANDLE
    ctypes.c_void_p,  # phAgreedSecret : NCRYPT_SECRET_HANDLE* out
    wintypes.DWORD,  # dwFlags : NCRYPT_FLAGS
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ncrypt.dll')
NCryptSecretAgreement = Fiddle::Function.new(
  lib['NCryptSecretAgreement'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hPrivKey : NCRYPT_KEY_HANDLE
    Fiddle::TYPE_UINTPTR_T,  # hPubKey : NCRYPT_KEY_HANDLE
    Fiddle::TYPE_VOIDP,  # phAgreedSecret : NCRYPT_SECRET_HANDLE* out
    -Fiddle::TYPE_INT,  # dwFlags : NCRYPT_FLAGS
  ],
  Fiddle::TYPE_INT)

#[link(name = "ncrypt")]
extern "system" {
    fn NCryptSecretAgreement(
        hPrivKey: usize,  // NCRYPT_KEY_HANDLE
        hPubKey: usize,  // NCRYPT_KEY_HANDLE
        phAgreedSecret: *mut usize,  // NCRYPT_SECRET_HANDLE* out
        dwFlags: u32  // NCRYPT_FLAGS
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ncrypt.dll")]
public static extern int NCryptSecretAgreement(UIntPtr hPrivKey, UIntPtr hPubKey, out UIntPtr phAgreedSecret, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ncrypt_NCryptSecretAgreement' -Namespace Win32 -PassThru
# $api::NCryptSecretAgreement(hPrivKey, hPubKey, phAgreedSecret, dwFlags)

#uselib "ncrypt.dll"
#func global NCryptSecretAgreement "NCryptSecretAgreement" sptr, sptr, sptr, sptr
; NCryptSecretAgreement hPrivKey, hPubKey, varptr(phAgreedSecret), dwFlags   ; 戻り値は stat
; hPrivKey : NCRYPT_KEY_HANDLE -> "sptr"
; hPubKey : NCRYPT_KEY_HANDLE -> "sptr"
; phAgreedSecret : NCRYPT_SECRET_HANDLE* out -> "sptr"
; dwFlags : NCRYPT_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ncrypt.dll"
#cfunc global NCryptSecretAgreement "NCryptSecretAgreement" sptr, sptr, var, int
; res = NCryptSecretAgreement(hPrivKey, hPubKey, phAgreedSecret, dwFlags)
; hPrivKey : NCRYPT_KEY_HANDLE -> "sptr"
; hPubKey : NCRYPT_KEY_HANDLE -> "sptr"
; phAgreedSecret : NCRYPT_SECRET_HANDLE* out -> "var"
; dwFlags : NCRYPT_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ncrypt.dll"
#cfunc global NCryptSecretAgreement "NCryptSecretAgreement" sptr, sptr, sptr, int
; res = NCryptSecretAgreement(hPrivKey, hPubKey, varptr(phAgreedSecret), dwFlags)
; hPrivKey : NCRYPT_KEY_HANDLE -> "sptr"
; hPubKey : NCRYPT_KEY_HANDLE -> "sptr"
; phAgreedSecret : NCRYPT_SECRET_HANDLE* out -> "sptr"
; dwFlags : NCRYPT_FLAGS -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。