ホーム › Security.Cryptography › NCryptOpenKey

NCryptOpenKey

関数

ストレージプロバイダー内の既存の永続キーを開く。

DLLncrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT NCryptOpenKey(
    NCRYPT_PROV_HANDLE hProvider,
    NCRYPT_KEY_HANDLE* phKey,
    LPCWSTR pszKeyName,
    CERT_KEY_SPEC dwLegacyKeySpec,
    NCRYPT_FLAGS dwFlags
);

パラメーター

名前

型

方向

説明

hProvider

NCRYPT_PROV_HANDLE

キーを開く対象のキーストレージプロバイダーのハンドル。

phKey

NCRYPT_KEY_HANDLE*

out

キーハンドルを受け取る NCRYPT_KEY_HANDLE 変数へのポインター。このハンドルの使用が終わったら、NCryptFreeObject 関数に渡して解放してください。

pszKeyName

LPCWSTR

取得するキーの名前を格納した、null 終端の Unicode 文字列へのポインター。

dwLegacyKeySpec

CERT_KEY_SPEC

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

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

dwFlags

NCRYPT_FLAGS

関数の動作を変更するフラグ。0、または以下の値の 1 つ以上を組み合わせて指定できます。

値	意味
NCRYPT_MACHINE_KEY_FLAG	ローカルコンピューターのキーを開きます。このフラグが指定されていない場合は、現在のユーザーのキーが開かれます。
NCRYPT_SILENT_FLAG	キーストレージプロバイダー (KSP) がユーザーインターフェイスを表示しないよう要求します。プロバイダーが動作のために UI を表示する必要がある場合、呼び出しは失敗し、KSP は最後のエラーとして NTE_SILENT_CONTEXT エラーコードを設定する必要があります。

戻り値の型: HRESULT

公式ドキュメント

指定した CNG キーストレージプロバイダーに存在するキーを開きます。

戻り値

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

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

戻り値	説明
ERROR_SUCCESS	関数は成功しました。
NTE_BAD_FLAGS	dwFlags パラメーターに無効な値が含まれています。
NTE_BAD_KEYSET	指定されたキーが見つかりませんでした。
NTE_INVALID_HANDLE	hProvider パラメーターが無効です。
NTE_INVALID_PARAMETER	1 つ以上のパラメーターが無効です。
NTE_NO_MEMORY	メモリの割り当てに失敗しました。

解説(Remarks)

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

パフォーマンス上の理由から、Microsoft のソフトウェアベースの KSP は、キーへのハンドルが開いている間、秘密鍵のマテリアルをローカルセキュリティ機関 (LSA) にキャッシュします。LSA は特権を持つシステムプロセスです。そのため、システム上で管理者特権を持っている場合を除き、他のユーザーはこのキャッシュされたキーのコピーにアクセスできません。この動作は構成によって変更することはできません。

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

各言語での呼び出し定義

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

HRESULT NCryptOpenKey(
    NCRYPT_PROV_HANDLE hProvider,
    NCRYPT_KEY_HANDLE* phKey,
    LPCWSTR pszKeyName,
    CERT_KEY_SPEC dwLegacyKeySpec,
    NCRYPT_FLAGS dwFlags
);

[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int NCryptOpenKey(
    UIntPtr hProvider,   // NCRYPT_PROV_HANDLE
    out UIntPtr phKey,   // NCRYPT_KEY_HANDLE* out
    [MarshalAs(UnmanagedType.LPWStr)] string pszKeyName,   // LPCWSTR
    uint dwLegacyKeySpec,   // CERT_KEY_SPEC
    uint dwFlags   // NCRYPT_FLAGS
);

<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function NCryptOpenKey(
    hProvider As UIntPtr,   ' NCRYPT_PROV_HANDLE
    <Out> ByRef phKey As UIntPtr,   ' NCRYPT_KEY_HANDLE* out
    <MarshalAs(UnmanagedType.LPWStr)> pszKeyName As String,   ' LPCWSTR
    dwLegacyKeySpec As UInteger,   ' CERT_KEY_SPEC
    dwFlags As UInteger   ' NCRYPT_FLAGS
) As Integer
End Function

' hProvider : NCRYPT_PROV_HANDLE
' phKey : NCRYPT_KEY_HANDLE* out
' pszKeyName : LPCWSTR
' dwLegacyKeySpec : CERT_KEY_SPEC
' dwFlags : NCRYPT_FLAGS
Declare PtrSafe Function NCryptOpenKey Lib "ncrypt" ( _
    ByVal hProvider As LongPtr, _
    ByRef phKey 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

NCryptOpenKey = ctypes.windll.ncrypt.NCryptOpenKey
NCryptOpenKey.restype = ctypes.c_int
NCryptOpenKey.argtypes = [
    ctypes.c_size_t,  # hProvider : NCRYPT_PROV_HANDLE
    ctypes.c_void_p,  # phKey : NCRYPT_KEY_HANDLE* out
    wintypes.LPCWSTR,  # pszKeyName : LPCWSTR
    wintypes.DWORD,  # dwLegacyKeySpec : CERT_KEY_SPEC
    wintypes.DWORD,  # dwFlags : NCRYPT_FLAGS
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ncrypt.dll')
NCryptOpenKey = Fiddle::Function.new(
  lib['NCryptOpenKey'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hProvider : NCRYPT_PROV_HANDLE
    Fiddle::TYPE_VOIDP,  # phKey : NCRYPT_KEY_HANDLE* out
    Fiddle::TYPE_VOIDP,  # pszKeyName : LPCWSTR
    -Fiddle::TYPE_INT,  # dwLegacyKeySpec : CERT_KEY_SPEC
    -Fiddle::TYPE_INT,  # dwFlags : NCRYPT_FLAGS
  ],
  Fiddle::TYPE_INT)

#[link(name = "ncrypt")]
extern "system" {
    fn NCryptOpenKey(
        hProvider: usize,  // NCRYPT_PROV_HANDLE
        phKey: *mut usize,  // NCRYPT_KEY_HANDLE* out
        pszKeyName: *const u16,  // LPCWSTR
        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 NCryptOpenKey(UIntPtr hProvider, out UIntPtr phKey, [MarshalAs(UnmanagedType.LPWStr)] string pszKeyName, uint dwLegacyKeySpec, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ncrypt_NCryptOpenKey' -Namespace Win32 -PassThru
# $api::NCryptOpenKey(hProvider, phKey, pszKeyName, dwLegacyKeySpec, dwFlags)

#uselib "ncrypt.dll"
#func global NCryptOpenKey "NCryptOpenKey" sptr, sptr, sptr, sptr, sptr
; NCryptOpenKey hProvider, varptr(phKey), pszKeyName, dwLegacyKeySpec, dwFlags   ; 戻り値は stat
; hProvider : NCRYPT_PROV_HANDLE -> "sptr"
; phKey : NCRYPT_KEY_HANDLE* out -> "sptr"
; pszKeyName : LPCWSTR -> "sptr"
; dwLegacyKeySpec : CERT_KEY_SPEC -> "sptr"
; dwFlags : NCRYPT_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ncrypt.dll"
#cfunc global NCryptOpenKey "NCryptOpenKey" sptr, var, wstr, int, int
; res = NCryptOpenKey(hProvider, phKey, pszKeyName, dwLegacyKeySpec, dwFlags)
; hProvider : NCRYPT_PROV_HANDLE -> "sptr"
; phKey : NCRYPT_KEY_HANDLE* out -> "var"
; pszKeyName : LPCWSTR -> "wstr"
; dwLegacyKeySpec : CERT_KEY_SPEC -> "int"
; dwFlags : NCRYPT_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ncrypt.dll"
#cfunc global NCryptOpenKey "NCryptOpenKey" sptr, sptr, wstr, int, int
; res = NCryptOpenKey(hProvider, varptr(phKey), pszKeyName, dwLegacyKeySpec, dwFlags)
; hProvider : NCRYPT_PROV_HANDLE -> "sptr"
; phKey : NCRYPT_KEY_HANDLE* out -> "sptr"
; pszKeyName : LPCWSTR -> "wstr"
; dwLegacyKeySpec : CERT_KEY_SPEC -> "int"
; dwFlags : NCRYPT_FLAGS -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。