ホーム › Security.Cryptography › BCryptSecretAgreement
BCryptSecretAgreement
関数秘密鍵と公開鍵から共有シークレットを生成する(鍵共有)。
シグネチャ
// bcrypt.dll
#include <windows.h>
NTSTATUS BCryptSecretAgreement(
BCRYPT_KEY_HANDLE hPrivKey,
BCRYPT_KEY_HANDLE hPubKey,
BCRYPT_SECRET_HANDLE* phAgreedSecret,
DWORD dwFlags
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hPrivKey | BCRYPT_KEY_HANDLE | in | 秘密合意値の作成に使用する秘密鍵のハンドル。この鍵と hPubKey の鍵は、同じ CNG 暗号アルゴリズムプロバイダーから取得したものである必要があります。 |
| hPubKey | BCRYPT_KEY_HANDLE | in | 秘密合意値の作成に使用する公開鍵のハンドル。この鍵と hPrivKey の鍵は、同じ CNG 暗号アルゴリズムプロバイダーから取得したものである必要があります。 |
| phAgreedSecret | BCRYPT_SECRET_HANDLE* | out | 秘密合意値を表すハンドルを受け取る BCRYPT_SECRET_HANDLE へのポインター。このハンドルは、不要になった時点で BCryptDestroySecret 関数に渡して解放する必要があります。 |
| dwFlags | DWORD | in | この関数の動作を変更する一連のフラグ。この関数に対して定義されているフラグはありません。 |
戻り値の型: NTSTATUS
公式ドキュメント
秘密鍵と公開鍵から秘密合意値を作成します。(BCryptSecretAgreement)
戻り値
関数の成功または失敗を示すステータスコードを返します。
返される可能性のあるコードには、以下のものが含まれますが、これらに限定されません。
| 戻り値 | 説明 |
|---|---|
| 関数は成功しました。 | |
| hPrivKey または hPubKey パラメーターの鍵ハンドルが無効です。 | |
| 1 つ以上のパラメーターが無効です。 | |
| hPrivKey パラメーターの鍵ハンドルが Diffie-Hellman 鍵ではありません。 |
解説(Remarks)
サポートされているアルゴリズムプロバイダーを使用する場合、BCryptSecretAgreement はユーザーモードまたはカーネルモードのいずれからでも呼び出すことができます。カーネルモードの呼び出し元は、PASSIVE_LEVEL IRQL または DISPATCH_LEVEL IRQL のいずれかで実行できます。現在の IRQL レベルが DISPATCH_LEVEL の場合、hPrivKey および hPubKey パラメーターで指定するハンドルは、BCRYPT_PROV_DISPATCH フラグを使用して開いたプロバイダーが返すアルゴリズムハンドルから派生したものである必要があり、また BCryptSecretAgreement 関数に渡すすべてのポインターは、ページング不可能(またはロックされた)メモリを参照する必要があります。
この関数をカーネルモードで呼び出すには、Driver Development Kit (DDK) に含まれる Cng.lib を使用します。Windows Server 2008 および Windows Vista: この関数をカーネルモードで呼び出すには、Ksecdd.lib を使用します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// bcrypt.dll
#include <windows.h>
NTSTATUS BCryptSecretAgreement(
BCRYPT_KEY_HANDLE hPrivKey,
BCRYPT_KEY_HANDLE hPubKey,
BCRYPT_SECRET_HANDLE* phAgreedSecret,
DWORD dwFlags
);[DllImport("bcrypt.dll", ExactSpelling = true)]
static extern int BCryptSecretAgreement(
IntPtr hPrivKey, // BCRYPT_KEY_HANDLE
IntPtr hPubKey, // BCRYPT_KEY_HANDLE
IntPtr phAgreedSecret, // BCRYPT_SECRET_HANDLE* out
uint dwFlags // DWORD
);<DllImport("bcrypt.dll", ExactSpelling:=True)>
Public Shared Function BCryptSecretAgreement(
hPrivKey As IntPtr, ' BCRYPT_KEY_HANDLE
hPubKey As IntPtr, ' BCRYPT_KEY_HANDLE
phAgreedSecret As IntPtr, ' BCRYPT_SECRET_HANDLE* out
dwFlags As UInteger ' DWORD
) As Integer
End Function' hPrivKey : BCRYPT_KEY_HANDLE
' hPubKey : BCRYPT_KEY_HANDLE
' phAgreedSecret : BCRYPT_SECRET_HANDLE* out
' dwFlags : DWORD
Declare PtrSafe Function BCryptSecretAgreement Lib "bcrypt" ( _
ByVal hPrivKey As LongPtr, _
ByVal hPubKey As LongPtr, _
ByVal 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
BCryptSecretAgreement = ctypes.windll.bcrypt.BCryptSecretAgreement
BCryptSecretAgreement.restype = ctypes.c_int
BCryptSecretAgreement.argtypes = [
wintypes.HANDLE, # hPrivKey : BCRYPT_KEY_HANDLE
wintypes.HANDLE, # hPubKey : BCRYPT_KEY_HANDLE
ctypes.c_void_p, # phAgreedSecret : BCRYPT_SECRET_HANDLE* out
wintypes.DWORD, # dwFlags : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('bcrypt.dll')
BCryptSecretAgreement = Fiddle::Function.new(
lib['BCryptSecretAgreement'],
[
Fiddle::TYPE_VOIDP, # hPrivKey : BCRYPT_KEY_HANDLE
Fiddle::TYPE_VOIDP, # hPubKey : BCRYPT_KEY_HANDLE
Fiddle::TYPE_VOIDP, # phAgreedSecret : BCRYPT_SECRET_HANDLE* out
-Fiddle::TYPE_INT, # dwFlags : DWORD
],
Fiddle::TYPE_INT)#[link(name = "bcrypt")]
extern "system" {
fn BCryptSecretAgreement(
hPrivKey: *mut core::ffi::c_void, // BCRYPT_KEY_HANDLE
hPubKey: *mut core::ffi::c_void, // BCRYPT_KEY_HANDLE
phAgreedSecret: *mut *mut core::ffi::c_void, // BCRYPT_SECRET_HANDLE* out
dwFlags: u32 // DWORD
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("bcrypt.dll")]
public static extern int BCryptSecretAgreement(IntPtr hPrivKey, IntPtr hPubKey, IntPtr phAgreedSecret, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'bcrypt_BCryptSecretAgreement' -Namespace Win32 -PassThru
# $api::BCryptSecretAgreement(hPrivKey, hPubKey, phAgreedSecret, dwFlags)#uselib "bcrypt.dll"
#func global BCryptSecretAgreement "BCryptSecretAgreement" sptr, sptr, sptr, sptr
; BCryptSecretAgreement hPrivKey, hPubKey, phAgreedSecret, dwFlags ; 戻り値は stat
; hPrivKey : BCRYPT_KEY_HANDLE -> "sptr"
; hPubKey : BCRYPT_KEY_HANDLE -> "sptr"
; phAgreedSecret : BCRYPT_SECRET_HANDLE* out -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "bcrypt.dll"
#cfunc global BCryptSecretAgreement "BCryptSecretAgreement" sptr, sptr, sptr, int
; res = BCryptSecretAgreement(hPrivKey, hPubKey, phAgreedSecret, dwFlags)
; hPrivKey : BCRYPT_KEY_HANDLE -> "sptr"
; hPubKey : BCRYPT_KEY_HANDLE -> "sptr"
; phAgreedSecret : BCRYPT_SECRET_HANDLE* out -> "sptr"
; dwFlags : DWORD -> "int"; NTSTATUS BCryptSecretAgreement(BCRYPT_KEY_HANDLE hPrivKey, BCRYPT_KEY_HANDLE hPubKey, BCRYPT_SECRET_HANDLE* phAgreedSecret, DWORD dwFlags)
#uselib "bcrypt.dll"
#cfunc global BCryptSecretAgreement "BCryptSecretAgreement" intptr, intptr, intptr, int
; res = BCryptSecretAgreement(hPrivKey, hPubKey, phAgreedSecret, dwFlags)
; hPrivKey : BCRYPT_KEY_HANDLE -> "intptr"
; hPubKey : BCRYPT_KEY_HANDLE -> "intptr"
; phAgreedSecret : BCRYPT_SECRET_HANDLE* out -> "intptr"
; dwFlags : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
bcrypt = windows.NewLazySystemDLL("bcrypt.dll")
procBCryptSecretAgreement = bcrypt.NewProc("BCryptSecretAgreement")
)
// hPrivKey (BCRYPT_KEY_HANDLE), hPubKey (BCRYPT_KEY_HANDLE), phAgreedSecret (BCRYPT_SECRET_HANDLE* out), dwFlags (DWORD)
r1, _, err := procBCryptSecretAgreement.Call(
uintptr(hPrivKey),
uintptr(hPubKey),
uintptr(phAgreedSecret),
uintptr(dwFlags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // NTSTATUSfunction BCryptSecretAgreement(
hPrivKey: THandle; // BCRYPT_KEY_HANDLE
hPubKey: THandle; // BCRYPT_KEY_HANDLE
phAgreedSecret: Pointer; // BCRYPT_SECRET_HANDLE* out
dwFlags: DWORD // DWORD
): Integer; stdcall;
external 'bcrypt.dll' name 'BCryptSecretAgreement';result := DllCall("bcrypt\BCryptSecretAgreement"
, "Ptr", hPrivKey ; BCRYPT_KEY_HANDLE
, "Ptr", hPubKey ; BCRYPT_KEY_HANDLE
, "Ptr", phAgreedSecret ; BCRYPT_SECRET_HANDLE* out
, "UInt", dwFlags ; DWORD
, "Int") ; return: NTSTATUS●BCryptSecretAgreement(hPrivKey, hPubKey, phAgreedSecret, dwFlags) = DLL("bcrypt.dll", "int BCryptSecretAgreement(void*, void*, void*, dword)")
# 呼び出し: BCryptSecretAgreement(hPrivKey, hPubKey, phAgreedSecret, dwFlags)
# hPrivKey : BCRYPT_KEY_HANDLE -> "void*"
# hPubKey : BCRYPT_KEY_HANDLE -> "void*"
# phAgreedSecret : BCRYPT_SECRET_HANDLE* out -> "void*"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "bcrypt" fn BCryptSecretAgreement(
hPrivKey: ?*anyopaque, // BCRYPT_KEY_HANDLE
hPubKey: ?*anyopaque, // BCRYPT_KEY_HANDLE
phAgreedSecret: ?*anyopaque, // BCRYPT_SECRET_HANDLE* out
dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc BCryptSecretAgreement(
hPrivKey: pointer, # BCRYPT_KEY_HANDLE
hPubKey: pointer, # BCRYPT_KEY_HANDLE
phAgreedSecret: pointer, # BCRYPT_SECRET_HANDLE* out
dwFlags: uint32 # DWORD
): int32 {.importc: "BCryptSecretAgreement", stdcall, dynlib: "bcrypt.dll".}pragma(lib, "bcrypt");
extern(Windows)
int BCryptSecretAgreement(
void* hPrivKey, // BCRYPT_KEY_HANDLE
void* hPubKey, // BCRYPT_KEY_HANDLE
void* phAgreedSecret, // BCRYPT_SECRET_HANDLE* out
uint dwFlags // DWORD
);ccall((:BCryptSecretAgreement, "bcrypt.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}, UInt32),
hPrivKey, hPubKey, phAgreedSecret, dwFlags)
# hPrivKey : BCRYPT_KEY_HANDLE -> Ptr{Cvoid}
# hPubKey : BCRYPT_KEY_HANDLE -> Ptr{Cvoid}
# phAgreedSecret : BCRYPT_SECRET_HANDLE* out -> Ptr{Cvoid}
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t BCryptSecretAgreement(
void* hPrivKey,
void* hPubKey,
void* phAgreedSecret,
uint32_t dwFlags);
]]
local bcrypt = ffi.load("bcrypt")
-- bcrypt.BCryptSecretAgreement(hPrivKey, hPubKey, phAgreedSecret, dwFlags)
-- hPrivKey : BCRYPT_KEY_HANDLE
-- hPubKey : BCRYPT_KEY_HANDLE
-- phAgreedSecret : BCRYPT_SECRET_HANDLE* out
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('bcrypt.dll');
const BCryptSecretAgreement = lib.func('__stdcall', 'BCryptSecretAgreement', 'int32_t', ['void *', 'void *', 'void *', 'uint32_t']);
// BCryptSecretAgreement(hPrivKey, hPubKey, phAgreedSecret, dwFlags)
// hPrivKey : BCRYPT_KEY_HANDLE -> 'void *'
// hPubKey : BCRYPT_KEY_HANDLE -> 'void *'
// phAgreedSecret : BCRYPT_SECRET_HANDLE* out -> 'void *'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("bcrypt.dll", {
BCryptSecretAgreement: { parameters: ["pointer", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.BCryptSecretAgreement(hPrivKey, hPubKey, phAgreedSecret, dwFlags)
// hPrivKey : BCRYPT_KEY_HANDLE -> "pointer"
// hPubKey : BCRYPT_KEY_HANDLE -> "pointer"
// phAgreedSecret : BCRYPT_SECRET_HANDLE* out -> "pointer"
// dwFlags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t BCryptSecretAgreement(
void* hPrivKey,
void* hPubKey,
void* phAgreedSecret,
uint32_t dwFlags);
C, "bcrypt.dll");
// $ffi->BCryptSecretAgreement(hPrivKey, hPubKey, phAgreedSecret, dwFlags);
// hPrivKey : BCRYPT_KEY_HANDLE
// hPubKey : BCRYPT_KEY_HANDLE
// phAgreedSecret : BCRYPT_SECRET_HANDLE* out
// dwFlags : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Bcrypt extends StdCallLibrary {
Bcrypt INSTANCE = Native.load("bcrypt", Bcrypt.class);
int BCryptSecretAgreement(
Pointer hPrivKey, // BCRYPT_KEY_HANDLE
Pointer hPubKey, // BCRYPT_KEY_HANDLE
Pointer phAgreedSecret, // BCRYPT_SECRET_HANDLE* out
int dwFlags // DWORD
);
}@[Link("bcrypt")]
lib Libbcrypt
fun BCryptSecretAgreement = BCryptSecretAgreement(
hPrivKey : Void*, # BCRYPT_KEY_HANDLE
hPubKey : Void*, # BCRYPT_KEY_HANDLE
phAgreedSecret : Void*, # BCRYPT_SECRET_HANDLE* out
dwFlags : UInt32 # DWORD
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef BCryptSecretAgreementNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Uint32);
typedef BCryptSecretAgreementDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, int);
final BCryptSecretAgreement = DynamicLibrary.open('bcrypt.dll')
.lookupFunction<BCryptSecretAgreementNative, BCryptSecretAgreementDart>('BCryptSecretAgreement');
// hPrivKey : BCRYPT_KEY_HANDLE -> Pointer<Void>
// hPubKey : BCRYPT_KEY_HANDLE -> Pointer<Void>
// phAgreedSecret : BCRYPT_SECRET_HANDLE* out -> Pointer<Void>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function BCryptSecretAgreement(
hPrivKey: THandle; // BCRYPT_KEY_HANDLE
hPubKey: THandle; // BCRYPT_KEY_HANDLE
phAgreedSecret: Pointer; // BCRYPT_SECRET_HANDLE* out
dwFlags: DWORD // DWORD
): Integer; stdcall;
external 'bcrypt.dll' name 'BCryptSecretAgreement';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "BCryptSecretAgreement"
c_BCryptSecretAgreement :: Ptr () -> Ptr () -> Ptr () -> Word32 -> IO Int32
-- hPrivKey : BCRYPT_KEY_HANDLE -> Ptr ()
-- hPubKey : BCRYPT_KEY_HANDLE -> Ptr ()
-- phAgreedSecret : BCRYPT_SECRET_HANDLE* out -> Ptr ()
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let bcryptsecretagreement =
foreign "BCryptSecretAgreement"
((ptr void) @-> (ptr void) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* hPrivKey : BCRYPT_KEY_HANDLE -> (ptr void) *)
(* hPubKey : BCRYPT_KEY_HANDLE -> (ptr void) *)
(* phAgreedSecret : BCRYPT_SECRET_HANDLE* out -> (ptr void) *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library bcrypt (t "bcrypt.dll"))
(cffi:use-foreign-library bcrypt)
(cffi:defcfun ("BCryptSecretAgreement" bcrypt-secret-agreement :convention :stdcall) :int32
(h-priv-key :pointer) ; BCRYPT_KEY_HANDLE
(h-pub-key :pointer) ; BCRYPT_KEY_HANDLE
(ph-agreed-secret :pointer) ; BCRYPT_SECRET_HANDLE* out
(dw-flags :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $BCryptSecretAgreement = Win32::API::More->new('bcrypt',
'int BCryptSecretAgreement(HANDLE hPrivKey, HANDLE hPubKey, HANDLE phAgreedSecret, DWORD dwFlags)');
# my $ret = $BCryptSecretAgreement->Call($hPrivKey, $hPubKey, $phAgreedSecret, $dwFlags);
# hPrivKey : BCRYPT_KEY_HANDLE -> HANDLE
# hPubKey : BCRYPT_KEY_HANDLE -> HANDLE
# phAgreedSecret : BCRYPT_SECRET_HANDLE* out -> HANDLE
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f BCryptDestroySecret — CNGの共有シークレットオブジェクトを破棄する。