Win32 API 日本語リファレンス
ホームSystem.TpmBaseServices › Tbsi_Get_TCG_Log_Ex

Tbsi_Get_TCG_Log_Ex

関数
指定種類のTPMのTCGイベントログを取得する(拡張版)。
DLLtbs.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

DWORD Tbsi_Get_TCG_Log_Ex(
    DWORD logType,
    BYTE* pbOutput,   // optional
    DWORD* pcbOutput
);

パラメーター

名前方向説明
logTypeDWORDin

取得するログの種類。

意味
TBS_TCGLOG_SRTM_CURRENT
0
現在のセッション (起動または再開) の PCR 0-15 に関連付けられたログ。
TBS_TCGLOG_DRTM_CURRENT
1
現在のセッション (起動または再開) の PCR 17-22 に関連付けられたログ。
TBS_TCGLOG_SRTM_BOOT
2
直近のクリーンブートセッションの PCR 0-15 に関連付けられたログ。
TBS_TCGLOG_SRTM_RESUME
3
休止状態からの直近の再開時の PCR 0-15 に関連付けられたログ。
pbOutputBYTE*outoptionalWBCL を受け取って格納するバッファーへのポインター。pcbOutput が指す場所の値も入力時に 0 である場合、必要なバッファーサイズを見積もるために NULL を設定します。
pcbOutputDWORD*inout

出力バッファーのサイズ (バイト単位) を指定する unsigned long 整数へのポインター。成功した場合は、pOutput が指すデータのサイズ (バイト単位) が格納されます。失敗した場合、値は格納されません。

メモ pbOutputNULL で、pcbOutput が指す場所の値が 0 の場合、この関数は TBS_E_BUFFER_TOO_SMALL を返します。その場合、pcbOutputpbOutput に必要なサイズを指します。

戻り値の型: DWORD

公式ドキュメント

指定した種類の Windows Boot Configuration Log (WBCL、TCG ログとも呼ばれます) を取得します。

戻り値

戻り値/コード 説明
TBS_SUCCESS
0 (0x0)
関数は成功しました。
TBS_E_NO_EVENT_LOG
1 (0x1)
TBS_TCGLOG_DRTM_CURRENT が要求されましたが、システムの起動時に DRTM がシステムで有効になっていませんでした。
TBS_E_INTERNAL_ERROR
2150121473 (0x80284001)
内部ソフトウェアエラーが発生しました。
メモ TBS_E_INTERNAL_ERROR が返された場合、システムイベントログに、TBS イベントソースからのイベント ID 16385 がエラーコード 0x80070032 とともに記録されていることがあります。これは、ハードウェアプラットフォームがオペレーティングシステムに TCG イベントログを提供していないことを示している可能性があります。プラットフォームの製造元が提供する BIOS のアップグレードをインストールすることで解決する場合があります。
TBS_E_INVALID_OUTPUT_POINTER
2150121475 (0x80284003)
指定された出力ポインターが有効ではありません。
TBS_E_INSUFFICIENT_BUFFER
2150121477 (0x80284005)
出力バッファーが小さすぎます。
TBS_E_BUFFER_TOO_LARGE
2150121486 (0x8028400E)
出力バッファーが大きすぎます。
TBS_E_TPM_NOT_FOUND
2150121487 (0x8028400F)
このコンピューターでは、互換性のあるトラステッド プラットフォーム モジュール (TPM) セキュリティデバイスが見つかりません。
TBS_E_DEACTIVATED
2150121494 (0x80284016)
トラステッド プラットフォーム モジュール (TPM) セキュリティデバイスが無効化されています。

解説(Remarks)

Tbsi_Get_TCG_Log_Ex 関数はシステムの TCG イベントログを返します。バッファーのサイズはイベントの数によって異なります。

ハードウェアの機能とファームウェアの設定によっては、この関数は複数のハッシュアルゴリズムに対応した形式のログを返す場合があります。この形式のログでは、最初のイベントを除く各イベントが TCG_PCR_EVENT2 構造体として書式設定されます。

typedef struct {
  TCG_PCRINDEX PCRIndex;
  TCG_EVENTTYPE EventType;
  TPML_DIGEST_VALUES Digests;
  UINT32 EventSize;
  UINT8 Event[EventSize];
} TCG_PCR_EVENT2;

typedef struct {
  UINT32 Count;
  TPMT_HA Digests;
} TPML_DIGEST_VALUES;

typedef struct {
  UINT16 HashAlg;
  UINT8 Digest[size_varies_with_algorithm];
} TPMT_HA;

最初のイベントは TCG_PCR_EVENT 構造体として書式設定されます。この構造体については、この解説の後半で説明します。次の表は、この最初のイベントにおけるこの構造体のメンバーの値を示しています。

TCG_PCR_EVENT のメンバー 値または説明
PCRIndex 0
EventType EV_NO_ACTION
Digest 20 バイトのゼロ
EventSize Event メンバーのサイズ
Event 型は TCG_EfiSpecIdEventStruct です

次に、TCG_PCR_EVENT 構造体の Event メンバーが最初のログイベントで使用する TCG_EfiSpecIdEventStruct 構造体の構文を示します。

typedef struct {
  BYTE[16] Signature;
  UINT32 PlatformClass;
  UINT8 SpecVersionMinor;
  UINT8 SpecVersionMajor;
  UINT8 SpecErrata;
  UINT8 UintNSize;
  UINT32 NumberOfAlgorithms;
  TCG_EfiSpecIdEventAlgorithmSize DigestSizes[NumberOfAlgorithms];
  UINT8 VendorInfoSize;
  UINT8 VendorInfo[VendorInfoSize];
} TCG_EfiSpecIdEventStruct;

typedef struct {
  UINT16 HashAlg;
  UINT16 DigestSize;
} TCG_EfiSpecIdEventAlgorithmSize;

ログが複数のハッシュアルゴリズムに対応した形式を使用している場合、TCG_EfiSpecIdEventStruct 構造体の Signature メンバーには、null 終端の ASCII 文字列 "Spec ID Event03" が設定されます。この最初のイベントの DigestSizes 配列には、ログが使用する各ハッシュアルゴリズムのダイジェストサイズが格納されます。パーサーは TCG_PCR_EVENT2 型のイベントを検査する際、存在するすべてのハッシュアルゴリズムに関する情報がなくても TPML_DIGEST_VALUES メンバーを解析できます。最初のイベントに含まれるダイジェストサイズによって、パーサーは存在するダイジェストの分だけ正しいバイト数をスキップできます。

Signature メンバーに null 終端の ASCII 文字列 "Spec ID Event03" が設定されていない場合、ログ内のイベントは TCG_PCR_EVENT 型であり、TCG_EfiSpecIdEventStruct 構造体に NumberOfAlgorithms メンバーと DigestSizes メンバーは含まれません。

複数のハッシュアルゴリズムに対応したログ形式では、プラットフォームとオペレーティングシステムは SHA1、SHA256、またはその他のハッシュアルゴリズムを使用できます。プラットフォームが SHA256 ハッシュアルゴリズムをサポートしていて、複数のハッシュアルゴリズムに対応したログ形式を使用している場合、プラットフォームは SHA1 ではなく SHA256 アルゴリズムを使用します。

TCG イベントログ内の Windows で定義されたイベントは、{Type, Length, Value} のタプルです。TCG PC Client 仕様の次の TCG_PCR_EVENT 構造体を使用してログを解析できます。TPM PCP ToolkitTPM Main Specification の情報を使用すると、ログイベントの一覧どうしを対応付けることができます。

typedef struct {
  TCG_PCRINDEX PCRIndex;
  TCG_EVENTTYPE EventType;
  TCG_DIGEST Digest;
  UINT32 EventSize;
  UINT8 Event[EventSize];
} TCG_PCR_EVENT;

pOutputBuf パラメーターに必要なメモリサイズは、Tbs.h ヘッダーファイルで定義されている定数 TBS_IN_OUT_BUF_SIZE_MAX にするか、長さ 0 のバッファーを指定して Tbsi_Get_TCG_Log_Ex 関数を呼び出して必要なバッファーサイズを取得してください。

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

各言語での呼び出し定義

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

DWORD Tbsi_Get_TCG_Log_Ex(
    DWORD logType,
    BYTE* pbOutput,   // optional
    DWORD* pcbOutput
);
[DllImport("tbs.dll", ExactSpelling = true)]
static extern uint Tbsi_Get_TCG_Log_Ex(
    uint logType,   // DWORD
    IntPtr pbOutput,   // BYTE* optional, out
    ref uint pcbOutput   // DWORD* in/out
);
<DllImport("tbs.dll", ExactSpelling:=True)>
Public Shared Function Tbsi_Get_TCG_Log_Ex(
    logType As UInteger,   ' DWORD
    pbOutput As IntPtr,   ' BYTE* optional, out
    ByRef pcbOutput As UInteger   ' DWORD* in/out
) As UInteger
End Function
' logType : DWORD
' pbOutput : BYTE* optional, out
' pcbOutput : DWORD* in/out
Declare PtrSafe Function Tbsi_Get_TCG_Log_Ex Lib "tbs" ( _
    ByVal logType As Long, _
    ByVal pbOutput As LongPtr, _
    ByRef pcbOutput As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

Tbsi_Get_TCG_Log_Ex = ctypes.windll.tbs.Tbsi_Get_TCG_Log_Ex
Tbsi_Get_TCG_Log_Ex.restype = wintypes.DWORD
Tbsi_Get_TCG_Log_Ex.argtypes = [
    wintypes.DWORD,  # logType : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbOutput : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbOutput : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('tbs.dll')
Tbsi_Get_TCG_Log_Ex = Fiddle::Function.new(
  lib['Tbsi_Get_TCG_Log_Ex'],
  [
    -Fiddle::TYPE_INT,  # logType : DWORD
    Fiddle::TYPE_VOIDP,  # pbOutput : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # pcbOutput : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "tbs")]
extern "system" {
    fn Tbsi_Get_TCG_Log_Ex(
        logType: u32,  // DWORD
        pbOutput: *mut u8,  // BYTE* optional, out
        pcbOutput: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("tbs.dll")]
public static extern uint Tbsi_Get_TCG_Log_Ex(uint logType, IntPtr pbOutput, ref uint pcbOutput);
"@
$api = Add-Type -MemberDefinition $sig -Name 'tbs_Tbsi_Get_TCG_Log_Ex' -Namespace Win32 -PassThru
# $api::Tbsi_Get_TCG_Log_Ex(logType, pbOutput, pcbOutput)
#uselib "tbs.dll"
#func global Tbsi_Get_TCG_Log_Ex "Tbsi_Get_TCG_Log_Ex" sptr, sptr, sptr
; Tbsi_Get_TCG_Log_Ex logType, varptr(pbOutput), varptr(pcbOutput)   ; 戻り値は stat
; logType : DWORD -> "sptr"
; pbOutput : BYTE* optional, out -> "sptr"
; pcbOutput : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "tbs.dll"
#cfunc global Tbsi_Get_TCG_Log_Ex "Tbsi_Get_TCG_Log_Ex" int, var, var
; res = Tbsi_Get_TCG_Log_Ex(logType, pbOutput, pcbOutput)
; logType : DWORD -> "int"
; pbOutput : BYTE* optional, out -> "var"
; pcbOutput : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD Tbsi_Get_TCG_Log_Ex(DWORD logType, BYTE* pbOutput, DWORD* pcbOutput)
#uselib "tbs.dll"
#cfunc global Tbsi_Get_TCG_Log_Ex "Tbsi_Get_TCG_Log_Ex" int, var, var
; res = Tbsi_Get_TCG_Log_Ex(logType, pbOutput, pcbOutput)
; logType : DWORD -> "int"
; pbOutput : BYTE* optional, out -> "var"
; pcbOutput : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	tbs = windows.NewLazySystemDLL("tbs.dll")
	procTbsi_Get_TCG_Log_Ex = tbs.NewProc("Tbsi_Get_TCG_Log_Ex")
)

// logType (DWORD), pbOutput (BYTE* optional, out), pcbOutput (DWORD* in/out)
r1, _, err := procTbsi_Get_TCG_Log_Ex.Call(
	uintptr(logType),
	uintptr(pbOutput),
	uintptr(pcbOutput),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function Tbsi_Get_TCG_Log_Ex(
  logType: DWORD;   // DWORD
  pbOutput: Pointer;   // BYTE* optional, out
  pcbOutput: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'tbs.dll' name 'Tbsi_Get_TCG_Log_Ex';
result := DllCall("tbs\Tbsi_Get_TCG_Log_Ex"
    , "UInt", logType   ; DWORD
    , "Ptr", pbOutput   ; BYTE* optional, out
    , "Ptr", pcbOutput   ; DWORD* in/out
    , "UInt")   ; return: DWORD
●Tbsi_Get_TCG_Log_Ex(logType, pbOutput, pcbOutput) = DLL("tbs.dll", "dword Tbsi_Get_TCG_Log_Ex(dword, void*, void*)")
# 呼び出し: Tbsi_Get_TCG_Log_Ex(logType, pbOutput, pcbOutput)
# logType : DWORD -> "dword"
# pbOutput : BYTE* optional, out -> "void*"
# pcbOutput : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "tbs" fn Tbsi_Get_TCG_Log_Ex(
    logType: u32, // DWORD
    pbOutput: [*c]u8, // BYTE* optional, out
    pcbOutput: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) u32;
proc Tbsi_Get_TCG_Log_Ex(
    logType: uint32,  # DWORD
    pbOutput: ptr uint8,  # BYTE* optional, out
    pcbOutput: ptr uint32  # DWORD* in/out
): uint32 {.importc: "Tbsi_Get_TCG_Log_Ex", stdcall, dynlib: "tbs.dll".}
pragma(lib, "tbs");
extern(Windows)
uint Tbsi_Get_TCG_Log_Ex(
    uint logType,   // DWORD
    ubyte* pbOutput,   // BYTE* optional, out
    uint* pcbOutput   // DWORD* in/out
);
ccall((:Tbsi_Get_TCG_Log_Ex, "tbs.dll"), stdcall, UInt32,
      (UInt32, Ptr{UInt8}, Ptr{UInt32}),
      logType, pbOutput, pcbOutput)
# logType : DWORD -> UInt32
# pbOutput : BYTE* optional, out -> Ptr{UInt8}
# pcbOutput : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t Tbsi_Get_TCG_Log_Ex(
    uint32_t logType,
    uint8_t* pbOutput,
    uint32_t* pcbOutput);
]]
local tbs = ffi.load("tbs")
-- tbs.Tbsi_Get_TCG_Log_Ex(logType, pbOutput, pcbOutput)
-- logType : DWORD
-- pbOutput : BYTE* optional, out
-- pcbOutput : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('tbs.dll');
const Tbsi_Get_TCG_Log_Ex = lib.func('__stdcall', 'Tbsi_Get_TCG_Log_Ex', 'uint32_t', ['uint32_t', 'uint8_t *', 'uint32_t *']);
// Tbsi_Get_TCG_Log_Ex(logType, pbOutput, pcbOutput)
// logType : DWORD -> 'uint32_t'
// pbOutput : BYTE* optional, out -> 'uint8_t *'
// pcbOutput : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("tbs.dll", {
  Tbsi_Get_TCG_Log_Ex: { parameters: ["u32", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.Tbsi_Get_TCG_Log_Ex(logType, pbOutput, pcbOutput)
// logType : DWORD -> "u32"
// pbOutput : BYTE* optional, out -> "pointer"
// pcbOutput : DWORD* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t Tbsi_Get_TCG_Log_Ex(
    uint32_t logType,
    uint8_t* pbOutput,
    uint32_t* pcbOutput);
C, "tbs.dll");
// $ffi->Tbsi_Get_TCG_Log_Ex(logType, pbOutput, pcbOutput);
// logType : DWORD
// pbOutput : BYTE* optional, out
// pcbOutput : DWORD* in/out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Tbs extends StdCallLibrary {
    Tbs INSTANCE = Native.load("tbs", Tbs.class);
    int Tbsi_Get_TCG_Log_Ex(
        int logType,   // DWORD
        byte[] pbOutput,   // BYTE* optional, out
        IntByReference pcbOutput   // DWORD* in/out
    );
}
@[Link("tbs")]
lib Libtbs
  fun Tbsi_Get_TCG_Log_Ex = Tbsi_Get_TCG_Log_Ex(
    logType : UInt32,   # DWORD
    pbOutput : UInt8*,   # BYTE* optional, out
    pcbOutput : UInt32*   # DWORD* in/out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef Tbsi_Get_TCG_Log_ExNative = Uint32 Function(Uint32, Pointer<Uint8>, Pointer<Uint32>);
typedef Tbsi_Get_TCG_Log_ExDart = int Function(int, Pointer<Uint8>, Pointer<Uint32>);
final Tbsi_Get_TCG_Log_Ex = DynamicLibrary.open('tbs.dll')
    .lookupFunction<Tbsi_Get_TCG_Log_ExNative, Tbsi_Get_TCG_Log_ExDart>('Tbsi_Get_TCG_Log_Ex');
// logType : DWORD -> Uint32
// pbOutput : BYTE* optional, out -> Pointer<Uint8>
// pcbOutput : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function Tbsi_Get_TCG_Log_Ex(
  logType: DWORD;   // DWORD
  pbOutput: Pointer;   // BYTE* optional, out
  pcbOutput: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'tbs.dll' name 'Tbsi_Get_TCG_Log_Ex';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "Tbsi_Get_TCG_Log_Ex"
  c_Tbsi_Get_TCG_Log_Ex :: Word32 -> Ptr Word8 -> Ptr Word32 -> IO Word32
-- logType : DWORD -> Word32
-- pbOutput : BYTE* optional, out -> Ptr Word8
-- pcbOutput : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let tbsi_get_tcg_log_ex =
  foreign "Tbsi_Get_TCG_Log_Ex"
    (uint32_t @-> (ptr uint8_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* logType : DWORD -> uint32_t *)
(* pbOutput : BYTE* optional, out -> (ptr uint8_t) *)
(* pcbOutput : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library tbs (t "tbs.dll"))
(cffi:use-foreign-library tbs)

(cffi:defcfun ("Tbsi_Get_TCG_Log_Ex" tbsi-get-tcg-log-ex :convention :stdcall) :uint32
  (log-type :uint32)   ; DWORD
  (pb-output :pointer)   ; BYTE* optional, out
  (pcb-output :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $Tbsi_Get_TCG_Log_Ex = Win32::API::More->new('tbs',
    'DWORD Tbsi_Get_TCG_Log_Ex(DWORD logType, LPVOID pbOutput, LPVOID pcbOutput)');
# my $ret = $Tbsi_Get_TCG_Log_Ex->Call($logType, $pbOutput, $pcbOutput);
# logType : DWORD -> DWORD
# pbOutput : BYTE* optional, out -> LPVOID
# pcbOutput : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。