ホーム › System.ApplicationInstallationAndServicing › MsiGetFileSignatureInformationW

MsiGetFileSignatureInformationW

関数

署名済みファイルから証明書コンテキストとハッシュ情報を取得する。

DLLmsi.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

// msi.dll  (Unicode / -W)
#include <windows.h>

HRESULT MsiGetFileSignatureInformationW(
    LPCWSTR szSignedObjectPath,
    DWORD dwFlags,
    CERT_CONTEXT** ppcCertContext,
    BYTE* pbHashData,   // optional
    DWORD* pcbHashData   // optional
);

パラメーター

名前

型

方向

説明

szSignedObjectPath

LPCWSTR

デジタル署名を含むファイルへのフルパスを指定する、null 終端文字列へのポインター。

dwFlags

DWORD

特殊なエラーケースのフラグ。

フラグ	意味
MSI_INVALID_HASH_IS_FATAL 0x1	このフラグを設定せず、証明書コンテキストのみを要求した場合、デジタル署名内のハッシュが無効であっても MsiGetFileSignatureInformation は致命的なエラーを返しません。無効なハッシュに対して致命的なエラーを返すには、MSI_INVALID_HASH_IS_FATAL フラグを設定します。

ppcCertContext

CERT_CONTEXT**

out

返される署名者証明書コンテキスト。

pbHashData

BYTE*

outoptional

返されるハッシュバッファー。ハッシュデータを要求しない場合、このパラメーターは NULL にできます。

pcbHashData

DWORD*

inoutoptional

pbHashData パラメーターが指すバッファーのサイズ (バイト単位) を指定する変数へのポインター。pbHashData が非 NULL の場合、このパラメーターを NULL にすることはできません。ERROR_MORE_DATA が返された場合、pbHashData にはハッシュデータを格納するために必要なバッファーのサイズが示されます。ERROR_SUCCESS が返された場合は、ハッシュバッファーに書き込まれたバイト数が示されます。pbHashData が NULL の場合、pcbHashData パラメーターは無視されます。

戻り値の型: HRESULT

公式ドキュメント

MsiGetFileSignatureInformation 関数は、デジタル署名されたファイルのパスを受け取り、そのファイルの署名者証明書とハッシュを返します。(Unicode)

戻り値

値	意味
ERROR_SUCCESS/S_OK	正常に完了しました。
ERROR_INVALID_PARAMETER	無効なパラメーターが指定されました。
ERROR_FUNCTION_FAILED	WinVerifyTrust がシステム上で利用できません。 MsiGetFileSignatureInformation は、システム上に Wintrust.dll ファイルが存在することを必要とします。
ERROR_MORE_DATA	バッファーが小さすぎて、要求されたデータを格納できません。ERROR_MORE_DATA が返された場合、pcbHashData にはハッシュデータを格納するために必要なバッファーのサイズが示されます。
TRUST_E_NOSIGNATURE	ファイルが署名されていません。
TRUST_E_BAD_DIGEST	ファイルのデジタル署名に格納されているハッシュに照らして、ファイルの現在のハッシュが無効です。
CERT_E_REVOKED	ファイルの署名者証明書が失効しています。ファイルのデジタル署名が侵害されています。
TRUST_E_SUBJECT_NOT_TRUSTED	サブジェクトが指定された検証アクションに失敗しました。ほとんどのトラストプロバイダーは、失敗の理由を説明する、より詳細なエラーコードを返します。
TRUST_E_PROVIDER_UNKNOWN	トラストプロバイダーがこのシステムで認識されていません。
TRUST_E_ACTION_UNKNOWN	トラストプロバイダーが指定されたアクションをサポートしていません。
TRUST_E_SUBJECT_FORM_UNKNOWN	トラストプロバイダーが、サブジェクトに対して指定された形式をサポートしていません。

MsiGetFileSignatureInformation は、HRESULT_FROM_WIN32 によって等価な HRESULT データ型にマップされた、すべての Win32 エラー値も返します。

解説(Remarks)

証明書コンテキストのみを要求した場合、デジタル署名内のハッシュが無効であっても MsiGetFileSignatureInformation は致命的なエラーを返しません。無効なハッシュに対して致命的なエラーを返すには、dwFlags パラメーターに MSI_INVALID_HASH_IS_FATAL フラグを設定します。

証明書コンテキストとハッシュ情報は、WinVerifyTrust の呼び出しによってファイルから抽出されます。ppcCertContext パラメーターは、署名内の署名者証明書コンテキストの複製です。処理が完了したら、CertFreeCertificateContext を呼び出して証明書コンテキストを解放するのは呼び出し元の責任です。

MsiGetFileSignatureInformation は、システム上に Wintrust.dll ファイルが存在することを必要とする点に注意してください。

メモ

msi.h ヘッダーは、MsiGetFileSignatureInformation を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディングニュートラルなエイリアスの使用と、エンコーディングニュートラルでないコードを混在させると、コンパイルエラーや実行時エラーを引き起こす不一致につながる可能性があります。詳細については、「Conventions for Function Prototypes」を参照してください。

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

各言語での呼び出し定義

// msi.dll  (Unicode / -W)
#include <windows.h>

HRESULT MsiGetFileSignatureInformationW(
    LPCWSTR szSignedObjectPath,
    DWORD dwFlags,
    CERT_CONTEXT** ppcCertContext,
    BYTE* pbHashData,   // optional
    DWORD* pcbHashData   // optional
);

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int MsiGetFileSignatureInformationW(
    [MarshalAs(UnmanagedType.LPWStr)] string szSignedObjectPath,   // LPCWSTR
    uint dwFlags,   // DWORD
    IntPtr ppcCertContext,   // CERT_CONTEXT** out
    IntPtr pbHashData,   // BYTE* optional, out
    IntPtr pcbHashData   // DWORD* optional, in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiGetFileSignatureInformationW(
    <MarshalAs(UnmanagedType.LPWStr)> szSignedObjectPath As String,   ' LPCWSTR
    dwFlags As UInteger,   ' DWORD
    ppcCertContext As IntPtr,   ' CERT_CONTEXT** out
    pbHashData As IntPtr,   ' BYTE* optional, out
    pcbHashData As IntPtr   ' DWORD* optional, in/out
) As Integer
End Function

' szSignedObjectPath : LPCWSTR
' dwFlags : DWORD
' ppcCertContext : CERT_CONTEXT** out
' pbHashData : BYTE* optional, out
' pcbHashData : DWORD* optional, in/out
Declare PtrSafe Function MsiGetFileSignatureInformationW Lib "msi" ( _
    ByVal szSignedObjectPath As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal ppcCertContext As LongPtr, _
    ByVal pbHashData As LongPtr, _
    ByVal pcbHashData As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MsiGetFileSignatureInformationW = ctypes.windll.msi.MsiGetFileSignatureInformationW
MsiGetFileSignatureInformationW.restype = ctypes.c_int
MsiGetFileSignatureInformationW.argtypes = [
    wintypes.LPCWSTR,  # szSignedObjectPath : LPCWSTR
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # ppcCertContext : CERT_CONTEXT** out
    ctypes.POINTER(ctypes.c_ubyte),  # pbHashData : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbHashData : DWORD* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiGetFileSignatureInformationW = Fiddle::Function.new(
  lib['MsiGetFileSignatureInformationW'],
  [
    Fiddle::TYPE_VOIDP,  # szSignedObjectPath : LPCWSTR
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # ppcCertContext : CERT_CONTEXT** out
    Fiddle::TYPE_VOIDP,  # pbHashData : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # pcbHashData : DWORD* optional, in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "msi")]
extern "system" {
    fn MsiGetFileSignatureInformationW(
        szSignedObjectPath: *const u16,  // LPCWSTR
        dwFlags: u32,  // DWORD
        ppcCertContext: *mut *mut CERT_CONTEXT,  // CERT_CONTEXT** out
        pbHashData: *mut u8,  // BYTE* optional, out
        pcbHashData: *mut u32  // DWORD* optional, in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern int MsiGetFileSignatureInformationW([MarshalAs(UnmanagedType.LPWStr)] string szSignedObjectPath, uint dwFlags, IntPtr ppcCertContext, IntPtr pbHashData, IntPtr pcbHashData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiGetFileSignatureInformationW' -Namespace Win32 -PassThru
# $api::MsiGetFileSignatureInformationW(szSignedObjectPath, dwFlags, ppcCertContext, pbHashData, pcbHashData)

#uselib "msi.dll"
#func global MsiGetFileSignatureInformationW "MsiGetFileSignatureInformationW" wptr, wptr, wptr, wptr, wptr
; MsiGetFileSignatureInformationW szSignedObjectPath, dwFlags, varptr(ppcCertContext), varptr(pbHashData), varptr(pcbHashData)   ; 戻り値は stat
; szSignedObjectPath : LPCWSTR -> "wptr"
; dwFlags : DWORD -> "wptr"
; ppcCertContext : CERT_CONTEXT** out -> "wptr"
; pbHashData : BYTE* optional, out -> "wptr"
; pcbHashData : DWORD* optional, in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "msi.dll"
#cfunc global MsiGetFileSignatureInformationW "MsiGetFileSignatureInformationW" wstr, int, var, var, var
; res = MsiGetFileSignatureInformationW(szSignedObjectPath, dwFlags, ppcCertContext, pbHashData, pcbHashData)
; szSignedObjectPath : LPCWSTR -> "wstr"
; dwFlags : DWORD -> "int"
; ppcCertContext : CERT_CONTEXT** out -> "var"
; pbHashData : BYTE* optional, out -> "var"
; pcbHashData : DWORD* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msi.dll"
#cfunc global MsiGetFileSignatureInformationW "MsiGetFileSignatureInformationW" wstr, int, sptr, sptr, sptr
; res = MsiGetFileSignatureInformationW(szSignedObjectPath, dwFlags, varptr(ppcCertContext), varptr(pbHashData), varptr(pcbHashData))
; szSignedObjectPath : LPCWSTR -> "wstr"
; dwFlags : DWORD -> "int"
; ppcCertContext : CERT_CONTEXT** out -> "sptr"
; pbHashData : BYTE* optional, out -> "sptr"
; pcbHashData : DWORD* optional, in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。