ホーム › Security.Cryptography › CertFindChainInStore

CertFindChainInStore

関数

証明書ストア内から条件に一致するチェーンを検索する。

DLLCRYPT32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

CERT_CHAIN_CONTEXT* CertFindChainInStore(
    HCERTSTORE hCertStore,
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    CERT_FIND_CHAIN_IN_STORE_FLAGS dwFindFlags,
    DWORD dwFindType,
    const void* pvFindPara,   // optional
    CERT_CHAIN_CONTEXT* pPrevChainContext   // optional
);

パラメーター

名前

型

方向

説明

hCertStore

HCERTSTORE

チェーンの構築対象となる証明書を検索するストアのハンドル。このハンドルは、チェーンの構築時に追加のストアとして CertGetCertificateChain 関数に渡されます。

dwCertEncodingType

CERT_QUERY_ENCODING_TYPE

ストアのエンコードに使用された証明書エンコード種別。この値の上位 WORD に含まれるメッセージエンコード種別の識別子は、この関数では無視されます。

このパラメーターには、現在定義されている次の証明書エンコード種別を指定できます。

値	意味
X509_ASN_ENCODING 1 (0x1)	X.509 証明書エンコードを指定します。

dwFindFlags

CERT_FIND_CHAIN_IN_STORE_FLAGS

検索に関する追加オプションを指定します。このパラメーターに指定できる値は、dwFindType パラメーターの値によって異なります。

dwFindType に CERT_CHAIN_FIND_BY_ISSUER を指定する場合、このパラメーターには 0、または次の値の 1 つ以上の組み合わせを指定できます。

値	意味
CERT_CHAIN_FIND_BY_ISSUER_COMPARE_KEY_FLAG	証明書内の公開キーを、暗号化サービスプロバイダーの公開キーと比較します。この比較は、チェーンの構築時に行われる最後のチェックです。発行者の hCryptProv メンバーには秘密キーが含まれており、この処理の間に複数回チェックが必要になることがあります。このチェックを容易にするため、CERT_CHAIN_FIND_BY_ISSUER_PARA 構造体の dwAcquirePrivateKeyFlags メンバーを設定して、その hCryptProv のキャッシュを有効にできます。
CERT_CHAIN_FIND_BY_ISSUER_COMPLEX_CHAIN_FLAG	既定では、最初の単純チェーンのみが発行者名の一致についてチェックされます。このフラグを設定すると、既定の動作が上書きされ、後続の単純チェーンも発行者名の一致についてチェックされます。
CERT_CHAIN_FIND_BY_ISSUER_CACHE_ONLY_FLAG	発行者証明書の検索対象をキャッシュ済みのシステムストア (Root、My、Ca、Trust) のみに限定することで、この関数のパフォーマンスを向上させます。このフラグを設定しない場合、関数はキャッシュ済みのシステムストアと、hCertStore パラメーターで表されるストアの両方を検索します。
CERT_CHAIN_FIND_BY_ISSUER_CACHE_ONLY_URL_FLAG	URL キャッシュのみが検索されます。インターネットは検索されません。
CERT_CHAIN_FIND_BY_ISSUER_LOCAL_MACHINE_FLAG	ローカルコンピューターの証明書ストアのみを開きます。現在のユーザーの証明書ストアは開きません。
CERT_CHAIN_FIND_BY_ISSUER_NO_KEY_FLAG	証明書に関連付けられた秘密キーが存在するかどうかのチェックは行われません。

dwFindType

DWORD

ストア内で証明書を検索する際に使用する条件を決定します。

このパラメーターには、現在定義されている次の値を指定できます。

CERT_CHAIN_FIND_BY_ISSUER

発行者の名前に基づいて証明書を検索します。pvFindPara パラメーターは、検索を変更するメンバーを含む CERT_CHAIN_FIND_BY_ISSUER_PARA 構造体へのポインターです。

証明書チェーンは、利用可能な秘密キーを持つ証明書に対して構築されます。既定では、発行者名の一致において最初の単純チェーン内の発行者のみが比較されます。このフラグを設定すると、すべてのチェーンが、一連の発行者名のいずれかに一致する発行者証明書についてチェックされます。

この関数は、pvFindPara 構造体で渡された名前 BLOB を、ルート証明書の認証機関だけでなく、チェーン内の任意の認証機関 (CA) と比較します。

この関数は失効チェックを一切行いません。

pPrevChainContext が NULL でない場合、この関数は呼び出されるたびに別の証明書のチェーンを返します。適切な証明書が 1 つしかないものの、一致する発行認証機関が 2 つあり、そのうちの 1 つが失効している場合、この関数が失効したチェーンを返すことがあります。アプリケーションが CertVerifyRevocation 関数を呼び出して自身で失効をチェックし、そのチェーンが不適切であると判断した場合、CertFindChainInStore 関数を追加で呼び出しても、有効な認証機関から得られる同じ証明書を含むチェーンは返されません。代わりに、別の証明書を含むまったく異なるチェーンが返されるか、そのようなチェーンが見つからない場合は NULL が返されます。

pvFindPara

void*

inoptional

追加の検索条件を格納するポインター。このパラメーターが指すデータの型および形式は、dwFindType パラメーターの値によって異なります。

pPrevChainContext

CERT_CHAIN_CONTEXT*

inoptional

この関数の前回の呼び出しから返された CERT_CHAIN_CONTEXT 構造体へのポインター。検索はこの証明書から開始されます。この関数の最初の呼び出しでは、このパラメーターは NULL でなければなりません。以降の呼び出しでは、前回の呼び出しで返されたポインターを指定します。このパラメーターが NULL でない場合、この関数はこの構造体を解放します。

戻り値の型: CERT_CHAIN_CONTEXT*

公式ドキュメント

ストア内で、指定した条件に一致する最初または次の証明書を検索します。

戻り値

最初または次のチェーンコンテキストが構築されなかった場合は NULL が返されます。それ以外の場合は、読み取り専用の CERT_CHAIN_CONTEXT 構造体へのポインターが返されます。CERT_CHAIN_CONTEXT 構造体は、この関数の後続の呼び出しで pPrevChainContext パラメーターとして渡されたときに解放されます。それ以外の場合は、CertFreeCertificateChain 関数を呼び出して、CERT_CHAIN_CONTEXT 構造体を明示的に解放する必要があります。

解説(Remarks)

チェーンコンテキストを構築する最初の呼び出しでは、pPrevChainContext パラメーターは NULL でなければなりません。次のチェーンコンテキストを構築するには、pPrevChainContext に前回の呼び出しで返された CERT_CHAIN_CONTEXT 構造体を設定します。pPrevChainContext が NULL でない場合、エラーが発生したときでも、この構造体は CertFreeCertificateChain 関数を使用して、この関数によって必ず解放されます。

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

各言語での呼び出し定義

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

CERT_CHAIN_CONTEXT* CertFindChainInStore(
    HCERTSTORE hCertStore,
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    CERT_FIND_CHAIN_IN_STORE_FLAGS dwFindFlags,
    DWORD dwFindType,
    const void* pvFindPara,   // optional
    CERT_CHAIN_CONTEXT* pPrevChainContext   // optional
);

[DllImport("CRYPT32.dll", ExactSpelling = true)]
static extern IntPtr CertFindChainInStore(
    IntPtr hCertStore,   // HCERTSTORE
    uint dwCertEncodingType,   // CERT_QUERY_ENCODING_TYPE
    uint dwFindFlags,   // CERT_FIND_CHAIN_IN_STORE_FLAGS
    uint dwFindType,   // DWORD
    IntPtr pvFindPara,   // void* optional
    IntPtr pPrevChainContext   // CERT_CHAIN_CONTEXT* optional
);

<DllImport("CRYPT32.dll", ExactSpelling:=True)>
Public Shared Function CertFindChainInStore(
    hCertStore As IntPtr,   ' HCERTSTORE
    dwCertEncodingType As UInteger,   ' CERT_QUERY_ENCODING_TYPE
    dwFindFlags As UInteger,   ' CERT_FIND_CHAIN_IN_STORE_FLAGS
    dwFindType As UInteger,   ' DWORD
    pvFindPara As IntPtr,   ' void* optional
    pPrevChainContext As IntPtr   ' CERT_CHAIN_CONTEXT* optional
) As IntPtr
End Function

' hCertStore : HCERTSTORE
' dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
' dwFindFlags : CERT_FIND_CHAIN_IN_STORE_FLAGS
' dwFindType : DWORD
' pvFindPara : void* optional
' pPrevChainContext : CERT_CHAIN_CONTEXT* optional
Declare PtrSafe Function CertFindChainInStore Lib "crypt32" ( _
    ByVal hCertStore As LongPtr, _
    ByVal dwCertEncodingType As Long, _
    ByVal dwFindFlags As Long, _
    ByVal dwFindType As Long, _
    ByVal pvFindPara As LongPtr, _
    ByVal pPrevChainContext As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CertFindChainInStore = ctypes.windll.crypt32.CertFindChainInStore
CertFindChainInStore.restype = ctypes.c_void_p
CertFindChainInStore.argtypes = [
    wintypes.HANDLE,  # hCertStore : HCERTSTORE
    wintypes.DWORD,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    wintypes.DWORD,  # dwFindFlags : CERT_FIND_CHAIN_IN_STORE_FLAGS
    wintypes.DWORD,  # dwFindType : DWORD
    ctypes.POINTER(None),  # pvFindPara : void* optional
    ctypes.c_void_p,  # pPrevChainContext : CERT_CHAIN_CONTEXT* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CertFindChainInStore = Fiddle::Function.new(
  lib['CertFindChainInStore'],
  [
    Fiddle::TYPE_VOIDP,  # hCertStore : HCERTSTORE
    -Fiddle::TYPE_INT,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    -Fiddle::TYPE_INT,  # dwFindFlags : CERT_FIND_CHAIN_IN_STORE_FLAGS
    -Fiddle::TYPE_INT,  # dwFindType : DWORD
    Fiddle::TYPE_VOIDP,  # pvFindPara : void* optional
    Fiddle::TYPE_VOIDP,  # pPrevChainContext : CERT_CHAIN_CONTEXT* optional
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "crypt32")]
extern "system" {
    fn CertFindChainInStore(
        hCertStore: *mut core::ffi::c_void,  // HCERTSTORE
        dwCertEncodingType: u32,  // CERT_QUERY_ENCODING_TYPE
        dwFindFlags: u32,  // CERT_FIND_CHAIN_IN_STORE_FLAGS
        dwFindType: u32,  // DWORD
        pvFindPara: *const (),  // void* optional
        pPrevChainContext: *mut CERT_CHAIN_CONTEXT  // CERT_CHAIN_CONTEXT* optional
    ) -> *mut CERT_CHAIN_CONTEXT;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("CRYPT32.dll")]
public static extern IntPtr CertFindChainInStore(IntPtr hCertStore, uint dwCertEncodingType, uint dwFindFlags, uint dwFindType, IntPtr pvFindPara, IntPtr pPrevChainContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CertFindChainInStore' -Namespace Win32 -PassThru
# $api::CertFindChainInStore(hCertStore, dwCertEncodingType, dwFindFlags, dwFindType, pvFindPara, pPrevChainContext)

#uselib "CRYPT32.dll"
#func global CertFindChainInStore "CertFindChainInStore" sptr, sptr, sptr, sptr, sptr, sptr
; CertFindChainInStore hCertStore, dwCertEncodingType, dwFindFlags, dwFindType, pvFindPara, varptr(pPrevChainContext)   ; 戻り値は stat
; hCertStore : HCERTSTORE -> "sptr"
; dwCertEncodingType : CERT_QUERY_ENCODING_TYPE -> "sptr"
; dwFindFlags : CERT_FIND_CHAIN_IN_STORE_FLAGS -> "sptr"
; dwFindType : DWORD -> "sptr"
; pvFindPara : void* optional -> "sptr"
; pPrevChainContext : CERT_CHAIN_CONTEXT* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CertFindChainInStore "CertFindChainInStore" sptr, int, int, int, sptr, var
; res = CertFindChainInStore(hCertStore, dwCertEncodingType, dwFindFlags, dwFindType, pvFindPara, pPrevChainContext)
; hCertStore : HCERTSTORE -> "sptr"
; dwCertEncodingType : CERT_QUERY_ENCODING_TYPE -> "int"
; dwFindFlags : CERT_FIND_CHAIN_IN_STORE_FLAGS -> "int"
; dwFindType : DWORD -> "int"
; pvFindPara : void* optional -> "sptr"
; pPrevChainContext : CERT_CHAIN_CONTEXT* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CertFindChainInStore "CertFindChainInStore" sptr, int, int, int, sptr, sptr
; res = CertFindChainInStore(hCertStore, dwCertEncodingType, dwFindFlags, dwFindType, pvFindPara, varptr(pPrevChainContext))
; hCertStore : HCERTSTORE -> "sptr"
; dwCertEncodingType : CERT_QUERY_ENCODING_TYPE -> "int"
; dwFindFlags : CERT_FIND_CHAIN_IN_STORE_FLAGS -> "int"
; dwFindType : DWORD -> "int"
; pvFindPara : void* optional -> "sptr"
; pPrevChainContext : CERT_CHAIN_CONTEXT* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。