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

SslExportKey

関数
SSL鍵を指定形式のBLOBにエクスポートする。
DLLncrypt.dll呼出規約winapi

シグネチャ

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

HRESULT SslExportKey(
    NCRYPT_PROV_HANDLE hSslProvider,
    NCRYPT_KEY_HANDLE hKey,
    LPCWSTR pszBlobType,
    BYTE* pbOutput,   // optional
    DWORD cbOutput,
    DWORD* pcbResult,
    DWORD dwFlags
);

パラメーター

名前方向説明
hSslProviderNCRYPT_PROV_HANDLEinSchannel SSLプロバイダのハンドル。
hKeyNCRYPT_KEY_HANDLEinエクスポート対象の鍵ハンドル。
pszBlobTypeLPCWSTRinエクスポートする鍵ブロブの種類を示す文字列。
pbOutputBYTE*outoptionalエクスポートした鍵ブロブを書き込む出力バッファ。NULLでサイズ問い合わせ。
cbOutputDWORDinpbOutputのバイト数。
pcbResultDWORD*out実際に書き込まれた(または必要な)バイト数を受け取る出力先。
dwFlagsDWORDin動作を制御するフラグ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT SslExportKey(
    NCRYPT_PROV_HANDLE hSslProvider,
    NCRYPT_KEY_HANDLE hKey,
    LPCWSTR pszBlobType,
    BYTE* pbOutput,   // optional
    DWORD cbOutput,
    DWORD* pcbResult,
    DWORD dwFlags
);
[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int SslExportKey(
    UIntPtr hSslProvider,   // NCRYPT_PROV_HANDLE
    UIntPtr hKey,   // NCRYPT_KEY_HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string pszBlobType,   // LPCWSTR
    IntPtr pbOutput,   // BYTE* optional, out
    uint cbOutput,   // DWORD
    out uint pcbResult,   // DWORD* out
    uint dwFlags   // DWORD
);
<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function SslExportKey(
    hSslProvider As UIntPtr,   ' NCRYPT_PROV_HANDLE
    hKey As UIntPtr,   ' NCRYPT_KEY_HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> pszBlobType As String,   ' LPCWSTR
    pbOutput As IntPtr,   ' BYTE* optional, out
    cbOutput As UInteger,   ' DWORD
    <Out> ByRef pcbResult As UInteger,   ' DWORD* out
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' hSslProvider : NCRYPT_PROV_HANDLE
' hKey : NCRYPT_KEY_HANDLE
' pszBlobType : LPCWSTR
' pbOutput : BYTE* optional, out
' cbOutput : DWORD
' pcbResult : DWORD* out
' dwFlags : DWORD
Declare PtrSafe Function SslExportKey Lib "ncrypt" ( _
    ByVal hSslProvider As LongPtr, _
    ByVal hKey As LongPtr, _
    ByVal pszBlobType As LongPtr, _
    ByVal pbOutput As LongPtr, _
    ByVal cbOutput As Long, _
    ByRef pcbResult 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

SslExportKey = ctypes.windll.ncrypt.SslExportKey
SslExportKey.restype = ctypes.c_int
SslExportKey.argtypes = [
    ctypes.c_size_t,  # hSslProvider : NCRYPT_PROV_HANDLE
    ctypes.c_size_t,  # hKey : NCRYPT_KEY_HANDLE
    wintypes.LPCWSTR,  # pszBlobType : LPCWSTR
    ctypes.POINTER(ctypes.c_ubyte),  # pbOutput : BYTE* optional, out
    wintypes.DWORD,  # cbOutput : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbResult : DWORD* out
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ncrypt = windows.NewLazySystemDLL("ncrypt.dll")
	procSslExportKey = ncrypt.NewProc("SslExportKey")
)

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

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

foreign import stdcall safe "SslExportKey"
  c_SslExportKey :: CUIntPtr -> CUIntPtr -> CWString -> Ptr Word8 -> Word32 -> Ptr Word32 -> Word32 -> IO Int32
-- hSslProvider : NCRYPT_PROV_HANDLE -> CUIntPtr
-- hKey : NCRYPT_KEY_HANDLE -> CUIntPtr
-- pszBlobType : LPCWSTR -> CWString
-- pbOutput : BYTE* optional, out -> Ptr Word8
-- cbOutput : DWORD -> Word32
-- pcbResult : DWORD* out -> Ptr Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let sslexportkey =
  foreign "SslExportKey"
    (size_t @-> size_t @-> (ptr uint16_t) @-> (ptr uint8_t) @-> uint32_t @-> (ptr uint32_t) @-> uint32_t @-> returning int32_t)
(* hSslProvider : NCRYPT_PROV_HANDLE -> size_t *)
(* hKey : NCRYPT_KEY_HANDLE -> size_t *)
(* pszBlobType : LPCWSTR -> (ptr uint16_t) *)
(* pbOutput : BYTE* optional, out -> (ptr uint8_t) *)
(* cbOutput : DWORD -> uint32_t *)
(* pcbResult : DWORD* out -> (ptr uint32_t) *)
(* 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 ("SslExportKey" ssl-export-key :convention :stdcall) :int32
  (h-ssl-provider :uint64)   ; NCRYPT_PROV_HANDLE
  (h-key :uint64)   ; NCRYPT_KEY_HANDLE
  (psz-blob-type (:string :encoding :utf-16le))   ; LPCWSTR
  (pb-output :pointer)   ; BYTE* optional, out
  (cb-output :uint32)   ; DWORD
  (pcb-result :pointer)   ; DWORD* out
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SslExportKey = Win32::API::More->new('ncrypt',
    'int SslExportKey(WPARAM hSslProvider, WPARAM hKey, LPCWSTR pszBlobType, LPVOID pbOutput, DWORD cbOutput, LPVOID pcbResult, DWORD dwFlags)');
# my $ret = $SslExportKey->Call($hSslProvider, $hKey, $pszBlobType, $pbOutput, $cbOutput, $pcbResult, $dwFlags);
# hSslProvider : NCRYPT_PROV_HANDLE -> WPARAM
# hKey : NCRYPT_KEY_HANDLE -> WPARAM
# pszBlobType : LPCWSTR -> LPCWSTR
# pbOutput : BYTE* optional, out -> LPVOID
# cbOutput : DWORD -> DWORD
# pcbResult : DWORD* out -> LPVOID
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。