ホーム › Security.Cryptography › CryptFindCertificateKeyProvInfo

CryptFindCertificateKeyProvInfo

関数

証明書に対応する鍵プロバイダ情報を検索し設定する。

DLLCRYPT32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL CryptFindCertificateKeyProvInfo(
    const CERT_CONTEXT* pCert,
    CRYPT_FIND_FLAGS dwFlags,
    void* pvReserved   // optional
);

パラメーター

名前

型

方向

説明

pCert

CERT_CONTEXT*

公開キー情報のエクスポートに使用する証明書の CERT_CONTEXT 構造体へのポインター。

dwFlags

CRYPT_FIND_FLAGS

この関数の動作を変更する一連のフラグ。ゼロ、または次のいずれかの値を指定できます。

値	意味
CRYPT_FIND_USER_KEYSET_FLAG	検索をユーザーコンテナーに限定します。既定では、ユーザーコンテナーとマシンコンテナーの両方を検索します。
CRYPT_FIND_MACHINE_KEYSET_FLAG	検索をマシンコンテナーに限定します。既定では、ユーザーコンテナーとマシンコンテナーの両方を検索します。
CRYPT_FIND_SILENT_KEYSET_FLAG	アプリケーションは、このコンテキストについて CSP がユーザーインターフェイス (UI) を表示しないよう要求します。CSP が動作するために UI を表示する必要がある場合、呼び出しは失敗し、最後のエラーとして NTE_SILENT_CONTEXT エラーコードが設定されます。

次のフラグは、キーの取得に使用するテクノロジを決定します。これらのフラグがいずれも指定されていない場合、この関数は CryptoAPI を使用してキーの取得のみを試みます。

Windows Server 2003 および Windows XP: これらのフラグはサポートされていません。

値	意味
CRYPT_ACQUIRE_ALLOW_NCRYPT_KEY_FLAG	この関数は CryptoAPI を使用してキーの取得を試みます。それが失敗した場合、この関数は Cryptography API: Next Generation (CNG) を使用してキーの取得を試みます。 CNG を使用してキーを取得した場合、証明書の CERT_KEY_PROV_INFO_PROP_ID プロパティはゼロに設定されます。
CRYPT_ACQUIRE_ONLY_NCRYPT_KEY_FLAG	この関数は CNG を使用してのみキーの取得を試み、キーの取得に CryptoAPI を使用しません。 CNG を使用してキーを取得した場合、証明書の CERT_KEY_PROV_INFO_PROP_ID プロパティはゼロに設定されます。
CRYPT_ACQUIRE_PREFER_NCRYPT_KEY_FLAG	この関数は CNG を使用してキーの取得を試みます。それが失敗した場合、この関数は CryptoAPI を使用してキーの取得を試みます。 CNG を使用してキーを取得した場合、証明書の CERT_KEY_PROV_INFO_PROP_ID プロパティはゼロに設定されます。

pvReserved

void*

optional

将来の使用のために予約されており、NULL である必要があります。

戻り値の型: BOOL

公式ドキュメント

暗号化プロバイダーとそのコンテナーを列挙し、証明書の公開キーに対応する秘密キーを検索します。

戻り値

検索対象のコンテナー内で証明書の公開キーに対応する秘密キーが見つかった場合は TRUE。コンテナーが見つからない場合、またはコンテナー内に秘密キーが見つからない場合は FALSE。

GetLastError は次のエラーを返します。

戻りコード	説明
NTE_NO_KEY	コンテナーが見つかりませんでした。

解説(Remarks)

この関数は、暗号化プロバイダーとそのコンテナーを列挙し、証明書の公開キーに対応する秘密キーを検索します。一致した場合、この関数は証明書の CERT_KEY_PROV_INFO_PROP_ID プロパティを更新します。CERT_KEY_PROV_INFO_PROP_ID が既に設定されている場合は、それがプロバイダーの公開キーと一致するかどうかが確認されます。一致した場合、この関数は前述の列挙をスキップします。

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

各言語での呼び出し定義

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

BOOL CryptFindCertificateKeyProvInfo(
    const CERT_CONTEXT* pCert,
    CRYPT_FIND_FLAGS dwFlags,
    void* pvReserved   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptFindCertificateKeyProvInfo(
    IntPtr pCert,   // CERT_CONTEXT*
    uint dwFlags,   // CRYPT_FIND_FLAGS
    IntPtr pvReserved   // void* optional
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptFindCertificateKeyProvInfo(
    pCert As IntPtr,   ' CERT_CONTEXT*
    dwFlags As UInteger,   ' CRYPT_FIND_FLAGS
    pvReserved As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pCert : CERT_CONTEXT*
' dwFlags : CRYPT_FIND_FLAGS
' pvReserved : void* optional
Declare PtrSafe Function CryptFindCertificateKeyProvInfo Lib "crypt32" ( _
    ByVal pCert As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pvReserved As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptFindCertificateKeyProvInfo = ctypes.windll.crypt32.CryptFindCertificateKeyProvInfo
CryptFindCertificateKeyProvInfo.restype = wintypes.BOOL
CryptFindCertificateKeyProvInfo.argtypes = [
    ctypes.c_void_p,  # pCert : CERT_CONTEXT*
    wintypes.DWORD,  # dwFlags : CRYPT_FIND_FLAGS
    ctypes.POINTER(None),  # pvReserved : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptFindCertificateKeyProvInfo = Fiddle::Function.new(
  lib['CryptFindCertificateKeyProvInfo'],
  [
    Fiddle::TYPE_VOIDP,  # pCert : CERT_CONTEXT*
    -Fiddle::TYPE_INT,  # dwFlags : CRYPT_FIND_FLAGS
    Fiddle::TYPE_VOIDP,  # pvReserved : void* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CryptFindCertificateKeyProvInfo(
        pCert: *const CERT_CONTEXT,  // CERT_CONTEXT*
        dwFlags: u32,  // CRYPT_FIND_FLAGS
        pvReserved: *mut ()  // void* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true)]
public static extern bool CryptFindCertificateKeyProvInfo(IntPtr pCert, uint dwFlags, IntPtr pvReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptFindCertificateKeyProvInfo' -Namespace Win32 -PassThru
# $api::CryptFindCertificateKeyProvInfo(pCert, dwFlags, pvReserved)

#uselib "CRYPT32.dll"
#func global CryptFindCertificateKeyProvInfo "CryptFindCertificateKeyProvInfo" sptr, sptr, sptr
; CryptFindCertificateKeyProvInfo varptr(pCert), dwFlags, pvReserved   ; 戻り値は stat
; pCert : CERT_CONTEXT* -> "sptr"
; dwFlags : CRYPT_FIND_FLAGS -> "sptr"
; pvReserved : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CryptFindCertificateKeyProvInfo "CryptFindCertificateKeyProvInfo" var, int, sptr
; res = CryptFindCertificateKeyProvInfo(pCert, dwFlags, pvReserved)
; pCert : CERT_CONTEXT* -> "var"
; dwFlags : CRYPT_FIND_FLAGS -> "int"
; pvReserved : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CryptFindCertificateKeyProvInfo "CryptFindCertificateKeyProvInfo" sptr, int, sptr
; res = CryptFindCertificateKeyProvInfo(varptr(pCert), dwFlags, pvReserved)
; pCert : CERT_CONTEXT* -> "sptr"
; dwFlags : CRYPT_FIND_FLAGS -> "int"
; pvReserved : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。