Tbsi_Get_TCG_Log
関数シグネチャ
// tbs.dll
#include <windows.h>
DWORD Tbsi_Get_TCG_Log(
void* hContext,
BYTE* pOutputBuf, // optional
DWORD* pOutputBufLen
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hContext | void* | in | ログを取得するコンテキストの TBS ハンドル。このパラメーターは、事前に Tbsi_Context_Create 関数を呼び出して取得します。 |
| pOutputBuf | BYTE* | outoptional | WBCL を受け取って格納するバッファーへのポインター。pcbOutput が指す位置の入力値が 0 である場合は、このパラメーターに NULL を指定して、必要なバッファーサイズを見積もることができます。 |
| pOutputBufLen | DWORD* | inout | 入力時に出力バッファーのサイズ (バイト単位) を指定する、unsigned long 整数へのポインター。関数が成功した場合、出力時にこのパラメーターは pOutputBuf が指すデータのサイズ (バイト単位) を受け取ります。関数が失敗した場合、このパラメーターは値を受け取りません。 長さ 0 のバッファーを指定して Tbsi_Get_TCG_Log 関数を呼び出すと、必要なバッファーのサイズが返されます。Windows Vista with SP1 および Windows Server 2008: この機能は利用できません。 |
戻り値の型: DWORD
公式ドキュメント
最新の Windows Boot Configuration Log (WBCL) を取得します。WBCL は TCG ログとも呼ばれます。
戻り値
| リターンコード/値 | 説明 |
|---|---|
|
関数は成功しました。 |
|
内部ソフトウェアエラーが発生しました。
メモ TBS_E_INTERNAL_ERROR が返された場合、システムイベントログに TBS イベントソースからのイベント ID 16385 がエラーコード 0x80070032 とともに記録されることがあります。これは、ハードウェアプラットフォームがオペレーティングシステムに TCG イベントログを提供していないことを示している可能性があります。プラットフォーム製造元が提供する BIOS のアップグレードをインストールすることで解決する場合もあります。
|
|
指定された出力ポインターが無効です。 |
|
指定されたコンテキストハンドルは、有効なコンテキストを参照していません。 |
|
出力バッファーが小さすぎます。 |
|
出力バッファーが大きすぎます。 |
|
互換性のあるトラステッドプラットフォームモジュール (TPM) セキュリティデバイスが、このコンピューターで見つかりません。 |
|
トラステッドプラットフォームモジュール (TPM) セキュリティデバイスが無効化されています。
Windows Vista with SP1 および Windows Server 2008: この戻り値は利用できません。 |
解説(Remarks)
Tbsi_Get_TCG_Log 関数はシステムの TCG イベントログを返します。バッファーのサイズはイベントの数によって異なります。
Windows 10:
この関数は、ハードウェアの機能とファームウェアの設定に応じて、複数のハッシュアルゴリズムに対応した形式のログを返す場合があります。この形式のログでは、最初のイベントを除く各イベントが 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 アルゴリズムを使用します。
Windows Vista with SP1 および Windows Server 2008: この関数は ACPI テーブルから直接ログを返し、イベントの後ろにある未使用部分も含めて、ACPI が割り当てたバッファー全体を返します。
TCG イベントログ内の Windows 定義イベントは、{Type, Length, Value} のタプルです。ログは、TCG PC Client 仕様の次の TCG_PCR_EVENT 構造体を使用して解析できます。TPM PCP Toolkit と TPM 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 関数を呼び出して取得した必要なバッファーサイズを使用してください。
Windows Vista with SP1 および Windows Server 2008: 長さ 0 のバッファーを指定して Tbsi_Get_TCG_Log 関数を呼び出し、必要なバッファーサイズを取得する方法はサポートされていません。pOutputBuf パラメーターのメモリサイズには、Tbs.h ヘッダーファイルで定義されている定数 TBS_IN_OUT_BUF_SIZE_MAX を使用することをお勧めします。
例
#include <windows.h>
#include <tbs.h>
#pragma comment(lib, "Tbs.lib")
void main()
{
TBS_RESULT result;
TBS_HCONTEXT hContext;
TBS_CONTEXT_PARAMS contextParams;
contextParams.version = TBS_CONTEXT_VERSION_ONE;
result = Tbsi_Context_Create(&contextParams, &hContext);
if (result == TBS_SUCCESS)
{
UINT32 iLogSize = TBS_IN_OUT_BUF_SIZE_MAX;
BYTE* pLogBuffer = new BYTE[iLogSize];
result = Tbsi_Get_TCG_Log(hContext, pLogBuffer, &iLogSize);
}
}
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// tbs.dll
#include <windows.h>
DWORD Tbsi_Get_TCG_Log(
void* hContext,
BYTE* pOutputBuf, // optional
DWORD* pOutputBufLen
);[DllImport("tbs.dll", ExactSpelling = true)]
static extern uint Tbsi_Get_TCG_Log(
IntPtr hContext, // void*
IntPtr pOutputBuf, // BYTE* optional, out
ref uint pOutputBufLen // DWORD* in/out
);<DllImport("tbs.dll", ExactSpelling:=True)>
Public Shared Function Tbsi_Get_TCG_Log(
hContext As IntPtr, ' void*
pOutputBuf As IntPtr, ' BYTE* optional, out
ByRef pOutputBufLen As UInteger ' DWORD* in/out
) As UInteger
End Function' hContext : void*
' pOutputBuf : BYTE* optional, out
' pOutputBufLen : DWORD* in/out
Declare PtrSafe Function Tbsi_Get_TCG_Log Lib "tbs" ( _
ByVal hContext As LongPtr, _
ByVal pOutputBuf As LongPtr, _
ByRef pOutputBufLen 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 = ctypes.windll.tbs.Tbsi_Get_TCG_Log
Tbsi_Get_TCG_Log.restype = wintypes.DWORD
Tbsi_Get_TCG_Log.argtypes = [
ctypes.POINTER(None), # hContext : void*
ctypes.POINTER(ctypes.c_ubyte), # pOutputBuf : BYTE* optional, out
ctypes.POINTER(wintypes.DWORD), # pOutputBufLen : DWORD* in/out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('tbs.dll')
Tbsi_Get_TCG_Log = Fiddle::Function.new(
lib['Tbsi_Get_TCG_Log'],
[
Fiddle::TYPE_VOIDP, # hContext : void*
Fiddle::TYPE_VOIDP, # pOutputBuf : BYTE* optional, out
Fiddle::TYPE_VOIDP, # pOutputBufLen : DWORD* in/out
],
-Fiddle::TYPE_INT)#[link(name = "tbs")]
extern "system" {
fn Tbsi_Get_TCG_Log(
hContext: *mut (), // void*
pOutputBuf: *mut u8, // BYTE* optional, out
pOutputBufLen: *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(IntPtr hContext, IntPtr pOutputBuf, ref uint pOutputBufLen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'tbs_Tbsi_Get_TCG_Log' -Namespace Win32 -PassThru
# $api::Tbsi_Get_TCG_Log(hContext, pOutputBuf, pOutputBufLen)#uselib "tbs.dll"
#func global Tbsi_Get_TCG_Log "Tbsi_Get_TCG_Log" sptr, sptr, sptr
; Tbsi_Get_TCG_Log hContext, varptr(pOutputBuf), varptr(pOutputBufLen) ; 戻り値は stat
; hContext : void* -> "sptr"
; pOutputBuf : BYTE* optional, out -> "sptr"
; pOutputBufLen : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "tbs.dll" #cfunc global Tbsi_Get_TCG_Log "Tbsi_Get_TCG_Log" sptr, var, var ; res = Tbsi_Get_TCG_Log(hContext, pOutputBuf, pOutputBufLen) ; hContext : void* -> "sptr" ; pOutputBuf : BYTE* optional, out -> "var" ; pOutputBufLen : DWORD* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "tbs.dll" #cfunc global Tbsi_Get_TCG_Log "Tbsi_Get_TCG_Log" sptr, sptr, sptr ; res = Tbsi_Get_TCG_Log(hContext, varptr(pOutputBuf), varptr(pOutputBufLen)) ; hContext : void* -> "sptr" ; pOutputBuf : BYTE* optional, out -> "sptr" ; pOutputBufLen : DWORD* in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; DWORD Tbsi_Get_TCG_Log(void* hContext, BYTE* pOutputBuf, DWORD* pOutputBufLen) #uselib "tbs.dll" #cfunc global Tbsi_Get_TCG_Log "Tbsi_Get_TCG_Log" intptr, var, var ; res = Tbsi_Get_TCG_Log(hContext, pOutputBuf, pOutputBufLen) ; hContext : void* -> "intptr" ; pOutputBuf : BYTE* optional, out -> "var" ; pOutputBufLen : DWORD* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD Tbsi_Get_TCG_Log(void* hContext, BYTE* pOutputBuf, DWORD* pOutputBufLen) #uselib "tbs.dll" #cfunc global Tbsi_Get_TCG_Log "Tbsi_Get_TCG_Log" intptr, intptr, intptr ; res = Tbsi_Get_TCG_Log(hContext, varptr(pOutputBuf), varptr(pOutputBufLen)) ; hContext : void* -> "intptr" ; pOutputBuf : BYTE* optional, out -> "intptr" ; pOutputBufLen : DWORD* in/out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
tbs = windows.NewLazySystemDLL("tbs.dll")
procTbsi_Get_TCG_Log = tbs.NewProc("Tbsi_Get_TCG_Log")
)
// hContext (void*), pOutputBuf (BYTE* optional, out), pOutputBufLen (DWORD* in/out)
r1, _, err := procTbsi_Get_TCG_Log.Call(
uintptr(hContext),
uintptr(pOutputBuf),
uintptr(pOutputBufLen),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction Tbsi_Get_TCG_Log(
hContext: Pointer; // void*
pOutputBuf: Pointer; // BYTE* optional, out
pOutputBufLen: Pointer // DWORD* in/out
): DWORD; stdcall;
external 'tbs.dll' name 'Tbsi_Get_TCG_Log';result := DllCall("tbs\Tbsi_Get_TCG_Log"
, "Ptr", hContext ; void*
, "Ptr", pOutputBuf ; BYTE* optional, out
, "Ptr", pOutputBufLen ; DWORD* in/out
, "UInt") ; return: DWORD●Tbsi_Get_TCG_Log(hContext, pOutputBuf, pOutputBufLen) = DLL("tbs.dll", "dword Tbsi_Get_TCG_Log(void*, void*, void*)")
# 呼び出し: Tbsi_Get_TCG_Log(hContext, pOutputBuf, pOutputBufLen)
# hContext : void* -> "void*"
# pOutputBuf : BYTE* optional, out -> "void*"
# pOutputBufLen : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "tbs" fn Tbsi_Get_TCG_Log(
hContext: ?*anyopaque, // void*
pOutputBuf: [*c]u8, // BYTE* optional, out
pOutputBufLen: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) u32;proc Tbsi_Get_TCG_Log(
hContext: pointer, # void*
pOutputBuf: ptr uint8, # BYTE* optional, out
pOutputBufLen: ptr uint32 # DWORD* in/out
): uint32 {.importc: "Tbsi_Get_TCG_Log", stdcall, dynlib: "tbs.dll".}pragma(lib, "tbs");
extern(Windows)
uint Tbsi_Get_TCG_Log(
void* hContext, // void*
ubyte* pOutputBuf, // BYTE* optional, out
uint* pOutputBufLen // DWORD* in/out
);ccall((:Tbsi_Get_TCG_Log, "tbs.dll"), stdcall, UInt32,
(Ptr{Cvoid}, Ptr{UInt8}, Ptr{UInt32}),
hContext, pOutputBuf, pOutputBufLen)
# hContext : void* -> Ptr{Cvoid}
# pOutputBuf : BYTE* optional, out -> Ptr{UInt8}
# pOutputBufLen : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t Tbsi_Get_TCG_Log(
void* hContext,
uint8_t* pOutputBuf,
uint32_t* pOutputBufLen);
]]
local tbs = ffi.load("tbs")
-- tbs.Tbsi_Get_TCG_Log(hContext, pOutputBuf, pOutputBufLen)
-- hContext : void*
-- pOutputBuf : BYTE* optional, out
-- pOutputBufLen : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('tbs.dll');
const Tbsi_Get_TCG_Log = lib.func('__stdcall', 'Tbsi_Get_TCG_Log', 'uint32_t', ['void *', 'uint8_t *', 'uint32_t *']);
// Tbsi_Get_TCG_Log(hContext, pOutputBuf, pOutputBufLen)
// hContext : void* -> 'void *'
// pOutputBuf : BYTE* optional, out -> 'uint8_t *'
// pOutputBufLen : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("tbs.dll", {
Tbsi_Get_TCG_Log: { parameters: ["pointer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.Tbsi_Get_TCG_Log(hContext, pOutputBuf, pOutputBufLen)
// hContext : void* -> "pointer"
// pOutputBuf : BYTE* optional, out -> "pointer"
// pOutputBufLen : DWORD* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t Tbsi_Get_TCG_Log(
void* hContext,
uint8_t* pOutputBuf,
uint32_t* pOutputBufLen);
C, "tbs.dll");
// $ffi->Tbsi_Get_TCG_Log(hContext, pOutputBuf, pOutputBufLen);
// hContext : void*
// pOutputBuf : BYTE* optional, out
// pOutputBufLen : 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(
Pointer hContext, // void*
byte[] pOutputBuf, // BYTE* optional, out
IntByReference pOutputBufLen // DWORD* in/out
);
}@[Link("tbs")]
lib Libtbs
fun Tbsi_Get_TCG_Log = Tbsi_Get_TCG_Log(
hContext : Void*, # void*
pOutputBuf : UInt8*, # BYTE* optional, out
pOutputBufLen : 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_LogNative = Uint32 Function(Pointer<Void>, Pointer<Uint8>, Pointer<Uint32>);
typedef Tbsi_Get_TCG_LogDart = int Function(Pointer<Void>, Pointer<Uint8>, Pointer<Uint32>);
final Tbsi_Get_TCG_Log = DynamicLibrary.open('tbs.dll')
.lookupFunction<Tbsi_Get_TCG_LogNative, Tbsi_Get_TCG_LogDart>('Tbsi_Get_TCG_Log');
// hContext : void* -> Pointer<Void>
// pOutputBuf : BYTE* optional, out -> Pointer<Uint8>
// pOutputBufLen : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function Tbsi_Get_TCG_Log(
hContext: Pointer; // void*
pOutputBuf: Pointer; // BYTE* optional, out
pOutputBufLen: Pointer // DWORD* in/out
): DWORD; stdcall;
external 'tbs.dll' name 'Tbsi_Get_TCG_Log';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "Tbsi_Get_TCG_Log"
c_Tbsi_Get_TCG_Log :: Ptr () -> Ptr Word8 -> Ptr Word32 -> IO Word32
-- hContext : void* -> Ptr ()
-- pOutputBuf : BYTE* optional, out -> Ptr Word8
-- pOutputBufLen : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let tbsi_get_tcg_log =
foreign "Tbsi_Get_TCG_Log"
((ptr void) @-> (ptr uint8_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* hContext : void* -> (ptr void) *)
(* pOutputBuf : BYTE* optional, out -> (ptr uint8_t) *)
(* pOutputBufLen : 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" tbsi-get-tcg-log :convention :stdcall) :uint32
(h-context :pointer) ; void*
(p-output-buf :pointer) ; BYTE* optional, out
(p-output-buf-len :pointer)) ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $Tbsi_Get_TCG_Log = Win32::API::More->new('tbs',
'DWORD Tbsi_Get_TCG_Log(LPVOID hContext, LPVOID pOutputBuf, LPVOID pOutputBufLen)');
# my $ret = $Tbsi_Get_TCG_Log->Call($hContext, $pOutputBuf, $pOutputBufLen);
# hContext : void* -> LPVOID
# pOutputBuf : BYTE* optional, out -> LPVOID
# pOutputBufLen : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。