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

SslImportKey

関数
BLOBからSSL鍵をインポートする。
DLLncrypt.dll呼出規約winapi

シグネチャ

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

HRESULT SslImportKey(
    NCRYPT_PROV_HANDLE hSslProvider,
    NCRYPT_KEY_HANDLE* phKey,
    LPCWSTR pszBlobType,
    BYTE* pbKeyBlob,
    DWORD cbKeyBlob,
    DWORD dwFlags
);

パラメーター

名前方向説明
hSslProviderNCRYPT_PROV_HANDLEinSchannel SSLプロバイダのハンドル。
phKeyNCRYPT_KEY_HANDLE*outインポートされた鍵のハンドルを受け取る出力先。
pszBlobTypeLPCWSTRinインポートする鍵ブロブの種類を示す文字列。
pbKeyBlobBYTE*inインポートする鍵ブロブデータへのポインタ。
cbKeyBlobDWORDinpbKeyBlobのバイト数。
dwFlagsDWORDin動作を制御するフラグ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

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

SslImportKey = ctypes.windll.ncrypt.SslImportKey
SslImportKey.restype = ctypes.c_int
SslImportKey.argtypes = [
    ctypes.c_size_t,  # hSslProvider : NCRYPT_PROV_HANDLE
    ctypes.c_void_p,  # phKey : NCRYPT_KEY_HANDLE* out
    wintypes.LPCWSTR,  # pszBlobType : LPCWSTR
    ctypes.POINTER(ctypes.c_ubyte),  # pbKeyBlob : BYTE*
    wintypes.DWORD,  # cbKeyBlob : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ncrypt = windows.NewLazySystemDLL("ncrypt.dll")
	procSslImportKey = ncrypt.NewProc("SslImportKey")
)

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

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

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

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