blob: 031b206740ed09d4137012f3c2a07a283070d6d1 [file] [log] [blame]
Ronak Kanabar1ae366f2023-06-07 01:21:56 +05301/** @file
2 TPM Specification data structures (TCG TPM Specification Version 1.2 Revision 103)
3 See http://trustedcomputinggroup.org for latest specification updates
4
5 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
6 SPDX-License-Identifier: BSD-2-Clause-Patent
7**/
8
9#ifndef _TPM12_H_
10#define _TPM12_H_
11
12///
13/// The start of TPM return codes
14///
15#define TPM_BASE 0
16
17//
18// All structures MUST be packed on a byte boundary.
19//
20
21#pragma pack (1)
22
23//
24// Part 2, section 2.2.3: Helper redefinitions
25//
26///
27/// Indicates the conditions where it is required that authorization be presented
28///
29typedef UINT8 TPM_AUTH_DATA_USAGE;
30///
31/// The information as to what the payload is in an encrypted structure
32///
33typedef UINT8 TPM_PAYLOAD_TYPE;
34///
35/// The version info breakdown
36///
37typedef UINT8 TPM_VERSION_BYTE;
38///
39/// The state of the dictionary attack mitigation logic
40///
41typedef UINT8 TPM_DA_STATE;
42///
43/// The request or response authorization type
44///
45typedef UINT16 TPM_TAG;
46///
47/// The protocol in use
48///
49typedef UINT16 TPM_PROTOCOL_ID;
50///
51/// Indicates the start state
52///
53typedef UINT16 TPM_STARTUP_TYPE;
54///
55/// The definition of the encryption scheme
56///
57typedef UINT16 TPM_ENC_SCHEME;
58///
59/// The definition of the signature scheme
60///
61typedef UINT16 TPM_SIG_SCHEME;
62///
63/// The definition of the migration scheme
64///
65typedef UINT16 TPM_MIGRATE_SCHEME;
66///
67/// Sets the state of the physical presence mechanism
68///
69typedef UINT16 TPM_PHYSICAL_PRESENCE;
70///
71/// Indicates the types of entity that are supported by the TPM
72///
73typedef UINT16 TPM_ENTITY_TYPE;
74///
75/// Indicates the permitted usage of the key
76///
77typedef UINT16 TPM_KEY_USAGE;
78///
79/// The type of asymmetric encrypted structure in use by the endorsement key
80///
81typedef UINT16 TPM_EK_TYPE;
82///
83/// The tag for the structure
84///
85typedef UINT16 TPM_STRUCTURE_TAG;
86///
87/// The platform specific spec to which the information relates to
88///
89typedef UINT16 TPM_PLATFORM_SPECIFIC;
90///
91/// The command ordinal
92///
93typedef UINT32 TPM_COMMAND_CODE;
94///
95/// Identifies a TPM capability area
96///
97typedef UINT32 TPM_CAPABILITY_AREA;
98///
99/// Indicates information regarding a key
100///
101typedef UINT32 TPM_KEY_FLAGS;
102///
103/// Indicates the type of algorithm
104///
105typedef UINT32 TPM_ALGORITHM_ID;
106///
107/// The locality modifier
108///
109typedef UINT32 TPM_MODIFIER_INDICATOR;
110///
111/// The actual number of a counter
112///
113typedef UINT32 TPM_ACTUAL_COUNT;
114///
115/// Attributes that define what options are in use for a transport session
116///
117typedef UINT32 TPM_TRANSPORT_ATTRIBUTES;
118///
119/// Handle to an authorization session
120///
121typedef UINT32 TPM_AUTHHANDLE;
122///
123/// Index to a DIR register
124///
125typedef UINT32 TPM_DIRINDEX;
126///
127/// The area where a key is held assigned by the TPM
128///
129typedef UINT32 TPM_KEY_HANDLE;
130///
131/// Index to a PCR register
132///
133typedef UINT32 TPM_PCRINDEX;
134///
135/// The return code from a function
136///
137typedef UINT32 TPM_RESULT;
138///
139/// The types of resources that a TPM may have using internal resources
140///
141typedef UINT32 TPM_RESOURCE_TYPE;
142///
143/// Allows for controlling of the key when loaded and how to handle TPM_Startup issues
144///
145typedef UINT32 TPM_KEY_CONTROL;
146///
147/// The index into the NV storage area
148///
149typedef UINT32 TPM_NV_INDEX;
150///
151/// The family ID. Family IDs are automatically assigned a sequence number by the TPM.
152/// A trusted process can set the FamilyID value in an individual row to NULL, which
153/// invalidates that row. The family ID resets to NULL on each change of TPM Owner.
154///
155typedef UINT32 TPM_FAMILY_ID;
156///
157/// IA value used as a label for the most recent verification of this family. Set to zero when not in use.
158///
159typedef UINT32 TPM_FAMILY_VERIFICATION;
160///
161/// How the TPM handles var
162///
163typedef UINT32 TPM_STARTUP_EFFECTS;
164///
165/// The mode of a symmetric encryption
166///
167typedef UINT32 TPM_SYM_MODE;
168///
169/// The family flags
170///
171typedef UINT32 TPM_FAMILY_FLAGS;
172///
173/// The index value for the delegate NV table
174///
175typedef UINT32 TPM_DELEGATE_INDEX;
176///
177/// The restrictions placed on delegation of CMK commands
178///
179typedef UINT32 TPM_CMK_DELEGATE;
180///
181/// The ID value of a monotonic counter
182///
183typedef UINT32 TPM_COUNT_ID;
184///
185/// A command to execute
186///
187typedef UINT32 TPM_REDIT_COMMAND;
188///
189/// A transport session handle
190///
191typedef UINT32 TPM_TRANSHANDLE;
192///
193/// A generic handle could be key, transport etc
194///
195typedef UINT32 TPM_HANDLE;
196///
197/// What operation is happening
198///
199typedef UINT32 TPM_FAMILY_OPERATION;
200
201//
202// Part 2, section 2.2.4: Vendor specific
203// The following defines allow for the quick specification of a
204// vendor specific item.
205//
206#define TPM_Vendor_Specific32 ((UINT32) 0x00000400)
207#define TPM_Vendor_Specific8 ((UINT8) 0x80)
208
209//
210// Part 2, section 3.1: TPM_STRUCTURE_TAG
211//
212#define TPM_TAG_CONTEXTBLOB ((TPM_STRUCTURE_TAG) 0x0001)
213#define TPM_TAG_CONTEXT_SENSITIVE ((TPM_STRUCTURE_TAG) 0x0002)
214#define TPM_TAG_CONTEXTPOINTER ((TPM_STRUCTURE_TAG) 0x0003)
215#define TPM_TAG_CONTEXTLIST ((TPM_STRUCTURE_TAG) 0x0004)
216#define TPM_TAG_SIGNINFO ((TPM_STRUCTURE_TAG) 0x0005)
217#define TPM_TAG_PCR_INFO_LONG ((TPM_STRUCTURE_TAG) 0x0006)
218#define TPM_TAG_PERSISTENT_FLAGS ((TPM_STRUCTURE_TAG) 0x0007)
219#define TPM_TAG_VOLATILE_FLAGS ((TPM_STRUCTURE_TAG) 0x0008)
220#define TPM_TAG_PERSISTENT_DATA ((TPM_STRUCTURE_TAG) 0x0009)
221#define TPM_TAG_VOLATILE_DATA ((TPM_STRUCTURE_TAG) 0x000A)
222#define TPM_TAG_SV_DATA ((TPM_STRUCTURE_TAG) 0x000B)
223#define TPM_TAG_EK_BLOB ((TPM_STRUCTURE_TAG) 0x000C)
224#define TPM_TAG_EK_BLOB_AUTH ((TPM_STRUCTURE_TAG) 0x000D)
225#define TPM_TAG_COUNTER_VALUE ((TPM_STRUCTURE_TAG) 0x000E)
226#define TPM_TAG_TRANSPORT_INTERNAL ((TPM_STRUCTURE_TAG) 0x000F)
227#define TPM_TAG_TRANSPORT_LOG_IN ((TPM_STRUCTURE_TAG) 0x0010)
228#define TPM_TAG_TRANSPORT_LOG_OUT ((TPM_STRUCTURE_TAG) 0x0011)
229#define TPM_TAG_AUDIT_EVENT_IN ((TPM_STRUCTURE_TAG) 0x0012)
230#define TPM_TAG_AUDIT_EVENT_OUT ((TPM_STRUCTURE_TAG) 0x0013)
231#define TPM_TAG_CURRENT_TICKS ((TPM_STRUCTURE_TAG) 0x0014)
232#define TPM_TAG_KEY ((TPM_STRUCTURE_TAG) 0x0015)
233#define TPM_TAG_STORED_DATA12 ((TPM_STRUCTURE_TAG) 0x0016)
234#define TPM_TAG_NV_ATTRIBUTES ((TPM_STRUCTURE_TAG) 0x0017)
235#define TPM_TAG_NV_DATA_PUBLIC ((TPM_STRUCTURE_TAG) 0x0018)
236#define TPM_TAG_NV_DATA_SENSITIVE ((TPM_STRUCTURE_TAG) 0x0019)
237#define TPM_TAG_DELEGATIONS ((TPM_STRUCTURE_TAG) 0x001A)
238#define TPM_TAG_DELEGATE_PUBLIC ((TPM_STRUCTURE_TAG) 0x001B)
239#define TPM_TAG_DELEGATE_TABLE_ROW ((TPM_STRUCTURE_TAG) 0x001C)
240#define TPM_TAG_TRANSPORT_AUTH ((TPM_STRUCTURE_TAG) 0x001D)
241#define TPM_TAG_TRANSPORT_PUBLIC ((TPM_STRUCTURE_TAG) 0x001E)
242#define TPM_TAG_PERMANENT_FLAGS ((TPM_STRUCTURE_TAG) 0x001F)
243#define TPM_TAG_STCLEAR_FLAGS ((TPM_STRUCTURE_TAG) 0x0020)
244#define TPM_TAG_STANY_FLAGS ((TPM_STRUCTURE_TAG) 0x0021)
245#define TPM_TAG_PERMANENT_DATA ((TPM_STRUCTURE_TAG) 0x0022)
246#define TPM_TAG_STCLEAR_DATA ((TPM_STRUCTURE_TAG) 0x0023)
247#define TPM_TAG_STANY_DATA ((TPM_STRUCTURE_TAG) 0x0024)
248#define TPM_TAG_FAMILY_TABLE_ENTRY ((TPM_STRUCTURE_TAG) 0x0025)
249#define TPM_TAG_DELEGATE_SENSITIVE ((TPM_STRUCTURE_TAG) 0x0026)
250#define TPM_TAG_DELG_KEY_BLOB ((TPM_STRUCTURE_TAG) 0x0027)
251#define TPM_TAG_KEY12 ((TPM_STRUCTURE_TAG) 0x0028)
252#define TPM_TAG_CERTIFY_INFO2 ((TPM_STRUCTURE_TAG) 0x0029)
253#define TPM_TAG_DELEGATE_OWNER_BLOB ((TPM_STRUCTURE_TAG) 0x002A)
254#define TPM_TAG_EK_BLOB_ACTIVATE ((TPM_STRUCTURE_TAG) 0x002B)
255#define TPM_TAG_DAA_BLOB ((TPM_STRUCTURE_TAG) 0x002C)
256#define TPM_TAG_DAA_CONTEXT ((TPM_STRUCTURE_TAG) 0x002D)
257#define TPM_TAG_DAA_ENFORCE ((TPM_STRUCTURE_TAG) 0x002E)
258#define TPM_TAG_DAA_ISSUER ((TPM_STRUCTURE_TAG) 0x002F)
259#define TPM_TAG_CAP_VERSION_INFO ((TPM_STRUCTURE_TAG) 0x0030)
260#define TPM_TAG_DAA_SENSITIVE ((TPM_STRUCTURE_TAG) 0x0031)
261#define TPM_TAG_DAA_TPM ((TPM_STRUCTURE_TAG) 0x0032)
262#define TPM_TAG_CMK_MIGAUTH ((TPM_STRUCTURE_TAG) 0x0033)
263#define TPM_TAG_CMK_SIGTICKET ((TPM_STRUCTURE_TAG) 0x0034)
264#define TPM_TAG_CMK_MA_APPROVAL ((TPM_STRUCTURE_TAG) 0x0035)
265#define TPM_TAG_QUOTE_INFO2 ((TPM_STRUCTURE_TAG) 0x0036)
266#define TPM_TAG_DA_INFO ((TPM_STRUCTURE_TAG) 0x0037)
267#define TPM_TAG_DA_LIMITED ((TPM_STRUCTURE_TAG) 0x0038)
268#define TPM_TAG_DA_ACTION_TYPE ((TPM_STRUCTURE_TAG) 0x0039)
269
270//
271// Part 2, section 4: TPM Types
272//
273
274//
275// Part 2, section 4.1: TPM_RESOURCE_TYPE
276//
277#define TPM_RT_KEY ((TPM_RESOURCE_TYPE) 0x00000001) ///< The handle is a key handle and is the result of a LoadKey type operation
278#define TPM_RT_AUTH ((TPM_RESOURCE_TYPE) 0x00000002) ///< The handle is an authorization handle. Auth handles come from TPM_OIAP, TPM_OSAP and TPM_DSAP
279#define TPM_RT_HASH ((TPM_RESOURCE_TYPE) 0x00000003) ///< Reserved for hashes
280#define TPM_RT_TRANS ((TPM_RESOURCE_TYPE) 0x00000004) ///< The handle is for a transport session. Transport handles come from TPM_EstablishTransport
281#define TPM_RT_CONTEXT ((TPM_RESOURCE_TYPE) 0x00000005) ///< Resource wrapped and held outside the TPM using the context save/restore commands
282#define TPM_RT_COUNTER ((TPM_RESOURCE_TYPE) 0x00000006) ///< Reserved for counters
283#define TPM_RT_DELEGATE ((TPM_RESOURCE_TYPE) 0x00000007) ///< The handle is for a delegate row. These are the internal rows held in NV storage by the TPM
284#define TPM_RT_DAA_TPM ((TPM_RESOURCE_TYPE) 0x00000008) ///< The value is a DAA TPM specific blob
285#define TPM_RT_DAA_V0 ((TPM_RESOURCE_TYPE) 0x00000009) ///< The value is a DAA V0 parameter
286#define TPM_RT_DAA_V1 ((TPM_RESOURCE_TYPE) 0x0000000A) ///< The value is a DAA V1 parameter
287
288//
289// Part 2, section 4.2: TPM_PAYLOAD_TYPE
290//
291#define TPM_PT_ASYM ((TPM_PAYLOAD_TYPE) 0x01) ///< The entity is an asymmetric key
292#define TPM_PT_BIND ((TPM_PAYLOAD_TYPE) 0x02) ///< The entity is bound data
293#define TPM_PT_MIGRATE ((TPM_PAYLOAD_TYPE) 0x03) ///< The entity is a migration blob
294#define TPM_PT_MAINT ((TPM_PAYLOAD_TYPE) 0x04) ///< The entity is a maintenance blob
295#define TPM_PT_SEAL ((TPM_PAYLOAD_TYPE) 0x05) ///< The entity is sealed data
296#define TPM_PT_MIGRATE_RESTRICTED ((TPM_PAYLOAD_TYPE) 0x06) ///< The entity is a restricted-migration asymmetric key
297#define TPM_PT_MIGRATE_EXTERNAL ((TPM_PAYLOAD_TYPE) 0x07) ///< The entity is a external migratable key
298#define TPM_PT_CMK_MIGRATE ((TPM_PAYLOAD_TYPE) 0x08) ///< The entity is a CMK migratable blob
299#define TPM_PT_VENDOR_SPECIFIC ((TPM_PAYLOAD_TYPE) 0x80) ///< 0x80 - 0xFF Vendor specific payloads
300
301//
302// Part 2, section 4.3: TPM_ENTITY_TYPE
303//
304#define TPM_ET_KEYHANDLE ((UINT16) 0x0001) ///< The entity is a keyHandle or key
305#define TPM_ET_OWNER ((UINT16) 0x0002) ///< The entity is the TPM Owner
306#define TPM_ET_DATA ((UINT16) 0x0003) ///< The entity is some data
307#define TPM_ET_SRK ((UINT16) 0x0004) ///< The entity is the SRK
308#define TPM_ET_KEY ((UINT16) 0x0005) ///< The entity is a key or keyHandle
309#define TPM_ET_REVOKE ((UINT16) 0x0006) ///< The entity is the RevokeTrust value
310#define TPM_ET_DEL_OWNER_BLOB ((UINT16) 0x0007) ///< The entity is a delegate owner blob
311#define TPM_ET_DEL_ROW ((UINT16) 0x0008) ///< The entity is a delegate row
312#define TPM_ET_DEL_KEY_BLOB ((UINT16) 0x0009) ///< The entity is a delegate key blob
313#define TPM_ET_COUNTER ((UINT16) 0x000A) ///< The entity is a counter
314#define TPM_ET_NV ((UINT16) 0x000B) ///< The entity is a NV index
315#define TPM_ET_OPERATOR ((UINT16) 0x000C) ///< The entity is the operator
316#define TPM_ET_RESERVED_HANDLE ((UINT16) 0x0040) ///< Reserved. This value avoids collisions with the handle MSB setting.
317//
318// TPM_ENTITY_TYPE MSB Values: The MSB is used to indicate the ADIP encryption sheme when applicable
319//
320#define TPM_ET_XOR ((UINT16) 0x0000) ///< ADIP encryption scheme: XOR
321#define TPM_ET_AES128 ((UINT16) 0x0006) ///< ADIP encryption scheme: AES 128 bits
322
323//
324// Part 2, section 4.4.1: Reserved Key Handles
325//
326#define TPM_KH_SRK ((TPM_KEY_HANDLE) 0x40000000) ///< The handle points to the SRK
327#define TPM_KH_OWNER ((TPM_KEY_HANDLE) 0x40000001) ///< The handle points to the TPM Owner
328#define TPM_KH_REVOKE ((TPM_KEY_HANDLE) 0x40000002) ///< The handle points to the RevokeTrust value
329#define TPM_KH_TRANSPORT ((TPM_KEY_HANDLE) 0x40000003) ///< The handle points to the EstablishTransport static authorization
330#define TPM_KH_OPERATOR ((TPM_KEY_HANDLE) 0x40000004) ///< The handle points to the Operator auth
331#define TPM_KH_ADMIN ((TPM_KEY_HANDLE) 0x40000005) ///< The handle points to the delegation administration auth
332#define TPM_KH_EK ((TPM_KEY_HANDLE) 0x40000006) ///< The handle points to the PUBEK, only usable with TPM_OwnerReadInternalPub
333
334//
335// Part 2, section 4.5: TPM_STARTUP_TYPE
336//
337#define TPM_ST_CLEAR ((TPM_STARTUP_TYPE) 0x0001) ///< The TPM is starting up from a clean state
338#define TPM_ST_STATE ((TPM_STARTUP_TYPE) 0x0002) ///< The TPM is starting up from a saved state
339#define TPM_ST_DEACTIVATED ((TPM_STARTUP_TYPE) 0x0003) ///< The TPM is to startup and set the deactivated flag to TRUE
340
341//
342// Part 2, section 4.6: TPM_STATUP_EFFECTS
343// The table makeup is still an open issue.
344//
345
346//
347// Part 2, section 4.7: TPM_PROTOCOL_ID
348//
349#define TPM_PID_OIAP ((TPM_PROTOCOL_ID) 0x0001) ///< The OIAP protocol.
350#define TPM_PID_OSAP ((TPM_PROTOCOL_ID) 0x0002) ///< The OSAP protocol.
351#define TPM_PID_ADIP ((TPM_PROTOCOL_ID) 0x0003) ///< The ADIP protocol.
352#define TPM_PID_ADCP ((TPM_PROTOCOL_ID) 0x0004) ///< The ADCP protocol.
353#define TPM_PID_OWNER ((TPM_PROTOCOL_ID) 0x0005) ///< The protocol for taking ownership of a TPM.
354#define TPM_PID_DSAP ((TPM_PROTOCOL_ID) 0x0006) ///< The DSAP protocol
355#define TPM_PID_TRANSPORT ((TPM_PROTOCOL_ID) 0x0007) ///< The transport protocol
356
357//
358// Part 2, section 4.8: TPM_ALGORITHM_ID
359// The TPM MUST support the algorithms TPM_ALG_RSA, TPM_ALG_SHA, TPM_ALG_HMAC,
360// TPM_ALG_MGF1
361//
362#define TPM_ALG_RSA ((TPM_ALGORITHM_ID) 0x00000001) ///< The RSA algorithm.
363#define TPM_ALG_DES ((TPM_ALGORITHM_ID) 0x00000002) ///< The DES algorithm
364#define TPM_ALG_3DES ((TPM_ALGORITHM_ID) 0x00000003) ///< The 3DES algorithm in EDE mode
365#define TPM_ALG_SHA ((TPM_ALGORITHM_ID) 0x00000004) ///< The SHA1 algorithm
366#define TPM_ALG_HMAC ((TPM_ALGORITHM_ID) 0x00000005) ///< The RFC 2104 HMAC algorithm
367#define TPM_ALG_AES128 ((TPM_ALGORITHM_ID) 0x00000006) ///< The AES algorithm, key size 128
368#define TPM_ALG_MGF1 ((TPM_ALGORITHM_ID) 0x00000007) ///< The XOR algorithm using MGF1 to create a string the size of the encrypted block
369#define TPM_ALG_AES192 ((TPM_ALGORITHM_ID) 0x00000008) ///< AES, key size 192
370#define TPM_ALG_AES256 ((TPM_ALGORITHM_ID) 0x00000009) ///< AES, key size 256
371#define TPM_ALG_XOR ((TPM_ALGORITHM_ID) 0x0000000A) ///< XOR using the rolling nonces
372
373//
374// Part 2, section 4.9: TPM_PHYSICAL_PRESENCE
375//
376#define TPM_PHYSICAL_PRESENCE_HW_DISABLE ((TPM_PHYSICAL_PRESENCE) 0x0200) ///< Sets the physicalPresenceHWEnable to FALSE
377#define TPM_PHYSICAL_PRESENCE_CMD_DISABLE ((TPM_PHYSICAL_PRESENCE) 0x0100) ///< Sets the physicalPresenceCMDEnable to FALSE
378#define TPM_PHYSICAL_PRESENCE_LIFETIME_LOCK ((TPM_PHYSICAL_PRESENCE) 0x0080) ///< Sets the physicalPresenceLifetimeLock to TRUE
379#define TPM_PHYSICAL_PRESENCE_HW_ENABLE ((TPM_PHYSICAL_PRESENCE) 0x0040) ///< Sets the physicalPresenceHWEnable to TRUE
380#define TPM_PHYSICAL_PRESENCE_CMD_ENABLE ((TPM_PHYSICAL_PRESENCE) 0x0020) ///< Sets the physicalPresenceCMDEnable to TRUE
381#define TPM_PHYSICAL_PRESENCE_NOTPRESENT ((TPM_PHYSICAL_PRESENCE) 0x0010) ///< Sets PhysicalPresence = FALSE
382#define TPM_PHYSICAL_PRESENCE_PRESENT ((TPM_PHYSICAL_PRESENCE) 0x0008) ///< Sets PhysicalPresence = TRUE
383#define TPM_PHYSICAL_PRESENCE_LOCK ((TPM_PHYSICAL_PRESENCE) 0x0004) ///< Sets PhysicalPresenceLock = TRUE
384
385//
386// Part 2, section 4.10: TPM_MIGRATE_SCHEME
387//
388#define TPM_MS_MIGRATE ((TPM_MIGRATE_SCHEME) 0x0001) ///< A public key that can be used with all TPM migration commands other than 'ReWrap' mode.
389#define TPM_MS_REWRAP ((TPM_MIGRATE_SCHEME) 0x0002) ///< A public key that can be used for the ReWrap mode of TPM_CreateMigrationBlob.
390#define TPM_MS_MAINT ((TPM_MIGRATE_SCHEME) 0x0003) ///< A public key that can be used for the Maintenance commands
391#define TPM_MS_RESTRICT_MIGRATE ((TPM_MIGRATE_SCHEME) 0x0004) ///< The key is to be migrated to a Migration Authority.
392#define TPM_MS_RESTRICT_APPROVE_DOUBLE ((TPM_MIGRATE_SCHEME) 0x0005) ///< The key is to be migrated to an entity approved by a Migration Authority using double wrapping
393
394//
395// Part 2, section 4.11: TPM_EK_TYPE
396//
397#define TPM_EK_TYPE_ACTIVATE ((TPM_EK_TYPE) 0x0001) ///< The blob MUST be TPM_EK_BLOB_ACTIVATE
398#define TPM_EK_TYPE_AUTH ((TPM_EK_TYPE) 0x0002) ///< The blob MUST be TPM_EK_BLOB_AUTH
399
400//
401// Part 2, section 4.12: TPM_PLATFORM_SPECIFIC
402//
403#define TPM_PS_PC_11 ((TPM_PLATFORM_SPECIFIC) 0x0001) ///< PC Specific version 1.1
404#define TPM_PS_PC_12 ((TPM_PLATFORM_SPECIFIC) 0x0002) ///< PC Specific version 1.2
405#define TPM_PS_PDA_12 ((TPM_PLATFORM_SPECIFIC) 0x0003) ///< PDA Specific version 1.2
406#define TPM_PS_Server_12 ((TPM_PLATFORM_SPECIFIC) 0x0004) ///< Server Specific version 1.2
407#define TPM_PS_Mobile_12 ((TPM_PLATFORM_SPECIFIC) 0x0005) ///< Mobil Specific version 1.2
408
409//
410// Part 2, section 5: Basic Structures
411//
412
413///
414/// Part 2, section 5.1: TPM_STRUCT_VER
415///
416typedef struct tdTPM_STRUCT_VER {
417 UINT8 major;
418 UINT8 minor;
419 UINT8 revMajor;
420 UINT8 revMinor;
421} TPM_STRUCT_VER;
422
423///
424/// Part 2, section 5.3: TPM_VERSION
425///
426typedef struct tdTPM_VERSION {
427 TPM_VERSION_BYTE major;
428 TPM_VERSION_BYTE minor;
429 UINT8 revMajor;
430 UINT8 revMinor;
431} TPM_VERSION;
432
433#define TPM_SHA1_160_HASH_LEN 0x14
434#define TPM_SHA1BASED_NONCE_LEN TPM_SHA1_160_HASH_LEN
435
436///
437/// Part 2, section 5.4: TPM_DIGEST
438///
439typedef struct tdTPM_DIGEST {
440 UINT8 digest[TPM_SHA1_160_HASH_LEN];
441} TPM_DIGEST;
442
443///
444/// This SHALL be the digest of the chosen identityLabel and privacyCA for a new TPM identity
445///
446typedef TPM_DIGEST TPM_CHOSENID_HASH;
447///
448/// This SHALL be the hash of a list of PCR indexes and PCR values that a key or data is bound to
449///
450typedef TPM_DIGEST TPM_COMPOSITE_HASH;
451///
452/// This SHALL be the value of a DIR register
453///
454typedef TPM_DIGEST TPM_DIRVALUE;
455
456typedef TPM_DIGEST TPM_HMAC;
457///
458/// The value inside of the PCR
459///
460typedef TPM_DIGEST TPM_PCRVALUE;
461///
462/// This SHALL be the value of the current internal audit state
463///
464typedef TPM_DIGEST TPM_AUDITDIGEST;
465
466///
467/// Part 2, section 5.5: TPM_NONCE
468///
469typedef struct tdTPM_NONCE {
470 UINT8 nonce[20];
471} TPM_NONCE;
472
473///
474/// This SHALL be a random value generated by a TPM immediately after the EK is installed
475/// in that TPM, whenever an EK is installed in that TPM
476///
477typedef TPM_NONCE TPM_DAA_TPM_SEED;
478///
479/// This SHALL be a random value
480///
481typedef TPM_NONCE TPM_DAA_CONTEXT_SEED;
482
483//
484// Part 2, section 5.6: TPM_AUTHDATA
485//
486///
487/// The AuthData data is the information that is saved or passed to provide proof of ownership
488/// 296 of an entity
489///
490typedef UINT8 tdTPM_AUTHDATA[20];
491
492typedef tdTPM_AUTHDATA TPM_AUTHDATA;
493///
494/// A secret plaintext value used in the authorization process
495///
496typedef TPM_AUTHDATA TPM_SECRET;
497///
498/// A ciphertext (encrypted) version of AuthData data. The encryption mechanism depends on the context
499///
500typedef TPM_AUTHDATA TPM_ENCAUTH;
501
502///
503/// Part 2, section 5.7: TPM_KEY_HANDLE_LIST
504/// Size of handle is loaded * sizeof(TPM_KEY_HANDLE)
505///
506typedef struct tdTPM_KEY_HANDLE_LIST {
507 UINT16 loaded;
508 TPM_KEY_HANDLE handle[1];
509} TPM_KEY_HANDLE_LIST;
510
511//
512// Part 2, section 5.8: TPM_KEY_USAGE values
513//
514///
515/// TPM_KEY_SIGNING SHALL indicate a signing key. The [private] key SHALL be
516/// used for signing operations, only. This means that it MUST be a leaf of the
517/// Protected Storage key hierarchy.
518///
519#define TPM_KEY_SIGNING ((UINT16) 0x0010)
520///
521/// TPM_KEY_STORAGE SHALL indicate a storage key. The key SHALL be used to wrap
522/// and unwrap other keys in the Protected Storage hierarchy
523///
524#define TPM_KEY_STORAGE ((UINT16) 0x0011)
525///
526/// TPM_KEY_IDENTITY SHALL indicate an identity key. The key SHALL be used for
527/// operations that require a TPM identity, only.
528///
529#define TPM_KEY_IDENTITY ((UINT16) 0x0012)
530///
531/// TPM_KEY_AUTHCHANGE SHALL indicate an ephemeral key that is in use during
532/// the ChangeAuthAsym process, only.
533///
534#define TPM_KEY_AUTHCHANGE ((UINT16) 0x0013)
535///
536/// TPM_KEY_BIND SHALL indicate a key that can be used for TPM_Bind and
537/// TPM_Unbind operations only.
538///
539#define TPM_KEY_BIND ((UINT16) 0x0014)
540///
541/// TPM_KEY_LEGACY SHALL indicate a key that can perform signing and binding
542/// operations. The key MAY be used for both signing and binding operations.
543/// The TPM_KEY_LEGACY key type is to allow for use by applications where both
544/// signing and encryption operations occur with the same key. The use of this
545/// key type is not recommended TPM_KEY_MIGRATE 0x0016 This SHALL indicate a
546/// key in use for TPM_MigrateKey
547///
548#define TPM_KEY_LEGACY ((UINT16) 0x0015)
549///
550/// TPM_KEY_MIGRAGE SHALL indicate a key in use for TPM_MigrateKey
551///
552#define TPM_KEY_MIGRATE ((UINT16) 0x0016)
553
554//
555// Part 2, section 5.8.1: Mandatory Key Usage Schemes
556//
557
558#define TPM_ES_NONE ((TPM_ENC_SCHEME) 0x0001)
559#define TPM_ES_RSAESPKCSv15 ((TPM_ENC_SCHEME) 0x0002)
560#define TPM_ES_RSAESOAEP_SHA1_MGF1 ((TPM_ENC_SCHEME) 0x0003)
561#define TPM_ES_SYM_CNT ((TPM_ENC_SCHEME) 0x0004) ///< rev94 defined
562#define TPM_ES_SYM_CTR ((TPM_ENC_SCHEME) 0x0004)
563#define TPM_ES_SYM_OFB ((TPM_ENC_SCHEME) 0x0005)
564
565#define TPM_SS_NONE ((TPM_SIG_SCHEME) 0x0001)
566#define TPM_SS_RSASSAPKCS1v15_SHA1 ((TPM_SIG_SCHEME) 0x0002)
567#define TPM_SS_RSASSAPKCS1v15_DER ((TPM_SIG_SCHEME) 0x0003)
568#define TPM_SS_RSASSAPKCS1v15_INFO ((TPM_SIG_SCHEME) 0x0004)
569
570//
571// Part 2, section 5.9: TPM_AUTH_DATA_USAGE values
572//
573#define TPM_AUTH_NEVER ((TPM_AUTH_DATA_USAGE) 0x00)
574#define TPM_AUTH_ALWAYS ((TPM_AUTH_DATA_USAGE) 0x01)
575#define TPM_AUTH_PRIV_USE_ONLY ((TPM_AUTH_DATA_USAGE) 0x03)
576
577///
578/// Part 2, section 5.10: TPM_KEY_FLAGS
579///
580typedef enum tdTPM_KEY_FLAGS {
581 redirection = 0x00000001,
582 migratable = 0x00000002,
583 isVolatile = 0x00000004,
584 pcrIgnoredOnRead = 0x00000008,
585 migrateAuthority = 0x00000010
586} TPM_KEY_FLAGS_BITS;
587
588///
589/// Part 2, section 5.11: TPM_CHANGEAUTH_VALIDATE
590///
591typedef struct tdTPM_CHANGEAUTH_VALIDATE {
592 TPM_SECRET newAuthSecret;
593 TPM_NONCE n1;
594} TPM_CHANGEAUTH_VALIDATE;
595
596///
597/// Part 2, section 5.12: TPM_MIGRATIONKEYAUTH
598/// declared after section 10 to catch declaration of TPM_PUBKEY
599///
600/// Part 2 section 10.1: TPM_KEY_PARMS
601/// [size_is(parmSize)] BYTE* parms;
602///
603typedef struct tdTPM_KEY_PARMS {
604 TPM_ALGORITHM_ID algorithmID;
605 TPM_ENC_SCHEME encScheme;
606 TPM_SIG_SCHEME sigScheme;
607 UINT32 parmSize;
608 UINT8 *parms;
609} TPM_KEY_PARMS;
610
611///
612/// Part 2, section 10.4: TPM_STORE_PUBKEY
613///
614typedef struct tdTPM_STORE_PUBKEY {
615 UINT32 keyLength;
616 UINT8 key[1];
617} TPM_STORE_PUBKEY;
618
619///
620/// Part 2, section 10.5: TPM_PUBKEY
621///
622typedef struct tdTPM_PUBKEY {
623 TPM_KEY_PARMS algorithmParms;
624 TPM_STORE_PUBKEY pubKey;
625} TPM_PUBKEY;
626
627///
628/// Part 2, section 5.12: TPM_MIGRATIONKEYAUTH
629///
630typedef struct tdTPM_MIGRATIONKEYAUTH {
631 TPM_PUBKEY migrationKey;
632 TPM_MIGRATE_SCHEME migrationScheme;
633 TPM_DIGEST digest;
634} TPM_MIGRATIONKEYAUTH;
635
636///
637/// Part 2, section 5.13: TPM_COUNTER_VALUE
638///
639typedef struct tdTPM_COUNTER_VALUE {
640 TPM_STRUCTURE_TAG tag;
641 UINT8 label[4];
642 TPM_ACTUAL_COUNT counter;
643} TPM_COUNTER_VALUE;
644
645///
646/// Part 2, section 5.14: TPM_SIGN_INFO
647/// Size of data indicated by dataLen
648///
649typedef struct tdTPM_SIGN_INFO {
650 TPM_STRUCTURE_TAG tag;
651 UINT8 fixed[4];
652 TPM_NONCE replay;
653 UINT32 dataLen;
654 UINT8 *data;
655} TPM_SIGN_INFO;
656
657///
658/// Part 2, section 5.15: TPM_MSA_COMPOSITE
659/// Number of migAuthDigest indicated by MSAlist
660///
661typedef struct tdTPM_MSA_COMPOSITE {
662 UINT32 MSAlist;
663 TPM_DIGEST migAuthDigest[1];
664} TPM_MSA_COMPOSITE;
665
666///
667/// Part 2, section 5.16: TPM_CMK_AUTH
668///
669typedef struct tdTPM_CMK_AUTH {
670 TPM_DIGEST migrationAuthorityDigest;
671 TPM_DIGEST destinationKeyDigest;
672 TPM_DIGEST sourceKeyDigest;
673} TPM_CMK_AUTH;
674
675//
676// Part 2, section 5.17: TPM_CMK_DELEGATE
677//
678#define TPM_CMK_DELEGATE_SIGNING ((TPM_CMK_DELEGATE) BIT31)
679#define TPM_CMK_DELEGATE_STORAGE ((TPM_CMK_DELEGATE) BIT30)
680#define TPM_CMK_DELEGATE_BIND ((TPM_CMK_DELEGATE) BIT29)
681#define TPM_CMK_DELEGATE_LEGACY ((TPM_CMK_DELEGATE) BIT28)
682#define TPM_CMK_DELEGATE_MIGRATE ((TPM_CMK_DELEGATE) BIT27)
683
684///
685/// Part 2, section 5.18: TPM_SELECT_SIZE
686///
687typedef struct tdTPM_SELECT_SIZE {
688 UINT8 major;
689 UINT8 minor;
690 UINT16 reqSize;
691} TPM_SELECT_SIZE;
692
693///
694/// Part 2, section 5,19: TPM_CMK_MIGAUTH
695///
696typedef struct tdTPM_CMK_MIGAUTH {
697 TPM_STRUCTURE_TAG tag;
698 TPM_DIGEST msaDigest;
699 TPM_DIGEST pubKeyDigest;
700} TPM_CMK_MIGAUTH;
701
702///
703/// Part 2, section 5.20: TPM_CMK_SIGTICKET
704///
705typedef struct tdTPM_CMK_SIGTICKET {
706 TPM_STRUCTURE_TAG tag;
707 TPM_DIGEST verKeyDigest;
708 TPM_DIGEST signedData;
709} TPM_CMK_SIGTICKET;
710
711///
712/// Part 2, section 5.21: TPM_CMK_MA_APPROVAL
713///
714typedef struct tdTPM_CMK_MA_APPROVAL {
715 TPM_STRUCTURE_TAG tag;
716 TPM_DIGEST migrationAuthorityDigest;
717} TPM_CMK_MA_APPROVAL;
718
719//
720// Part 2, section 6: Command Tags
721//
722#define TPM_TAG_RQU_COMMAND ((TPM_STRUCTURE_TAG) 0x00C1)
723#define TPM_TAG_RQU_AUTH1_COMMAND ((TPM_STRUCTURE_TAG) 0x00C2)
724#define TPM_TAG_RQU_AUTH2_COMMAND ((TPM_STRUCTURE_TAG) 0x00C3)
725#define TPM_TAG_RSP_COMMAND ((TPM_STRUCTURE_TAG) 0x00C4)
726#define TPM_TAG_RSP_AUTH1_COMMAND ((TPM_STRUCTURE_TAG) 0x00C5)
727#define TPM_TAG_RSP_AUTH2_COMMAND ((TPM_STRUCTURE_TAG) 0x00C6)
728
729///
730/// Part 2, section 7.1: TPM_PERMANENT_FLAGS
731///
732typedef struct tdTPM_PERMANENT_FLAGS {
733 TPM_STRUCTURE_TAG tag;
734 BOOLEAN disable;
735 BOOLEAN ownership;
736 BOOLEAN deactivated;
737 BOOLEAN readPubek;
738 BOOLEAN disableOwnerClear;
739 BOOLEAN allowMaintenance;
740 BOOLEAN physicalPresenceLifetimeLock;
741 BOOLEAN physicalPresenceHWEnable;
742 BOOLEAN physicalPresenceCMDEnable;
743 BOOLEAN CEKPUsed;
744 BOOLEAN TPMpost;
745 BOOLEAN TPMpostLock;
746 BOOLEAN FIPS;
747 BOOLEAN operator;
748 BOOLEAN enableRevokeEK;
749 BOOLEAN nvLocked;
750 BOOLEAN readSRKPub;
751 BOOLEAN tpmEstablished;
752 BOOLEAN maintenanceDone;
753 BOOLEAN disableFullDALogicInfo;
754} TPM_PERMANENT_FLAGS;
755
756//
757// Part 2, section 7.1.1: Flag Restrictions (of TPM_PERMANENT_FLAGS)
758//
759#define TPM_PF_DISABLE ((TPM_CAPABILITY_AREA) 1)
760#define TPM_PF_OWNERSHIP ((TPM_CAPABILITY_AREA) 2)
761#define TPM_PF_DEACTIVATED ((TPM_CAPABILITY_AREA) 3)
762#define TPM_PF_READPUBEK ((TPM_CAPABILITY_AREA) 4)
763#define TPM_PF_DISABLEOWNERCLEAR ((TPM_CAPABILITY_AREA) 5)
764#define TPM_PF_ALLOWMAINTENANCE ((TPM_CAPABILITY_AREA) 6)
765#define TPM_PF_PHYSICALPRESENCELIFETIMELOCK ((TPM_CAPABILITY_AREA) 7)
766#define TPM_PF_PHYSICALPRESENCEHWENABLE ((TPM_CAPABILITY_AREA) 8)
767#define TPM_PF_PHYSICALPRESENCECMDENABLE ((TPM_CAPABILITY_AREA) 9)
768#define TPM_PF_CEKPUSED ((TPM_CAPABILITY_AREA) 10)
769#define TPM_PF_TPMPOST ((TPM_CAPABILITY_AREA) 11)
770#define TPM_PF_TPMPOSTLOCK ((TPM_CAPABILITY_AREA) 12)
771#define TPM_PF_FIPS ((TPM_CAPABILITY_AREA) 13)
772#define TPM_PF_OPERATOR ((TPM_CAPABILITY_AREA) 14)
773#define TPM_PF_ENABLEREVOKEEK ((TPM_CAPABILITY_AREA) 15)
774#define TPM_PF_NV_LOCKED ((TPM_CAPABILITY_AREA) 16)
775#define TPM_PF_READSRKPUB ((TPM_CAPABILITY_AREA) 17)
776#define TPM_PF_TPMESTABLISHED ((TPM_CAPABILITY_AREA) 18)
777#define TPM_PF_MAINTENANCEDONE ((TPM_CAPABILITY_AREA) 19)
778#define TPM_PF_DISABLEFULLDALOGICINFO ((TPM_CAPABILITY_AREA) 20)
779
780///
781/// Part 2, section 7.2: TPM_STCLEAR_FLAGS
782///
783typedef struct tdTPM_STCLEAR_FLAGS {
784 TPM_STRUCTURE_TAG tag;
785 BOOLEAN deactivated;
786 BOOLEAN disableForceClear;
787 BOOLEAN physicalPresence;
788 BOOLEAN physicalPresenceLock;
789 BOOLEAN bGlobalLock;
790} TPM_STCLEAR_FLAGS;
791
792//
793// Part 2, section 7.2.1: Flag Restrictions (of TPM_STCLEAR_FLAGS)
794//
795#define TPM_SF_DEACTIVATED ((TPM_CAPABILITY_AREA) 1)
796#define TPM_SF_DISABLEFORCECLEAR ((TPM_CAPABILITY_AREA) 2)
797#define TPM_SF_PHYSICALPRESENCE ((TPM_CAPABILITY_AREA) 3)
798#define TPM_SF_PHYSICALPRESENCELOCK ((TPM_CAPABILITY_AREA) 4)
799#define TPM_SF_BGLOBALLOCK ((TPM_CAPABILITY_AREA) 5)
800
801///
802/// Part 2, section 7.3: TPM_STANY_FLAGS
803///
804typedef struct tdTPM_STANY_FLAGS {
805 TPM_STRUCTURE_TAG tag;
806 BOOLEAN postInitialise;
807 TPM_MODIFIER_INDICATOR localityModifier;
808 BOOLEAN transportExclusive;
809 BOOLEAN TOSPresent;
810} TPM_STANY_FLAGS;
811
812//
813// Part 2, section 7.3.1: Flag Restrictions (of TPM_STANY_FLAGS)
814//
815#define TPM_AF_POSTINITIALISE ((TPM_CAPABILITY_AREA) 1)
816#define TPM_AF_LOCALITYMODIFIER ((TPM_CAPABILITY_AREA) 2)
817#define TPM_AF_TRANSPORTEXCLUSIVE ((TPM_CAPABILITY_AREA) 3)
818#define TPM_AF_TOSPRESENT ((TPM_CAPABILITY_AREA) 4)
819
820//
821// All those structures defined in section 7.4, 7.5, 7.6 are not normative and
822// thus no definitions here
823//
824// Part 2, section 7.4: TPM_PERMANENT_DATA
825//
826#define TPM_MIN_COUNTERS 4 ///< the minimum number of counters is 4
827#define TPM_DELEGATE_KEY TPM_KEY
828#define TPM_NUM_PCR 16
829#define TPM_MAX_NV_WRITE_NOOWNER 64
830
831//
832// Part 2, section 7.4.1: PERMANENT_DATA Subcap for SetCapability
833//
834#define TPM_PD_REVMAJOR ((TPM_CAPABILITY_AREA) 1)
835#define TPM_PD_REVMINOR ((TPM_CAPABILITY_AREA) 2)
836#define TPM_PD_TPMPROOF ((TPM_CAPABILITY_AREA) 3)
837#define TPM_PD_OWNERAUTH ((TPM_CAPABILITY_AREA) 4)
838#define TPM_PD_OPERATORAUTH ((TPM_CAPABILITY_AREA) 5)
839#define TPM_PD_MANUMAINTPUB ((TPM_CAPABILITY_AREA) 6)
840#define TPM_PD_ENDORSEMENTKEY ((TPM_CAPABILITY_AREA) 7)
841#define TPM_PD_SRK ((TPM_CAPABILITY_AREA) 8)
842#define TPM_PD_DELEGATEKEY ((TPM_CAPABILITY_AREA) 9)
843#define TPM_PD_CONTEXTKEY ((TPM_CAPABILITY_AREA) 10)
844#define TPM_PD_AUDITMONOTONICCOUNTER ((TPM_CAPABILITY_AREA) 11)
845#define TPM_PD_MONOTONICCOUNTER ((TPM_CAPABILITY_AREA) 12)
846#define TPM_PD_PCRATTRIB ((TPM_CAPABILITY_AREA) 13)
847#define TPM_PD_ORDINALAUDITSTATUS ((TPM_CAPABILITY_AREA) 14)
848#define TPM_PD_AUTHDIR ((TPM_CAPABILITY_AREA) 15)
849#define TPM_PD_RNGSTATE ((TPM_CAPABILITY_AREA) 16)
850#define TPM_PD_FAMILYTABLE ((TPM_CAPABILITY_AREA) 17)
851#define TPM_DELEGATETABLE ((TPM_CAPABILITY_AREA) 18)
852#define TPM_PD_EKRESET ((TPM_CAPABILITY_AREA) 19)
853#define TPM_PD_MAXNVBUFSIZE ((TPM_CAPABILITY_AREA) 20)
854#define TPM_PD_LASTFAMILYID ((TPM_CAPABILITY_AREA) 21)
855#define TPM_PD_NOOWNERNVWRITE ((TPM_CAPABILITY_AREA) 22)
856#define TPM_PD_RESTRICTDELEGATE ((TPM_CAPABILITY_AREA) 23)
857#define TPM_PD_TPMDAASEED ((TPM_CAPABILITY_AREA) 24)
858#define TPM_PD_DAAPROOF ((TPM_CAPABILITY_AREA) 25)
859
860///
861/// Part 2, section 7.5: TPM_STCLEAR_DATA
862/// available inside TPM only
863///
864typedef struct tdTPM_STCLEAR_DATA {
865 TPM_STRUCTURE_TAG tag;
866 TPM_NONCE contextNonceKey;
867 TPM_COUNT_ID countID;
868 UINT32 ownerReference;
869 BOOLEAN disableResetLock;
870 TPM_PCRVALUE PCR[TPM_NUM_PCR];
871 UINT32 deferredPhysicalPresence;
872} TPM_STCLEAR_DATA;
873
874//
875// Part 2, section 7.5.1: STCLEAR_DATA Subcap for SetCapability
876//
877#define TPM_SD_CONTEXTNONCEKEY ((TPM_CAPABILITY_AREA)0x00000001)
878#define TPM_SD_COUNTID ((TPM_CAPABILITY_AREA)0x00000002)
879#define TPM_SD_OWNERREFERENCE ((TPM_CAPABILITY_AREA)0x00000003)
880#define TPM_SD_DISABLERESETLOCK ((TPM_CAPABILITY_AREA)0x00000004)
881#define TPM_SD_PCR ((TPM_CAPABILITY_AREA)0x00000005)
882#define TPM_SD_DEFERREDPHYSICALPRESENCE ((TPM_CAPABILITY_AREA)0x00000006)
883
884//
885// Part 2, section 7.6.1: STANY_DATA Subcap for SetCapability
886//
887#define TPM_AD_CONTEXTNONCESESSION ((TPM_CAPABILITY_AREA) 1)
888#define TPM_AD_AUDITDIGEST ((TPM_CAPABILITY_AREA) 2)
889#define TPM_AD_CURRENTTICKS ((TPM_CAPABILITY_AREA) 3)
890#define TPM_AD_CONTEXTCOUNT ((TPM_CAPABILITY_AREA) 4)
891#define TPM_AD_CONTEXTLIST ((TPM_CAPABILITY_AREA) 5)
892#define TPM_AD_SESSIONS ((TPM_CAPABILITY_AREA) 6)
893
894//
895// Part 2, section 8: PCR Structures
896//
897
898///
899/// Part 2, section 8.1: TPM_PCR_SELECTION
900/// Size of pcrSelect[] indicated by sizeOfSelect
901///
902typedef struct tdTPM_PCR_SELECTION {
903 UINT16 sizeOfSelect;
904 UINT8 pcrSelect[1];
905} TPM_PCR_SELECTION;
906
907///
908/// Part 2, section 8.2: TPM_PCR_COMPOSITE
909/// Size of pcrValue[] indicated by valueSize
910///
911typedef struct tdTPM_PCR_COMPOSITE {
912 TPM_PCR_SELECTION select;
913 UINT32 valueSize;
914 TPM_PCRVALUE pcrValue[1];
915} TPM_PCR_COMPOSITE;
916
917///
918/// Part 2, section 8.3: TPM_PCR_INFO
919///
920typedef struct tdTPM_PCR_INFO {
921 TPM_PCR_SELECTION pcrSelection;
922 TPM_COMPOSITE_HASH digestAtRelease;
923 TPM_COMPOSITE_HASH digestAtCreation;
924} TPM_PCR_INFO;
925
926///
927/// Part 2, section 8.6: TPM_LOCALITY_SELECTION
928///
929typedef UINT8 TPM_LOCALITY_SELECTION;
930
931#define TPM_LOC_FOUR ((UINT8) 0x10)
932#define TPM_LOC_THREE ((UINT8) 0x08)
933#define TPM_LOC_TWO ((UINT8) 0x04)
934#define TPM_LOC_ONE ((UINT8) 0x02)
935#define TPM_LOC_ZERO ((UINT8) 0x01)
936
937///
938/// Part 2, section 8.4: TPM_PCR_INFO_LONG
939///
940typedef struct tdTPM_PCR_INFO_LONG {
941 TPM_STRUCTURE_TAG tag;
942 TPM_LOCALITY_SELECTION localityAtCreation;
943 TPM_LOCALITY_SELECTION localityAtRelease;
944 TPM_PCR_SELECTION creationPCRSelection;
945 TPM_PCR_SELECTION releasePCRSelection;
946 TPM_COMPOSITE_HASH digestAtCreation;
947 TPM_COMPOSITE_HASH digestAtRelease;
948} TPM_PCR_INFO_LONG;
949
950///
951/// Part 2, section 8.5: TPM_PCR_INFO_SHORT
952///
953typedef struct tdTPM_PCR_INFO_SHORT {
954 TPM_PCR_SELECTION pcrSelection;
955 TPM_LOCALITY_SELECTION localityAtRelease;
956 TPM_COMPOSITE_HASH digestAtRelease;
957} TPM_PCR_INFO_SHORT;
958
959///
960/// Part 2, section 8.8: TPM_PCR_ATTRIBUTES
961///
962typedef struct tdTPM_PCR_ATTRIBUTES {
963 BOOLEAN pcrReset;
964 TPM_LOCALITY_SELECTION pcrExtendLocal;
965 TPM_LOCALITY_SELECTION pcrResetLocal;
966} TPM_PCR_ATTRIBUTES;
967
968//
969// Part 2, section 9: Storage Structures
970//
971
972///
973/// Part 2, section 9.1: TPM_STORED_DATA
974/// [size_is(sealInfoSize)] BYTE* sealInfo;
975/// [size_is(encDataSize)] BYTE* encData;
976///
977typedef struct tdTPM_STORED_DATA {
978 TPM_STRUCT_VER ver;
979 UINT32 sealInfoSize;
980 UINT8 *sealInfo;
981 UINT32 encDataSize;
982 UINT8 *encData;
983} TPM_STORED_DATA;
984
985///
986/// Part 2, section 9.2: TPM_STORED_DATA12
987/// [size_is(sealInfoSize)] BYTE* sealInfo;
988/// [size_is(encDataSize)] BYTE* encData;
989///
990typedef struct tdTPM_STORED_DATA12 {
991 TPM_STRUCTURE_TAG tag;
992 TPM_ENTITY_TYPE et;
993 UINT32 sealInfoSize;
994 UINT8 *sealInfo;
995 UINT32 encDataSize;
996 UINT8 *encData;
997} TPM_STORED_DATA12;
998
999///
1000/// Part 2, section 9.3: TPM_SEALED_DATA
1001/// [size_is(dataSize)] BYTE* data;
1002///
1003typedef struct tdTPM_SEALED_DATA {
1004 TPM_PAYLOAD_TYPE payload;
1005 TPM_SECRET authData;
1006 TPM_NONCE tpmProof;
1007 TPM_DIGEST storedDigest;
1008 UINT32 dataSize;
1009 UINT8 *data;
1010} TPM_SEALED_DATA;
1011
1012///
1013/// Part 2, section 9.4: TPM_SYMMETRIC_KEY
1014/// [size_is(size)] BYTE* data;
1015///
1016typedef struct tdTPM_SYMMETRIC_KEY {
1017 TPM_ALGORITHM_ID algId;
1018 TPM_ENC_SCHEME encScheme;
1019 UINT16 dataSize;
1020 UINT8 *data;
1021} TPM_SYMMETRIC_KEY;
1022
1023///
1024/// Part 2, section 9.5: TPM_BOUND_DATA
1025///
1026typedef struct tdTPM_BOUND_DATA {
1027 TPM_STRUCT_VER ver;
1028 TPM_PAYLOAD_TYPE payload;
1029 UINT8 payloadData[1];
1030} TPM_BOUND_DATA;
1031
1032//
1033// Part 2 section 10: TPM_KEY complex
1034//
1035
1036//
1037// Section 10.1, 10.4, and 10.5 have been defined previously
1038//
1039
1040///
1041/// Part 2, section 10.2: TPM_KEY
1042/// [size_is(encDataSize)] BYTE* encData;
1043///
1044typedef struct tdTPM_KEY {
1045 TPM_STRUCT_VER ver;
1046 TPM_KEY_USAGE keyUsage;
1047 TPM_KEY_FLAGS keyFlags;
1048 TPM_AUTH_DATA_USAGE authDataUsage;
1049 TPM_KEY_PARMS algorithmParms;
1050 UINT32 PCRInfoSize;
1051 UINT8 *PCRInfo;
1052 TPM_STORE_PUBKEY pubKey;
1053 UINT32 encDataSize;
1054 UINT8 *encData;
1055} TPM_KEY;
1056
1057///
1058/// Part 2, section 10.3: TPM_KEY12
1059/// [size_is(encDataSize)] BYTE* encData;
1060///
1061typedef struct tdTPM_KEY12 {
1062 TPM_STRUCTURE_TAG tag;
1063 UINT16 fill;
1064 TPM_KEY_USAGE keyUsage;
1065 TPM_KEY_FLAGS keyFlags;
1066 TPM_AUTH_DATA_USAGE authDataUsage;
1067 TPM_KEY_PARMS algorithmParms;
1068 UINT32 PCRInfoSize;
1069 UINT8 *PCRInfo;
1070 TPM_STORE_PUBKEY pubKey;
1071 UINT32 encDataSize;
1072 UINT8 *encData;
1073} TPM_KEY12;
1074
1075///
1076/// Part 2, section 10.7: TPM_STORE_PRIVKEY
1077/// [size_is(keyLength)] BYTE* key;
1078///
1079typedef struct tdTPM_STORE_PRIVKEY {
1080 UINT32 keyLength;
1081 UINT8 *key;
1082} TPM_STORE_PRIVKEY;
1083
1084///
1085/// Part 2, section 10.6: TPM_STORE_ASYMKEY
1086///
1087typedef struct tdTPM_STORE_ASYMKEY {
1088 // pos len total
1089 TPM_PAYLOAD_TYPE payload; // 0 1 1
1090 TPM_SECRET usageAuth; // 1 20 21
1091 TPM_SECRET migrationAuth; // 21 20 41
1092 TPM_DIGEST pubDataDigest; // 41 20 61
1093 TPM_STORE_PRIVKEY privKey; // 61 132-151 193-214
1094} TPM_STORE_ASYMKEY;
1095
1096///
1097/// Part 2, section 10.8: TPM_MIGRATE_ASYMKEY
1098/// [size_is(partPrivKeyLen)] BYTE* partPrivKey;
1099///
1100typedef struct tdTPM_MIGRATE_ASYMKEY {
1101 // pos len total
1102 TPM_PAYLOAD_TYPE payload; // 0 1 1
1103 TPM_SECRET usageAuth; // 1 20 21
1104 TPM_DIGEST pubDataDigest; // 21 20 41
1105 UINT32 partPrivKeyLen; // 41 4 45
1106 UINT8 *partPrivKey; // 45 112-127 157-172
1107} TPM_MIGRATE_ASYMKEY;
1108
1109///
1110/// Part 2, section 10.9: TPM_KEY_CONTROL
1111///
1112#define TPM_KEY_CONTROL_OWNER_EVICT ((UINT32) 0x00000001)
1113
1114//
1115// Part 2, section 11: Signed Structures
1116//
1117
1118///
1119/// Part 2, section 11.1: TPM_CERTIFY_INFO Structure
1120///
1121typedef struct tdTPM_CERTIFY_INFO {
1122 TPM_STRUCT_VER version;
1123 TPM_KEY_USAGE keyUsage;
1124 TPM_KEY_FLAGS keyFlags;
1125 TPM_AUTH_DATA_USAGE authDataUsage;
1126 TPM_KEY_PARMS algorithmParms;
1127 TPM_DIGEST pubkeyDigest;
1128 TPM_NONCE data;
1129 BOOLEAN parentPCRStatus;
1130 UINT32 PCRInfoSize;
1131 UINT8 *PCRInfo;
1132} TPM_CERTIFY_INFO;
1133
1134///
1135/// Part 2, section 11.2: TPM_CERTIFY_INFO2 Structure
1136///
1137typedef struct tdTPM_CERTIFY_INFO2 {
1138 TPM_STRUCTURE_TAG tag;
1139 UINT8 fill;
1140 TPM_PAYLOAD_TYPE payloadType;
1141 TPM_KEY_USAGE keyUsage;
1142 TPM_KEY_FLAGS keyFlags;
1143 TPM_AUTH_DATA_USAGE authDataUsage;
1144 TPM_KEY_PARMS algorithmParms;
1145 TPM_DIGEST pubkeyDigest;
1146 TPM_NONCE data;
1147 BOOLEAN parentPCRStatus;
1148 UINT32 PCRInfoSize;
1149 UINT8 *PCRInfo;
1150 UINT32 migrationAuthoritySize;
1151 UINT8 *migrationAuthority;
1152} TPM_CERTIFY_INFO2;
1153
1154///
1155/// Part 2, section 11.3 TPM_QUOTE_INFO Structure
1156///
1157typedef struct tdTPM_QUOTE_INFO {
1158 TPM_STRUCT_VER version;
1159 UINT8 fixed[4];
1160 TPM_COMPOSITE_HASH digestValue;
1161 TPM_NONCE externalData;
1162} TPM_QUOTE_INFO;
1163
1164///
1165/// Part 2, section 11.4 TPM_QUOTE_INFO2 Structure
1166///
1167typedef struct tdTPM_QUOTE_INFO2 {
1168 TPM_STRUCTURE_TAG tag;
1169 UINT8 fixed[4];
1170 TPM_NONCE externalData;
1171 TPM_PCR_INFO_SHORT infoShort;
1172} TPM_QUOTE_INFO2;
1173
1174//
1175// Part 2, section 12: Identity Structures
1176//
1177
1178///
1179/// Part 2, section 12.1 TPM_EK_BLOB
1180///
1181typedef struct tdTPM_EK_BLOB {
1182 TPM_STRUCTURE_TAG tag;
1183 TPM_EK_TYPE ekType;
1184 UINT32 blobSize;
1185 UINT8 *blob;
1186} TPM_EK_BLOB;
1187
1188///
1189/// Part 2, section 12.2 TPM_EK_BLOB_ACTIVATE
1190///
1191typedef struct tdTPM_EK_BLOB_ACTIVATE {
1192 TPM_STRUCTURE_TAG tag;
1193 TPM_SYMMETRIC_KEY sessionKey;
1194 TPM_DIGEST idDigest;
1195 TPM_PCR_INFO_SHORT pcrInfo;
1196} TPM_EK_BLOB_ACTIVATE;
1197
1198///
1199/// Part 2, section 12.3 TPM_EK_BLOB_AUTH
1200///
1201typedef struct tdTPM_EK_BLOB_AUTH {
1202 TPM_STRUCTURE_TAG tag;
1203 TPM_SECRET authValue;
1204} TPM_EK_BLOB_AUTH;
1205
1206///
1207/// Part 2, section 12.5 TPM_IDENTITY_CONTENTS
1208///
1209typedef struct tdTPM_IDENTITY_CONTENTS {
1210 TPM_STRUCT_VER ver;
1211 UINT32 ordinal;
1212 TPM_CHOSENID_HASH labelPrivCADigest;
1213 TPM_PUBKEY identityPubKey;
1214} TPM_IDENTITY_CONTENTS;
1215
1216///
1217/// Part 2, section 12.6 TPM_IDENTITY_REQ
1218///
1219typedef struct tdTPM_IDENTITY_REQ {
1220 UINT32 asymSize;
1221 UINT32 symSize;
1222 TPM_KEY_PARMS asymAlgorithm;
1223 TPM_KEY_PARMS symAlgorithm;
1224 UINT8 *asymBlob;
1225 UINT8 *symBlob;
1226} TPM_IDENTITY_REQ;
1227
1228///
1229/// Part 2, section 12.7 TPM_IDENTITY_PROOF
1230///
1231typedef struct tdTPM_IDENTITY_PROOF {
1232 TPM_STRUCT_VER ver;
1233 UINT32 labelSize;
1234 UINT32 identityBindingSize;
1235 UINT32 endorsementSize;
1236 UINT32 platformSize;
1237 UINT32 conformanceSize;
1238 TPM_PUBKEY identityKey;
1239 UINT8 *labelArea;
1240 UINT8 *identityBinding;
1241 UINT8 *endorsementCredential;
1242 UINT8 *platformCredential;
1243 UINT8 *conformanceCredential;
1244} TPM_IDENTITY_PROOF;
1245
1246///
1247/// Part 2, section 12.8 TPM_ASYM_CA_CONTENTS
1248///
1249typedef struct tdTPM_ASYM_CA_CONTENTS {
1250 TPM_SYMMETRIC_KEY sessionKey;
1251 TPM_DIGEST idDigest;
1252} TPM_ASYM_CA_CONTENTS;
1253
1254///
1255/// Part 2, section 12.9 TPM_SYM_CA_ATTESTATION
1256///
1257typedef struct tdTPM_SYM_CA_ATTESTATION {
1258 UINT32 credSize;
1259 TPM_KEY_PARMS algorithm;
1260 UINT8 *credential;
1261} TPM_SYM_CA_ATTESTATION;
1262
1263///
1264/// Part 2, section 15: Tick Structures
1265/// Placed here out of order because definitions are used in section 13.
1266///
1267typedef struct tdTPM_CURRENT_TICKS {
1268 TPM_STRUCTURE_TAG tag;
1269 UINT64 currentTicks;
1270 UINT16 tickRate;
1271 TPM_NONCE tickNonce;
1272} TPM_CURRENT_TICKS;
1273
1274///
1275/// Part 2, section 13: Transport structures
1276///
1277
1278///
1279/// Part 2, section 13.1: TPM _TRANSPORT_PUBLIC
1280///
1281typedef struct tdTPM_TRANSPORT_PUBLIC {
1282 TPM_STRUCTURE_TAG tag;
1283 TPM_TRANSPORT_ATTRIBUTES transAttributes;
1284 TPM_ALGORITHM_ID algId;
1285 TPM_ENC_SCHEME encScheme;
1286} TPM_TRANSPORT_PUBLIC;
1287
1288//
1289// Part 2, section 13.1.1 TPM_TRANSPORT_ATTRIBUTES Definitions
1290//
1291#define TPM_TRANSPORT_ENCRYPT ((UINT32)BIT0)
1292#define TPM_TRANSPORT_LOG ((UINT32)BIT1)
1293#define TPM_TRANSPORT_EXCLUSIVE ((UINT32)BIT2)
1294
1295///
1296/// Part 2, section 13.2 TPM_TRANSPORT_INTERNAL
1297///
1298typedef struct tdTPM_TRANSPORT_INTERNAL {
1299 TPM_STRUCTURE_TAG tag;
1300 TPM_AUTHDATA authData;
1301 TPM_TRANSPORT_PUBLIC transPublic;
1302 TPM_TRANSHANDLE transHandle;
1303 TPM_NONCE transNonceEven;
1304 TPM_DIGEST transDigest;
1305} TPM_TRANSPORT_INTERNAL;
1306
1307///
1308/// Part 2, section 13.3 TPM_TRANSPORT_LOG_IN structure
1309///
1310typedef struct tdTPM_TRANSPORT_LOG_IN {
1311 TPM_STRUCTURE_TAG tag;
1312 TPM_DIGEST parameters;
1313 TPM_DIGEST pubKeyHash;
1314} TPM_TRANSPORT_LOG_IN;
1315
1316///
1317/// Part 2, section 13.4 TPM_TRANSPORT_LOG_OUT structure
1318///
1319typedef struct tdTPM_TRANSPORT_LOG_OUT {
1320 TPM_STRUCTURE_TAG tag;
1321 TPM_CURRENT_TICKS currentTicks;
1322 TPM_DIGEST parameters;
1323 TPM_MODIFIER_INDICATOR locality;
1324} TPM_TRANSPORT_LOG_OUT;
1325
1326///
1327/// Part 2, section 13.5 TPM_TRANSPORT_AUTH structure
1328///
1329typedef struct tdTPM_TRANSPORT_AUTH {
1330 TPM_STRUCTURE_TAG tag;
1331 TPM_AUTHDATA authData;
1332} TPM_TRANSPORT_AUTH;
1333
1334//
1335// Part 2, section 14: Audit Structures
1336//
1337
1338///
1339/// Part 2, section 14.1 TPM_AUDIT_EVENT_IN structure
1340///
1341typedef struct tdTPM_AUDIT_EVENT_IN {
1342 TPM_STRUCTURE_TAG tag;
1343 TPM_DIGEST inputParms;
1344 TPM_COUNTER_VALUE auditCount;
1345} TPM_AUDIT_EVENT_IN;
1346
1347///
1348/// Part 2, section 14.2 TPM_AUDIT_EVENT_OUT structure
1349///
1350typedef struct tdTPM_AUDIT_EVENT_OUT {
1351 TPM_STRUCTURE_TAG tag;
1352 TPM_COMMAND_CODE ordinal;
1353 TPM_DIGEST outputParms;
1354 TPM_COUNTER_VALUE auditCount;
1355 TPM_RESULT returnCode;
1356} TPM_AUDIT_EVENT_OUT;
1357
1358//
1359// Part 2, section 16: Return Codes
1360//
1361
1362#define TPM_VENDOR_ERROR TPM_Vendor_Specific32
1363#define TPM_NON_FATAL 0x00000800
1364
1365#define TPM_SUCCESS ((TPM_RESULT) TPM_BASE)
1366#define TPM_AUTHFAIL ((TPM_RESULT) (TPM_BASE + 1))
1367#define TPM_BADINDEX ((TPM_RESULT) (TPM_BASE + 2))
1368#define TPM_BAD_PARAMETER ((TPM_RESULT) (TPM_BASE + 3))
1369#define TPM_AUDITFAILURE ((TPM_RESULT) (TPM_BASE + 4))
1370#define TPM_CLEAR_DISABLED ((TPM_RESULT) (TPM_BASE + 5))
1371#define TPM_DEACTIVATED ((TPM_RESULT) (TPM_BASE + 6))
1372#define TPM_DISABLED ((TPM_RESULT) (TPM_BASE + 7))
1373#define TPM_DISABLED_CMD ((TPM_RESULT) (TPM_BASE + 8))
1374#define TPM_FAIL ((TPM_RESULT) (TPM_BASE + 9))
1375#define TPM_BAD_ORDINAL ((TPM_RESULT) (TPM_BASE + 10))
1376#define TPM_INSTALL_DISABLED ((TPM_RESULT) (TPM_BASE + 11))
1377#define TPM_INVALID_KEYHANDLE ((TPM_RESULT) (TPM_BASE + 12))
1378#define TPM_KEYNOTFOUND ((TPM_RESULT) (TPM_BASE + 13))
1379#define TPM_INAPPROPRIATE_ENC ((TPM_RESULT) (TPM_BASE + 14))
1380#define TPM_MIGRATEFAIL ((TPM_RESULT) (TPM_BASE + 15))
1381#define TPM_INVALID_PCR_INFO ((TPM_RESULT) (TPM_BASE + 16))
1382#define TPM_NOSPACE ((TPM_RESULT) (TPM_BASE + 17))
1383#define TPM_NOSRK ((TPM_RESULT) (TPM_BASE + 18))
1384#define TPM_NOTSEALED_BLOB ((TPM_RESULT) (TPM_BASE + 19))
1385#define TPM_OWNER_SET ((TPM_RESULT) (TPM_BASE + 20))
1386#define TPM_RESOURCES ((TPM_RESULT) (TPM_BASE + 21))
1387#define TPM_SHORTRANDOM ((TPM_RESULT) (TPM_BASE + 22))
1388#define TPM_SIZE ((TPM_RESULT) (TPM_BASE + 23))
1389#define TPM_WRONGPCRVAL ((TPM_RESULT) (TPM_BASE + 24))
1390#define TPM_BAD_PARAM_SIZE ((TPM_RESULT) (TPM_BASE + 25))
1391#define TPM_SHA_THREAD ((TPM_RESULT) (TPM_BASE + 26))
1392#define TPM_SHA_ERROR ((TPM_RESULT) (TPM_BASE + 27))
1393#define TPM_FAILEDSELFTEST ((TPM_RESULT) (TPM_BASE + 28))
1394#define TPM_AUTH2FAIL ((TPM_RESULT) (TPM_BASE + 29))
1395#define TPM_BADTAG ((TPM_RESULT) (TPM_BASE + 30))
1396#define TPM_IOERROR ((TPM_RESULT) (TPM_BASE + 31))
1397#define TPM_ENCRYPT_ERROR ((TPM_RESULT) (TPM_BASE + 32))
1398#define TPM_DECRYPT_ERROR ((TPM_RESULT) (TPM_BASE + 33))
1399#define TPM_INVALID_AUTHHANDLE ((TPM_RESULT) (TPM_BASE + 34))
1400#define TPM_NO_ENDORSEMENT ((TPM_RESULT) (TPM_BASE + 35))
1401#define TPM_INVALID_KEYUSAGE ((TPM_RESULT) (TPM_BASE + 36))
1402#define TPM_WRONG_ENTITYTYPE ((TPM_RESULT) (TPM_BASE + 37))
1403#define TPM_INVALID_POSTINIT ((TPM_RESULT) (TPM_BASE + 38))
1404#define TPM_INAPPROPRIATE_SIG ((TPM_RESULT) (TPM_BASE + 39))
1405#define TPM_BAD_KEY_PROPERTY ((TPM_RESULT) (TPM_BASE + 40))
1406#define TPM_BAD_MIGRATION ((TPM_RESULT) (TPM_BASE + 41))
1407#define TPM_BAD_SCHEME ((TPM_RESULT) (TPM_BASE + 42))
1408#define TPM_BAD_DATASIZE ((TPM_RESULT) (TPM_BASE + 43))
1409#define TPM_BAD_MODE ((TPM_RESULT) (TPM_BASE + 44))
1410#define TPM_BAD_PRESENCE ((TPM_RESULT) (TPM_BASE + 45))
1411#define TPM_BAD_VERSION ((TPM_RESULT) (TPM_BASE + 46))
1412#define TPM_NO_WRAP_TRANSPORT ((TPM_RESULT) (TPM_BASE + 47))
1413#define TPM_AUDITFAIL_UNSUCCESSFUL ((TPM_RESULT) (TPM_BASE + 48))
1414#define TPM_AUDITFAIL_SUCCESSFUL ((TPM_RESULT) (TPM_BASE + 49))
1415#define TPM_NOTRESETABLE ((TPM_RESULT) (TPM_BASE + 50))
1416#define TPM_NOTLOCAL ((TPM_RESULT) (TPM_BASE + 51))
1417#define TPM_BAD_TYPE ((TPM_RESULT) (TPM_BASE + 52))
1418#define TPM_INVALID_RESOURCE ((TPM_RESULT) (TPM_BASE + 53))
1419#define TPM_NOTFIPS ((TPM_RESULT) (TPM_BASE + 54))
1420#define TPM_INVALID_FAMILY ((TPM_RESULT) (TPM_BASE + 55))
1421#define TPM_NO_NV_PERMISSION ((TPM_RESULT) (TPM_BASE + 56))
1422#define TPM_REQUIRES_SIGN ((TPM_RESULT) (TPM_BASE + 57))
1423#define TPM_KEY_NOTSUPPORTED ((TPM_RESULT) (TPM_BASE + 58))
1424#define TPM_AUTH_CONFLICT ((TPM_RESULT) (TPM_BASE + 59))
1425#define TPM_AREA_LOCKED ((TPM_RESULT) (TPM_BASE + 60))
1426#define TPM_BAD_LOCALITY ((TPM_RESULT) (TPM_BASE + 61))
1427#define TPM_READ_ONLY ((TPM_RESULT) (TPM_BASE + 62))
1428#define TPM_PER_NOWRITE ((TPM_RESULT) (TPM_BASE + 63))
1429#define TPM_FAMILYCOUNT ((TPM_RESULT) (TPM_BASE + 64))
1430#define TPM_WRITE_LOCKED ((TPM_RESULT) (TPM_BASE + 65))
1431#define TPM_BAD_ATTRIBUTES ((TPM_RESULT) (TPM_BASE + 66))
1432#define TPM_INVALID_STRUCTURE ((TPM_RESULT) (TPM_BASE + 67))
1433#define TPM_KEY_OWNER_CONTROL ((TPM_RESULT) (TPM_BASE + 68))
1434#define TPM_BAD_COUNTER ((TPM_RESULT) (TPM_BASE + 69))
1435#define TPM_NOT_FULLWRITE ((TPM_RESULT) (TPM_BASE + 70))
1436#define TPM_CONTEXT_GAP ((TPM_RESULT) (TPM_BASE + 71))
1437#define TPM_MAXNVWRITES ((TPM_RESULT) (TPM_BASE + 72))
1438#define TPM_NOOPERATOR ((TPM_RESULT) (TPM_BASE + 73))
1439#define TPM_RESOURCEMISSING ((TPM_RESULT) (TPM_BASE + 74))
1440#define TPM_DELEGATE_LOCK ((TPM_RESULT) (TPM_BASE + 75))
1441#define TPM_DELEGATE_FAMILY ((TPM_RESULT) (TPM_BASE + 76))
1442#define TPM_DELEGATE_ADMIN ((TPM_RESULT) (TPM_BASE + 77))
1443#define TPM_TRANSPORT_NOTEXCLUSIVE ((TPM_RESULT) (TPM_BASE + 78))
1444#define TPM_OWNER_CONTROL ((TPM_RESULT) (TPM_BASE + 79))
1445#define TPM_DAA_RESOURCES ((TPM_RESULT) (TPM_BASE + 80))
1446#define TPM_DAA_INPUT_DATA0 ((TPM_RESULT) (TPM_BASE + 81))
1447#define TPM_DAA_INPUT_DATA1 ((TPM_RESULT) (TPM_BASE + 82))
1448#define TPM_DAA_ISSUER_SETTINGS ((TPM_RESULT) (TPM_BASE + 83))
1449#define TPM_DAA_TPM_SETTINGS ((TPM_RESULT) (TPM_BASE + 84))
1450#define TPM_DAA_STAGE ((TPM_RESULT) (TPM_BASE + 85))
1451#define TPM_DAA_ISSUER_VALIDITY ((TPM_RESULT) (TPM_BASE + 86))
1452#define TPM_DAA_WRONG_W ((TPM_RESULT) (TPM_BASE + 87))
1453#define TPM_BAD_HANDLE ((TPM_RESULT) (TPM_BASE + 88))
1454#define TPM_BAD_DELEGATE ((TPM_RESULT) (TPM_BASE + 89))
1455#define TPM_BADCONTEXT ((TPM_RESULT) (TPM_BASE + 90))
1456#define TPM_TOOMANYCONTEXTS ((TPM_RESULT) (TPM_BASE + 91))
1457#define TPM_MA_TICKET_SIGNATURE ((TPM_RESULT) (TPM_BASE + 92))
1458#define TPM_MA_DESTINATION ((TPM_RESULT) (TPM_BASE + 93))
1459#define TPM_MA_SOURCE ((TPM_RESULT) (TPM_BASE + 94))
1460#define TPM_MA_AUTHORITY ((TPM_RESULT) (TPM_BASE + 95))
1461#define TPM_PERMANENTEK ((TPM_RESULT) (TPM_BASE + 97))
1462#define TPM_BAD_SIGNATURE ((TPM_RESULT) (TPM_BASE + 98))
1463#define TPM_NOCONTEXTSPACE ((TPM_RESULT) (TPM_BASE + 99))
1464
1465#define TPM_RETRY ((TPM_RESULT) (TPM_BASE + TPM_NON_FATAL))
1466#define TPM_NEEDS_SELFTEST ((TPM_RESULT) (TPM_BASE + TPM_NON_FATAL + 1))
1467#define TPM_DOING_SELFTEST ((TPM_RESULT) (TPM_BASE + TPM_NON_FATAL + 2))
1468#define TPM_DEFEND_LOCK_RUNNING ((TPM_RESULT) (TPM_BASE + TPM_NON_FATAL + 3))
1469
1470//
1471// Part 2, section 17: Ordinals
1472//
1473// Ordinals are 32 bit values. The upper byte contains values that serve as
1474// flag indicators, the next byte contains values indicating what committee
1475// designated the ordinal, and the final two bytes contain the Command
1476// Ordinal Index.
1477// 3 2 1
1478// 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0
1479// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1480// |P|C|V| Reserved| Purview | Command Ordinal Index |
1481// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1482//
1483// Where:
1484//
1485// * P is Protected/Unprotected command. When 0 the command is a Protected
1486// command, when 1 the command is an Unprotected command.
1487//
1488// * C is Non-Connection/Connection related command. When 0 this command
1489// passes through to either the protected (TPM) or unprotected (TSS)
1490// components.
1491//
1492// * V is TPM/Vendor command. When 0 the command is TPM defined, when 1 the
1493// command is vendor defined.
1494//
1495// * All reserved area bits are set to 0.
1496//
1497
1498#define TPM_ORD_ActivateIdentity ((TPM_COMMAND_CODE) 0x0000007A)
1499#define TPM_ORD_AuthorizeMigrationKey ((TPM_COMMAND_CODE) 0x0000002B)
1500#define TPM_ORD_CertifyKey ((TPM_COMMAND_CODE) 0x00000032)
1501#define TPM_ORD_CertifyKey2 ((TPM_COMMAND_CODE) 0x00000033)
1502#define TPM_ORD_CertifySelfTest ((TPM_COMMAND_CODE) 0x00000052)
1503#define TPM_ORD_ChangeAuth ((TPM_COMMAND_CODE) 0x0000000C)
1504#define TPM_ORD_ChangeAuthAsymFinish ((TPM_COMMAND_CODE) 0x0000000F)
1505#define TPM_ORD_ChangeAuthAsymStart ((TPM_COMMAND_CODE) 0x0000000E)
1506#define TPM_ORD_ChangeAuthOwner ((TPM_COMMAND_CODE) 0x00000010)
1507#define TPM_ORD_CMK_ApproveMA ((TPM_COMMAND_CODE) 0x0000001D)
1508#define TPM_ORD_CMK_ConvertMigration ((TPM_COMMAND_CODE) 0x00000024)
1509#define TPM_ORD_CMK_CreateBlob ((TPM_COMMAND_CODE) 0x0000001B)
1510#define TPM_ORD_CMK_CreateKey ((TPM_COMMAND_CODE) 0x00000013)
1511#define TPM_ORD_CMK_CreateTicket ((TPM_COMMAND_CODE) 0x00000012)
1512#define TPM_ORD_CMK_SetRestrictions ((TPM_COMMAND_CODE) 0x0000001C)
1513#define TPM_ORD_ContinueSelfTest ((TPM_COMMAND_CODE) 0x00000053)
1514#define TPM_ORD_ConvertMigrationBlob ((TPM_COMMAND_CODE) 0x0000002A)
1515#define TPM_ORD_CreateCounter ((TPM_COMMAND_CODE) 0x000000DC)
1516#define TPM_ORD_CreateEndorsementKeyPair ((TPM_COMMAND_CODE) 0x00000078)
1517#define TPM_ORD_CreateMaintenanceArchive ((TPM_COMMAND_CODE) 0x0000002C)
1518#define TPM_ORD_CreateMigrationBlob ((TPM_COMMAND_CODE) 0x00000028)
1519#define TPM_ORD_CreateRevocableEK ((TPM_COMMAND_CODE) 0x0000007F)
1520#define TPM_ORD_CreateWrapKey ((TPM_COMMAND_CODE) 0x0000001F)
1521#define TPM_ORD_DAA_JOIN ((TPM_COMMAND_CODE) 0x00000029)
1522#define TPM_ORD_DAA_SIGN ((TPM_COMMAND_CODE) 0x00000031)
1523#define TPM_ORD_Delegate_CreateKeyDelegation ((TPM_COMMAND_CODE) 0x000000D4)
1524#define TPM_ORD_Delegate_CreateOwnerDelegation ((TPM_COMMAND_CODE) 0x000000D5)
1525#define TPM_ORD_Delegate_LoadOwnerDelegation ((TPM_COMMAND_CODE) 0x000000D8)
1526#define TPM_ORD_Delegate_Manage ((TPM_COMMAND_CODE) 0x000000D2)
1527#define TPM_ORD_Delegate_ReadTable ((TPM_COMMAND_CODE) 0x000000DB)
1528#define TPM_ORD_Delegate_UpdateVerification ((TPM_COMMAND_CODE) 0x000000D1)
1529#define TPM_ORD_Delegate_VerifyDelegation ((TPM_COMMAND_CODE) 0x000000D6)
1530#define TPM_ORD_DirRead ((TPM_COMMAND_CODE) 0x0000001A)
1531#define TPM_ORD_DirWriteAuth ((TPM_COMMAND_CODE) 0x00000019)
1532#define TPM_ORD_DisableForceClear ((TPM_COMMAND_CODE) 0x0000005E)
1533#define TPM_ORD_DisableOwnerClear ((TPM_COMMAND_CODE) 0x0000005C)
1534#define TPM_ORD_DisablePubekRead ((TPM_COMMAND_CODE) 0x0000007E)
1535#define TPM_ORD_DSAP ((TPM_COMMAND_CODE) 0x00000011)
1536#define TPM_ORD_EstablishTransport ((TPM_COMMAND_CODE) 0x000000E6)
1537#define TPM_ORD_EvictKey ((TPM_COMMAND_CODE) 0x00000022)
1538#define TPM_ORD_ExecuteTransport ((TPM_COMMAND_CODE) 0x000000E7)
1539#define TPM_ORD_Extend ((TPM_COMMAND_CODE) 0x00000014)
1540#define TPM_ORD_FieldUpgrade ((TPM_COMMAND_CODE) 0x000000AA)
1541#define TPM_ORD_FlushSpecific ((TPM_COMMAND_CODE) 0x000000BA)
1542#define TPM_ORD_ForceClear ((TPM_COMMAND_CODE) 0x0000005D)
1543#define TPM_ORD_GetAuditDigest ((TPM_COMMAND_CODE) 0x00000085)
1544#define TPM_ORD_GetAuditDigestSigned ((TPM_COMMAND_CODE) 0x00000086)
1545#define TPM_ORD_GetAuditEvent ((TPM_COMMAND_CODE) 0x00000082)
1546#define TPM_ORD_GetAuditEventSigned ((TPM_COMMAND_CODE) 0x00000083)
1547#define TPM_ORD_GetCapability ((TPM_COMMAND_CODE) 0x00000065)
1548#define TPM_ORD_GetCapabilityOwner ((TPM_COMMAND_CODE) 0x00000066)
1549#define TPM_ORD_GetCapabilitySigned ((TPM_COMMAND_CODE) 0x00000064)
1550#define TPM_ORD_GetOrdinalAuditStatus ((TPM_COMMAND_CODE) 0x0000008C)
1551#define TPM_ORD_GetPubKey ((TPM_COMMAND_CODE) 0x00000021)
1552#define TPM_ORD_GetRandom ((TPM_COMMAND_CODE) 0x00000046)
1553#define TPM_ORD_GetTestResult ((TPM_COMMAND_CODE) 0x00000054)
1554#define TPM_ORD_GetTicks ((TPM_COMMAND_CODE) 0x000000F1)
1555#define TPM_ORD_IncrementCounter ((TPM_COMMAND_CODE) 0x000000DD)
1556#define TPM_ORD_Init ((TPM_COMMAND_CODE) 0x00000097)
1557#define TPM_ORD_KeyControlOwner ((TPM_COMMAND_CODE) 0x00000023)
1558#define TPM_ORD_KillMaintenanceFeature ((TPM_COMMAND_CODE) 0x0000002E)
1559#define TPM_ORD_LoadAuthContext ((TPM_COMMAND_CODE) 0x000000B7)
1560#define TPM_ORD_LoadContext ((TPM_COMMAND_CODE) 0x000000B9)
1561#define TPM_ORD_LoadKey ((TPM_COMMAND_CODE) 0x00000020)
1562#define TPM_ORD_LoadKey2 ((TPM_COMMAND_CODE) 0x00000041)
1563#define TPM_ORD_LoadKeyContext ((TPM_COMMAND_CODE) 0x000000B5)
1564#define TPM_ORD_LoadMaintenanceArchive ((TPM_COMMAND_CODE) 0x0000002D)
1565#define TPM_ORD_LoadManuMaintPub ((TPM_COMMAND_CODE) 0x0000002F)
1566#define TPM_ORD_MakeIdentity ((TPM_COMMAND_CODE) 0x00000079)
1567#define TPM_ORD_MigrateKey ((TPM_COMMAND_CODE) 0x00000025)
1568#define TPM_ORD_NV_DefineSpace ((TPM_COMMAND_CODE) 0x000000CC)
1569#define TPM_ORD_NV_ReadValue ((TPM_COMMAND_CODE) 0x000000CF)
1570#define TPM_ORD_NV_ReadValueAuth ((TPM_COMMAND_CODE) 0x000000D0)
1571#define TPM_ORD_NV_WriteValue ((TPM_COMMAND_CODE) 0x000000CD)
1572#define TPM_ORD_NV_WriteValueAuth ((TPM_COMMAND_CODE) 0x000000CE)
1573#define TPM_ORD_OIAP ((TPM_COMMAND_CODE) 0x0000000A)
1574#define TPM_ORD_OSAP ((TPM_COMMAND_CODE) 0x0000000B)
1575#define TPM_ORD_OwnerClear ((TPM_COMMAND_CODE) 0x0000005B)
1576#define TPM_ORD_OwnerReadInternalPub ((TPM_COMMAND_CODE) 0x00000081)
1577#define TPM_ORD_OwnerReadPubek ((TPM_COMMAND_CODE) 0x0000007D)
1578#define TPM_ORD_OwnerSetDisable ((TPM_COMMAND_CODE) 0x0000006E)
1579#define TPM_ORD_PCR_Reset ((TPM_COMMAND_CODE) 0x000000C8)
1580#define TPM_ORD_PcrRead ((TPM_COMMAND_CODE) 0x00000015)
1581#define TPM_ORD_PhysicalDisable ((TPM_COMMAND_CODE) 0x00000070)
1582#define TPM_ORD_PhysicalEnable ((TPM_COMMAND_CODE) 0x0000006F)
1583#define TPM_ORD_PhysicalSetDeactivated ((TPM_COMMAND_CODE) 0x00000072)
1584#define TPM_ORD_Quote ((TPM_COMMAND_CODE) 0x00000016)
1585#define TPM_ORD_Quote2 ((TPM_COMMAND_CODE) 0x0000003E)
1586#define TPM_ORD_ReadCounter ((TPM_COMMAND_CODE) 0x000000DE)
1587#define TPM_ORD_ReadManuMaintPub ((TPM_COMMAND_CODE) 0x00000030)
1588#define TPM_ORD_ReadPubek ((TPM_COMMAND_CODE) 0x0000007C)
1589#define TPM_ORD_ReleaseCounter ((TPM_COMMAND_CODE) 0x000000DF)
1590#define TPM_ORD_ReleaseCounterOwner ((TPM_COMMAND_CODE) 0x000000E0)
1591#define TPM_ORD_ReleaseTransportSigned ((TPM_COMMAND_CODE) 0x000000E8)
1592#define TPM_ORD_Reset ((TPM_COMMAND_CODE) 0x0000005A)
1593#define TPM_ORD_ResetLockValue ((TPM_COMMAND_CODE) 0x00000040)
1594#define TPM_ORD_RevokeTrust ((TPM_COMMAND_CODE) 0x00000080)
1595#define TPM_ORD_SaveAuthContext ((TPM_COMMAND_CODE) 0x000000B6)
1596#define TPM_ORD_SaveContext ((TPM_COMMAND_CODE) 0x000000B8)
1597#define TPM_ORD_SaveKeyContext ((TPM_COMMAND_CODE) 0x000000B4)
1598#define TPM_ORD_SaveState ((TPM_COMMAND_CODE) 0x00000098)
1599#define TPM_ORD_Seal ((TPM_COMMAND_CODE) 0x00000017)
1600#define TPM_ORD_Sealx ((TPM_COMMAND_CODE) 0x0000003D)
1601#define TPM_ORD_SelfTestFull ((TPM_COMMAND_CODE) 0x00000050)
1602#define TPM_ORD_SetCapability ((TPM_COMMAND_CODE) 0x0000003F)
1603#define TPM_ORD_SetOperatorAuth ((TPM_COMMAND_CODE) 0x00000074)
1604#define TPM_ORD_SetOrdinalAuditStatus ((TPM_COMMAND_CODE) 0x0000008D)
1605#define TPM_ORD_SetOwnerInstall ((TPM_COMMAND_CODE) 0x00000071)
1606#define TPM_ORD_SetOwnerPointer ((TPM_COMMAND_CODE) 0x00000075)
1607#define TPM_ORD_SetRedirection ((TPM_COMMAND_CODE) 0x0000009A)
1608#define TPM_ORD_SetTempDeactivated ((TPM_COMMAND_CODE) 0x00000073)
1609#define TPM_ORD_SHA1Complete ((TPM_COMMAND_CODE) 0x000000A2)
1610#define TPM_ORD_SHA1CompleteExtend ((TPM_COMMAND_CODE) 0x000000A3)
1611#define TPM_ORD_SHA1Start ((TPM_COMMAND_CODE) 0x000000A0)
1612#define TPM_ORD_SHA1Update ((TPM_COMMAND_CODE) 0x000000A1)
1613#define TPM_ORD_Sign ((TPM_COMMAND_CODE) 0x0000003C)
1614#define TPM_ORD_Startup ((TPM_COMMAND_CODE) 0x00000099)
1615#define TPM_ORD_StirRandom ((TPM_COMMAND_CODE) 0x00000047)
1616#define TPM_ORD_TakeOwnership ((TPM_COMMAND_CODE) 0x0000000D)
1617#define TPM_ORD_Terminate_Handle ((TPM_COMMAND_CODE) 0x00000096)
1618#define TPM_ORD_TickStampBlob ((TPM_COMMAND_CODE) 0x000000F2)
1619#define TPM_ORD_UnBind ((TPM_COMMAND_CODE) 0x0000001E)
1620#define TPM_ORD_Unseal ((TPM_COMMAND_CODE) 0x00000018)
1621#define TSC_ORD_PhysicalPresence ((TPM_COMMAND_CODE) 0x4000000A)
1622#define TSC_ORD_ResetEstablishmentBit ((TPM_COMMAND_CODE) 0x4000000B)
1623
1624//
1625// Part 2, section 18: Context structures
1626//
1627
1628///
1629/// Part 2, section 18.1: TPM_CONTEXT_BLOB
1630///
1631typedef struct tdTPM_CONTEXT_BLOB {
1632 TPM_STRUCTURE_TAG tag;
1633 TPM_RESOURCE_TYPE resourceType;
1634 TPM_HANDLE handle;
1635 UINT8 label[16];
1636 UINT32 contextCount;
1637 TPM_DIGEST integrityDigest;
1638 UINT32 additionalSize;
1639 UINT8 *additionalData;
1640 UINT32 sensitiveSize;
1641 UINT8 *sensitiveData;
1642} TPM_CONTEXT_BLOB;
1643
1644///
1645/// Part 2, section 18.2 TPM_CONTEXT_SENSITIVE
1646///
1647typedef struct tdTPM_CONTEXT_SENSITIVE {
1648 TPM_STRUCTURE_TAG tag;
1649 TPM_NONCE contextNonce;
1650 UINT32 internalSize;
1651 UINT8 *internalData;
1652} TPM_CONTEXT_SENSITIVE;
1653
1654//
1655// Part 2, section 19: NV Structures
1656//
1657
1658//
1659// Part 2, section 19.1.1: Required TPM_NV_INDEX values
1660//
1661#define TPM_NV_INDEX_LOCK ((UINT32)0xffffffff)
1662#define TPM_NV_INDEX0 ((UINT32)0x00000000)
1663#define TPM_NV_INDEX_DIR ((UINT32)0x10000001)
1664#define TPM_NV_INDEX_EKCert ((UINT32)0x0000f000)
1665#define TPM_NV_INDEX_TPM_CC ((UINT32)0x0000f001)
1666#define TPM_NV_INDEX_PlatformCert ((UINT32)0x0000f002)
1667#define TPM_NV_INDEX_Platform_CC ((UINT32)0x0000f003)
1668//
1669// Part 2, section 19.1.2: Reserved Index values
1670//
1671#define TPM_NV_INDEX_TSS_BASE ((UINT32)0x00011100)
1672#define TPM_NV_INDEX_PC_BASE ((UINT32)0x00011200)
1673#define TPM_NV_INDEX_SERVER_BASE ((UINT32)0x00011300)
1674#define TPM_NV_INDEX_MOBILE_BASE ((UINT32)0x00011400)
1675#define TPM_NV_INDEX_PERIPHERAL_BASE ((UINT32)0x00011500)
1676#define TPM_NV_INDEX_GROUP_RESV_BASE ((UINT32)0x00010000)
1677
1678///
1679/// Part 2, section 19.2: TPM_NV_ATTRIBUTES
1680///
1681typedef struct tdTPM_NV_ATTRIBUTES {
1682 TPM_STRUCTURE_TAG tag;
1683 UINT32 attributes;
1684} TPM_NV_ATTRIBUTES;
1685
1686#define TPM_NV_PER_READ_STCLEAR (BIT31)
1687#define TPM_NV_PER_AUTHREAD (BIT18)
1688#define TPM_NV_PER_OWNERREAD (BIT17)
1689#define TPM_NV_PER_PPREAD (BIT16)
1690#define TPM_NV_PER_GLOBALLOCK (BIT15)
1691#define TPM_NV_PER_WRITE_STCLEAR (BIT14)
1692#define TPM_NV_PER_WRITEDEFINE (BIT13)
1693#define TPM_NV_PER_WRITEALL (BIT12)
1694#define TPM_NV_PER_AUTHWRITE (BIT2)
1695#define TPM_NV_PER_OWNERWRITE (BIT1)
1696#define TPM_NV_PER_PPWRITE (BIT0)
1697
1698///
1699/// Part 2, section 19.3: TPM_NV_DATA_PUBLIC
1700///
1701typedef struct tdTPM_NV_DATA_PUBLIC {
1702 TPM_STRUCTURE_TAG tag;
1703 TPM_NV_INDEX nvIndex;
1704 TPM_PCR_INFO_SHORT pcrInfoRead;
1705 TPM_PCR_INFO_SHORT pcrInfoWrite;
1706 TPM_NV_ATTRIBUTES permission;
1707 BOOLEAN bReadSTClear;
1708 BOOLEAN bWriteSTClear;
1709 BOOLEAN bWriteDefine;
1710 UINT32 dataSize;
1711} TPM_NV_DATA_PUBLIC;
1712
1713//
1714// Part 2, section 20: Delegate Structures
1715//
1716
1717#define TPM_DEL_OWNER_BITS ((UINT32)0x00000001)
1718#define TPM_DEL_KEY_BITS ((UINT32)0x00000002)
1719///
1720/// Part 2, section 20.2: Delegate Definitions
1721///
1722typedef struct tdTPM_DELEGATIONS {
1723 TPM_STRUCTURE_TAG tag;
1724 UINT32 delegateType;
1725 UINT32 per1;
1726 UINT32 per2;
1727} TPM_DELEGATIONS;
1728
1729//
1730// Part 2, section 20.2.1: Owner Permission Settings
1731//
1732#define TPM_DELEGATE_SetOrdinalAuditStatus (BIT30)
1733#define TPM_DELEGATE_DirWriteAuth (BIT29)
1734#define TPM_DELEGATE_CMK_ApproveMA (BIT28)
1735#define TPM_DELEGATE_NV_WriteValue (BIT27)
1736#define TPM_DELEGATE_CMK_CreateTicket (BIT26)
1737#define TPM_DELEGATE_NV_ReadValue (BIT25)
1738#define TPM_DELEGATE_Delegate_LoadOwnerDelegation (BIT24)
1739#define TPM_DELEGATE_DAA_Join (BIT23)
1740#define TPM_DELEGATE_AuthorizeMigrationKey (BIT22)
1741#define TPM_DELEGATE_CreateMaintenanceArchive (BIT21)
1742#define TPM_DELEGATE_LoadMaintenanceArchive (BIT20)
1743#define TPM_DELEGATE_KillMaintenanceFeature (BIT19)
1744#define TPM_DELEGATE_OwnerReadInteralPub (BIT18)
1745#define TPM_DELEGATE_ResetLockValue (BIT17)
1746#define TPM_DELEGATE_OwnerClear (BIT16)
1747#define TPM_DELEGATE_DisableOwnerClear (BIT15)
1748#define TPM_DELEGATE_NV_DefineSpace (BIT14)
1749#define TPM_DELEGATE_OwnerSetDisable (BIT13)
1750#define TPM_DELEGATE_SetCapability (BIT12)
1751#define TPM_DELEGATE_MakeIdentity (BIT11)
1752#define TPM_DELEGATE_ActivateIdentity (BIT10)
1753#define TPM_DELEGATE_OwnerReadPubek (BIT9)
1754#define TPM_DELEGATE_DisablePubekRead (BIT8)
1755#define TPM_DELEGATE_SetRedirection (BIT7)
1756#define TPM_DELEGATE_FieldUpgrade (BIT6)
1757#define TPM_DELEGATE_Delegate_UpdateVerification (BIT5)
1758#define TPM_DELEGATE_CreateCounter (BIT4)
1759#define TPM_DELEGATE_ReleaseCounterOwner (BIT3)
1760#define TPM_DELEGATE_DelegateManage (BIT2)
1761#define TPM_DELEGATE_Delegate_CreateOwnerDelegation (BIT1)
1762#define TPM_DELEGATE_DAA_Sign (BIT0)
1763
1764//
1765// Part 2, section 20.2.3: Key Permission settings
1766//
1767#define TPM_KEY_DELEGATE_CMK_ConvertMigration (BIT28)
1768#define TPM_KEY_DELEGATE_TickStampBlob (BIT27)
1769#define TPM_KEY_DELEGATE_ChangeAuthAsymStart (BIT26)
1770#define TPM_KEY_DELEGATE_ChangeAuthAsymFinish (BIT25)
1771#define TPM_KEY_DELEGATE_CMK_CreateKey (BIT24)
1772#define TPM_KEY_DELEGATE_MigrateKey (BIT23)
1773#define TPM_KEY_DELEGATE_LoadKey2 (BIT22)
1774#define TPM_KEY_DELEGATE_EstablishTransport (BIT21)
1775#define TPM_KEY_DELEGATE_ReleaseTransportSigned (BIT20)
1776#define TPM_KEY_DELEGATE_Quote2 (BIT19)
1777#define TPM_KEY_DELEGATE_Sealx (BIT18)
1778#define TPM_KEY_DELEGATE_MakeIdentity (BIT17)
1779#define TPM_KEY_DELEGATE_ActivateIdentity (BIT16)
1780#define TPM_KEY_DELEGATE_GetAuditDigestSigned (BIT15)
1781#define TPM_KEY_DELEGATE_Sign (BIT14)
1782#define TPM_KEY_DELEGATE_CertifyKey2 (BIT13)
1783#define TPM_KEY_DELEGATE_CertifyKey (BIT12)
1784#define TPM_KEY_DELEGATE_CreateWrapKey (BIT11)
1785#define TPM_KEY_DELEGATE_CMK_CreateBlob (BIT10)
1786#define TPM_KEY_DELEGATE_CreateMigrationBlob (BIT9)
1787#define TPM_KEY_DELEGATE_ConvertMigrationBlob (BIT8)
1788#define TPM_KEY_DELEGATE_CreateKeyDelegation (BIT7)
1789#define TPM_KEY_DELEGATE_ChangeAuth (BIT6)
1790#define TPM_KEY_DELEGATE_GetPubKey (BIT5)
1791#define TPM_KEY_DELEGATE_UnBind (BIT4)
1792#define TPM_KEY_DELEGATE_Quote (BIT3)
1793#define TPM_KEY_DELEGATE_Unseal (BIT2)
1794#define TPM_KEY_DELEGATE_Seal (BIT1)
1795#define TPM_KEY_DELEGATE_LoadKey (BIT0)
1796
1797//
1798// Part 2, section 20.3: TPM_FAMILY_FLAGS
1799//
1800#define TPM_DELEGATE_ADMIN_LOCK (BIT1)
1801#define TPM_FAMFLAG_ENABLE (BIT0)
1802
1803///
1804/// Part 2, section 20.4: TPM_FAMILY_LABEL
1805///
1806typedef struct tdTPM_FAMILY_LABEL {
1807 UINT8 label;
1808} TPM_FAMILY_LABEL;
1809
1810///
1811/// Part 2, section 20.5: TPM_FAMILY_TABLE_ENTRY
1812///
1813typedef struct tdTPM_FAMILY_TABLE_ENTRY {
1814 TPM_STRUCTURE_TAG tag;
1815 TPM_FAMILY_LABEL label;
1816 TPM_FAMILY_ID familyID;
1817 TPM_FAMILY_VERIFICATION verificationCount;
1818 TPM_FAMILY_FLAGS flags;
1819} TPM_FAMILY_TABLE_ENTRY;
1820
1821//
1822// Part 2, section 20.6: TPM_FAMILY_TABLE
1823//
1824#define TPM_NUM_FAMILY_TABLE_ENTRY_MIN 8
1825
1826typedef struct tdTPM_FAMILY_TABLE {
1827 TPM_FAMILY_TABLE_ENTRY famTableRow[TPM_NUM_FAMILY_TABLE_ENTRY_MIN];
1828} TPM_FAMILY_TABLE;
1829
1830///
1831/// Part 2, section 20.7: TPM_DELEGATE_LABEL
1832///
1833typedef struct tdTPM_DELEGATE_LABEL {
1834 UINT8 label;
1835} TPM_DELEGATE_LABEL;
1836
1837///
1838/// Part 2, section 20.8: TPM_DELEGATE_PUBLIC
1839///
1840typedef struct tdTPM_DELEGATE_PUBLIC {
1841 TPM_STRUCTURE_TAG tag;
1842 TPM_DELEGATE_LABEL label;
1843 TPM_PCR_INFO_SHORT pcrInfo;
1844 TPM_DELEGATIONS permissions;
1845 TPM_FAMILY_ID familyID;
1846 TPM_FAMILY_VERIFICATION verificationCount;
1847} TPM_DELEGATE_PUBLIC;
1848
1849///
1850/// Part 2, section 20.9: TPM_DELEGATE_TABLE_ROW
1851///
1852typedef struct tdTPM_DELEGATE_TABLE_ROW {
1853 TPM_STRUCTURE_TAG tag;
1854 TPM_DELEGATE_PUBLIC pub;
1855 TPM_SECRET authValue;
1856} TPM_DELEGATE_TABLE_ROW;
1857
1858//
1859// Part 2, section 20.10: TPM_DELEGATE_TABLE
1860//
1861#define TPM_NUM_DELEGATE_TABLE_ENTRY_MIN 2
1862
1863typedef struct tdTPM_DELEGATE_TABLE {
1864 TPM_DELEGATE_TABLE_ROW delRow[TPM_NUM_DELEGATE_TABLE_ENTRY_MIN];
1865} TPM_DELEGATE_TABLE;
1866
1867///
1868/// Part 2, section 20.11: TPM_DELEGATE_SENSITIVE
1869///
1870typedef struct tdTPM_DELEGATE_SENSITIVE {
1871 TPM_STRUCTURE_TAG tag;
1872 TPM_SECRET authValue;
1873} TPM_DELEGATE_SENSITIVE;
1874
1875///
1876/// Part 2, section 20.12: TPM_DELEGATE_OWNER_BLOB
1877///
1878typedef struct tdTPM_DELEGATE_OWNER_BLOB {
1879 TPM_STRUCTURE_TAG tag;
1880 TPM_DELEGATE_PUBLIC pub;
1881 TPM_DIGEST integrityDigest;
1882 UINT32 additionalSize;
1883 UINT8 *additionalArea;
1884 UINT32 sensitiveSize;
1885 UINT8 *sensitiveArea;
1886} TPM_DELEGATE_OWNER_BLOB;
1887
1888///
1889/// Part 2, section 20.13: TTPM_DELEGATE_KEY_BLOB
1890///
1891typedef struct tdTPM_DELEGATE_KEY_BLOB {
1892 TPM_STRUCTURE_TAG tag;
1893 TPM_DELEGATE_PUBLIC pub;
1894 TPM_DIGEST integrityDigest;
1895 TPM_DIGEST pubKeyDigest;
1896 UINT32 additionalSize;
1897 UINT8 *additionalArea;
1898 UINT32 sensitiveSize;
1899 UINT8 *sensitiveArea;
1900} TPM_DELEGATE_KEY_BLOB;
1901
1902//
1903// Part 2, section 20.14: TPM_FAMILY_OPERATION Values
1904//
1905#define TPM_FAMILY_CREATE ((UINT32)0x00000001)
1906#define TPM_FAMILY_ENABLE ((UINT32)0x00000002)
1907#define TPM_FAMILY_ADMIN ((UINT32)0x00000003)
1908#define TPM_FAMILY_INVALIDATE ((UINT32)0x00000004)
1909
1910//
1911// Part 2, section 21.1: TPM_CAPABILITY_AREA for GetCapability
1912//
1913#define TPM_CAP_ORD ((TPM_CAPABILITY_AREA) 0x00000001)
1914#define TPM_CAP_ALG ((TPM_CAPABILITY_AREA) 0x00000002)
1915#define TPM_CAP_PID ((TPM_CAPABILITY_AREA) 0x00000003)
1916#define TPM_CAP_FLAG ((TPM_CAPABILITY_AREA) 0x00000004)
1917#define TPM_CAP_PROPERTY ((TPM_CAPABILITY_AREA) 0x00000005)
1918#define TPM_CAP_VERSION ((TPM_CAPABILITY_AREA) 0x00000006)
1919#define TPM_CAP_KEY_HANDLE ((TPM_CAPABILITY_AREA) 0x00000007)
1920#define TPM_CAP_CHECK_LOADED ((TPM_CAPABILITY_AREA) 0x00000008)
1921#define TPM_CAP_SYM_MODE ((TPM_CAPABILITY_AREA) 0x00000009)
1922#define TPM_CAP_KEY_STATUS ((TPM_CAPABILITY_AREA) 0x0000000C)
1923#define TPM_CAP_NV_LIST ((TPM_CAPABILITY_AREA) 0x0000000D)
1924#define TPM_CAP_MFR ((TPM_CAPABILITY_AREA) 0x00000010)
1925#define TPM_CAP_NV_INDEX ((TPM_CAPABILITY_AREA) 0x00000011)
1926#define TPM_CAP_TRANS_ALG ((TPM_CAPABILITY_AREA) 0x00000012)
1927#define TPM_CAP_HANDLE ((TPM_CAPABILITY_AREA) 0x00000014)
1928#define TPM_CAP_TRANS_ES ((TPM_CAPABILITY_AREA) 0x00000015)
1929#define TPM_CAP_AUTH_ENCRYPT ((TPM_CAPABILITY_AREA) 0x00000017)
1930#define TPM_CAP_SELECT_SIZE ((TPM_CAPABILITY_AREA) 0x00000018)
1931#define TPM_CAP_VERSION_VAL ((TPM_CAPABILITY_AREA) 0x0000001A)
1932
1933#define TPM_CAP_FLAG_PERMANENT ((TPM_CAPABILITY_AREA) 0x00000108)
1934#define TPM_CAP_FLAG_VOLATILE ((TPM_CAPABILITY_AREA) 0x00000109)
1935
1936//
1937// Part 2, section 21.2: CAP_PROPERTY Subcap values for GetCapability
1938//
1939#define TPM_CAP_PROP_PCR ((TPM_CAPABILITY_AREA) 0x00000101)
1940#define TPM_CAP_PROP_DIR ((TPM_CAPABILITY_AREA) 0x00000102)
1941#define TPM_CAP_PROP_MANUFACTURER ((TPM_CAPABILITY_AREA) 0x00000103)
1942#define TPM_CAP_PROP_KEYS ((TPM_CAPABILITY_AREA) 0x00000104)
1943#define TPM_CAP_PROP_MIN_COUNTER ((TPM_CAPABILITY_AREA) 0x00000107)
1944#define TPM_CAP_PROP_AUTHSESS ((TPM_CAPABILITY_AREA) 0x0000010A)
1945#define TPM_CAP_PROP_TRANSESS ((TPM_CAPABILITY_AREA) 0x0000010B)
1946#define TPM_CAP_PROP_COUNTERS ((TPM_CAPABILITY_AREA) 0x0000010C)
1947#define TPM_CAP_PROP_MAX_AUTHSESS ((TPM_CAPABILITY_AREA) 0x0000010D)
1948#define TPM_CAP_PROP_MAX_TRANSESS ((TPM_CAPABILITY_AREA) 0x0000010E)
1949#define TPM_CAP_PROP_MAX_COUNTERS ((TPM_CAPABILITY_AREA) 0x0000010F)
1950#define TPM_CAP_PROP_MAX_KEYS ((TPM_CAPABILITY_AREA) 0x00000110)
1951#define TPM_CAP_PROP_OWNER ((TPM_CAPABILITY_AREA) 0x00000111)
1952#define TPM_CAP_PROP_CONTEXT ((TPM_CAPABILITY_AREA) 0x00000112)
1953#define TPM_CAP_PROP_MAX_CONTEXT ((TPM_CAPABILITY_AREA) 0x00000113)
1954#define TPM_CAP_PROP_FAMILYROWS ((TPM_CAPABILITY_AREA) 0x00000114)
1955#define TPM_CAP_PROP_TIS_TIMEOUT ((TPM_CAPABILITY_AREA) 0x00000115)
1956#define TPM_CAP_PROP_STARTUP_EFFECT ((TPM_CAPABILITY_AREA) 0x00000116)
1957#define TPM_CAP_PROP_DELEGATE_ROW ((TPM_CAPABILITY_AREA) 0x00000117)
1958#define TPM_CAP_PROP_DAA_MAX ((TPM_CAPABILITY_AREA) 0x00000119)
1959#define CAP_PROP_SESSION_DAA ((TPM_CAPABILITY_AREA) 0x0000011A)
1960#define TPM_CAP_PROP_CONTEXT_DIST ((TPM_CAPABILITY_AREA) 0x0000011B)
1961#define TPM_CAP_PROP_DAA_INTERRUPT ((TPM_CAPABILITY_AREA) 0x0000011C)
1962#define TPM_CAP_PROP_SESSIONS ((TPM_CAPABILITY_AREA) 0x0000011D)
1963#define TPM_CAP_PROP_MAX_SESSIONS ((TPM_CAPABILITY_AREA) 0x0000011E)
1964#define TPM_CAP_PROP_CMK_RESTRICTION ((TPM_CAPABILITY_AREA) 0x0000011F)
1965#define TPM_CAP_PROP_DURATION ((TPM_CAPABILITY_AREA) 0x00000120)
1966#define TPM_CAP_PROP_ACTIVE_COUNTER ((TPM_CAPABILITY_AREA) 0x00000122)
1967#define TPM_CAP_PROP_MAX_NV_AVAILABLE ((TPM_CAPABILITY_AREA) 0x00000123)
1968#define TPM_CAP_PROP_INPUT_BUFFER ((TPM_CAPABILITY_AREA) 0x00000124)
1969
1970//
1971// Part 2, section 21.4: TPM_CAPABILITY_AREA for SetCapability
1972//
1973#define TPM_SET_PERM_FLAGS ((TPM_CAPABILITY_AREA) 0x00000001)
1974#define TPM_SET_PERM_DATA ((TPM_CAPABILITY_AREA) 0x00000002)
1975#define TPM_SET_STCLEAR_FLAGS ((TPM_CAPABILITY_AREA) 0x00000003)
1976#define TPM_SET_STCLEAR_DATA ((TPM_CAPABILITY_AREA) 0x00000004)
1977#define TPM_SET_STANY_FLAGS ((TPM_CAPABILITY_AREA) 0x00000005)
1978#define TPM_SET_STANY_DATA ((TPM_CAPABILITY_AREA) 0x00000006)
1979
1980///
1981/// Part 2, section 21.6: TPM_CAP_VERSION_INFO
1982/// [size_is(vendorSpecificSize)] BYTE* vendorSpecific;
1983///
1984typedef struct tdTPM_CAP_VERSION_INFO {
1985 TPM_STRUCTURE_TAG tag;
1986 TPM_VERSION version;
1987 UINT16 specLevel;
1988 UINT8 errataRev;
1989 UINT8 tpmVendorID[4];
1990 UINT16 vendorSpecificSize;
1991 UINT8 *vendorSpecific;
1992} TPM_CAP_VERSION_INFO;
1993
1994///
1995/// Part 2, section 21.10: TPM_DA_ACTION_TYPE
1996///
1997typedef struct tdTPM_DA_ACTION_TYPE {
1998 TPM_STRUCTURE_TAG tag;
1999 UINT32 actions;
2000} TPM_DA_ACTION_TYPE;
2001
2002#define TPM_DA_ACTION_FAILURE_MODE (((UINT32)1)<<3)
2003#define TPM_DA_ACTION_DEACTIVATE (((UINT32)1)<<2)
2004#define TPM_DA_ACTION_DISABLE (((UINT32)1)<<1)
2005#define TPM_DA_ACTION_TIMEOUT (((UINT32)1)<<0)
2006
2007///
2008/// Part 2, section 21.7: TPM_DA_INFO
2009///
2010typedef struct tdTPM_DA_INFO {
2011 TPM_STRUCTURE_TAG tag;
2012 TPM_DA_STATE state;
2013 UINT16 currentCount;
2014 UINT16 thresholdCount;
2015 TPM_DA_ACTION_TYPE actionAtThreshold;
2016 UINT32 actionDependValue;
2017 UINT32 vendorDataSize;
2018 UINT8 *vendorData;
2019} TPM_DA_INFO;
2020
2021///
2022/// Part 2, section 21.8: TPM_DA_INFO_LIMITED
2023///
2024typedef struct tdTPM_DA_INFO_LIMITED {
2025 TPM_STRUCTURE_TAG tag;
2026 TPM_DA_STATE state;
2027 TPM_DA_ACTION_TYPE actionAtThreshold;
2028 UINT32 vendorDataSize;
2029 UINT8 *vendorData;
2030} TPM_DA_INFO_LIMITED;
2031
2032//
2033// Part 2, section 21.9: CAP_PROPERTY Subcap values for GetCapability
2034//
2035#define TPM_DA_STATE_INACTIVE ((UINT8)0x00)
2036#define TPM_DA_STATE_ACTIVE ((UINT8)0x01)
2037
2038//
2039// Part 2, section 22: DAA Structures
2040//
2041
2042//
2043// Part 2, section 22.1: Size definitions
2044//
2045#define TPM_DAA_SIZE_r0 (43)
2046#define TPM_DAA_SIZE_r1 (43)
2047#define TPM_DAA_SIZE_r2 (128)
2048#define TPM_DAA_SIZE_r3 (168)
2049#define TPM_DAA_SIZE_r4 (219)
2050#define TPM_DAA_SIZE_NT (20)
2051#define TPM_DAA_SIZE_v0 (128)
2052#define TPM_DAA_SIZE_v1 (192)
2053#define TPM_DAA_SIZE_NE (256)
2054#define TPM_DAA_SIZE_w (256)
2055#define TPM_DAA_SIZE_issuerModulus (256)
2056//
2057// Part 2, section 22.2: Constant definitions
2058//
2059#define TPM_DAA_power0 (104)
2060#define TPM_DAA_power1 (1024)
2061
2062///
2063/// Part 2, section 22.3: TPM_DAA_ISSUER
2064///
2065typedef struct tdTPM_DAA_ISSUER {
2066 TPM_STRUCTURE_TAG tag;
2067 TPM_DIGEST DAA_digest_R0;
2068 TPM_DIGEST DAA_digest_R1;
2069 TPM_DIGEST DAA_digest_S0;
2070 TPM_DIGEST DAA_digest_S1;
2071 TPM_DIGEST DAA_digest_n;
2072 TPM_DIGEST DAA_digest_gamma;
2073 UINT8 DAA_generic_q[26];
2074} TPM_DAA_ISSUER;
2075
2076///
2077/// Part 2, section 22.4: TPM_DAA_TPM
2078///
2079typedef struct tdTPM_DAA_TPM {
2080 TPM_STRUCTURE_TAG tag;
2081 TPM_DIGEST DAA_digestIssuer;
2082 TPM_DIGEST DAA_digest_v0;
2083 TPM_DIGEST DAA_digest_v1;
2084 TPM_DIGEST DAA_rekey;
2085 UINT32 DAA_count;
2086} TPM_DAA_TPM;
2087
2088///
2089/// Part 2, section 22.5: TPM_DAA_CONTEXT
2090///
2091typedef struct tdTPM_DAA_CONTEXT {
2092 TPM_STRUCTURE_TAG tag;
2093 TPM_DIGEST DAA_digestContext;
2094 TPM_DIGEST DAA_digest;
2095 TPM_DAA_CONTEXT_SEED DAA_contextSeed;
2096 UINT8 DAA_scratch[256];
2097 UINT8 DAA_stage;
2098} TPM_DAA_CONTEXT;
2099
2100///
2101/// Part 2, section 22.6: TPM_DAA_JOINDATA
2102///
2103typedef struct tdTPM_DAA_JOINDATA {
2104 UINT8 DAA_join_u0[128];
2105 UINT8 DAA_join_u1[138];
2106 TPM_DIGEST DAA_digest_n0;
2107} TPM_DAA_JOINDATA;
2108
2109///
2110/// Part 2, section 22.8: TPM_DAA_BLOB
2111///
2112typedef struct tdTPM_DAA_BLOB {
2113 TPM_STRUCTURE_TAG tag;
2114 TPM_RESOURCE_TYPE resourceType;
2115 UINT8 label[16];
2116 TPM_DIGEST blobIntegrity;
2117 UINT32 additionalSize;
2118 UINT8 *additionalData;
2119 UINT32 sensitiveSize;
2120 UINT8 *sensitiveData;
2121} TPM_DAA_BLOB;
2122
2123///
2124/// Part 2, section 22.9: TPM_DAA_SENSITIVE
2125///
2126typedef struct tdTPM_DAA_SENSITIVE {
2127 TPM_STRUCTURE_TAG tag;
2128 UINT32 internalSize;
2129 UINT8 *internalData;
2130} TPM_DAA_SENSITIVE;
2131
2132//
2133// Part 2, section 23: Redirection
2134//
2135
2136///
2137/// Part 2 section 23.1: TPM_REDIR_COMMAND
2138/// This section defines exactly one value but does not
2139/// give it a name. The definition of TPM_SetRedirection in Part3
2140/// refers to exactly one name but does not give its value. We join
2141/// them here.
2142///
2143#define TPM_REDIR_GPIO (0x00000001)
2144
2145///
2146/// TPM Command Headers defined in Part 3
2147///
2148typedef struct tdTPM_RQU_COMMAND_HDR {
2149 TPM_STRUCTURE_TAG tag;
2150 UINT32 paramSize;
2151 TPM_COMMAND_CODE ordinal;
2152} TPM_RQU_COMMAND_HDR;
2153
2154///
2155/// TPM Response Headers defined in Part 3
2156///
2157typedef struct tdTPM_RSP_COMMAND_HDR {
2158 TPM_STRUCTURE_TAG tag;
2159 UINT32 paramSize;
2160 TPM_RESULT returnCode;
2161} TPM_RSP_COMMAND_HDR;
2162
2163#pragma pack ()
2164
2165#endif