ホーム › System.Diagnostics.Debug › ImageGetCertificateData

ImageGetCertificateData

関数

イメージファイルから指定証明書のデータを取得する。

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

シグネチャ

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

BOOL ImageGetCertificateData(
    HANDLE FileHandle,
    DWORD CertificateIndex,
    WIN_CERTIFICATE* Certificate,
    DWORD* RequiredLength
);

パラメーター

名前	型	方向	説明
FileHandle	HANDLE	in	イメージファイルへのハンドルです。このハンドルは FILE_READ_DATA アクセスで開かれている必要があります。
CertificateIndex	DWORD	in	返される証明書のインデックスです。
Certificate	WIN_CERTIFICATE*	out	証明書データを受け取る WIN_CERTIFICATE 構造体へのポインターです。バッファーが構造体を格納するのに十分な大きさでない場合、関数は失敗し、最終エラーコードが ERROR_INSUFFICIENT_BUFFER に設定されます。
RequiredLength	DWORD*	inout	入力時、このパラメーターは Certificate バッファーの長さをバイト単位で指定します。成功時には、証明書の長さを受け取ります。

戻り値の型: BOOL

公式ドキュメント

ファイルから完全な証明書を取得します。

戻り値

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

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

解説(Remarks)

WIN_CERTIFICATE 構造体は次のように定義されています。

typedef struct _WIN_CERTIFICATE {
    DWORD       dwLength;
    WORD        wRevision;
    WORD        wCertificateType;   // WIN_CERT_TYPE_xxx
    BYTE        bCertificate[ANYSIZE_ARRAY];
} WIN_CERTIFICATE, *LPWIN_CERTIFICATE;

この関数を含むすべての 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 ImageGetCertificateData(
    HANDLE FileHandle,
    DWORD CertificateIndex,
    WIN_CERTIFICATE* Certificate,
    DWORD* RequiredLength
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("imagehlp.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ImageGetCertificateData(
    IntPtr FileHandle,   // HANDLE
    uint CertificateIndex,   // DWORD
    IntPtr Certificate,   // WIN_CERTIFICATE* out
    ref uint RequiredLength   // DWORD* in/out
);

<DllImport("imagehlp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ImageGetCertificateData(
    FileHandle As IntPtr,   ' HANDLE
    CertificateIndex As UInteger,   ' DWORD
    Certificate As IntPtr,   ' WIN_CERTIFICATE* out
    ByRef RequiredLength As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' FileHandle : HANDLE
' CertificateIndex : DWORD
' Certificate : WIN_CERTIFICATE* out
' RequiredLength : DWORD* in/out
Declare PtrSafe Function ImageGetCertificateData Lib "imagehlp" ( _
    ByVal FileHandle As LongPtr, _
    ByVal CertificateIndex As Long, _
    ByVal Certificate As LongPtr, _
    ByRef RequiredLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ImageGetCertificateData = ctypes.windll.imagehlp.ImageGetCertificateData
ImageGetCertificateData.restype = wintypes.BOOL
ImageGetCertificateData.argtypes = [
    wintypes.HANDLE,  # FileHandle : HANDLE
    wintypes.DWORD,  # CertificateIndex : DWORD
    ctypes.c_void_p,  # Certificate : WIN_CERTIFICATE* out
    ctypes.POINTER(wintypes.DWORD),  # RequiredLength : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('imagehlp.dll')
ImageGetCertificateData = Fiddle::Function.new(
  lib['ImageGetCertificateData'],
  [
    Fiddle::TYPE_VOIDP,  # FileHandle : HANDLE
    -Fiddle::TYPE_INT,  # CertificateIndex : DWORD
    Fiddle::TYPE_VOIDP,  # Certificate : WIN_CERTIFICATE* out
    Fiddle::TYPE_VOIDP,  # RequiredLength : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "imagehlp")]
extern "system" {
    fn ImageGetCertificateData(
        FileHandle: *mut core::ffi::c_void,  // HANDLE
        CertificateIndex: u32,  // DWORD
        Certificate: *mut WIN_CERTIFICATE,  // WIN_CERTIFICATE* out
        RequiredLength: *mut u32  // DWORD* in/out
    ) -> 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 ImageGetCertificateData(IntPtr FileHandle, uint CertificateIndex, IntPtr Certificate, ref uint RequiredLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'imagehlp_ImageGetCertificateData' -Namespace Win32 -PassThru
# $api::ImageGetCertificateData(FileHandle, CertificateIndex, Certificate, RequiredLength)

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

出力引数:

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