qemu/roms/ipxe/src/include/ipxe/efi/IndustryStandard/Tpm12.h

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