ホーム › Security.Cryptography › CertGetCRLFromStore

CertGetCRLFromStore

関数

発行者に対応するCRLをストアから取得する。

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

シグネチャ

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

CRL_CONTEXT* CertGetCRLFromStore(
    HCERTSTORE hCertStore,
    const CERT_CONTEXT* pIssuerContext,   // optional
    CRL_CONTEXT* pPrevCrlContext,   // optional
    DWORD* pdwFlags
);

パラメーター

名前

型

方向

説明

hCertStore

HCERTSTORE

証明書ストアのハンドル。

pIssuerContext

CERT_CONTEXT*

inoptional

発行者の CERT_CONTEXT へのポインター。pIssuerContext ポインターは、このストアまたは別のストアから取得することも、呼び出し側で CertCreateCertificateContext によって作成することもできます。このパラメーターに NULL を渡した場合、ストア内のすべての CRL が検索されます。

pPrevCrlContext

CRL_CONTEXT*

inoptional

CRL_CONTEXT へのポインター。発行者は複数の CRL を持つことができます。たとえば、X.509 バージョン 3 の拡張を使用して差分 CRL を生成できます。CRL を取得する最初の呼び出しでは、このパラメーターを NULL にする必要があります。同じ発行者の次の CRL を取得するには、前回の呼び出しで返された CRL_CONTEXT をこのパラメーターに設定します。NULL 以外の pPrevCrlContext は、エラー時であっても常に CertFreeCRLContext の呼び出しによってこの関数で解放されます。

pdwFlags

DWORD*

inout

返される CRL に対する検証チェックを有効にするために、次のフラグ値が定義されています。これらのフラグはビットごとの OR 演算で組み合わせることができます。

値	意味
CERT_STORE_SIGNATURE_FLAG	発行者の証明書内の公開鍵を使用して、返される CRL の署名を検証します。
CERT_STORE_TIME_VALIDITY_FLAG	現在の時刻を取得し、それが CRL の ThisUpdate と NextUpdate の間の時間内にあることを検証します。
CERT_STORE_BASE_CRL_FLAG	基本 CRL を取得します。
CERT_STORE_DELTA_CRL_FLAG	差分 CRL を取得します。

有効にした検証チェックが成功すると、そのフラグはゼロに設定されます。

有効にした検証チェックが失敗すると、そのフラグは戻り値において設定されたままになります。pIssuerContext が NULL の場合、有効にした CERT_STORE_SIGNATURE_FLAG は常に失敗し、CERT_STORE_NO_ISSUER_FLAG も設定されます。詳細については、「注釈」を参照してください。

CERT_STORE_BASE_CRL_FLAG または CERT_STORE_DELTA_CRL_FLAG のいずれか一方のみが設定されている場合、この関数は基本 CRL または差分 CRL のいずれかを返し、対応する基本または差分のフラグが戻り値においてクリアされます。両方のフラグが設定されている場合は、いずれか一方のフラグのみがクリアされます。

検証チェックが失敗した場合でも、最初の、または次の CRL_CONTEXT へのポインターは返され、 GetLastError は更新されません。

戻り値の型: CRL_CONTEXT*

公式ドキュメント

指定された発行者について、証明書ストアから最初の、または次の証明書失効リスト (CRL) コンテキストを取得します。

戻り値

関数が成功した場合、戻り値は読み取り専用の CRL_CONTEXT へのポインターです。

関数が失敗し、最初の、または次の CRL が見つからない場合、戻り値は NULL です。

返された CRL_CONTEXT は、 CertFreeCRLContext を呼び出して解放する必要があります。ただし、返された CRL_CONTEXT を後続の呼び出しで pPrevCrlContext として渡した場合は、この関数がそれを解放します。

拡張エラー情報を取得するには、 GetLastError を呼び出します。考えられるエラーコードの一部を次に示します。

値	説明
E_INVALIDARG	hCertStore パラメーターのハンドルが、pPrevCrlContext パラメーターが指す CRL コンテキスト内のハンドルと一致しないか、pdwFlags にサポートされていないフラグが設定されています。
CRYPT_E_NOT_FOUND	発行者に対する CRL がストア内に存在しなかったか、関数がストアのリストの末尾に達しました。

解説(Remarks)

CertDuplicateCRLContext を呼び出すと、CRL の複製を作成できます。

フラグの 16 進値はビットごとの OR 演算で組み合わせることができ、両方の検証を有効にできます。たとえば、両方の検証を有効にするには、pdwFlags が指す DWORD 値を CERT_STORE_SIGNATURE_FLAG | CERT_STORE_TIME_VALIDITY_FLAG に設定します。CERT_STORE_SIGNATURE_FLAG の検証が成功したものの、CERT_STORE_TIME_VALIDITY_FLAG の検証が失敗した場合、関数が戻るときに pdwFlags が指す DWORD 値は CERT_STORE_TIME_VALIDITY_FLAG に設定されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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* CertGetCRLFromStore(
    HCERTSTORE hCertStore,
    const CERT_CONTEXT* pIssuerContext,   // optional
    CRL_CONTEXT* pPrevCrlContext,   // optional
    DWORD* pdwFlags
);

[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr CertGetCRLFromStore(
    IntPtr hCertStore,   // HCERTSTORE
    IntPtr pIssuerContext,   // CERT_CONTEXT* optional
    IntPtr pPrevCrlContext,   // CRL_CONTEXT* optional
    ref uint pdwFlags   // DWORD* in/out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CertGetCRLFromStore(
    hCertStore As IntPtr,   ' HCERTSTORE
    pIssuerContext As IntPtr,   ' CERT_CONTEXT* optional
    pPrevCrlContext As IntPtr,   ' CRL_CONTEXT* optional
    ByRef pdwFlags As UInteger   ' DWORD* in/out
) As IntPtr
End Function

' hCertStore : HCERTSTORE
' pIssuerContext : CERT_CONTEXT* optional
' pPrevCrlContext : CRL_CONTEXT* optional
' pdwFlags : DWORD* in/out
Declare PtrSafe Function CertGetCRLFromStore Lib "crypt32" ( _
    ByVal hCertStore As LongPtr, _
    ByVal pIssuerContext As LongPtr, _
    ByVal pPrevCrlContext As LongPtr, _
    ByRef pdwFlags As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CertGetCRLFromStore = ctypes.windll.crypt32.CertGetCRLFromStore
CertGetCRLFromStore.restype = ctypes.c_void_p
CertGetCRLFromStore.argtypes = [
    wintypes.HANDLE,  # hCertStore : HCERTSTORE
    ctypes.c_void_p,  # pIssuerContext : CERT_CONTEXT* optional
    ctypes.c_void_p,  # pPrevCrlContext : CRL_CONTEXT* optional
    ctypes.POINTER(wintypes.DWORD),  # pdwFlags : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CertGetCRLFromStore = Fiddle::Function.new(
  lib['CertGetCRLFromStore'],
  [
    Fiddle::TYPE_VOIDP,  # hCertStore : HCERTSTORE
    Fiddle::TYPE_VOIDP,  # pIssuerContext : CERT_CONTEXT* optional
    Fiddle::TYPE_VOIDP,  # pPrevCrlContext : CRL_CONTEXT* optional
    Fiddle::TYPE_VOIDP,  # pdwFlags : DWORD* in/out
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "crypt32")]
extern "system" {
    fn CertGetCRLFromStore(
        hCertStore: *mut core::ffi::c_void,  // HCERTSTORE
        pIssuerContext: *const CERT_CONTEXT,  // CERT_CONTEXT* optional
        pPrevCrlContext: *mut CRL_CONTEXT,  // CRL_CONTEXT* optional
        pdwFlags: *mut u32  // DWORD* in/out
    ) -> *mut CRL_CONTEXT;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("CRYPT32.dll", SetLastError = true)]
public static extern IntPtr CertGetCRLFromStore(IntPtr hCertStore, IntPtr pIssuerContext, IntPtr pPrevCrlContext, ref uint pdwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CertGetCRLFromStore' -Namespace Win32 -PassThru
# $api::CertGetCRLFromStore(hCertStore, pIssuerContext, pPrevCrlContext, pdwFlags)

#uselib "CRYPT32.dll"
#func global CertGetCRLFromStore "CertGetCRLFromStore" sptr, sptr, sptr, sptr
; CertGetCRLFromStore hCertStore, varptr(pIssuerContext), varptr(pPrevCrlContext), varptr(pdwFlags)   ; 戻り値は stat
; hCertStore : HCERTSTORE -> "sptr"
; pIssuerContext : CERT_CONTEXT* optional -> "sptr"
; pPrevCrlContext : CRL_CONTEXT* optional -> "sptr"
; pdwFlags : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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