MdePkg/Include/IndustryStandard/Tpm12.h

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