tpm-v2.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * Defines APIs and structures that allow software to interact with a
  4. * TPM2 device
  5. *
  6. * Copyright (c) 2020 Linaro
  7. * Copyright (c) 2018 Bootlin
  8. *
  9. * https://trustedcomputinggroup.org/resource/tss-overview-common-structures-specification/
  10. *
  11. * Author: Miquel Raynal <miquel.raynal@bootlin.com>
  12. */
  13. #ifndef __TPM_V2_H
  14. #define __TPM_V2_H
  15. #include <tpm-common.h>
  16. struct udevice;
  17. #define TPM2_DIGEST_LEN 32
  18. #define TPM2_SHA1_DIGEST_SIZE 20
  19. #define TPM2_SHA256_DIGEST_SIZE 32
  20. #define TPM2_SHA384_DIGEST_SIZE 48
  21. #define TPM2_SHA512_DIGEST_SIZE 64
  22. #define TPM2_SM3_256_DIGEST_SIZE 32
  23. #define TPM2_MAX_PCRS 32
  24. #define TPM2_PCR_SELECT_MAX ((TPM2_MAX_PCRS + 7) / 8)
  25. #define TPM2_MAX_CAP_BUFFER 1024
  26. #define TPM2_MAX_TPM_PROPERTIES ((TPM2_MAX_CAP_BUFFER - sizeof(u32) /* TPM2_CAP */ - \
  27. sizeof(u32)) / sizeof(struct tpms_tagged_property))
  28. /*
  29. * We deviate from this draft of the specification by increasing the value of
  30. * TPM2_NUM_PCR_BANKS from 3 to 16 to ensure compatibility with TPM2
  31. * implementations that have enabled a larger than typical number of PCR
  32. * banks. This larger value for TPM2_NUM_PCR_BANKS is expected to be included
  33. * in a future revision of the specification.
  34. */
  35. #define TPM2_NUM_PCR_BANKS 16
  36. /* Definition of (UINT32) TPM2_CAP Constants */
  37. #define TPM2_CAP_PCRS 0x00000005U
  38. #define TPM2_CAP_TPM_PROPERTIES 0x00000006U
  39. /* Definition of (UINT32) TPM2_PT Constants */
  40. #define TPM2_PT_GROUP (u32)(0x00000100)
  41. #define TPM2_PT_FIXED (u32)(TPM2_PT_GROUP * 1)
  42. #define TPM2_PT_MANUFACTURER (u32)(TPM2_PT_FIXED + 5)
  43. #define TPM2_PT_PCR_COUNT (u32)(TPM2_PT_FIXED + 18)
  44. #define TPM2_PT_MAX_COMMAND_SIZE (u32)(TPM2_PT_FIXED + 30)
  45. #define TPM2_PT_MAX_RESPONSE_SIZE (u32)(TPM2_PT_FIXED + 31)
  46. /* event types */
  47. #define EV_POST_CODE ((u32)0x00000001)
  48. #define EV_NO_ACTION ((u32)0x00000003)
  49. #define EV_SEPARATOR ((u32)0x00000004)
  50. #define EV_S_CRTM_CONTENTS ((u32)0x00000007)
  51. #define EV_S_CRTM_VERSION ((u32)0x00000008)
  52. #define EV_CPU_MICROCODE ((u32)0x00000009)
  53. #define EV_TABLE_OF_DEVICES ((u32)0x0000000B)
  54. /* TPMS_TAGGED_PROPERTY Structure */
  55. struct tpms_tagged_property {
  56. u32 property;
  57. u32 value;
  58. } __packed;
  59. /* TPMS_PCR_SELECTION Structure */
  60. struct tpms_pcr_selection {
  61. u16 hash;
  62. u8 size_of_select;
  63. u8 pcr_select[TPM2_PCR_SELECT_MAX];
  64. } __packed;
  65. /* TPML_PCR_SELECTION Structure */
  66. struct tpml_pcr_selection {
  67. u32 count;
  68. struct tpms_pcr_selection selection[TPM2_NUM_PCR_BANKS];
  69. } __packed;
  70. /* TPML_TAGGED_TPM_PROPERTY Structure */
  71. struct tpml_tagged_tpm_property {
  72. u32 count;
  73. struct tpms_tagged_property tpm_property[TPM2_MAX_TPM_PROPERTIES];
  74. } __packed;
  75. /* TPMU_CAPABILITIES Union */
  76. union tpmu_capabilities {
  77. /*
  78. * Non exhaustive. Only added the structs needed for our
  79. * current code
  80. */
  81. struct tpml_pcr_selection assigned_pcr;
  82. struct tpml_tagged_tpm_property tpm_properties;
  83. } __packed;
  84. /* TPMS_CAPABILITY_DATA Structure */
  85. struct tpms_capability_data {
  86. u32 capability;
  87. union tpmu_capabilities data;
  88. } __packed;
  89. /**
  90. * SHA1 Event Log Entry Format
  91. *
  92. * @pcr_index: PCRIndex event extended to
  93. * @event_type: Type of event (see EFI specs)
  94. * @digest: Value extended into PCR index
  95. * @event_size: Size of event
  96. * @event: Event data
  97. */
  98. struct tcg_pcr_event {
  99. u32 pcr_index;
  100. u32 event_type;
  101. u8 digest[TPM2_SHA1_DIGEST_SIZE];
  102. u32 event_size;
  103. u8 event[];
  104. } __packed;
  105. /**
  106. * Definition of TPMU_HA Union
  107. */
  108. union tmpu_ha {
  109. u8 sha1[TPM2_SHA1_DIGEST_SIZE];
  110. u8 sha256[TPM2_SHA256_DIGEST_SIZE];
  111. u8 sm3_256[TPM2_SM3_256_DIGEST_SIZE];
  112. u8 sha384[TPM2_SHA384_DIGEST_SIZE];
  113. u8 sha512[TPM2_SHA512_DIGEST_SIZE];
  114. } __packed;
  115. /**
  116. * Definition of TPMT_HA Structure
  117. *
  118. * @hash_alg: Hash algorithm defined in enum tpm2_algorithms
  119. * @digest: Digest value for a given algorithm
  120. */
  121. struct tpmt_ha {
  122. u16 hash_alg;
  123. union tmpu_ha digest;
  124. } __packed;
  125. /**
  126. * Definition of TPML_DIGEST_VALUES Structure
  127. *
  128. * @count: Number of algorithms supported by hardware
  129. * @digests: struct for algorithm id and hash value
  130. */
  131. struct tpml_digest_values {
  132. u32 count;
  133. struct tpmt_ha digests[TPM2_NUM_PCR_BANKS];
  134. } __packed;
  135. /**
  136. * Crypto Agile Log Entry Format
  137. *
  138. * @pcr_index: PCRIndex event extended to
  139. * @event_type: Type of event
  140. * @digests: List of digestsextended to PCR index
  141. * @event_size: Size of the event data
  142. * @event: Event data
  143. */
  144. struct tcg_pcr_event2 {
  145. u32 pcr_index;
  146. u32 event_type;
  147. struct tpml_digest_values digests;
  148. u32 event_size;
  149. u8 event[];
  150. } __packed;
  151. /**
  152. * TPM2 Structure Tags for command/response buffers.
  153. *
  154. * @TPM2_ST_NO_SESSIONS: the command does not need an authentication.
  155. * @TPM2_ST_SESSIONS: the command needs an authentication.
  156. */
  157. enum tpm2_structures {
  158. TPM2_ST_NO_SESSIONS = 0x8001,
  159. TPM2_ST_SESSIONS = 0x8002,
  160. };
  161. /**
  162. * TPM2 type of boolean.
  163. */
  164. enum tpm2_yes_no {
  165. TPMI_YES = 1,
  166. TPMI_NO = 0,
  167. };
  168. /**
  169. * TPM2 startup values.
  170. *
  171. * @TPM2_SU_CLEAR: reset the internal state.
  172. * @TPM2_SU_STATE: restore saved state (if any).
  173. */
  174. enum tpm2_startup_types {
  175. TPM2_SU_CLEAR = 0x0000,
  176. TPM2_SU_STATE = 0x0001,
  177. };
  178. /**
  179. * TPM2 permanent handles.
  180. *
  181. * @TPM2_RH_OWNER: refers to the 'owner' hierarchy.
  182. * @TPM2_RS_PW: indicates a password.
  183. * @TPM2_RH_LOCKOUT: refers to the 'lockout' hierarchy.
  184. * @TPM2_RH_ENDORSEMENT: refers to the 'endorsement' hierarchy.
  185. * @TPM2_RH_PLATFORM: refers to the 'platform' hierarchy.
  186. */
  187. enum tpm2_handles {
  188. TPM2_RH_OWNER = 0x40000001,
  189. TPM2_RS_PW = 0x40000009,
  190. TPM2_RH_LOCKOUT = 0x4000000A,
  191. TPM2_RH_ENDORSEMENT = 0x4000000B,
  192. TPM2_RH_PLATFORM = 0x4000000C,
  193. };
  194. /**
  195. * TPM2 command codes used at the beginning of a buffer, gives the command.
  196. *
  197. * @TPM2_CC_STARTUP: TPM2_Startup().
  198. * @TPM2_CC_SELF_TEST: TPM2_SelfTest().
  199. * @TPM2_CC_CLEAR: TPM2_Clear().
  200. * @TPM2_CC_CLEARCONTROL: TPM2_ClearControl().
  201. * @TPM2_CC_HIERCHANGEAUTH: TPM2_HierarchyChangeAuth().
  202. * @TPM2_CC_PCR_SETAUTHPOL: TPM2_PCR_SetAuthPolicy().
  203. * @TPM2_CC_DAM_RESET: TPM2_DictionaryAttackLockReset().
  204. * @TPM2_CC_DAM_PARAMETERS: TPM2_DictionaryAttackParameters().
  205. * @TPM2_CC_GET_CAPABILITY: TPM2_GetCapibility().
  206. * @TPM2_CC_GET_RANDOM: TPM2_GetRandom().
  207. * @TPM2_CC_PCR_READ: TPM2_PCR_Read().
  208. * @TPM2_CC_PCR_EXTEND: TPM2_PCR_Extend().
  209. * @TPM2_CC_PCR_SETAUTHVAL: TPM2_PCR_SetAuthValue().
  210. */
  211. enum tpm2_command_codes {
  212. TPM2_CC_STARTUP = 0x0144,
  213. TPM2_CC_SELF_TEST = 0x0143,
  214. TPM2_CC_CLEAR = 0x0126,
  215. TPM2_CC_CLEARCONTROL = 0x0127,
  216. TPM2_CC_HIERCHANGEAUTH = 0x0129,
  217. TPM2_CC_PCR_SETAUTHPOL = 0x012C,
  218. TPM2_CC_DAM_RESET = 0x0139,
  219. TPM2_CC_DAM_PARAMETERS = 0x013A,
  220. TPM2_CC_NV_READ = 0x014E,
  221. TPM2_CC_GET_CAPABILITY = 0x017A,
  222. TPM2_CC_GET_RANDOM = 0x017B,
  223. TPM2_CC_PCR_READ = 0x017E,
  224. TPM2_CC_PCR_EXTEND = 0x0182,
  225. TPM2_CC_PCR_SETAUTHVAL = 0x0183,
  226. };
  227. /**
  228. * TPM2 return codes.
  229. */
  230. enum tpm2_return_codes {
  231. TPM2_RC_SUCCESS = 0x0000,
  232. TPM2_RC_BAD_TAG = 0x001E,
  233. TPM2_RC_FMT1 = 0x0080,
  234. TPM2_RC_HASH = TPM2_RC_FMT1 + 0x0003,
  235. TPM2_RC_VALUE = TPM2_RC_FMT1 + 0x0004,
  236. TPM2_RC_SIZE = TPM2_RC_FMT1 + 0x0015,
  237. TPM2_RC_BAD_AUTH = TPM2_RC_FMT1 + 0x0022,
  238. TPM2_RC_HANDLE = TPM2_RC_FMT1 + 0x000B,
  239. TPM2_RC_VER1 = 0x0100,
  240. TPM2_RC_INITIALIZE = TPM2_RC_VER1 + 0x0000,
  241. TPM2_RC_FAILURE = TPM2_RC_VER1 + 0x0001,
  242. TPM2_RC_DISABLED = TPM2_RC_VER1 + 0x0020,
  243. TPM2_RC_AUTH_MISSING = TPM2_RC_VER1 + 0x0025,
  244. TPM2_RC_COMMAND_CODE = TPM2_RC_VER1 + 0x0043,
  245. TPM2_RC_AUTHSIZE = TPM2_RC_VER1 + 0x0044,
  246. TPM2_RC_AUTH_CONTEXT = TPM2_RC_VER1 + 0x0045,
  247. TPM2_RC_NEEDS_TEST = TPM2_RC_VER1 + 0x0053,
  248. TPM2_RC_WARN = 0x0900,
  249. TPM2_RC_TESTING = TPM2_RC_WARN + 0x000A,
  250. TPM2_RC_REFERENCE_H0 = TPM2_RC_WARN + 0x0010,
  251. TPM2_RC_LOCKOUT = TPM2_RC_WARN + 0x0021,
  252. };
  253. /**
  254. * TPM2 algorithms.
  255. */
  256. enum tpm2_algorithms {
  257. TPM2_ALG_SHA1 = 0x04,
  258. TPM2_ALG_XOR = 0x0A,
  259. TPM2_ALG_SHA256 = 0x0B,
  260. TPM2_ALG_SHA384 = 0x0C,
  261. TPM2_ALG_SHA512 = 0x0D,
  262. TPM2_ALG_NULL = 0x10,
  263. TPM2_ALG_SM3_256 = 0x12,
  264. };
  265. /* NV index attributes */
  266. enum tpm_index_attrs {
  267. TPMA_NV_PPWRITE = 1UL << 0,
  268. TPMA_NV_OWNERWRITE = 1UL << 1,
  269. TPMA_NV_AUTHWRITE = 1UL << 2,
  270. TPMA_NV_POLICYWRITE = 1UL << 3,
  271. TPMA_NV_COUNTER = 1UL << 4,
  272. TPMA_NV_BITS = 1UL << 5,
  273. TPMA_NV_EXTEND = 1UL << 6,
  274. TPMA_NV_POLICY_DELETE = 1UL << 10,
  275. TPMA_NV_WRITELOCKED = 1UL << 11,
  276. TPMA_NV_WRITEALL = 1UL << 12,
  277. TPMA_NV_WRITEDEFINE = 1UL << 13,
  278. TPMA_NV_WRITE_STCLEAR = 1UL << 14,
  279. TPMA_NV_GLOBALLOCK = 1UL << 15,
  280. TPMA_NV_PPREAD = 1UL << 16,
  281. TPMA_NV_OWNERREAD = 1UL << 17,
  282. TPMA_NV_AUTHREAD = 1UL << 18,
  283. TPMA_NV_POLICYREAD = 1UL << 19,
  284. TPMA_NV_NO_DA = 1UL << 25,
  285. TPMA_NV_ORDERLY = 1UL << 26,
  286. TPMA_NV_CLEAR_STCLEAR = 1UL << 27,
  287. TPMA_NV_READLOCKED = 1UL << 28,
  288. TPMA_NV_WRITTEN = 1UL << 29,
  289. TPMA_NV_PLATFORMCREATE = 1UL << 30,
  290. TPMA_NV_READ_STCLEAR = 1UL << 31,
  291. TPMA_NV_MASK_READ = TPMA_NV_PPREAD | TPMA_NV_OWNERREAD |
  292. TPMA_NV_AUTHREAD | TPMA_NV_POLICYREAD,
  293. TPMA_NV_MASK_WRITE = TPMA_NV_PPWRITE | TPMA_NV_OWNERWRITE |
  294. TPMA_NV_AUTHWRITE | TPMA_NV_POLICYWRITE,
  295. };
  296. enum {
  297. TPM_ACCESS_VALID = 1 << 7,
  298. TPM_ACCESS_ACTIVE_LOCALITY = 1 << 5,
  299. TPM_ACCESS_REQUEST_PENDING = 1 << 2,
  300. TPM_ACCESS_REQUEST_USE = 1 << 1,
  301. TPM_ACCESS_ESTABLISHMENT = 1 << 0,
  302. };
  303. enum {
  304. TPM_STS_FAMILY_SHIFT = 26,
  305. TPM_STS_FAMILY_MASK = 0x3 << TPM_STS_FAMILY_SHIFT,
  306. TPM_STS_FAMILY_TPM2 = 1 << TPM_STS_FAMILY_SHIFT,
  307. TPM_STS_RESE_TESTABLISMENT_BIT = 1 << 25,
  308. TPM_STS_COMMAND_CANCEL = 1 << 24,
  309. TPM_STS_BURST_COUNT_SHIFT = 8,
  310. TPM_STS_BURST_COUNT_MASK = 0xffff << TPM_STS_BURST_COUNT_SHIFT,
  311. TPM_STS_VALID = 1 << 7,
  312. TPM_STS_COMMAND_READY = 1 << 6,
  313. TPM_STS_GO = 1 << 5,
  314. TPM_STS_DATA_AVAIL = 1 << 4,
  315. TPM_STS_DATA_EXPECT = 1 << 3,
  316. TPM_STS_SELF_TEST_DONE = 1 << 2,
  317. TPM_STS_RESPONSE_RETRY = 1 << 1,
  318. };
  319. enum {
  320. TPM_CMD_COUNT_OFFSET = 2,
  321. TPM_CMD_ORDINAL_OFFSET = 6,
  322. TPM_MAX_BUF_SIZE = 1260,
  323. };
  324. /**
  325. * Issue a TPM2_Startup command.
  326. *
  327. * @dev TPM device
  328. * @mode TPM startup mode
  329. *
  330. * @return code of the operation
  331. */
  332. u32 tpm2_startup(struct udevice *dev, enum tpm2_startup_types mode);
  333. /**
  334. * Issue a TPM2_SelfTest command.
  335. *
  336. * @dev TPM device
  337. * @full_test Asking to perform all tests or only the untested ones
  338. *
  339. * @return code of the operation
  340. */
  341. u32 tpm2_self_test(struct udevice *dev, enum tpm2_yes_no full_test);
  342. /**
  343. * Issue a TPM2_Clear command.
  344. *
  345. * @dev TPM device
  346. * @handle Handle
  347. * @pw Password
  348. * @pw_sz Length of the password
  349. *
  350. * @return code of the operation
  351. */
  352. u32 tpm2_clear(struct udevice *dev, u32 handle, const char *pw,
  353. const ssize_t pw_sz);
  354. /**
  355. * Issue a TPM2_PCR_Extend command.
  356. *
  357. * @dev TPM device
  358. * @index Index of the PCR
  359. * @algorithm Algorithm used, defined in 'enum tpm2_algorithms'
  360. * @digest Value representing the event to be recorded
  361. * @digest_len len of the hash
  362. *
  363. * @return code of the operation
  364. */
  365. u32 tpm2_pcr_extend(struct udevice *dev, u32 index, u32 algorithm,
  366. const u8 *digest, u32 digest_len);
  367. /**
  368. * Issue a TPM2_PCR_Read command.
  369. *
  370. * @dev TPM device
  371. * @idx Index of the PCR
  372. * @idx_min_sz Minimum size in bytes of the pcrSelect array
  373. * @data Output buffer for contents of the named PCR
  374. * @updates Optional out parameter: number of updates for this PCR
  375. *
  376. * @return code of the operation
  377. */
  378. u32 tpm2_pcr_read(struct udevice *dev, u32 idx, unsigned int idx_min_sz,
  379. void *data, unsigned int *updates);
  380. /**
  381. * Issue a TPM2_GetCapability command. This implementation is limited
  382. * to query property index that is 4-byte wide.
  383. *
  384. * @dev TPM device
  385. * @capability Partition of capabilities
  386. * @property Further definition of capability, limited to be 4 bytes wide
  387. * @buf Output buffer for capability information
  388. * @prop_count Size of output buffer
  389. *
  390. * @return code of the operation
  391. */
  392. u32 tpm2_get_capability(struct udevice *dev, u32 capability, u32 property,
  393. void *buf, size_t prop_count);
  394. /**
  395. * Issue a TPM2_DictionaryAttackLockReset command.
  396. *
  397. * @dev TPM device
  398. * @pw Password
  399. * @pw_sz Length of the password
  400. *
  401. * @return code of the operation
  402. */
  403. u32 tpm2_dam_reset(struct udevice *dev, const char *pw, const ssize_t pw_sz);
  404. /**
  405. * Issue a TPM2_DictionaryAttackParameters command.
  406. *
  407. * @dev TPM device
  408. * @pw Password
  409. * @pw_sz Length of the password
  410. * @max_tries Count of authorizations before lockout
  411. * @recovery_time Time before decrementation of the failure count
  412. * @lockout_recovery Time to wait after a lockout
  413. *
  414. * @return code of the operation
  415. */
  416. u32 tpm2_dam_parameters(struct udevice *dev, const char *pw,
  417. const ssize_t pw_sz, unsigned int max_tries,
  418. unsigned int recovery_time,
  419. unsigned int lockout_recovery);
  420. /**
  421. * Issue a TPM2_HierarchyChangeAuth command.
  422. *
  423. * @dev TPM device
  424. * @handle Handle
  425. * @newpw New password
  426. * @newpw_sz Length of the new password
  427. * @oldpw Old password
  428. * @oldpw_sz Length of the old password
  429. *
  430. * @return code of the operation
  431. */
  432. int tpm2_change_auth(struct udevice *dev, u32 handle, const char *newpw,
  433. const ssize_t newpw_sz, const char *oldpw,
  434. const ssize_t oldpw_sz);
  435. /**
  436. * Issue a TPM_PCR_SetAuthPolicy command.
  437. *
  438. * @dev TPM device
  439. * @pw Platform password
  440. * @pw_sz Length of the password
  441. * @index Index of the PCR
  442. * @digest New key to access the PCR
  443. *
  444. * @return code of the operation
  445. */
  446. u32 tpm2_pcr_setauthpolicy(struct udevice *dev, const char *pw,
  447. const ssize_t pw_sz, u32 index, const char *key);
  448. /**
  449. * Issue a TPM_PCR_SetAuthValue command.
  450. *
  451. * @dev TPM device
  452. * @pw Platform password
  453. * @pw_sz Length of the password
  454. * @index Index of the PCR
  455. * @digest New key to access the PCR
  456. * @key_sz Length of the new key
  457. *
  458. * @return code of the operation
  459. */
  460. u32 tpm2_pcr_setauthvalue(struct udevice *dev, const char *pw,
  461. const ssize_t pw_sz, u32 index, const char *key,
  462. const ssize_t key_sz);
  463. /**
  464. * Issue a TPM2_GetRandom command.
  465. *
  466. * @dev TPM device
  467. * @param data output buffer for the random bytes
  468. * @param count size of output buffer
  469. *
  470. * @return return code of the operation
  471. */
  472. u32 tpm2_get_random(struct udevice *dev, void *data, u32 count);
  473. #endif /* __TPM_V2_H */