ホーム › System.Diagnostics.Debug › ImageEnumerateCertificates

ImageEnumerateCertificates

関数

イメージファイル内の証明書を列挙する。

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

シグネチャ

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

BOOL ImageEnumerateCertificates(
    HANDLE FileHandle,
    WORD TypeFilter,
    DWORD* CertificateCount,
    DWORD* Indices,   // optional
    DWORD IndexCount   // optional
);

パラメーター

名前	型	方向	説明
FileHandle	HANDLE	in	調査対象のイメージファイルへのハンドル。このハンドルは FILE_READ_DATA アクセスで開かれている必要があります。
TypeFilter	WORD	in	証明書情報を返す際にフィルターとして使用する証明書セクションの種類。イメージ内に存在するすべてのセクションの種類に関する情報を取得するには、CERT_SECTION_TYPE_ANY を渡します。
CertificateCount	DWORD*	out	TypeFilter パラメーターで指定された種類のセクションを含む、イメージ内の証明書の数を受け取る変数へのポインター。該当する証明書が見つからない場合、このパラメーターは 0 になります。
Indices	DWORD*	inoutoptional	指定された種類のセクションを含む証明書へのインデックスの配列を返すために使用するバッファーを任意で指定します。インデックス値の順序は想定すべきではなく、また CERT_SECTION_TYPE_ANY を照会した場合に連続していることも保証されません。
IndexCount	DWORD	inoptional	Indices バッファーのサイズ（DWORD 単位）。このパラメーターは Indices が存在する場合に常に検査されます。CertificateCount が IndexCount より大きい場合、Indices にはイメージ内で最初に見つかった IndexCount 個のセクションが格納され、それ以外は返されません。

戻り値の型: BOOL

公式ドキュメント

イメージファイルに現在格納されている証明書に関する情報を取得します。

戻り値

関数が成功した場合、戻り値は TRUE です。

関数が失敗した場合、戻り値は FALSE です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

ImageEnumerateCertificates 関数は、イメージファイルに現在格納されている証明書に関する情報を返します。この関数にはフィルタリング機能があり、任意の単一の種類（または任意の種類）のセクションを含む証明書を返すことができます。

対象となる証明書のインデックスを取得した後、それらを ImageGetCertificateData 関数に渡すことで、証明書の実際の本体を取得できます。

この関数を含むすべての ImageHlp 関数はシングルスレッドです。したがって、複数のスレッドからこの関数を呼び出すと、予期しない動作やメモリ破損が発生する可能性が高くなります。これを回避するには、複数のスレッドからこの関数への同時呼び出しをすべて同期する必要があります。

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

各言語での呼び出し定義

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

BOOL ImageEnumerateCertificates(
    HANDLE FileHandle,
    WORD TypeFilter,
    DWORD* CertificateCount,
    DWORD* Indices,   // optional
    DWORD IndexCount   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("imagehlp.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ImageEnumerateCertificates(
    IntPtr FileHandle,   // HANDLE
    ushort TypeFilter,   // WORD
    out uint CertificateCount,   // DWORD* out
    IntPtr Indices,   // DWORD* optional, in/out
    uint IndexCount   // DWORD optional
);

<DllImport("imagehlp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ImageEnumerateCertificates(
    FileHandle As IntPtr,   ' HANDLE
    TypeFilter As UShort,   ' WORD
    <Out> ByRef CertificateCount As UInteger,   ' DWORD* out
    Indices As IntPtr,   ' DWORD* optional, in/out
    IndexCount As UInteger   ' DWORD optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' FileHandle : HANDLE
' TypeFilter : WORD
' CertificateCount : DWORD* out
' Indices : DWORD* optional, in/out
' IndexCount : DWORD optional
Declare PtrSafe Function ImageEnumerateCertificates Lib "imagehlp" ( _
    ByVal FileHandle As LongPtr, _
    ByVal TypeFilter As Integer, _
    ByRef CertificateCount As Long, _
    ByVal Indices As LongPtr, _
    ByVal IndexCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ImageEnumerateCertificates = ctypes.windll.imagehlp.ImageEnumerateCertificates
ImageEnumerateCertificates.restype = wintypes.BOOL
ImageEnumerateCertificates.argtypes = [
    wintypes.HANDLE,  # FileHandle : HANDLE
    ctypes.c_ushort,  # TypeFilter : WORD
    ctypes.POINTER(wintypes.DWORD),  # CertificateCount : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # Indices : DWORD* optional, in/out
    wintypes.DWORD,  # IndexCount : DWORD optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('imagehlp.dll')
ImageEnumerateCertificates = Fiddle::Function.new(
  lib['ImageEnumerateCertificates'],
  [
    Fiddle::TYPE_VOIDP,  # FileHandle : HANDLE
    -Fiddle::TYPE_SHORT,  # TypeFilter : WORD
    Fiddle::TYPE_VOIDP,  # CertificateCount : DWORD* out
    Fiddle::TYPE_VOIDP,  # Indices : DWORD* optional, in/out
    -Fiddle::TYPE_INT,  # IndexCount : DWORD optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "imagehlp")]
extern "system" {
    fn ImageEnumerateCertificates(
        FileHandle: *mut core::ffi::c_void,  // HANDLE
        TypeFilter: u16,  // WORD
        CertificateCount: *mut u32,  // DWORD* out
        Indices: *mut u32,  // DWORD* optional, in/out
        IndexCount: u32  // DWORD optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("imagehlp.dll", SetLastError = true)]
public static extern bool ImageEnumerateCertificates(IntPtr FileHandle, ushort TypeFilter, out uint CertificateCount, IntPtr Indices, uint IndexCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'imagehlp_ImageEnumerateCertificates' -Namespace Win32 -PassThru
# $api::ImageEnumerateCertificates(FileHandle, TypeFilter, CertificateCount, Indices, IndexCount)

#uselib "imagehlp.dll"
#func global ImageEnumerateCertificates "ImageEnumerateCertificates" sptr, sptr, sptr, sptr, sptr
; ImageEnumerateCertificates FileHandle, TypeFilter, varptr(CertificateCount), varptr(Indices), IndexCount   ; 戻り値は stat
; FileHandle : HANDLE -> "sptr"
; TypeFilter : WORD -> "sptr"
; CertificateCount : DWORD* out -> "sptr"
; Indices : DWORD* optional, in/out -> "sptr"
; IndexCount : DWORD optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "imagehlp.dll"
#cfunc global ImageEnumerateCertificates "ImageEnumerateCertificates" sptr, int, var, var, int
; res = ImageEnumerateCertificates(FileHandle, TypeFilter, CertificateCount, Indices, IndexCount)
; FileHandle : HANDLE -> "sptr"
; TypeFilter : WORD -> "int"
; CertificateCount : DWORD* out -> "var"
; Indices : DWORD* optional, in/out -> "var"
; IndexCount : DWORD optional -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "imagehlp.dll"
#cfunc global ImageEnumerateCertificates "ImageEnumerateCertificates" sptr, int, sptr, sptr, int
; res = ImageEnumerateCertificates(FileHandle, TypeFilter, varptr(CertificateCount), varptr(Indices), IndexCount)
; FileHandle : HANDLE -> "sptr"
; TypeFilter : WORD -> "int"
; CertificateCount : DWORD* out -> "sptr"
; Indices : DWORD* optional, in/out -> "sptr"
; IndexCount : DWORD optional -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。