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