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

NCryptFinalizeKey

関数
作成中のキーを確定して使用可能な状態にする。
DLLncrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT NCryptFinalizeKey(
    NCRYPT_KEY_HANDLE hKey,
    NCRYPT_FLAGS dwFlags
);

パラメーター

名前方向説明
hKeyNCRYPT_KEY_HANDLEin完成させるキーのハンドル。このハンドルは NCryptCreatePersistedKey 関数を呼び出して取得します。
dwFlagsNCRYPT_FLAGSin

関数の動作を変更するフラグ。ゼロを指定するか、次の値の 1 つ以上を組み合わせて指定できます。

意味
NCRYPT_NO_KEY_VALIDATION
キーペアの公開部分を検証しません。このフラグは公開鍵/秘密鍵のペアにのみ適用されます。
NCRYPT_WRITE_KEY_TO_LEGACY_STORE_FLAG
キーをレガシーストレージにも保存します。これにより、キーを CryptoAPI で使用できるようになります。このフラグは RSA キーにのみ適用されます。
NCRYPT_SILENT_FLAG
キーストレージプロバイダー (KSP) がユーザーインターフェイスを一切表示しないように要求します。プロバイダーが動作するために UI を表示する必要がある場合、呼び出しは失敗し、KSP は最後のエラーとして NTE_SILENT_CONTEXT エラーコードを設定する必要があります。

戻り値の型: HRESULT

公式ドキュメント

CNG キーストレージキーを完成させます。

戻り値

関数の成功または失敗を示すステータスコードを返します。

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

戻り値 説明
ERROR_SUCCESS
関数は成功しました。
NTE_BAD_FLAGS
dwFlags パラメーターに無効な値が含まれています。
NTE_INVALID_HANDLE
hKey パラメーターが無効です。

解説(Remarks)

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

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

各言語での呼び出し定義

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

HRESULT NCryptFinalizeKey(
    NCRYPT_KEY_HANDLE hKey,
    NCRYPT_FLAGS dwFlags
);
[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int NCryptFinalizeKey(
    UIntPtr hKey,   // NCRYPT_KEY_HANDLE
    uint dwFlags   // NCRYPT_FLAGS
);
<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function NCryptFinalizeKey(
    hKey As UIntPtr,   ' NCRYPT_KEY_HANDLE
    dwFlags As UInteger   ' NCRYPT_FLAGS
) As Integer
End Function
' hKey : NCRYPT_KEY_HANDLE
' dwFlags : NCRYPT_FLAGS
Declare PtrSafe Function NCryptFinalizeKey Lib "ncrypt" ( _
    ByVal hKey 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

NCryptFinalizeKey = ctypes.windll.ncrypt.NCryptFinalizeKey
NCryptFinalizeKey.restype = ctypes.c_int
NCryptFinalizeKey.argtypes = [
    ctypes.c_size_t,  # hKey : NCRYPT_KEY_HANDLE
    wintypes.DWORD,  # dwFlags : NCRYPT_FLAGS
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ncrypt.dll')
NCryptFinalizeKey = Fiddle::Function.new(
  lib['NCryptFinalizeKey'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hKey : NCRYPT_KEY_HANDLE
    -Fiddle::TYPE_INT,  # dwFlags : NCRYPT_FLAGS
  ],
  Fiddle::TYPE_INT)
#[link(name = "ncrypt")]
extern "system" {
    fn NCryptFinalizeKey(
        hKey: usize,  // NCRYPT_KEY_HANDLE
        dwFlags: u32  // NCRYPT_FLAGS
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ncrypt.dll")]
public static extern int NCryptFinalizeKey(UIntPtr hKey, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ncrypt_NCryptFinalizeKey' -Namespace Win32 -PassThru
# $api::NCryptFinalizeKey(hKey, dwFlags)
#uselib "ncrypt.dll"
#func global NCryptFinalizeKey "NCryptFinalizeKey" sptr, sptr
; NCryptFinalizeKey hKey, dwFlags   ; 戻り値は stat
; hKey : NCRYPT_KEY_HANDLE -> "sptr"
; dwFlags : NCRYPT_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ncrypt.dll"
#cfunc global NCryptFinalizeKey "NCryptFinalizeKey" sptr, int
; res = NCryptFinalizeKey(hKey, dwFlags)
; hKey : NCRYPT_KEY_HANDLE -> "sptr"
; dwFlags : NCRYPT_FLAGS -> "int"
; HRESULT NCryptFinalizeKey(NCRYPT_KEY_HANDLE hKey, NCRYPT_FLAGS dwFlags)
#uselib "ncrypt.dll"
#cfunc global NCryptFinalizeKey "NCryptFinalizeKey" intptr, int
; res = NCryptFinalizeKey(hKey, dwFlags)
; hKey : NCRYPT_KEY_HANDLE -> "intptr"
; dwFlags : NCRYPT_FLAGS -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ncrypt = windows.NewLazySystemDLL("ncrypt.dll")
	procNCryptFinalizeKey = ncrypt.NewProc("NCryptFinalizeKey")
)

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

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

foreign import stdcall safe "NCryptFinalizeKey"
  c_NCryptFinalizeKey :: CUIntPtr -> Word32 -> IO Int32
-- hKey : NCRYPT_KEY_HANDLE -> CUIntPtr
-- dwFlags : NCRYPT_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ncryptfinalizekey =
  foreign "NCryptFinalizeKey"
    (size_t @-> uint32_t @-> returning int32_t)
(* hKey : NCRYPT_KEY_HANDLE -> size_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 ("NCryptFinalizeKey" ncrypt-finalize-key :convention :stdcall) :int32
  (h-key :uint64)   ; NCRYPT_KEY_HANDLE
  (dw-flags :uint32))   ; NCRYPT_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NCryptFinalizeKey = Win32::API::More->new('ncrypt',
    'int NCryptFinalizeKey(WPARAM hKey, DWORD dwFlags)');
# my $ret = $NCryptFinalizeKey->Call($hKey, $dwFlags);
# hKey : NCRYPT_KEY_HANDLE -> WPARAM
# dwFlags : NCRYPT_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型