ホーム › Security.Cryptography › CertFindCRLInStore

CertFindCRLInStore

関数

指定条件に合致するCRLをストアから検索する。

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

シグネチャ

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

CRL_CONTEXT* CertFindCRLInStore(
    HCERTSTORE hCertStore,
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    DWORD dwFindFlags,
    DWORD dwFindType,
    const void* pvFindPara,   // optional
    CRL_CONTEXT* pPrevCrlContext   // optional
);

パラメーター

名前

型

方向

説明

hCertStore

HCERTSTORE

検索対象となる証明書ストアのハンドル。

dwCertEncodingType

CERT_QUERY_ENCODING_TYPE

このパラメーターは現在使用されていません。ゼロに設定する必要があります。

dwFindFlags

DWORD

dwFindType が CRL_FIND_ISSUED_BY の場合、既定では発行者名の照合のみが行われます。次のフラグを使用すると、追加のフィルタリングを行えます。

値	意味
CRL_FIND_ISSUED_BY_AKI_FLAG	Authority Key Identifier (AKI) 拡張を持つ CRL かどうかを確認します。CRL が AKI を持つ場合、その AKI が発行者と一致する CRL のみが返されます。注意 AKI 拡張はオブジェクト識別子 (OID) 値 szOID_AUTHORITY_KEY_IDENTIFIER2 と、それに対応するデータ構造を持ちます。
CRL_FIND_ISSUED_BY_SIGNATURE_FLAG	発行者の証明書に含まれる公開キーを使用して、CRL の署名を検証します。有効な署名を持つ CRL のみを返します。
CRL_FIND_ISSUED_BY_DELTA_FLAG	デルタ CRL を検索して返します。
CRL_FIND_ISSUED_BY_BASE_FLAG	ベース CRL を検索して返します。
CRL_FIND_ISSUED_FOR_SET_STRONG_PROPERTIES_FLAG	検証に成功した後、署名の強度がチェックされます。このフラグは dwFindType パラメーターが CRL_FIND_ISSUED_FOR に設定されている場合にのみ適用されます。CRL_FIND_ISSUED_BY_SIGNATURE_FLAG も設定する必要があります。成功した場合、CRL コンテキストに次の強い署名プロパティが設定されます。 CERT_SIGN_HASH_CNG_ALG_PROP_ID CERT_ISSUER_PUB_KEY_BIT_LENGTH_PROP_ID Windows 8 および Windows Server 2012: このフラグはこのバージョンからサポートされます。

dwFindType

DWORD

実行する検索の種類を指定します。dwFindType の値によって、pvFindPara パラメーターのデータ型、内容、および用途が決まります。現在定義されている検索の種類と、それぞれの pvFindPara の要件は次のとおりです。

値	意味
CRL_FIND_ANY pvFindPara パラメーターは使用されません。NULL に設定する必要があります。	検索条件はありません。ストア内の次の CRL が返されます。
CRL_FIND_ISSUED_BY CERT_CONTEXT へのポインター。	CERT_CONTEXT 内の発行者に一致する、ストア内の次の CRL を検索します。
CRL_FIND_EXISTING CRL_CONTEXT へのポインター。	次の方法で CRL_CONTEXT に一致する次の CRL を検索します。両方がベース CRL であるか、両方がデルタ CRL である。両方の発行者名 BLOB が同一である。存在する場合、Authority/KeyIdentifier および IssuingDistributionPoint のエンコード済み拡張 BLOB が一致する。
CRL_FIND_ISSUED_FOR CRL_FIND_ISSUED_FOR_PARA へのポインター。	CRL_FIND_ISSUED_FOR_PARA 構造体内のサブジェクト証明書の発行者に一致する、ストア内の次の CRL を検索します。 CRL が見つからない場合は、CRL_FIND_ISSUED_FOR_PARA 構造体内の発行者に一致する、ストア内の次の CRL を検索します。注意クロス証明書を使用する場合、発行者の証明書内のサブジェクト名が、サブジェクト証明書および対応する CRL 内の発行者名と一致しないことがあります。

pvFindPara

void*

inoptional

このパラメーターは dwFindType の値によって決まります。詳細については、このトピックの前出の表を参照してください。

pPrevCrlContext

CRL_CONTEXT*

inoptional

この関数によって最後に返された CRL_CONTEXT へのポインター。検索条件を満たすストア内の最初の CRL を取得するには NULL にする必要があります。検索条件を満たす後続の CRL は、pPrevCrlContext を、この関数の前回の呼び出しで返された PCCRL_CONTEXT ポインターに設定することで取得できます。検索処理では、検索条件に一致しない CRL や、 CertDeleteCRLFromStore によってストアから以前に削除された CRL はスキップされます。この関数は、このパラメーターの値が NULL でない場合、その値が参照する CRL_CONTEXT を解放します。

戻り値の型: CRL_CONTEXT*

公式ドキュメント

証明書ストア内で、dwFindType パラメーターおよび関連する pvFindPara パラメーターによって指定された検索条件に一致する、最初または次の証明書失効リスト (CRL) コンテキストを検索します。

戻り値

関数が成功した場合、読み取り専用の CRL コンテキストへのポインターが返されます。返された CRL コンテキストの使用が終わったら、 CertFreeCRLContext 関数を呼び出して解放するか、後続の CertFindCRLInStore 関数の呼び出しで pPrevCrlContext パラメーターとして渡すことで暗黙的に解放します。

関数が失敗し、検索条件に一致する CRL が見つからなかった場合、戻り値は NULL です。拡張エラー情報を取得するには、 GetLastError を呼び出します。考えられるエラーコードの一部を次に示します。

戻りコード	説明
E_INVALIDARG	hCertStore パラメーターのハンドルが、pPrevCrlContext パラメーターが指す CRL コンテキスト内のハンドルと一致しないか、dwFindType パラメーターに無効な検索の種類が指定されました。
CRYPT_E_NOT_FOUND	ストアに CRL が存在しないか、検索条件に一致する CRL が見つからなかったか、ストアのリストの末尾に達しました。

解説(Remarks)

返されたポインターは、後続の関数呼び出しで pPrevCrlContext パラメーターとして渡されると解放されます。それ以外の場合は、 CertFreeCRLContext を呼び出して明示的に解放する必要があります。NULL でない pPrevCrlContext は、関数内でエラーが発生した場合でも、CertFindCRLInStore によって CertFreeCRLContext の呼び出しを使用して常に解放されます。

CertDuplicateCRLContext を呼び出すことで、返されたコンテキストの複製を作成できます。返された CRL コンテキストは、 CertAddCRLContextToStore を使用して別の証明書ストアに追加できます。また、 CertAddCRLLinkToStore を使用して、その CRL コンテキストへのリンクを非コレクションストアに追加することもできます。

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

各言語での呼び出し定義

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

CRL_CONTEXT* CertFindCRLInStore(
    HCERTSTORE hCertStore,
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    DWORD dwFindFlags,
    DWORD dwFindType,
    const void* pvFindPara,   // optional
    CRL_CONTEXT* pPrevCrlContext   // optional
);

[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr CertFindCRLInStore(
    IntPtr hCertStore,   // HCERTSTORE
    uint dwCertEncodingType,   // CERT_QUERY_ENCODING_TYPE
    uint dwFindFlags,   // DWORD
    uint dwFindType,   // DWORD
    IntPtr pvFindPara,   // void* optional
    IntPtr pPrevCrlContext   // CRL_CONTEXT* optional
);

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

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

import ctypes
from ctypes import wintypes

CertFindCRLInStore = ctypes.windll.crypt32.CertFindCRLInStore
CertFindCRLInStore.restype = ctypes.c_void_p
CertFindCRLInStore.argtypes = [
    wintypes.HANDLE,  # hCertStore : HCERTSTORE
    wintypes.DWORD,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    wintypes.DWORD,  # dwFindFlags : DWORD
    wintypes.DWORD,  # dwFindType : DWORD
    ctypes.POINTER(None),  # pvFindPara : void* optional
    ctypes.c_void_p,  # pPrevCrlContext : CRL_CONTEXT* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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