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

SslExportKey

関数
SSL鍵を指定形式のBLOBにエクスポートする。
DLLncrypt.dll呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

// 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)。