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

SslOpenPrivateKey

関数
証明書に対応するSSL秘密鍵を開く。
DLLncrypt.dll呼出規約winapi

シグネチャ

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

HRESULT SslOpenPrivateKey(
    NCRYPT_PROV_HANDLE hSslProvider,
    NCRYPT_KEY_HANDLE* phPrivateKey,
    const CERT_CONTEXT* pCertContext,
    DWORD dwFlags
);

パラメーター

名前方向説明
hSslProviderNCRYPT_PROV_HANDLEinSchannel SSLプロバイダのハンドル。
phPrivateKeyNCRYPT_KEY_HANDLE*out開いた秘密鍵のハンドルを受け取る出力先。
pCertContextCERT_CONTEXT*in対象の証明書を示すCERT_CONTEXT構造体。
dwFlagsDWORDin動作を制御するフラグ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

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

SslOpenPrivateKey = ctypes.windll.ncrypt.SslOpenPrivateKey
SslOpenPrivateKey.restype = ctypes.c_int
SslOpenPrivateKey.argtypes = [
    ctypes.c_size_t,  # hSslProvider : NCRYPT_PROV_HANDLE
    ctypes.c_void_p,  # phPrivateKey : NCRYPT_KEY_HANDLE* out
    ctypes.c_void_p,  # pCertContext : CERT_CONTEXT*
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ncrypt = windows.NewLazySystemDLL("ncrypt.dll")
	procSslOpenPrivateKey = ncrypt.NewProc("SslOpenPrivateKey")
)

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

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

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

let sslopenprivatekey =
  foreign "SslOpenPrivateKey"
    (size_t @-> (ptr size_t) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* hSslProvider : NCRYPT_PROV_HANDLE -> size_t *)
(* phPrivateKey : NCRYPT_KEY_HANDLE* out -> (ptr size_t) *)
(* pCertContext : CERT_CONTEXT* -> (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 ("SslOpenPrivateKey" ssl-open-private-key :convention :stdcall) :int32
  (h-ssl-provider :uint64)   ; NCRYPT_PROV_HANDLE
  (ph-private-key :pointer)   ; NCRYPT_KEY_HANDLE* out
  (p-cert-context :pointer)   ; CERT_CONTEXT*
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SslOpenPrivateKey = Win32::API::More->new('ncrypt',
    'int SslOpenPrivateKey(WPARAM hSslProvider, LPVOID phPrivateKey, LPVOID pCertContext, DWORD dwFlags)');
# my $ret = $SslOpenPrivateKey->Call($hSslProvider, $phPrivateKey, $pCertContext, $dwFlags);
# hSslProvider : NCRYPT_PROV_HANDLE -> WPARAM
# phPrivateKey : NCRYPT_KEY_HANDLE* out -> LPVOID
# pCertContext : CERT_CONTEXT* -> LPVOID
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型