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

NCryptCreatePersistedKey

関数
ストレージプロバイダーに新しい永続キーを作成する。
DLLncrypt.dll呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

HRESULT NCryptCreatePersistedKey(
    NCRYPT_PROV_HANDLE hProvider,
    NCRYPT_KEY_HANDLE* phKey,
    LPCWSTR pszAlgId,
    LPCWSTR pszKeyName,   // optional
    CERT_KEY_SPEC dwLegacyKeySpec,
    NCRYPT_FLAGS dwFlags
);

パラメーター

名前型方向説明
hProviderNCRYPT_PROV_HANDLEinキーを作成するキーストレージプロバイダーのハンドルです。このハンドルは NCryptOpenStorageProvider 関数を使用して取得します。
phKeyNCRYPT_KEY_HANDLE*outキーのハンドルを受け取る NCRYPT_KEY_HANDLE 変数のアドレスです。このハンドルの使用を終えたら、NCryptFreeObject 関数に渡して解放してください。ディスク上のキーファイルを削除するには、ハンドルを NCryptDeleteKey 関数に渡します。この関数もハンドルを解放します。したがってアプリケーションは、ハンドルを NCryptFreeObject または NCryptDeleteKey のいずれか一方に渡せますが、両方には渡せません。
pszAlgIdLPCWSTRinキーを作成する暗号アルゴリズムの識別子を含む、null 終端の Unicode 文字列へのポインターです。これには標準の CNG Algorithm Identifiers のいずれか、または登録済みの別のアルゴリズムの識別子を指定できます。
pszKeyNameLPCWSTRinoptionalキーの名前を含む、null 終端の Unicode 文字列へのポインターです。このパラメーターが NULL の場合、この関数は永続化されない一時キーを作成します。
dwLegacyKeySpecCERT_KEY_SPECin

キーの種類を指定するレガシー識別子です。これには次のいずれかの値を指定できます。

Value Meaning
AT_KEYEXCHANGE キーは鍵交換キーです。
AT_SIGNATURE キーは署名キーです。
0 キーは上記のいずれの種類でもありません。
dwFlagsNCRYPT_FLAGSin

この関数の動作を変更する一連のフラグです。これにはゼロ、または次の値の 1 つ以上の組み合わせを指定できます。

Value Meaning
NCRYPT_MACHINE_KEY_FLAG キーはローカルコンピューターに適用されます。このフラグが指定されていない場合、キーは現在のユーザーに適用されます。
NCRYPT_OVERWRITE_KEY_FLAG 指定した名前のキーがコンテナーに既に存在する場合、既存のキーは上書きされます。このフラグが指定されておらず、指定した名前のキーが既に存在する場合、この関数は NTE_EXISTS を返します。
NCRYPT_REQUIRE_VBS_FLAG キーを仮想化ベースのセキュリティ (VBS) で保護する必要があることを示します。既定では、再起動サイクルをまたいで永続化される、ディスクに格納されたクロスブートの永続キーを作成します。

VBS が利用できない場合、操作は失敗します。(*「解説」を参照)
NCRYPT_PREFER_VBS_FLAG キーを仮想化ベースのセキュリティ (VBS) で保護すべきであることを示します。既定では、再起動サイクルをまたいで永続化される、ディスクに格納されたクロスブートの永続キーを作成します。

VBS が利用できない場合、操作はソフトウェアで分離されたキーを生成します。(*「解説」を参照)
NCRYPT_USE_PER_BOOT_KEY_FLAG NCRYPT_REQUIRE_VBS_FLAG または NCRYPT_PREFER_VBS_FLAG と併用できる追加フラグです。仮想化ベースのセキュリティ (VBS) に対して、ディスクに格納されるがブートサイクルをまたいで再利用できないブートごとのキーでクライアントキーを保護するよう指示します。(*「解説」を参照)

戻り値の型: HRESULT

公式ドキュメント

新しいキーを作成し、指定したキーストレージプロバイダーに格納します。

戻り値

関数の成否を示すステータスコードを返します。

返される可能性のあるコードには、次のものが含まれますが、これらに限りません。

Return code Description
ERROR_SUCCESS 関数は成功しました。
NTE_BAD_FLAGS dwFlags パラメーターに無効な値が含まれています。
NTE_EXISTS 指定した名前のキーが既に存在し、NCRYPT_OVERWRITE_KEY_FLAG が指定されていませんでした。
NTE_INVALID_HANDLE hProvider パラメーターが無効です。
NTE_INVALID_PARAMETER 1 つ以上のパラメーターが無効です。
NTE_NO_MEMORY メモリの割り当てに失敗しました。
NTE_VBS_UNAVAILABLE VBS が利用できません。

解説(Remarks)

重要

VBS フラグに関する情報は、商用リリース前に大幅に変更される可能性のあるプレリリース製品に関するものです。Microsoft は、ここで提供される情報について、明示または黙示を問わずいかなる保証も行いません。

RSA キーペアを作成する場合、キーをレガシーストレージに格納して CryptoAPI で使用できるようにすることもできます。これを行うには、キーをファイナライズする際に NCryptFinalizeKey 関数へ NCRYPT_WRITE_KEY_TO_LEGACY_STORE_FLAG フラグを渡します。

サービスは、この関数を自身の StartService Function から呼び出してはなりません。サービスが StartService 関数からこの関数を呼び出すと、デッドロックが発生し、サービスが応答しなくなる可能性があります。

VBS キーの追加ハードウェア要件

適切な OS がマシンにインストールされていても、VBS を使用してキーを生成および保護するには、次の追加ハードウェア要件を満たす必要があります。

ハードウェア要件の詳細については、次を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT NCryptCreatePersistedKey(
    NCRYPT_PROV_HANDLE hProvider,
    NCRYPT_KEY_HANDLE* phKey,
    LPCWSTR pszAlgId,
    LPCWSTR pszKeyName,   // optional
    CERT_KEY_SPEC dwLegacyKeySpec,
    NCRYPT_FLAGS dwFlags
);
[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int NCryptCreatePersistedKey(
    UIntPtr hProvider,   // NCRYPT_PROV_HANDLE
    out UIntPtr phKey,   // NCRYPT_KEY_HANDLE* out
    [MarshalAs(UnmanagedType.LPWStr)] string pszAlgId,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string pszKeyName,   // LPCWSTR optional
    uint dwLegacyKeySpec,   // CERT_KEY_SPEC
    uint dwFlags   // NCRYPT_FLAGS
);
<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function NCryptCreatePersistedKey(
    hProvider As UIntPtr,   ' NCRYPT_PROV_HANDLE
    <Out> ByRef phKey As UIntPtr,   ' NCRYPT_KEY_HANDLE* out
    <MarshalAs(UnmanagedType.LPWStr)> pszAlgId As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pszKeyName As String,   ' LPCWSTR optional
    dwLegacyKeySpec As UInteger,   ' CERT_KEY_SPEC
    dwFlags As UInteger   ' NCRYPT_FLAGS
) As Integer
End Function
' hProvider : NCRYPT_PROV_HANDLE
' phKey : NCRYPT_KEY_HANDLE* out
' pszAlgId : LPCWSTR
' pszKeyName : LPCWSTR optional
' dwLegacyKeySpec : CERT_KEY_SPEC
' dwFlags : NCRYPT_FLAGS
Declare PtrSafe Function NCryptCreatePersistedKey Lib "ncrypt" ( _
    ByVal hProvider As LongPtr, _
    ByRef phKey As LongPtr, _
    ByVal pszAlgId As LongPtr, _
    ByVal pszKeyName As LongPtr, _
    ByVal dwLegacyKeySpec 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

NCryptCreatePersistedKey = ctypes.windll.ncrypt.NCryptCreatePersistedKey
NCryptCreatePersistedKey.restype = ctypes.c_int
NCryptCreatePersistedKey.argtypes = [
    ctypes.c_size_t,  # hProvider : NCRYPT_PROV_HANDLE
    ctypes.c_void_p,  # phKey : NCRYPT_KEY_HANDLE* out
    wintypes.LPCWSTR,  # pszAlgId : LPCWSTR
    wintypes.LPCWSTR,  # pszKeyName : LPCWSTR optional
    wintypes.DWORD,  # dwLegacyKeySpec : CERT_KEY_SPEC
    wintypes.DWORD,  # dwFlags : NCRYPT_FLAGS
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ncrypt = windows.NewLazySystemDLL("ncrypt.dll")
	procNCryptCreatePersistedKey = ncrypt.NewProc("NCryptCreatePersistedKey")
)

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

extern "ncrypt" fn NCryptCreatePersistedKey(
    hProvider: usize, // NCRYPT_PROV_HANDLE
    phKey: [*c]usize, // NCRYPT_KEY_HANDLE* out
    pszAlgId: [*c]const u16, // LPCWSTR
    pszKeyName: [*c]const u16, // LPCWSTR optional
    dwLegacyKeySpec: u32, // CERT_KEY_SPEC
    dwFlags: u32 // NCRYPT_FLAGS
) callconv(std.os.windows.WINAPI) i32;
proc NCryptCreatePersistedKey(
    hProvider: uint,  # NCRYPT_PROV_HANDLE
    phKey: ptr uint,  # NCRYPT_KEY_HANDLE* out
    pszAlgId: WideCString,  # LPCWSTR
    pszKeyName: WideCString,  # LPCWSTR optional
    dwLegacyKeySpec: uint32,  # CERT_KEY_SPEC
    dwFlags: uint32  # NCRYPT_FLAGS
): int32 {.importc: "NCryptCreatePersistedKey", stdcall, dynlib: "ncrypt.dll".}
pragma(lib, "ncrypt");
extern(Windows)
int NCryptCreatePersistedKey(
    size_t hProvider,   // NCRYPT_PROV_HANDLE
    size_t* phKey,   // NCRYPT_KEY_HANDLE* out
    const(wchar)* pszAlgId,   // LPCWSTR
    const(wchar)* pszKeyName,   // LPCWSTR optional
    uint dwLegacyKeySpec,   // CERT_KEY_SPEC
    uint dwFlags   // NCRYPT_FLAGS
);
ccall((:NCryptCreatePersistedKey, "ncrypt.dll"), stdcall, Int32,
      (Csize_t, Ptr{Csize_t}, Cwstring, Cwstring, UInt32, UInt32),
      hProvider, phKey, pszAlgId, pszKeyName, dwLegacyKeySpec, dwFlags)
# hProvider : NCRYPT_PROV_HANDLE -> Csize_t
# phKey : NCRYPT_KEY_HANDLE* out -> Ptr{Csize_t}
# pszAlgId : LPCWSTR -> Cwstring
# pszKeyName : LPCWSTR optional -> Cwstring
# dwLegacyKeySpec : CERT_KEY_SPEC -> UInt32
# dwFlags : NCRYPT_FLAGS -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t NCryptCreatePersistedKey(
    uintptr_t hProvider,
    uintptr_t* phKey,
    const uint16_t* pszAlgId,
    const uint16_t* pszKeyName,
    uint32_t dwLegacyKeySpec,
    uint32_t dwFlags);
]]
local ncrypt = ffi.load("ncrypt")
-- ncrypt.NCryptCreatePersistedKey(hProvider, phKey, pszAlgId, pszKeyName, dwLegacyKeySpec, dwFlags)
-- hProvider : NCRYPT_PROV_HANDLE
-- phKey : NCRYPT_KEY_HANDLE* out
-- pszAlgId : LPCWSTR
-- pszKeyName : LPCWSTR optional
-- dwLegacyKeySpec : CERT_KEY_SPEC
-- dwFlags : NCRYPT_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ncrypt.dll');
const NCryptCreatePersistedKey = lib.func('__stdcall', 'NCryptCreatePersistedKey', 'int32_t', ['uintptr_t', 'uintptr_t *', 'str16', 'str16', 'uint32_t', 'uint32_t']);
// NCryptCreatePersistedKey(hProvider, phKey, pszAlgId, pszKeyName, dwLegacyKeySpec, dwFlags)
// hProvider : NCRYPT_PROV_HANDLE -> 'uintptr_t'
// phKey : NCRYPT_KEY_HANDLE* out -> 'uintptr_t *'
// pszAlgId : LPCWSTR -> 'str16'
// pszKeyName : LPCWSTR optional -> 'str16'
// dwLegacyKeySpec : CERT_KEY_SPEC -> 'uint32_t'
// dwFlags : NCRYPT_FLAGS -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ncrypt.dll", {
  NCryptCreatePersistedKey: { parameters: ["usize", "pointer", "buffer", "buffer", "u32", "u32"], result: "i32" },
});
// lib.symbols.NCryptCreatePersistedKey(hProvider, phKey, pszAlgId, pszKeyName, dwLegacyKeySpec, dwFlags)
// hProvider : NCRYPT_PROV_HANDLE -> "usize"
// phKey : NCRYPT_KEY_HANDLE* out -> "pointer"
// pszAlgId : LPCWSTR -> "buffer"
// pszKeyName : LPCWSTR optional -> "buffer"
// dwLegacyKeySpec : CERT_KEY_SPEC -> "u32"
// dwFlags : NCRYPT_FLAGS -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t NCryptCreatePersistedKey(
    size_t hProvider,
    size_t* phKey,
    const uint16_t* pszAlgId,
    const uint16_t* pszKeyName,
    uint32_t dwLegacyKeySpec,
    uint32_t dwFlags);
C, "ncrypt.dll");
// $ffi->NCryptCreatePersistedKey(hProvider, phKey, pszAlgId, pszKeyName, dwLegacyKeySpec, dwFlags);
// hProvider : NCRYPT_PROV_HANDLE
// phKey : NCRYPT_KEY_HANDLE* out
// pszAlgId : LPCWSTR
// pszKeyName : LPCWSTR optional
// dwLegacyKeySpec : CERT_KEY_SPEC
// dwFlags : NCRYPT_FLAGS
// 構造体/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 NCryptCreatePersistedKey(
        long hProvider,   // NCRYPT_PROV_HANDLE
        LongByReference phKey,   // NCRYPT_KEY_HANDLE* out
        WString pszAlgId,   // LPCWSTR
        WString pszKeyName,   // LPCWSTR optional
        int dwLegacyKeySpec,   // CERT_KEY_SPEC
        int dwFlags   // NCRYPT_FLAGS
    );
}
@[Link("ncrypt")]
lib Libncrypt
  fun NCryptCreatePersistedKey = NCryptCreatePersistedKey(
    hProvider : LibC::SizeT,   # NCRYPT_PROV_HANDLE
    phKey : LibC::SizeT*,   # NCRYPT_KEY_HANDLE* out
    pszAlgId : UInt16*,   # LPCWSTR
    pszKeyName : UInt16*,   # LPCWSTR optional
    dwLegacyKeySpec : UInt32,   # CERT_KEY_SPEC
    dwFlags : UInt32   # NCRYPT_FLAGS
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef NCryptCreatePersistedKeyNative = Int32 Function(UintPtr, Pointer<UintPtr>, Pointer<Utf16>, Pointer<Utf16>, Uint32, Uint32);
typedef NCryptCreatePersistedKeyDart = int Function(int, Pointer<UintPtr>, Pointer<Utf16>, Pointer<Utf16>, int, int);
final NCryptCreatePersistedKey = DynamicLibrary.open('ncrypt.dll')
    .lookupFunction<NCryptCreatePersistedKeyNative, NCryptCreatePersistedKeyDart>('NCryptCreatePersistedKey');
// hProvider : NCRYPT_PROV_HANDLE -> UintPtr
// phKey : NCRYPT_KEY_HANDLE* out -> Pointer<UintPtr>
// pszAlgId : LPCWSTR -> Pointer<Utf16>
// pszKeyName : LPCWSTR optional -> Pointer<Utf16>
// dwLegacyKeySpec : CERT_KEY_SPEC -> Uint32
// dwFlags : NCRYPT_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NCryptCreatePersistedKey(
  hProvider: NativeUInt;   // NCRYPT_PROV_HANDLE
  phKey: Pointer;   // NCRYPT_KEY_HANDLE* out
  pszAlgId: PWideChar;   // LPCWSTR
  pszKeyName: PWideChar;   // LPCWSTR optional
  dwLegacyKeySpec: DWORD;   // CERT_KEY_SPEC
  dwFlags: DWORD   // NCRYPT_FLAGS
): Integer; stdcall;
  external 'ncrypt.dll' name 'NCryptCreatePersistedKey';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NCryptCreatePersistedKey"
  c_NCryptCreatePersistedKey :: CUIntPtr -> Ptr CUIntPtr -> CWString -> CWString -> Word32 -> Word32 -> IO Int32
-- hProvider : NCRYPT_PROV_HANDLE -> CUIntPtr
-- phKey : NCRYPT_KEY_HANDLE* out -> Ptr CUIntPtr
-- pszAlgId : LPCWSTR -> CWString
-- pszKeyName : LPCWSTR optional -> CWString
-- dwLegacyKeySpec : CERT_KEY_SPEC -> Word32
-- dwFlags : NCRYPT_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ncryptcreatepersistedkey =
  foreign "NCryptCreatePersistedKey"
    (size_t @-> (ptr size_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* hProvider : NCRYPT_PROV_HANDLE -> size_t *)
(* phKey : NCRYPT_KEY_HANDLE* out -> (ptr size_t) *)
(* pszAlgId : LPCWSTR -> (ptr uint16_t) *)
(* pszKeyName : LPCWSTR optional -> (ptr uint16_t) *)
(* dwLegacyKeySpec : CERT_KEY_SPEC -> uint32_t *)
(* dwFlags : NCRYPT_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ncrypt (t "ncrypt.dll"))
(cffi:use-foreign-library ncrypt)

(cffi:defcfun ("NCryptCreatePersistedKey" ncrypt-create-persisted-key :convention :stdcall) :int32
  (h-provider :uint64)   ; NCRYPT_PROV_HANDLE
  (ph-key :pointer)   ; NCRYPT_KEY_HANDLE* out
  (psz-alg-id (:string :encoding :utf-16le))   ; LPCWSTR
  (psz-key-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (dw-legacy-key-spec :uint32)   ; CERT_KEY_SPEC
  (dw-flags :uint32))   ; NCRYPT_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NCryptCreatePersistedKey = Win32::API::More->new('ncrypt',
    'int NCryptCreatePersistedKey(WPARAM hProvider, LPVOID phKey, LPCWSTR pszAlgId, LPCWSTR pszKeyName, DWORD dwLegacyKeySpec, DWORD dwFlags)');
# my $ret = $NCryptCreatePersistedKey->Call($hProvider, $phKey, $pszAlgId, $pszKeyName, $dwLegacyKeySpec, $dwFlags);
# hProvider : NCRYPT_PROV_HANDLE -> WPARAM
# phKey : NCRYPT_KEY_HANDLE* out -> LPVOID
# pszAlgId : LPCWSTR -> LPCWSTR
# pszKeyName : LPCWSTR optional -> LPCWSTR
# dwLegacyKeySpec : CERT_KEY_SPEC -> DWORD
# dwFlags : NCRYPT_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型