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

SslCreateEphemeralKey

関数
SSL用の一時鍵を生成する。
DLLncrypt.dll呼出規約winapi

シグネチャ

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

HRESULT SslCreateEphemeralKey(
    NCRYPT_PROV_HANDLE hSslProvider,
    NCRYPT_KEY_HANDLE* phEphemeralKey,
    DWORD dwProtocol,
    DWORD dwCipherSuite,
    DWORD dwKeyType,
    DWORD dwKeyBitLen,
    BYTE* pbParams,   // optional
    DWORD cbParams,
    DWORD dwFlags
);

パラメーター

名前方向
hSslProviderNCRYPT_PROV_HANDLEin
phEphemeralKeyNCRYPT_KEY_HANDLE*out
dwProtocolDWORDin
dwCipherSuiteDWORDin
dwKeyTypeDWORDin
dwKeyBitLenDWORDin
pbParamsBYTE*inoptional
cbParamsDWORDin
dwFlagsDWORDin

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT SslCreateEphemeralKey(
    NCRYPT_PROV_HANDLE hSslProvider,
    NCRYPT_KEY_HANDLE* phEphemeralKey,
    DWORD dwProtocol,
    DWORD dwCipherSuite,
    DWORD dwKeyType,
    DWORD dwKeyBitLen,
    BYTE* pbParams,   // optional
    DWORD cbParams,
    DWORD dwFlags
);
[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int SslCreateEphemeralKey(
    UIntPtr hSslProvider,   // NCRYPT_PROV_HANDLE
    out UIntPtr phEphemeralKey,   // NCRYPT_KEY_HANDLE* out
    uint dwProtocol,   // DWORD
    uint dwCipherSuite,   // DWORD
    uint dwKeyType,   // DWORD
    uint dwKeyBitLen,   // DWORD
    IntPtr pbParams,   // BYTE* optional
    uint cbParams,   // DWORD
    uint dwFlags   // DWORD
);
<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function SslCreateEphemeralKey(
    hSslProvider As UIntPtr,   ' NCRYPT_PROV_HANDLE
    <Out> ByRef phEphemeralKey As UIntPtr,   ' NCRYPT_KEY_HANDLE* out
    dwProtocol As UInteger,   ' DWORD
    dwCipherSuite As UInteger,   ' DWORD
    dwKeyType As UInteger,   ' DWORD
    dwKeyBitLen As UInteger,   ' DWORD
    pbParams As IntPtr,   ' BYTE* optional
    cbParams As UInteger,   ' DWORD
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' hSslProvider : NCRYPT_PROV_HANDLE
' phEphemeralKey : NCRYPT_KEY_HANDLE* out
' dwProtocol : DWORD
' dwCipherSuite : DWORD
' dwKeyType : DWORD
' dwKeyBitLen : DWORD
' pbParams : BYTE* optional
' cbParams : DWORD
' dwFlags : DWORD
Declare PtrSafe Function SslCreateEphemeralKey Lib "ncrypt" ( _
    ByVal hSslProvider As LongPtr, _
    ByRef phEphemeralKey As LongPtr, _
    ByVal dwProtocol As Long, _
    ByVal dwCipherSuite As Long, _
    ByVal dwKeyType As Long, _
    ByVal dwKeyBitLen As Long, _
    ByVal pbParams As LongPtr, _
    ByVal cbParams As Long, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SslCreateEphemeralKey = ctypes.windll.ncrypt.SslCreateEphemeralKey
SslCreateEphemeralKey.restype = ctypes.c_int
SslCreateEphemeralKey.argtypes = [
    ctypes.c_size_t,  # hSslProvider : NCRYPT_PROV_HANDLE
    ctypes.c_void_p,  # phEphemeralKey : NCRYPT_KEY_HANDLE* out
    wintypes.DWORD,  # dwProtocol : DWORD
    wintypes.DWORD,  # dwCipherSuite : DWORD
    wintypes.DWORD,  # dwKeyType : DWORD
    wintypes.DWORD,  # dwKeyBitLen : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbParams : BYTE* optional
    wintypes.DWORD,  # cbParams : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ncrypt = windows.NewLazySystemDLL("ncrypt.dll")
	procSslCreateEphemeralKey = ncrypt.NewProc("SslCreateEphemeralKey")
)

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