Win32 API 日本語リファレンス
ホームSecurity.Cryptography › SslExpandWriteKey

SslExpandWriteKey

関数
TLS1.3でトラフィック鍵から書き込み用鍵を展開する。
DLLncrypt.dll呼出規約winapi

シグネチャ

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

HRESULT SslExpandWriteKey(
    NCRYPT_PROV_HANDLE hSslProvider,
    NCRYPT_KEY_HANDLE hBaseTrafficKey,
    NCRYPT_KEY_HANDLE* phWriteKey,
    BCryptBufferDesc* pParameterList,   // optional
    DWORD dwFlags
);

パラメーター

名前方向説明
hSslProviderNCRYPT_PROV_HANDLEinSchannel SSLプロバイダのハンドル。
hBaseTrafficKeyNCRYPT_KEY_HANDLEin書き込み鍵を展開する基となるトラフィック鍵ハンドル。
phWriteKeyNCRYPT_KEY_HANDLE*out展開された書き込み(送信)鍵のハンドルを受け取る出力先。
pParameterListBCryptBufferDesc*inoptional追加パラメータを示すBCryptBufferDesc。
dwFlagsDWORDin動作を制御するフラグ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT SslExpandWriteKey(
    NCRYPT_PROV_HANDLE hSslProvider,
    NCRYPT_KEY_HANDLE hBaseTrafficKey,
    NCRYPT_KEY_HANDLE* phWriteKey,
    BCryptBufferDesc* pParameterList,   // optional
    DWORD dwFlags
);
[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int SslExpandWriteKey(
    UIntPtr hSslProvider,   // NCRYPT_PROV_HANDLE
    UIntPtr hBaseTrafficKey,   // NCRYPT_KEY_HANDLE
    out UIntPtr phWriteKey,   // NCRYPT_KEY_HANDLE* out
    IntPtr pParameterList,   // BCryptBufferDesc* optional
    uint dwFlags   // DWORD
);
<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function SslExpandWriteKey(
    hSslProvider As UIntPtr,   ' NCRYPT_PROV_HANDLE
    hBaseTrafficKey As UIntPtr,   ' NCRYPT_KEY_HANDLE
    <Out> ByRef phWriteKey As UIntPtr,   ' NCRYPT_KEY_HANDLE* out
    pParameterList As IntPtr,   ' BCryptBufferDesc* optional
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' hSslProvider : NCRYPT_PROV_HANDLE
' hBaseTrafficKey : NCRYPT_KEY_HANDLE
' phWriteKey : NCRYPT_KEY_HANDLE* out
' pParameterList : BCryptBufferDesc* optional
' dwFlags : DWORD
Declare PtrSafe Function SslExpandWriteKey Lib "ncrypt" ( _
    ByVal hSslProvider As LongPtr, _
    ByVal hBaseTrafficKey As LongPtr, _
    ByRef phWriteKey As LongPtr, _
    ByVal pParameterList 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

SslExpandWriteKey = ctypes.windll.ncrypt.SslExpandWriteKey
SslExpandWriteKey.restype = ctypes.c_int
SslExpandWriteKey.argtypes = [
    ctypes.c_size_t,  # hSslProvider : NCRYPT_PROV_HANDLE
    ctypes.c_size_t,  # hBaseTrafficKey : NCRYPT_KEY_HANDLE
    ctypes.c_void_p,  # phWriteKey : NCRYPT_KEY_HANDLE* out
    ctypes.c_void_p,  # pParameterList : BCryptBufferDesc* optional
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ncrypt.dll')
SslExpandWriteKey = Fiddle::Function.new(
  lib['SslExpandWriteKey'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hSslProvider : NCRYPT_PROV_HANDLE
    Fiddle::TYPE_UINTPTR_T,  # hBaseTrafficKey : NCRYPT_KEY_HANDLE
    Fiddle::TYPE_VOIDP,  # phWriteKey : NCRYPT_KEY_HANDLE* out
    Fiddle::TYPE_VOIDP,  # pParameterList : BCryptBufferDesc* optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "ncrypt")]
extern "system" {
    fn SslExpandWriteKey(
        hSslProvider: usize,  // NCRYPT_PROV_HANDLE
        hBaseTrafficKey: usize,  // NCRYPT_KEY_HANDLE
        phWriteKey: *mut usize,  // NCRYPT_KEY_HANDLE* out
        pParameterList: *mut BCryptBufferDesc,  // BCryptBufferDesc* optional
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ncrypt.dll")]
public static extern int SslExpandWriteKey(UIntPtr hSslProvider, UIntPtr hBaseTrafficKey, out UIntPtr phWriteKey, IntPtr pParameterList, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ncrypt_SslExpandWriteKey' -Namespace Win32 -PassThru
# $api::SslExpandWriteKey(hSslProvider, hBaseTrafficKey, phWriteKey, pParameterList, dwFlags)
#uselib "ncrypt.dll"
#func global SslExpandWriteKey "SslExpandWriteKey" sptr, sptr, sptr, sptr, sptr
; SslExpandWriteKey hSslProvider, hBaseTrafficKey, varptr(phWriteKey), varptr(pParameterList), dwFlags   ; 戻り値は stat
; hSslProvider : NCRYPT_PROV_HANDLE -> "sptr"
; hBaseTrafficKey : NCRYPT_KEY_HANDLE -> "sptr"
; phWriteKey : NCRYPT_KEY_HANDLE* out -> "sptr"
; pParameterList : BCryptBufferDesc* optional -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ncrypt.dll"
#cfunc global SslExpandWriteKey "SslExpandWriteKey" sptr, sptr, var, var, int
; res = SslExpandWriteKey(hSslProvider, hBaseTrafficKey, phWriteKey, pParameterList, dwFlags)
; hSslProvider : NCRYPT_PROV_HANDLE -> "sptr"
; hBaseTrafficKey : NCRYPT_KEY_HANDLE -> "sptr"
; phWriteKey : NCRYPT_KEY_HANDLE* out -> "var"
; pParameterList : BCryptBufferDesc* optional -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT SslExpandWriteKey(NCRYPT_PROV_HANDLE hSslProvider, NCRYPT_KEY_HANDLE hBaseTrafficKey, NCRYPT_KEY_HANDLE* phWriteKey, BCryptBufferDesc* pParameterList, DWORD dwFlags)
#uselib "ncrypt.dll"
#cfunc global SslExpandWriteKey "SslExpandWriteKey" intptr, intptr, var, var, int
; res = SslExpandWriteKey(hSslProvider, hBaseTrafficKey, phWriteKey, pParameterList, dwFlags)
; hSslProvider : NCRYPT_PROV_HANDLE -> "intptr"
; hBaseTrafficKey : NCRYPT_KEY_HANDLE -> "intptr"
; phWriteKey : NCRYPT_KEY_HANDLE* out -> "var"
; pParameterList : BCryptBufferDesc* optional -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ncrypt = windows.NewLazySystemDLL("ncrypt.dll")
	procSslExpandWriteKey = ncrypt.NewProc("SslExpandWriteKey")
)

// hSslProvider (NCRYPT_PROV_HANDLE), hBaseTrafficKey (NCRYPT_KEY_HANDLE), phWriteKey (NCRYPT_KEY_HANDLE* out), pParameterList (BCryptBufferDesc* optional), dwFlags (DWORD)
r1, _, err := procSslExpandWriteKey.Call(
	uintptr(hSslProvider),
	uintptr(hBaseTrafficKey),
	uintptr(phWriteKey),
	uintptr(pParameterList),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function SslExpandWriteKey(
  hSslProvider: NativeUInt;   // NCRYPT_PROV_HANDLE
  hBaseTrafficKey: NativeUInt;   // NCRYPT_KEY_HANDLE
  phWriteKey: Pointer;   // NCRYPT_KEY_HANDLE* out
  pParameterList: Pointer;   // BCryptBufferDesc* optional
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'ncrypt.dll' name 'SslExpandWriteKey';
result := DllCall("ncrypt\SslExpandWriteKey"
    , "UPtr", hSslProvider   ; NCRYPT_PROV_HANDLE
    , "UPtr", hBaseTrafficKey   ; NCRYPT_KEY_HANDLE
    , "Ptr", phWriteKey   ; NCRYPT_KEY_HANDLE* out
    , "Ptr", pParameterList   ; BCryptBufferDesc* optional
    , "UInt", dwFlags   ; DWORD
    , "Int")   ; return: HRESULT
●SslExpandWriteKey(hSslProvider, hBaseTrafficKey, phWriteKey, pParameterList, dwFlags) = DLL("ncrypt.dll", "int SslExpandWriteKey(int, int, void*, void*, dword)")
# 呼び出し: SslExpandWriteKey(hSslProvider, hBaseTrafficKey, phWriteKey, pParameterList, dwFlags)
# hSslProvider : NCRYPT_PROV_HANDLE -> "int"
# hBaseTrafficKey : NCRYPT_KEY_HANDLE -> "int"
# phWriteKey : NCRYPT_KEY_HANDLE* out -> "void*"
# pParameterList : BCryptBufferDesc* optional -> "void*"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "ncrypt" fn SslExpandWriteKey(
    hSslProvider: usize, // NCRYPT_PROV_HANDLE
    hBaseTrafficKey: usize, // NCRYPT_KEY_HANDLE
    phWriteKey: [*c]usize, // NCRYPT_KEY_HANDLE* out
    pParameterList: [*c]BCryptBufferDesc, // BCryptBufferDesc* optional
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc SslExpandWriteKey(
    hSslProvider: uint,  # NCRYPT_PROV_HANDLE
    hBaseTrafficKey: uint,  # NCRYPT_KEY_HANDLE
    phWriteKey: ptr uint,  # NCRYPT_KEY_HANDLE* out
    pParameterList: ptr BCryptBufferDesc,  # BCryptBufferDesc* optional
    dwFlags: uint32  # DWORD
): int32 {.importc: "SslExpandWriteKey", stdcall, dynlib: "ncrypt.dll".}
pragma(lib, "ncrypt");
extern(Windows)
int SslExpandWriteKey(
    size_t hSslProvider,   // NCRYPT_PROV_HANDLE
    size_t hBaseTrafficKey,   // NCRYPT_KEY_HANDLE
    size_t* phWriteKey,   // NCRYPT_KEY_HANDLE* out
    BCryptBufferDesc* pParameterList,   // BCryptBufferDesc* optional
    uint dwFlags   // DWORD
);
ccall((:SslExpandWriteKey, "ncrypt.dll"), stdcall, Int32,
      (Csize_t, Csize_t, Ptr{Csize_t}, Ptr{BCryptBufferDesc}, UInt32),
      hSslProvider, hBaseTrafficKey, phWriteKey, pParameterList, dwFlags)
# hSslProvider : NCRYPT_PROV_HANDLE -> Csize_t
# hBaseTrafficKey : NCRYPT_KEY_HANDLE -> Csize_t
# phWriteKey : NCRYPT_KEY_HANDLE* out -> Ptr{Csize_t}
# pParameterList : BCryptBufferDesc* optional -> Ptr{BCryptBufferDesc}
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SslExpandWriteKey(
    uintptr_t hSslProvider,
    uintptr_t hBaseTrafficKey,
    uintptr_t* phWriteKey,
    void* pParameterList,
    uint32_t dwFlags);
]]
local ncrypt = ffi.load("ncrypt")
-- ncrypt.SslExpandWriteKey(hSslProvider, hBaseTrafficKey, phWriteKey, pParameterList, dwFlags)
-- hSslProvider : NCRYPT_PROV_HANDLE
-- hBaseTrafficKey : NCRYPT_KEY_HANDLE
-- phWriteKey : NCRYPT_KEY_HANDLE* out
-- pParameterList : BCryptBufferDesc* optional
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ncrypt.dll');
const SslExpandWriteKey = lib.func('__stdcall', 'SslExpandWriteKey', 'int32_t', ['uintptr_t', 'uintptr_t', 'uintptr_t *', 'void *', 'uint32_t']);
// SslExpandWriteKey(hSslProvider, hBaseTrafficKey, phWriteKey, pParameterList, dwFlags)
// hSslProvider : NCRYPT_PROV_HANDLE -> 'uintptr_t'
// hBaseTrafficKey : NCRYPT_KEY_HANDLE -> 'uintptr_t'
// phWriteKey : NCRYPT_KEY_HANDLE* out -> 'uintptr_t *'
// pParameterList : BCryptBufferDesc* optional -> 'void *'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ncrypt.dll", {
  SslExpandWriteKey: { parameters: ["usize", "usize", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.SslExpandWriteKey(hSslProvider, hBaseTrafficKey, phWriteKey, pParameterList, dwFlags)
// hSslProvider : NCRYPT_PROV_HANDLE -> "usize"
// hBaseTrafficKey : NCRYPT_KEY_HANDLE -> "usize"
// phWriteKey : NCRYPT_KEY_HANDLE* out -> "pointer"
// pParameterList : BCryptBufferDesc* optional -> "pointer"
// dwFlags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SslExpandWriteKey(
    size_t hSslProvider,
    size_t hBaseTrafficKey,
    size_t* phWriteKey,
    void* pParameterList,
    uint32_t dwFlags);
C, "ncrypt.dll");
// $ffi->SslExpandWriteKey(hSslProvider, hBaseTrafficKey, phWriteKey, pParameterList, dwFlags);
// hSslProvider : NCRYPT_PROV_HANDLE
// hBaseTrafficKey : NCRYPT_KEY_HANDLE
// phWriteKey : NCRYPT_KEY_HANDLE* out
// pParameterList : BCryptBufferDesc* optional
// 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 Ncrypt extends StdCallLibrary {
    Ncrypt INSTANCE = Native.load("ncrypt", Ncrypt.class);
    int SslExpandWriteKey(
        long hSslProvider,   // NCRYPT_PROV_HANDLE
        long hBaseTrafficKey,   // NCRYPT_KEY_HANDLE
        LongByReference phWriteKey,   // NCRYPT_KEY_HANDLE* out
        Pointer pParameterList,   // BCryptBufferDesc* optional
        int dwFlags   // DWORD
    );
}
@[Link("ncrypt")]
lib Libncrypt
  fun SslExpandWriteKey = SslExpandWriteKey(
    hSslProvider : LibC::SizeT,   # NCRYPT_PROV_HANDLE
    hBaseTrafficKey : LibC::SizeT,   # NCRYPT_KEY_HANDLE
    phWriteKey : LibC::SizeT*,   # NCRYPT_KEY_HANDLE* out
    pParameterList : BCryptBufferDesc*,   # BCryptBufferDesc* optional
    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 SslExpandWriteKeyNative = Int32 Function(UintPtr, UintPtr, Pointer<UintPtr>, Pointer<Void>, Uint32);
typedef SslExpandWriteKeyDart = int Function(int, int, Pointer<UintPtr>, Pointer<Void>, int);
final SslExpandWriteKey = DynamicLibrary.open('ncrypt.dll')
    .lookupFunction<SslExpandWriteKeyNative, SslExpandWriteKeyDart>('SslExpandWriteKey');
// hSslProvider : NCRYPT_PROV_HANDLE -> UintPtr
// hBaseTrafficKey : NCRYPT_KEY_HANDLE -> UintPtr
// phWriteKey : NCRYPT_KEY_HANDLE* out -> Pointer<UintPtr>
// pParameterList : BCryptBufferDesc* optional -> Pointer<Void>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SslExpandWriteKey(
  hSslProvider: NativeUInt;   // NCRYPT_PROV_HANDLE
  hBaseTrafficKey: NativeUInt;   // NCRYPT_KEY_HANDLE
  phWriteKey: Pointer;   // NCRYPT_KEY_HANDLE* out
  pParameterList: Pointer;   // BCryptBufferDesc* optional
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'ncrypt.dll' name 'SslExpandWriteKey';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SslExpandWriteKey"
  c_SslExpandWriteKey :: CUIntPtr -> CUIntPtr -> Ptr CUIntPtr -> Ptr () -> Word32 -> IO Int32
-- hSslProvider : NCRYPT_PROV_HANDLE -> CUIntPtr
-- hBaseTrafficKey : NCRYPT_KEY_HANDLE -> CUIntPtr
-- phWriteKey : NCRYPT_KEY_HANDLE* out -> Ptr CUIntPtr
-- pParameterList : BCryptBufferDesc* optional -> Ptr ()
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let sslexpandwritekey =
  foreign "SslExpandWriteKey"
    (size_t @-> size_t @-> (ptr size_t) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* hSslProvider : NCRYPT_PROV_HANDLE -> size_t *)
(* hBaseTrafficKey : NCRYPT_KEY_HANDLE -> size_t *)
(* phWriteKey : NCRYPT_KEY_HANDLE* out -> (ptr size_t) *)
(* pParameterList : BCryptBufferDesc* optional -> (ptr void) *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ncrypt (t "ncrypt.dll"))
(cffi:use-foreign-library ncrypt)

(cffi:defcfun ("SslExpandWriteKey" ssl-expand-write-key :convention :stdcall) :int32
  (h-ssl-provider :uint64)   ; NCRYPT_PROV_HANDLE
  (h-base-traffic-key :uint64)   ; NCRYPT_KEY_HANDLE
  (ph-write-key :pointer)   ; NCRYPT_KEY_HANDLE* out
  (p-parameter-list :pointer)   ; BCryptBufferDesc* optional
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SslExpandWriteKey = Win32::API::More->new('ncrypt',
    'int SslExpandWriteKey(WPARAM hSslProvider, WPARAM hBaseTrafficKey, LPVOID phWriteKey, LPVOID pParameterList, DWORD dwFlags)');
# my $ret = $SslExpandWriteKey->Call($hSslProvider, $hBaseTrafficKey, $phWriteKey, $pParameterList, $dwFlags);
# hSslProvider : NCRYPT_PROV_HANDLE -> WPARAM
# hBaseTrafficKey : NCRYPT_KEY_HANDLE -> WPARAM
# phWriteKey : NCRYPT_KEY_HANDLE* out -> LPVOID
# pParameterList : BCryptBufferDesc* optional -> LPVOID
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型