ホーム › Security.Cryptography › CertEnumCertificatesInStore

CertEnumCertificatesInStore

関数

証明書ストア内の証明書を順に列挙する。

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

シグネチャ

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

CERT_CONTEXT* CertEnumCertificatesInStore(
    HCERTSTORE hCertStore,
    const CERT_CONTEXT* pPrevCertContext   // optional
);

パラメーター

名前	型	方向	説明
hCertStore	HCERTSTORE	in	証明書ストアのハンドル。
pPrevCertContext	CERT_CONTEXT*	inoptional	直前に見つかった証明書コンテキストの CERT_CONTEXT へのポインター。列挙を開始してストア内の最初の証明書を取得するには、このパラメーターを NULL にする必要があります。以降の証明書は、pPrevCertContext に直前の関数呼び出しで返されたポインターを設定することで列挙されます。この関数は、このパラメーターが非 NULL 値の場合に参照される CERT_CONTEXT を解放します。コレクションストアを含む論理ストアでは、この関数が返した pCertContext の複製を使用して新しい列挙のサブシーケンスを開始することはできません。複製された証明書は初期の列挙状態を失うためです。列挙では、以前に CertDeleteCertificateFromStore によって削除された証明書はスキップされます。

名前

型

方向

説明

hCertStore

HCERTSTORE

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

pPrevCertContext

CERT_CONTEXT*

inoptional

直前に見つかった証明書コンテキストの CERT_CONTEXT へのポインター。

列挙を開始してストア内の最初の証明書を取得するには、このパラメーターを NULL にする必要があります。以降の証明書は、pPrevCertContext に直前の関数呼び出しで返されたポインターを設定することで列挙されます。この関数は、このパラメーターが非 NULL 値の場合に参照される CERT_CONTEXT を解放します。

コレクションストアを含む論理ストアでは、この関数が返した pCertContext の複製を使用して新しい列挙のサブシーケンスを開始することはできません。複製された証明書は初期の列挙状態を失うためです。列挙では、以前に CertDeleteCertificateFromStore によって削除された証明書はスキップされます。

戻り値の型: CERT_CONTEXT*

公式ドキュメント

証明書ストア内の最初の証明書、または次の証明書を取得します。ループ内で使用すると、この関数は証明書ストア内のすべての証明書を順に取得できます。

戻り値

関数が成功すると、ストア内の次の CERT_CONTEXT へのポインターを返します。ストア内にこれ以上証明書が存在しない場合、関数は NULL を返します。

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

値	説明
E_INVALIDARG	hCertStore パラメーターのハンドルが、pPrevCertContext が指す証明書コンテキスト内のハンドルと一致しません。
CRYPT_E_NOT_FOUND	証明書が見つかりませんでした。ストアが空である場合、または関数がストアのリストの末尾に達した場合に発生します。
ERROR_NO_MORE_FILES	外部ストアに適用されます。証明書が見つかりませんでした。ストアが空である場合、または関数がストアのリストの末尾に達した場合に発生します。

解説(Remarks)

返されたポインターは、後続の呼び出しで pPrevCertContext パラメーターとして渡されると解放されます。それ以外の場合は、 CertFreeCertificateContext を呼び出してポインターを解放する必要があります。CertEnumCertificatesInStore に渡された非 NULL の pPrevCertContext は、エラーの場合でも常に解放されます。

現在列挙中の証明書の複製は、 CertDuplicateCertificateContext を呼び出して作成できます。

例

次の例は、証明書ストア内の証明書コンテキストを一覧表示します。この関数を使用する別の例については、例: 証明書ストアから証明書を削除する C プログラムを参照してください。

#include <windows.h>
#include <stdio.h>
#include <Wincrypt.h>
#pragma comment(lib, "crypt32.lib")


//--------------------------------------------------------------------
// 変数を宣言して初期化します。
HANDLE          hStoreHandle = NULL;
PCCERT_CONTEXT  pCertContext = NULL;   
char * pszStoreName = "CA";

//--------------------------------------------------------------------
// システム証明書ストアを開きます。
if (hStoreHandle = CertOpenSystemStore(
     NULL,     
     pszStoreName))
    {
         printf("The %s store has been opened. \n", pszStoreName);
    }
    else
    {
         printf("The store was not opened.\n");
         exit(1);
    }

//-------------------------------------------------------------------
// システムストア内の証明書を検索します。
while(pCertContext= CertEnumCertificatesInStore(
      hStoreHandle,
      pCertContext)) // 関数の最初の呼び出しでは、
                     // このパラメーターは NULL です。
                     // 以降のすべての呼び出しでは、
                     // このパラメーターは関数が前回返した
                     // ポインターになります。
{
    //----------------------------------------------------------------
    // 現在の証明書に対して必要な処理を行います。
    // ...
} // while の終わり。

//--------------------------------------------------------------------
//   クリーンアップ。
if (!CertCloseStore(
         hStoreHandle,
         0))
{
    printf("Failed CertCloseStore\n");
    exit(1);
}

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

各言語での呼び出し定義

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

CERT_CONTEXT* CertEnumCertificatesInStore(
    HCERTSTORE hCertStore,
    const CERT_CONTEXT* pPrevCertContext   // optional
);

[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr CertEnumCertificatesInStore(
    IntPtr hCertStore,   // HCERTSTORE
    IntPtr pPrevCertContext   // CERT_CONTEXT* optional
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CertEnumCertificatesInStore(
    hCertStore As IntPtr,   ' HCERTSTORE
    pPrevCertContext As IntPtr   ' CERT_CONTEXT* optional
) As IntPtr
End Function

' hCertStore : HCERTSTORE
' pPrevCertContext : CERT_CONTEXT* optional
Declare PtrSafe Function CertEnumCertificatesInStore Lib "crypt32" ( _
    ByVal hCertStore As LongPtr, _
    ByVal pPrevCertContext As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CertEnumCertificatesInStore = ctypes.windll.crypt32.CertEnumCertificatesInStore
CertEnumCertificatesInStore.restype = ctypes.c_void_p
CertEnumCertificatesInStore.argtypes = [
    wintypes.HANDLE,  # hCertStore : HCERTSTORE
    ctypes.c_void_p,  # pPrevCertContext : CERT_CONTEXT* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CertEnumCertificatesInStore = Fiddle::Function.new(
  lib['CertEnumCertificatesInStore'],
  [
    Fiddle::TYPE_VOIDP,  # hCertStore : HCERTSTORE
    Fiddle::TYPE_VOIDP,  # pPrevCertContext : CERT_CONTEXT* optional
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "crypt32")]
extern "system" {
    fn CertEnumCertificatesInStore(
        hCertStore: *mut core::ffi::c_void,  // HCERTSTORE
        pPrevCertContext: *const CERT_CONTEXT  // CERT_CONTEXT* optional
    ) -> *mut CERT_CONTEXT;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("CRYPT32.dll", SetLastError = true)]
public static extern IntPtr CertEnumCertificatesInStore(IntPtr hCertStore, IntPtr pPrevCertContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CertEnumCertificatesInStore' -Namespace Win32 -PassThru
# $api::CertEnumCertificatesInStore(hCertStore, pPrevCertContext)

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

出力引数:

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