esys_tpm.3 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336
  1. .TH "esys_tpm" 3 "Fri Oct 7 2022" "Version 3.2.0" "tpm2-tss" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. esys_tpm
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .SS "Modules"
  10. .in +1c
  11. .ti -1c
  12. .RI "\fBThe ESAPI function for the TPM2_ActivateCredential command\&.\fP"
  13. .br
  14. .ti -1c
  15. .RI "\fBThe ESAPI function for the TPM2_Certify command\&.\fP"
  16. .br
  17. .ti -1c
  18. .RI "\fBThe ESAPI function for the TPM2_CertifyCreation command\&.\fP"
  19. .br
  20. .ti -1c
  21. .RI "\fBThe ESAPI function for the TPM2_ChangeEPS command\&.\fP"
  22. .br
  23. .ti -1c
  24. .RI "\fBThe ESAPI function for the TPM2_ChangePPS command\&.\fP"
  25. .br
  26. .ti -1c
  27. .RI "\fBThe ESAPI function for the TPM2_Clear command\&.\fP"
  28. .br
  29. .ti -1c
  30. .RI "\fBThe ESAPI function for the TPM2_ClearControl command\&.\fP"
  31. .br
  32. .ti -1c
  33. .RI "\fBThe ESAPI function for the TPM2_ClockRateAdjust command\&.\fP"
  34. .br
  35. .ti -1c
  36. .RI "\fBThe ESAPI function for the TPM2_ClockSet command\&.\fP"
  37. .br
  38. .ti -1c
  39. .RI "\fBThe ESAPI function for the TPM2_Commit command\&.\fP"
  40. .br
  41. .ti -1c
  42. .RI "\fBThe ESAPI function for the TPM2_ContextLoad command\&.\fP"
  43. .br
  44. .ti -1c
  45. .RI "\fBThe ESAPI function for the TPM2_ContextSave command\&.\fP"
  46. .br
  47. .ti -1c
  48. .RI "\fBThe ESAPI function for the TPM2_Create command\&.\fP"
  49. .br
  50. .ti -1c
  51. .RI "\fBThe ESAPI function for the TPM2_CreatePrimary command\&.\fP"
  52. .br
  53. .ti -1c
  54. .RI "\fBThe ESAPI function for the TPM2_DictionaryAttackLockReset command\&.\fP"
  55. .br
  56. .ti -1c
  57. .RI "\fBThe ESAPI function for the TPM2_DictionaryAttackParameters command\&.\fP"
  58. .br
  59. .ti -1c
  60. .RI "\fBThe ESAPI function for the TPM2_Duplicate command\&.\fP"
  61. .br
  62. .ti -1c
  63. .RI "\fBThe ESAPI function for the TPM2_ECC_Parameters command\&.\fP"
  64. .br
  65. .ti -1c
  66. .RI "\fBThe ESAPI function for the TPM2_ECDH_KeyGen command\&.\fP"
  67. .br
  68. .ti -1c
  69. .RI "\fBThe ESAPI function for the TPM2_ECDH_ZGen command\&.\fP"
  70. .br
  71. .ti -1c
  72. .RI "\fBThe ESAPI function for the TPM2_EC_Ephemeral command\&.\fP"
  73. .br
  74. .ti -1c
  75. .RI "\fBThe ESAPI function for the TPM2_EncryptDecrypt command\&.\fP"
  76. .br
  77. .ti -1c
  78. .RI "\fBThe ESAPI function for the TPM2_EventSequenceComplete command\&.\fP"
  79. .br
  80. .ti -1c
  81. .RI "\fBThe ESAPI function for the TPM2_EvictControl command\&.\fP"
  82. .br
  83. .ti -1c
  84. .RI "\fBThe ESAPI function for the TPM2_FlushContext command\&.\fP"
  85. .br
  86. .ti -1c
  87. .RI "\fBThe ESAPI function for the TPM2_GetCapability command\&.\fP"
  88. .br
  89. .ti -1c
  90. .RI "\fBThe ESAPI function for the TPM2_GetCommandAuditDigest command\&.\fP"
  91. .br
  92. .ti -1c
  93. .RI "\fBThe ESAPI function for the TPM2_GetRandom command\&.\fP"
  94. .br
  95. .ti -1c
  96. .RI "\fBThe ESAPI function for the TPM2_GetSessionAuditDigest command\&.\fP"
  97. .br
  98. .ti -1c
  99. .RI "\fBThe ESAPI function for the TPM2_GetTestResult command\&.\fP"
  100. .br
  101. .ti -1c
  102. .RI "\fBThe ESAPI function for the TPM2_GetTime command\&.\fP"
  103. .br
  104. .ti -1c
  105. .RI "\fBThe ESAPI function for the TPM2_Hash command\&.\fP"
  106. .br
  107. .ti -1c
  108. .RI "\fBThe ESAPI function for the TPM2_HashSequenceStart command\&.\fP"
  109. .br
  110. .ti -1c
  111. .RI "\fBThe ESAPI function for the TPM2_HierarchyChangeAuth command\&.\fP"
  112. .br
  113. .ti -1c
  114. .RI "\fBThe ESAPI function for the TPM2_HierarchyControl command\&.\fP"
  115. .br
  116. .ti -1c
  117. .RI "\fBThe ESAPI function for the TPM2_HMAC command\&.\fP"
  118. .br
  119. .ti -1c
  120. .RI "\fBThe ESAPI function for the TPM2_HMAC_Start command\&.\fP"
  121. .br
  122. .ti -1c
  123. .RI "\fBThe ESAPI function for the TPM2_Import command\&.\fP"
  124. .br
  125. .ti -1c
  126. .RI "\fBThe ESAPI function for the TPM2_IncrementalSelfTest command\&.\fP"
  127. .br
  128. .ti -1c
  129. .RI "\fBThe ESAPI function for the TPM2_Load command\&.\fP"
  130. .br
  131. .ti -1c
  132. .RI "\fBThe ESAPI function for the TPM2_LoadExternal command\&.\fP"
  133. .br
  134. .ti -1c
  135. .RI "\fBThe ESAPI function for the TPM2_MakeCredential command\&.\fP"
  136. .br
  137. .ti -1c
  138. .RI "\fBThe ESAPI function for the TPM2_NV_Certify command\&.\fP"
  139. .br
  140. .ti -1c
  141. .RI "\fBThe ESAPI function for the TPM2_NV_ChangeAuth command\&.\fP"
  142. .br
  143. .ti -1c
  144. .RI "\fBThe ESAPI function for the TPM2_NV_DefineSpace command\&.\fP"
  145. .br
  146. .ti -1c
  147. .RI "\fBThe ESAPI function for the TPM2_NV_Extend command\&.\fP"
  148. .br
  149. .ti -1c
  150. .RI "\fBThe ESAPI function for the TPM2_NV_GlobalWriteLock command\&.\fP"
  151. .br
  152. .ti -1c
  153. .RI "\fBThe ESAPI function for the TPM2_NV_Increment command\&.\fP"
  154. .br
  155. .ti -1c
  156. .RI "\fBThe ESAPI function for the TPM2_NV_Read command\&.\fP"
  157. .br
  158. .ti -1c
  159. .RI "\fBThe ESAPI function for the TPM2_NV_ReadLock command\&.\fP"
  160. .br
  161. .ti -1c
  162. .RI "\fBThe ESAPI function for the TPM2_NV_ReadPublic command\&.\fP"
  163. .br
  164. .ti -1c
  165. .RI "\fBThe ESAPI function for the TPM2_NV_SetBits command\&.\fP"
  166. .br
  167. .ti -1c
  168. .RI "\fBThe ESAPI function for the TPM2_NV_UndefineSpace command\&.\fP"
  169. .br
  170. .ti -1c
  171. .RI "\fBThe ESAPI function for the TPM2_NV_UndefineSpaceSpecial command\&.\fP"
  172. .br
  173. .ti -1c
  174. .RI "\fBThe ESAPI function for the TPM2_NV_Write command\&.\fP"
  175. .br
  176. .ti -1c
  177. .RI "\fBThe ESAPI function for the TPM2_NV_WriteLock command\&.\fP"
  178. .br
  179. .ti -1c
  180. .RI "\fBThe ESAPI function for the TPM2_ObjectChangeAuth command\&.\fP"
  181. .br
  182. .ti -1c
  183. .RI "\fBThe ESAPI function for the TPM2_PCR_Allocate command\&.\fP"
  184. .br
  185. .ti -1c
  186. .RI "\fBThe ESAPI function for the TPM2_PCR_Event command\&.\fP"
  187. .br
  188. .ti -1c
  189. .RI "\fBThe ESAPI function for the TPM2_PCR_Extend command\&.\fP"
  190. .br
  191. .ti -1c
  192. .RI "\fBThe ESAPI function for the TPM2_PCR_Read command\&.\fP"
  193. .br
  194. .ti -1c
  195. .RI "\fBThe ESAPI function for the TPM2_PCR_Reset command\&.\fP"
  196. .br
  197. .ti -1c
  198. .RI "\fBThe ESAPI function for the TPM2_PCR_SetAuthPolicy command\&.\fP"
  199. .br
  200. .ti -1c
  201. .RI "\fBThe ESAPI function for the TPM2_PCR_SetAuthValue command\&.\fP"
  202. .br
  203. .ti -1c
  204. .RI "\fBThe ESAPI function for the TPM2_PolicyAuthorize command\&.\fP"
  205. .br
  206. .ti -1c
  207. .RI "\fBThe ESAPI function for the TPM2_PolicyAuthValue command\&.\fP"
  208. .br
  209. .ti -1c
  210. .RI "\fBThe ESAPI function for the TPM2_PolicyCommandCode command\&.\fP"
  211. .br
  212. .ti -1c
  213. .RI "\fBThe ESAPI function for the TPM2_PolicyCounterTimer command\&.\fP"
  214. .br
  215. .ti -1c
  216. .RI "\fBThe ESAPI function for the TPM2_PolicyCpHash command\&.\fP"
  217. .br
  218. .ti -1c
  219. .RI "\fBThe ESAPI function for the TPM2_PolicyDuplicationSelect command\&.\fP"
  220. .br
  221. .ti -1c
  222. .RI "\fBThe ESAPI function for the TPM2_PolicyGetDigest command\&.\fP"
  223. .br
  224. .ti -1c
  225. .RI "\fBThe ESAPI function for the TPM2_PolicyLocality command\&.\fP"
  226. .br
  227. .ti -1c
  228. .RI "\fBThe ESAPI function for the TPM2_PolicyNameHash command\&.\fP"
  229. .br
  230. .ti -1c
  231. .RI "\fBThe ESAPI function for the TPM2_PolicyNV command\&.\fP"
  232. .br
  233. .ti -1c
  234. .RI "\fBThe ESAPI function for the TPM2_PolicyNvWritten command\&.\fP"
  235. .br
  236. .ti -1c
  237. .RI "\fBThe ESAPI function for the TPM2_PolicyOR command\&.\fP"
  238. .br
  239. .ti -1c
  240. .RI "\fBThe ESAPI function for the TPM2_PolicyPassword command\&.\fP"
  241. .br
  242. .ti -1c
  243. .RI "\fBThe ESAPI function for the TPM2_PolicyPCR command\&.\fP"
  244. .br
  245. .ti -1c
  246. .RI "\fBThe ESAPI function for the TPM2_PolicyPhysicalPresence command\&.\fP"
  247. .br
  248. .ti -1c
  249. .RI "\fBThe ESAPI function for the TPM2_PolicyRestart command\&.\fP"
  250. .br
  251. .ti -1c
  252. .RI "\fBThe ESAPI function for the TPM2_PolicySecret command\&.\fP"
  253. .br
  254. .ti -1c
  255. .RI "\fBThe ESAPI function for the TPM2_PolicySigned command\&.\fP"
  256. .br
  257. .ti -1c
  258. .RI "\fBThe ESAPI function for the TPM2_PolicyTicket command\&.\fP"
  259. .br
  260. .ti -1c
  261. .RI "\fBThe ESAPI function for the TPM2_PP_Commands command\&.\fP"
  262. .br
  263. .ti -1c
  264. .RI "\fBThe ESAPI function for the TPM2_Quote command\&.\fP"
  265. .br
  266. .ti -1c
  267. .RI "\fBThe ESAPI function for the TPM2_ReadClock command\&.\fP"
  268. .br
  269. .ti -1c
  270. .RI "\fBThe ESAPI function for the TPM2_ReadPublic command\&.\fP"
  271. .br
  272. .ti -1c
  273. .RI "\fBThe ESAPI function for the TPM2_Rewrap command\&.\fP"
  274. .br
  275. .ti -1c
  276. .RI "\fBThe ESAPI function for the TPM2_RSA_Decrypt command\&.\fP"
  277. .br
  278. .ti -1c
  279. .RI "\fBThe ESAPI function for the TPM2_RSA_Encrypt command\&.\fP"
  280. .br
  281. .ti -1c
  282. .RI "\fBThe ESAPI function for the TPM2_SelfTest command\&.\fP"
  283. .br
  284. .ti -1c
  285. .RI "\fBThe ESAPI function for the TPM2_SequenceComplete command\&.\fP"
  286. .br
  287. .ti -1c
  288. .RI "\fBThe ESAPI function for the TPM2_SequenceUpdate command\&.\fP"
  289. .br
  290. .ti -1c
  291. .RI "\fBThe ESAPI function for the TPM2_SetAlgorithmSet command\&.\fP"
  292. .br
  293. .ti -1c
  294. .RI "\fBThe ESAPI function for the TPM2_SetCommandCodeAuditStatus command\&.\fP"
  295. .br
  296. .ti -1c
  297. .RI "\fBThe ESAPI function for the TPM2_SetPrimaryPolicy command\&.\fP"
  298. .br
  299. .ti -1c
  300. .RI "\fBThe ESAPI function for the TPM2_Shutdown command\&.\fP"
  301. .br
  302. .ti -1c
  303. .RI "\fBThe ESAPI function for the TPM2_Sign command\&.\fP"
  304. .br
  305. .ti -1c
  306. .RI "\fBThe ESAPI function for the TPM2_StartAuthSession command\&.\fP"
  307. .br
  308. .ti -1c
  309. .RI "\fBThe ESAPI function for the TPM2_Startup command\&.\fP"
  310. .br
  311. .ti -1c
  312. .RI "\fBThe ESAPI function for the TPM2_StirRandom command\&.\fP"
  313. .br
  314. .ti -1c
  315. .RI "\fBThe ESAPI function for the TPM2_TestParms command\&.\fP"
  316. .br
  317. .ti -1c
  318. .RI "\fBThe ESAPI function for the TPM2_Unseal command\&.\fP"
  319. .br
  320. .ti -1c
  321. .RI "\fBThe ESAPI function for the TPM2_Vendor_TCG_Test command\&.\fP"
  322. .br
  323. .ti -1c
  324. .RI "\fBThe ESAPI function for the TPM2_VerifySignature command\&.\fP"
  325. .br
  326. .ti -1c
  327. .RI "\fBThe ESAPI function for the TPM2_ZGen_2Phase command\&.\fP"
  328. .br
  329. .in -1c
  330. .SH "Detailed Description"
  331. .PP
  332. The following function represent interactions with the corresponding TPM commands\&.
  333. .SH "Author"
  334. .PP
  335. Generated automatically by Doxygen for tpm2-tss from the source code\&.