include/tpm.h

   1 /*
   2  * Copyright (c) 2013 The Chromium OS Authors.
   3  * Coypright (c) 2013 Guntermann & Drunck GmbH
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  */
   7
   8 #ifndef __TPM_H
   9 #define __TPM_H
  10
  11 #include <tis.h>
  12
  13 /*
  14  * Here is a partial implementation of TPM commands.  Please consult TCG Main
  15  * Specification for definitions of TPM commands.
  16  */
  17
  18 #define TPM_HEADER_SIZE         10
  19
  20 enum tpm_duration {
  21         TPM_SHORT = 0,
  22         TPM_MEDIUM = 1,
  23         TPM_LONG = 2,
  24         TPM_UNDEFINED,
  25
  26         TPM_DURATION_COUNT,
  27 };
  28
  29 enum tpm_startup_type {
  30         TPM_ST_CLEAR            = 0x0001,
  31         TPM_ST_STATE            = 0x0002,
  32         TPM_ST_DEACTIVATED      = 0x0003,
  33 };
  34
  35 enum tpm_physical_presence {
  36         TPM_PHYSICAL_PRESENCE_HW_DISABLE        = 0x0200,
  37         TPM_PHYSICAL_PRESENCE_CMD_DISABLE       = 0x0100,
  38         TPM_PHYSICAL_PRESENCE_LIFETIME_LOCK     = 0x0080,
  39         TPM_PHYSICAL_PRESENCE_HW_ENABLE         = 0x0040,
  40         TPM_PHYSICAL_PRESENCE_CMD_ENABLE        = 0x0020,
  41         TPM_PHYSICAL_PRESENCE_NOTPRESENT        = 0x0010,
  42         TPM_PHYSICAL_PRESENCE_PRESENT           = 0x0008,
  43         TPM_PHYSICAL_PRESENCE_LOCK              = 0x0004,
  44 };
  45
  46 enum tpm_nv_index {
  47         TPM_NV_INDEX_LOCK       = 0xffffffff,
  48         TPM_NV_INDEX_0          = 0x00000000,
  49         TPM_NV_INDEX_DIR        = 0x10000001,
  50 };
  51
  52 /**
  53  * TPM return codes as defined in the TCG Main specification
  54  * (TPM Main Part 2 Structures; Specification version 1.2)
  55  */
  56 enum tpm_return_code {
  57         TPM_BASE        = 0x00000000,
  58         TPM_NON_FATAL   = 0x00000800,
  59         TPM_SUCCESS     = TPM_BASE,
  60         /* TPM-defined fatal error codes */
  61         TPM_AUTHFAIL                    = TPM_BASE +  1,
  62         TPM_BADINDEX                    = TPM_BASE +  2,
  63         TPM_BAD_PARAMETER               = TPM_BASE +  3,
  64         TPM_AUDITFAILURE                = TPM_BASE +  4,
  65         TPM_CLEAR_DISABLED              = TPM_BASE +  5,
  66         TPM_DEACTIVATED                 = TPM_BASE +  6,
  67         TPM_DISABLED                    = TPM_BASE +  7,
  68         TPM_DISABLED_CMD                = TPM_BASE +  8,
  69         TPM_FAIL                        = TPM_BASE +  9,
  70         TPM_BAD_ORDINAL                 = TPM_BASE + 10,
  71         TPM_INSTALL_DISABLED            = TPM_BASE + 11,
  72         TPM_INVALID_KEYHANDLE           = TPM_BASE + 12,
  73         TPM_KEYNOTFOUND                 = TPM_BASE + 13,
  74         TPM_INAPPROPRIATE_ENC           = TPM_BASE + 14,
  75         TPM_MIGRATE_FAIL                = TPM_BASE + 15,
  76         TPM_INVALID_PCR_INFO            = TPM_BASE + 16,
  77         TPM_NOSPACE                     = TPM_BASE + 17,
  78         TPM_NOSRK                       = TPM_BASE + 18,
  79         TPM_NOTSEALED_BLOB              = TPM_BASE + 19,
  80         TPM_OWNER_SET                   = TPM_BASE + 20,
  81         TPM_RESOURCES                   = TPM_BASE + 21,
  82         TPM_SHORTRANDOM                 = TPM_BASE + 22,
  83         TPM_SIZE                        = TPM_BASE + 23,
  84         TPM_WRONGPCRVAL                 = TPM_BASE + 24,
  85         TPM_BAD_PARAM_SIZE              = TPM_BASE + 25,
  86         TPM_SHA_THREAD                  = TPM_BASE + 26,
  87         TPM_SHA_ERROR                   = TPM_BASE + 27,
  88         TPM_FAILEDSELFTEST              = TPM_BASE + 28,
  89         TPM_AUTH2FAIL                   = TPM_BASE + 29,
  90         TPM_BADTAG                      = TPM_BASE + 30,
  91         TPM_IOERROR                     = TPM_BASE + 31,
  92         TPM_ENCRYPT_ERROR               = TPM_BASE + 32,
  93         TPM_DECRYPT_ERROR               = TPM_BASE + 33,
  94         TPM_INVALID_AUTHHANDLE          = TPM_BASE + 34,
  95         TPM_NO_ENDORSEMENT              = TPM_BASE + 35,
  96         TPM_INVALID_KEYUSAGE            = TPM_BASE + 36,
  97         TPM_WRONG_ENTITYTYPE            = TPM_BASE + 37,
  98         TPM_INVALID_POSTINIT            = TPM_BASE + 38,
  99         TPM_INAPPROPRIATE_SIG           = TPM_BASE + 39,
 100         TPM_BAD_KEY_PROPERTY            = TPM_BASE + 40,
 101         TPM_BAD_MIGRATION               = TPM_BASE + 41,
 102         TPM_BAD_SCHEME                  = TPM_BASE + 42,
 103         TPM_BAD_DATASIZE                = TPM_BASE + 43,
 104         TPM_BAD_MODE                    = TPM_BASE + 44,
 105         TPM_BAD_PRESENCE                = TPM_BASE + 45,
 106         TPM_BAD_VERSION                 = TPM_BASE + 46,
 107         TPM_NO_WRAP_TRANSPORT           = TPM_BASE + 47,
 108         TPM_AUDITFAIL_UNSUCCESSFUL      = TPM_BASE + 48,
 109         TPM_AUDITFAIL_SUCCESSFUL        = TPM_BASE + 49,
 110         TPM_NOTRESETABLE                = TPM_BASE + 50,
 111         TPM_NOTLOCAL                    = TPM_BASE + 51,
 112         TPM_BAD_TYPE                    = TPM_BASE + 52,
 113         TPM_INVALID_RESOURCE            = TPM_BASE + 53,
 114         TPM_NOTFIPS                     = TPM_BASE + 54,
 115         TPM_INVALID_FAMILY              = TPM_BASE + 55,
 116         TPM_NO_NV_PERMISSION            = TPM_BASE + 56,
 117         TPM_REQUIRES_SIGN               = TPM_BASE + 57,
 118         TPM_KEY_NOTSUPPORTED            = TPM_BASE + 58,
 119         TPM_AUTH_CONFLICT               = TPM_BASE + 59,
 120         TPM_AREA_LOCKED                 = TPM_BASE + 60,
 121         TPM_BAD_LOCALITY                = TPM_BASE + 61,
 122         TPM_READ_ONLY                   = TPM_BASE + 62,
 123         TPM_PER_NOWRITE                 = TPM_BASE + 63,
 124         TPM_FAMILY_COUNT                = TPM_BASE + 64,
 125         TPM_WRITE_LOCKED                = TPM_BASE + 65,
 126         TPM_BAD_ATTRIBUTES              = TPM_BASE + 66,
 127         TPM_INVALID_STRUCTURE           = TPM_BASE + 67,
 128         TPM_KEY_OWNER_CONTROL           = TPM_BASE + 68,
 129         TPM_BAD_COUNTER                 = TPM_BASE + 69,
 130         TPM_NOT_FULLWRITE               = TPM_BASE + 70,
 131         TPM_CONTEXT_GAP                 = TPM_BASE + 71,
 132         TPM_MAXNVWRITES                 = TPM_BASE + 72,
 133         TPM_NOOPERATOR                  = TPM_BASE + 73,
 134         TPM_RESOURCEMISSING             = TPM_BASE + 74,
 135         TPM_DELEGATE_LOCK               = TPM_BASE + 75,
 136         TPM_DELEGATE_FAMILY             = TPM_BASE + 76,
 137         TPM_DELEGATE_ADMIN              = TPM_BASE + 77,
 138         TPM_TRANSPORT_NOTEXCLUSIVE      = TPM_BASE + 78,
 139         TPM_OWNER_CONTROL               = TPM_BASE + 79,
 140         TPM_DAA_RESOURCES               = TPM_BASE + 80,
 141         TPM_DAA_INPUT_DATA0             = TPM_BASE + 81,
 142         TPM_DAA_INPUT_DATA1             = TPM_BASE + 82,
 143         TPM_DAA_ISSUER_SETTINGS         = TPM_BASE + 83,
 144         TPM_DAA_TPM_SETTINGS            = TPM_BASE + 84,
 145         TPM_DAA_STAGE                   = TPM_BASE + 85,
 146         TPM_DAA_ISSUER_VALIDITY         = TPM_BASE + 86,
 147         TPM_DAA_WRONG_W                 = TPM_BASE + 87,
 148         TPM_BAD_HANDLE                  = TPM_BASE + 88,
 149         TPM_BAD_DELEGATE                = TPM_BASE + 89,
 150         TPM_BADCONTEXT                  = TPM_BASE + 90,
 151         TPM_TOOMANYCONTEXTS             = TPM_BASE + 91,
 152         TPM_MA_TICKET_SIGNATURE         = TPM_BASE + 92,
 153         TPM_MA_DESTINATION              = TPM_BASE + 93,
 154         TPM_MA_SOURCE                   = TPM_BASE + 94,
 155         TPM_MA_AUTHORITY                = TPM_BASE + 95,
 156         TPM_PERMANENTEK                 = TPM_BASE + 97,
 157         TPM_BAD_SIGNATURE               = TPM_BASE + 98,
 158         TPM_NOCONTEXTSPACE              = TPM_BASE + 99,
 159         /* TPM-defined non-fatal errors */
 160         TPM_RETRY               = TPM_BASE + TPM_NON_FATAL,
 161         TPM_NEEDS_SELFTEST      = TPM_BASE + TPM_NON_FATAL + 1,
 162         TPM_DOING_SELFTEST      = TPM_BASE + TPM_NON_FATAL + 2,
 163         TPM_DEFEND_LOCK_RUNNING = TPM_BASE + TPM_NON_FATAL + 3,
 164 };
 165
 166 #ifdef CONFIG_DM_TPM
 167
 168 /* Max buffer size supported by our tpm */
 169 #define TPM_DEV_BUFSIZE         1260
 170
 171 /**
 172  * struct tpm_chip_priv - Information about a TPM, stored by the uclass
 173  *
 174  * These values must be set up by the device's probe() method before
 175  * communcation is attempted. If the device has an xfer() method, this is
 176  * not needed. There is no need to set up @buf.
 177  *
 178  * @duration_ms:        Length of each duration type in milliseconds
 179  * @retry_time_ms:      Time to wait before retrying receive
 180  */
 181 struct tpm_chip_priv {
 182         uint duration_ms[TPM_DURATION_COUNT];
 183         uint retry_time_ms;
 184         u8 buf[TPM_DEV_BUFSIZE + sizeof(u8)];  /* Max buffer size + addr */
 185 };
 186
 187 /**
 188  * struct tpm_ops - low-level TPM operations
 189  *
 190  * These are designed to avoid loops and delays in the driver itself. These
 191  * should be handled in the uclass.
 192  *
 193  * In gneral you should implement everything except xfer(). Where you need
 194  * complete control of the transfer, then xfer() can be provided and will
 195  * override the other methods.
 196  *
 197  * This interface is for low-level TPM access. It does not understand the
 198  * concept of localities or the various TPM messages. That interface is
 199  * defined in the functions later on in this file, but they all translate
 200  * to bytes which are sent and received.
 201  */
 202 struct tpm_ops {
 203         /**
 204          * open() - Request access to locality 0 for the caller
 205          *
 206          * After all commands have been completed the caller should call
 207          * close().
 208          *
 209          * @dev:        Device to close
 210          * @return 0 ok OK, -ve on error
 211          */
 212         int (*open)(struct udevice *dev);
 213
 214         /**
 215          * close() - Close the current session
 216          *
 217          * Releasing the locked locality. Returns 0 on success, -ve 1 on
 218          * failure (in case lock removal did not succeed).
 219          *
 220          * @dev:        Device to close
 221          * @return 0 ok OK, -ve on error
 222          */
 223         int (*close)(struct udevice *dev);
 224
 225         /**
 226          * get_desc() - Get a text description of the TPM
 227          *
 228          * @dev:        Device to check
 229          * @buf:        Buffer to put the string
 230          * @size:       Maximum size of buffer
 231          * @return length of string, or -ENOSPC it no space
 232          */
 233         int (*get_desc)(struct udevice *dev, char *buf, int size);
 234
 235         /**
 236          * send() - send data to the TPM
 237          *
 238          * @dev:        Device to talk to
 239          * @sendbuf:    Buffer of the data to send
 240          * @send_size:  Size of the data to send
 241          *
 242          * Returns 0 on success or -ve on failure.
 243          */
 244         int (*send)(struct udevice *dev, const uint8_t *sendbuf,
 245                     size_t send_size);
 246
 247         /**
 248          * recv() - receive a response from the TPM
 249          *
 250          * @dev:        Device to talk to
 251          * @recvbuf:    Buffer to save the response to
 252          * @max_size:   Maximum number of bytes to receive
 253          *
 254          * Returns number of bytes received on success, -EAGAIN if the TPM
 255          * response is not ready, -EINTR if cancelled, or other -ve value on
 256          * failure.
 257          */
 258         int (*recv)(struct udevice *dev, uint8_t *recvbuf, size_t max_size);
 259
 260         /**
 261          * cleanup() - clean up after an operation in progress
 262          *
 263          * This is called if receiving times out. The TPM may need to abort
 264          * the current transaction if it did not complete, and make itself
 265          * ready for another.
 266          *
 267          * @dev:        Device to talk to
 268          */
 269         int (*cleanup)(struct udevice *dev);
 270
 271         /**
 272          * xfer() - send data to the TPM and get response
 273          *
 274          * This method is optional. If it exists it is used in preference
 275          * to send(), recv() and cleanup(). It should handle all aspects of
 276          * TPM communication for a single transfer.
 277          *
 278          * @dev:        Device to talk to
 279          * @sendbuf:    Buffer of the data to send
 280          * @send_size:  Size of the data to send
 281          * @recvbuf:    Buffer to save the response to
 282          * @recv_size:  Pointer to the size of the response buffer
 283          *
 284          * Returns 0 on success (and places the number of response bytes at
 285          * recv_size) or -ve on failure.
 286          */
 287         int (*xfer)(struct udevice *dev, const uint8_t *sendbuf,
 288                     size_t send_size, uint8_t *recvbuf, size_t *recv_size);
 289 };
 290
 291 #define tpm_get_ops(dev)        ((struct tpm_ops *)device_get_ops(dev))
 292
 293 /**
 294  * tpm_open() - Request access to locality 0 for the caller
 295  *
 296  * After all commands have been completed the caller is supposed to
 297  * call tpm_close().
 298  *
 299  * Returns 0 on success, -ve on failure.
 300  */
 301 int tpm_open(struct udevice *dev);
 302
 303 /**
 304  * tpm_close() - Close the current session
 305  *
 306  * Releasing the locked locality. Returns 0 on success, -ve 1 on
 307  * failure (in case lock removal did not succeed).
 308  */
 309 int tpm_close(struct udevice *dev);
 310
 311 /**
 312  * tpm_get_desc() - Get a text description of the TPM
 313  *
 314  * @dev:        Device to check
 315  * @buf:        Buffer to put the string
 316  * @size:       Maximum size of buffer
 317  * @return length of string, or -ENOSPC it no space
 318  */
 319 int tpm_get_desc(struct udevice *dev, char *buf, int size);
 320
 321 /**
 322  * tpm_xfer() - send data to the TPM and get response
 323  *
 324  * This first uses the device's send() method to send the bytes. Then it calls
 325  * recv() to get the reply. If recv() returns -EAGAIN then it will delay a
 326  * short time and then call recv() again.
 327  *
 328  * Regardless of whether recv() completes successfully, it will then call
 329  * cleanup() to finish the transaction.
 330  *
 331  * Note that the outgoing data is inspected to determine command type
 332  * (ordinal) and a timeout is used for that command type.
 333  *
 334  * @sendbuf - buffer of the data to send
 335  * @send_size size of the data to send
 336  * @recvbuf - memory to save the response to
 337  * @recv_len - pointer to the size of the response buffer
 338  *
 339  * Returns 0 on success (and places the number of response bytes at
 340  * recv_len) or -ve on failure.
 341  */
 342 int tpm_xfer(struct udevice *dev, const uint8_t *sendbuf, size_t send_size,
 343              uint8_t *recvbuf, size_t *recv_size);
 344
 345 #endif /* CONFIG_DM_TPM */
 346
 347 /**
 348  * Initialize TPM device.  It must be called before any TPM commands.
 349  *
 350  * @return 0 on success, non-0 on error.
 351  */
 352 uint32_t tpm_init(void);
 353
 354 /**
 355  * Issue a TPM_Startup command.
 356  *
 357  * @param mode          TPM startup mode
 358  * @return return code of the operation
 359  */
 360 uint32_t tpm_startup(enum tpm_startup_type mode);
 361
 362 /**
 363  * Issue a TPM_SelfTestFull command.
 364  *
 365  * @return return code of the operation
 366  */
 367 uint32_t tpm_self_test_full(void);
 368
 369 /**
 370  * Issue a TPM_ContinueSelfTest command.
 371  *
 372  * @return return code of the operation
 373  */
 374 uint32_t tpm_continue_self_test(void);
 375
 376 /**
 377  * Issue a TPM_NV_DefineSpace command.  The implementation is limited
 378  * to specify TPM_NV_ATTRIBUTES and size of the area.  The area index
 379  * could be one of the special value listed in enum tpm_nv_index.
 380  *
 381  * @param index         index of the area
 382  * @param perm          TPM_NV_ATTRIBUTES of the area
 383  * @param size          size of the area
 384  * @return return code of the operation
 385  */
 386 uint32_t tpm_nv_define_space(uint32_t index, uint32_t perm, uint32_t size);
 387
 388 /**
 389  * Issue a TPM_NV_ReadValue command.  This implementation is limited
 390  * to read the area from offset 0.  The area index could be one of
 391  * the special value listed in enum tpm_nv_index.
 392  *
 393  * @param index         index of the area
 394  * @param data          output buffer of the area contents
 395  * @param count         size of output buffer
 396  * @return return code of the operation
 397  */
 398 uint32_t tpm_nv_read_value(uint32_t index, void *data, uint32_t count);
 399
 400 /**
 401  * Issue a TPM_NV_WriteValue command.  This implementation is limited
 402  * to write the area from offset 0.  The area index could be one of
 403  * the special value listed in enum tpm_nv_index.
 404  *
 405  * @param index         index of the area
 406  * @param data          input buffer to be wrote to the area
 407  * @param length        length of data bytes of input buffer
 408  * @return return code of the operation
 409  */
 410 uint32_t tpm_nv_write_value(uint32_t index, const void *data, uint32_t length);
 411
 412 /**
 413  * Issue a TPM_Extend command.
 414  *
 415  * @param index         index of the PCR
 416  * @param in_digest     160-bit value representing the event to be
 417  *                      recorded
 418  * @param out_digest    160-bit PCR value after execution of the
 419  *                      command
 420  * @return return code of the operation
 421  */
 422 uint32_t tpm_extend(uint32_t index, const void *in_digest, void *out_digest);
 423
 424 /**
 425  * Issue a TPM_PCRRead command.
 426  *
 427  * @param index         index of the PCR
 428  * @param data          output buffer for contents of the named PCR
 429  * @param count         size of output buffer
 430  * @return return code of the operation
 431  */
 432 uint32_t tpm_pcr_read(uint32_t index, void *data, size_t count);
 433
 434 /**
 435  * Issue a TSC_PhysicalPresence command.  TPM physical presence flag
 436  * is bit-wise OR'ed of flags listed in enum tpm_physical_presence.
 437  *
 438  * @param presence      TPM physical presence flag
 439  * @return return code of the operation
 440  */
 441 uint32_t tpm_tsc_physical_presence(uint16_t presence);
 442
 443 /**
 444  * Issue a TPM_ReadPubek command.
 445  *
 446  * @param data          output buffer for the public endorsement key
 447  * @param count         size of ouput buffer
 448  * @return return code of the operation
 449  */
 450 uint32_t tpm_read_pubek(void *data, size_t count);
 451
 452 /**
 453  * Issue a TPM_ForceClear command.
 454  *
 455  * @return return code of the operation
 456  */
 457 uint32_t tpm_force_clear(void);
 458
 459 /**
 460  * Issue a TPM_PhysicalEnable command.
 461  *
 462  * @return return code of the operation
 463  */
 464 uint32_t tpm_physical_enable(void);
 465
 466 /**
 467  * Issue a TPM_PhysicalDisable command.
 468  *
 469  * @return return code of the operation
 470  */
 471 uint32_t tpm_physical_disable(void);
 472
 473 /**
 474  * Issue a TPM_PhysicalSetDeactivated command.
 475  *
 476  * @param state         boolean state of the deactivated flag
 477  * @return return code of the operation
 478  */
 479 uint32_t tpm_physical_set_deactivated(uint8_t state);
 480
 481 /**
 482  * Issue a TPM_GetCapability command.  This implementation is limited
 483  * to query sub_cap index that is 4-byte wide.
 484  *
 485  * @param cap_area      partition of capabilities
 486  * @param sub_cap       further definition of capability, which is
 487  *                      limited to be 4-byte wide
 488  * @param cap           output buffer for capability information
 489  * @param count         size of ouput buffer
 490  * @return return code of the operation
 491  */
 492 uint32_t tpm_get_capability(uint32_t cap_area, uint32_t sub_cap,
 493                 void *cap, size_t count);
 494
 495 /**
 496  * Issue a TPM_FlushSpecific command for a AUTH ressource.
 497  *
 498  * @param auth_handle   handle of the auth session
 499  * @return return code of the operation
 500  */
 501 uint32_t tpm_terminate_auth_session(uint32_t auth_handle);
 502
 503 /**
 504  * Issue a TPM_OIAP command to setup an object independant authorization
 505  * session.
 506  * Information about the session is stored internally.
 507  * If there was already an OIAP session active it is terminated and a new
 508  * session is set up.
 509  *
 510  * @param auth_handle   pointer to the (new) auth handle or NULL.
 511  * @return return code of the operation
 512  */
 513 uint32_t tpm_oiap(uint32_t *auth_handle);
 514
 515 /**
 516  * Ends an active OIAP session.
 517  *
 518  * @return return code of the operation
 519  */
 520 uint32_t tpm_end_oiap(void);
 521
 522 /**
 523  * Issue a TPM_LoadKey2 (Auth1) command using an OIAP session for authenticating
 524  * the usage of the parent key.
 525  *
 526  * @param parent_handle handle of the parent key.
 527  * @param key           pointer to the key structure (TPM_KEY or TPM_KEY12).
 528  * @param key_length    size of the key structure
 529  * @param parent_key_usage_auth usage auth for the parent key
 530  * @param key_handle    pointer to the key handle
 531  * @return return code of the operation
 532  */
 533 uint32_t tpm_load_key2_oiap(uint32_t parent_handle,
 534                 const void *key, size_t key_length,
 535                 const void *parent_key_usage_auth,
 536                 uint32_t *key_handle);
 537
 538 /**
 539  * Issue a TPM_GetPubKey (Auth1) command using an OIAP session for
 540  * authenticating the usage of the key.
 541  *
 542  * @param key_handle    handle of the key
 543  * @param usage_auth    usage auth for the key
 544  * @param pubkey        pointer to the pub key buffer; may be NULL if the pubkey
 545  *                      should not be stored.
 546  * @param pubkey_len    pointer to the pub key buffer len. On entry: the size of
 547  *                      the provided pubkey buffer. On successful exit: the size
 548  *                      of the stored TPM_PUBKEY structure (iff pubkey != NULL).
 549  * @return return code of the operation
 550  */
 551 uint32_t tpm_get_pub_key_oiap(uint32_t key_handle, const void *usage_auth,
 552                 void *pubkey, size_t *pubkey_len);
 553
 554 #endif /* __TPM_H */