FapiTestgroup.3 18 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055
  1. .TH "FapiTestgroup" 3 "Fri Oct 7 2022" "Version 3.2.0" "tpm2-tss" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. FapiTestgroup
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .SS "Functions"
  10. .in +1c
  11. .ti -1c
  12. .RI "int \fBtest_fapi_data_crypt\fP (\fBFAPI_CONTEXT\fP *context)"
  13. .br
  14. .ti -1c
  15. .RI "int \fBtest_fapi_duplicate\fP (\fBFAPI_CONTEXT\fP *context)"
  16. .br
  17. .ti -1c
  18. .RI "int \fBtest_fapi_ext_public_key\fP (\fBFAPI_CONTEXT\fP *context)"
  19. .br
  20. .ti -1c
  21. .RI "int \fBtest_fapi_get_random\fP (\fBFAPI_CONTEXT\fP *context)"
  22. .br
  23. .ti -1c
  24. .RI "int \fBtest_fapi_info\fP (\fBFAPI_CONTEXT\fP *context)"
  25. .br
  26. .ti -1c
  27. .RI "int \fBtest_fapi_key_change_auth\fP (\fBFAPI_CONTEXT\fP *context)"
  28. .br
  29. .ti -1c
  30. .RI "int \fBtest_fapi_key_create_ckda_sign\fP (\fBFAPI_CONTEXT\fP *context)"
  31. .br
  32. .ti -1c
  33. .RI "int \fBtest_fapi_key_create_policies_sign\fP (\fBFAPI_CONTEXT\fP *context)"
  34. .br
  35. .ti -1c
  36. .RI "int \fBtest_fapi_key_create_policy_authorize_nv\fP (\fBFAPI_CONTEXT\fP *context)"
  37. .br
  38. .ti -1c
  39. .RI "int \fBtest_fapi_key_create_policy_authorize_sign\fP (\fBFAPI_CONTEXT\fP *context)"
  40. .br
  41. .ti -1c
  42. .RI "int \fBtest_fapi_key_create_policy_nv_sign\fP (\fBFAPI_CONTEXT\fP *context)"
  43. .br
  44. .ti -1c
  45. .RI "int \fBtest_fapi_key_create_policy_or_sign\fP (\fBFAPI_CONTEXT\fP *context)"
  46. .br
  47. .ti -1c
  48. .RI "int \fBtest_fapi_key_create_policy_pcr_sign\fP (\fBFAPI_CONTEXT\fP *context)"
  49. .br
  50. .ti -1c
  51. .RI "int \fBtest_fapi_key_create_policy_secret_nv_sign\fP (\fBFAPI_CONTEXT\fP *context)"
  52. .br
  53. .ti -1c
  54. .RI "int \fBtest_fapi_key_create_policy_signed\fP (\fBFAPI_CONTEXT\fP *context)"
  55. .br
  56. .ti -1c
  57. .RI "int \fBtest_fapi_key_create_sign\fP (\fBFAPI_CONTEXT\fP *context)"
  58. .br
  59. .ti -1c
  60. .RI "int \fBtest_fapi_key_create_sign_password_provision\fP (\fBFAPI_CONTEXT\fP *context)"
  61. .br
  62. .ti -1c
  63. .RI "int \fBtest_fapi_key_create_sign_policy_provision\fP (\fBFAPI_CONTEXT\fP *context)"
  64. .br
  65. .ti -1c
  66. .RI "int \fBtest_fapi_nv_extend\fP (\fBFAPI_CONTEXT\fP *context)"
  67. .br
  68. .ti -1c
  69. .RI "int \fBtest_fapi_nv_increment\fP (\fBFAPI_CONTEXT\fP *context)"
  70. .br
  71. .ti -1c
  72. .RI "int \fBtest_fapi_nv_ordinary\fP (\fBFAPI_CONTEXT\fP *context)"
  73. .br
  74. .ti -1c
  75. .RI "int \fBtest_fapi_nv_set_bits\fP (\fBFAPI_CONTEXT\fP *context)"
  76. .br
  77. .ti -1c
  78. .RI "int \fBtest_fapi_nv_written_policy\fP (\fBFAPI_CONTEXT\fP *context)"
  79. .br
  80. .ti -1c
  81. .RI "int \fBtest_fapi_pcr_test\fP (\fBFAPI_CONTEXT\fP *context)"
  82. .br
  83. .ti -1c
  84. .RI "int \fBtest_fapi_platform_certificates\fP (\fBFAPI_CONTEXT\fP *context)"
  85. .br
  86. .ti -1c
  87. .RI "int \fBtest_fapi_quote\fP (\fBFAPI_CONTEXT\fP *context)"
  88. .br
  89. .ti -1c
  90. .RI "int \fBtest_fapi_unseal\fP (\fBFAPI_CONTEXT\fP *context)"
  91. .br
  92. .in -1c
  93. .SH "Detailed Description"
  94. .PP
  95. Testing of FAPI functionality\&. The tested FAPI functions are listed in each of the testcase functions' descriptions\&.
  96. .SH "Function Documentation"
  97. .PP
  98. .SS "test_fapi_data_crypt (\fBFAPI_CONTEXT\fP * context)"
  99. Test the FAPI functions for encryption and decryption\&.
  100. .PP
  101. Tested FAPI commands:
  102. .IP "\(bu" 2
  103. \fBFapi_Provision()\fP
  104. .IP "\(bu" 2
  105. \fBFapi_Import()\fP
  106. .IP "\(bu" 2
  107. \fBFapi_CreateKey()\fP
  108. .IP "\(bu" 2
  109. \fBFapi_SetSignCB()\fP
  110. .IP "\(bu" 2
  111. \fBFapi_Encrypt()\fP
  112. .IP "\(bu" 2
  113. \fBFapi_Decrypt()\fP
  114. .IP "\(bu" 2
  115. \fBFapi_Free()\fP
  116. .PP
  117. .PP
  118. Tested Policies:
  119. .IP "\(bu" 2
  120. PolicySigned
  121. .PP
  122. .PP
  123. \fBParameters:\fP
  124. .RS 4
  125. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  126. .RE
  127. .PP
  128. \fBReturn values:\fP
  129. .RS 4
  130. \fIEXIT_FAILURE\fP
  131. .br
  132. \fIEXIT_SUCCESS\fP
  133. .RE
  134. .PP
  135. .SS "test_fapi_duplicate (\fBFAPI_CONTEXT\fP * context)"
  136. Test the FAPI functions for key duplication\&.
  137. .PP
  138. Tested FAPI commands:
  139. .IP "\(bu" 2
  140. \fBFapi_Provision()\fP
  141. .IP "\(bu" 2
  142. \fBFapi_Import()\fP
  143. .IP "\(bu" 2
  144. \fBFapi_CreateKey()\fP
  145. .IP "\(bu" 2
  146. \fBFapi_ExportKey()\fP
  147. .IP "\(bu" 2
  148. \fBFapi_Delete()\fP
  149. .PP
  150. .PP
  151. Tested Policies:
  152. .IP "\(bu" 2
  153. PolicyDuplicationSelect
  154. .PP
  155. .PP
  156. \fBParameters:\fP
  157. .RS 4
  158. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  159. .RE
  160. .PP
  161. \fBReturn values:\fP
  162. .RS 4
  163. \fIEXIT_FAILURE\fP
  164. .br
  165. \fIEXIT_SUCCESS\fP
  166. .RE
  167. .PP
  168. .SS "test_fapi_ext_public_key (\fBFAPI_CONTEXT\fP * context)"
  169. Test the FAPI functions use an external public key for signature and quote verify without TPM\&.
  170. .PP
  171. Tested FAPI commands:
  172. .IP "\(bu" 2
  173. \fBFapi_Import()\fP
  174. .IP "\(bu" 2
  175. \fBFapi_VerifySignature()\fP
  176. .IP "\(bu" 2
  177. \fBFapi_SetCertificate()\fP
  178. .IP "\(bu" 2
  179. \fBFapi_GetCertificate()\fP
  180. .IP "\(bu" 2
  181. \fBFapi_List()\fP
  182. .IP "\(bu" 2
  183. \fBFapi_VerifyQuote()\fP
  184. .IP "\(bu" 2
  185. \fBFapi_Delete()\fP
  186. .PP
  187. .PP
  188. \fBParameters:\fP
  189. .RS 4
  190. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  191. .RE
  192. .PP
  193. \fBReturn values:\fP
  194. .RS 4
  195. \fIEXIT_FAILURE\fP
  196. .br
  197. \fIEXIT_SUCCESS\fP
  198. .RE
  199. .PP
  200. .SS "test_fapi_get_random (\fBFAPI_CONTEXT\fP * context)"
  201. Test the FAPI function FAPI_GetRandom and async invocations\&.
  202. .PP
  203. Tested FAPI commands:
  204. .IP "\(bu" 2
  205. \fBFapi_Provision()\fP
  206. .IP "\(bu" 2
  207. \fBFapi_GetRandom_Async()\fP
  208. .IP "\(bu" 2
  209. \fBFapi_GetRandom_Finish()\fP
  210. .IP "\(bu" 2
  211. \fBFapi_GetPollHandles()\fP
  212. .IP "\(bu" 2
  213. \fBFapi_GetRandom()\fP
  214. .IP "\(bu" 2
  215. \fBFapi_Delete()\fP
  216. .PP
  217. .PP
  218. \fBParameters:\fP
  219. .RS 4
  220. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  221. .RE
  222. .PP
  223. \fBReturn values:\fP
  224. .RS 4
  225. \fIEXIT_FAILURE\fP
  226. .br
  227. \fIEXIT_SUCCESS\fP
  228. .RE
  229. .PP
  230. .SS "test_fapi_info (\fBFAPI_CONTEXT\fP * context)"
  231. Test the FAPI functions for GetInfo\&.
  232. .PP
  233. Tested FAPI commands:
  234. .IP "\(bu" 2
  235. \fBFapi_Provision()\fP
  236. .IP "\(bu" 2
  237. \fBFapi_GetInfo()\fP
  238. .IP "\(bu" 2
  239. \fBFapi_Delete()\fP
  240. .PP
  241. .PP
  242. \fBParameters:\fP
  243. .RS 4
  244. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  245. .RE
  246. .PP
  247. \fBReturn values:\fP
  248. .RS 4
  249. \fIEXIT_FAILURE\fP
  250. .br
  251. \fIEXIT_SUCCESS\fP
  252. .RE
  253. .PP
  254. .SS "test_fapi_key_change_auth (\fBFAPI_CONTEXT\fP * context)"
  255. Test the FAPI function for changing key authorizations\&.
  256. .PP
  257. The setting of the authorization callback and usage of the key with Fapi_Sign afterwards is also tested\&.
  258. .PP
  259. Tested FAPI commands:
  260. .IP "\(bu" 2
  261. \fBFapi_Provision()\fP
  262. .IP "\(bu" 2
  263. \fBFapi_CreateKey()\fP
  264. .IP "\(bu" 2
  265. \fBFapi_ChangeAuth()\fP
  266. .IP "\(bu" 2
  267. \fBFapi_SetAuthCB()\fP
  268. .IP "\(bu" 2
  269. \fBFapi_Sign()\fP
  270. .IP "\(bu" 2
  271. \fBFapi_Delete()\fP
  272. .PP
  273. .PP
  274. \fBParameters:\fP
  275. .RS 4
  276. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  277. .RE
  278. .PP
  279. \fBReturn values:\fP
  280. .RS 4
  281. \fIEXIT_FAILURE\fP
  282. .br
  283. \fIEXIT_SUCCESS\fP
  284. .RE
  285. .PP
  286. .SS "test_fapi_key_create_ckda_sign (\fBFAPI_CONTEXT\fP * context)"
  287. Test the FAPI functions for key creation and usage with noda and da flag\&.
  288. .PP
  289. Tested FAPI commands:
  290. .IP "\(bu" 2
  291. \fBFapi_Provision()\fP
  292. .IP "\(bu" 2
  293. \fBFapi_CreateKey()\fP
  294. .IP "\(bu" 2
  295. \fBFapi_SetAuthCB()\fP
  296. .IP "\(bu" 2
  297. \fBFapi_Sign()\fP
  298. .IP "\(bu" 2
  299. \fBFapi_Delete()\fP
  300. .PP
  301. .PP
  302. \fBParameters:\fP
  303. .RS 4
  304. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  305. .RE
  306. .PP
  307. \fBReturn values:\fP
  308. .RS 4
  309. \fIEXIT_FAILURE\fP
  310. .br
  311. \fIEXIT_SUCCESS\fP
  312. .RE
  313. .PP
  314. .SS "test_fapi_key_create_policies_sign (\fBFAPI_CONTEXT\fP * context)"
  315. Test several FAPI policies by usage of signing key\&.
  316. .PP
  317. Which test case will be executed is determined by the compiler switches: TEST_POLICY_PASSWORD, TEST_POLICY_AUTH_VALUE, TEST_POLICY_LOCALITY TEST_POLICY_PHYSICAL_PRESENCE, TEST_POLICY_COMMAND_CODE, TEST_POLICY_COUNTERTIMER\&.
  318. .PP
  319. Tested FAPI commands:
  320. .IP "\(bu" 2
  321. \fBFapi_Provision()\fP
  322. .IP "\(bu" 2
  323. \fBFapi_Import()\fP
  324. .IP "\(bu" 2
  325. \fBFapi_CreateKey()\fP
  326. .IP "\(bu" 2
  327. \fBFapi_SetAuthCB()\fP
  328. .IP "\(bu" 2
  329. \fBFapi_Sign()\fP
  330. .IP "\(bu" 2
  331. \fBFapi_Delete()\fP
  332. .PP
  333. .PP
  334. Tested Policies:
  335. .IP "\(bu" 2
  336. PolicyPassword
  337. .IP "\(bu" 2
  338. PolicyAuthValue
  339. .IP "\(bu" 2
  340. PolicyLocality
  341. .IP "\(bu" 2
  342. PolicyPhysicalPresence
  343. .IP "\(bu" 2
  344. PolicyCommandCode
  345. .IP "\(bu" 2
  346. PolicyCounterTimer
  347. .PP
  348. .PP
  349. \fBParameters:\fP
  350. .RS 4
  351. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  352. .RE
  353. .PP
  354. \fBReturn values:\fP
  355. .RS 4
  356. \fIEXIT_FAILURE\fP
  357. .br
  358. \fIEXIT_SUCCESS\fP
  359. .RE
  360. .PP
  361. .SS "test_fapi_key_create_policy_authorize_nv (\fBFAPI_CONTEXT\fP * context)"
  362. Test the FAPI key signing with PolicyAuthorizeNV\&.
  363. .PP
  364. Tested FAPI commands:
  365. .IP "\(bu" 2
  366. \fBFapi_GetTcti()\fP
  367. .IP "\(bu" 2
  368. \fBFapi_Provision()\fP
  369. .IP "\(bu" 2
  370. \fBFapi_CreateNv()\fP
  371. .IP "\(bu" 2
  372. \fBFapi_Import()\fP
  373. .IP "\(bu" 2
  374. \fBFapi_WriteAuthorizeNv()\fP
  375. .IP "\(bu" 2
  376. \fBFapi_CreateKey()\fP
  377. .IP "\(bu" 2
  378. \fBFapi_Sign()\fP
  379. .IP "\(bu" 2
  380. \fBFapi_Delete()\fP
  381. .PP
  382. .PP
  383. Tested Policies:
  384. .IP "\(bu" 2
  385. PolicyAuthorizeNv
  386. .PP
  387. .PP
  388. \fBParameters:\fP
  389. .RS 4
  390. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  391. .RE
  392. .PP
  393. \fBReturn values:\fP
  394. .RS 4
  395. \fIEXIT_FAILURE\fP
  396. .br
  397. \fIEXIT_SUCCESS\fP
  398. .RE
  399. .PP
  400. .SS "test_fapi_key_create_policy_authorize_sign (\fBFAPI_CONTEXT\fP * context)"
  401. Test the FAPI functions for PolicyAuthoirze with signing\&.
  402. .PP
  403. Tested FAPI commands:
  404. .IP "\(bu" 2
  405. \fBFapi_Provision()\fP
  406. .IP "\(bu" 2
  407. \fBFapi_SetBranchCB()\fP
  408. .IP "\(bu" 2
  409. \fBFapi_Import()\fP
  410. .IP "\(bu" 2
  411. \fBFapi_CreateKey()\fP
  412. .IP "\(bu" 2
  413. \fBFapi_AuthorizePolicy()\fP
  414. .IP "\(bu" 2
  415. \fBFapi_Sign()\fP
  416. .IP "\(bu" 2
  417. \fBFapi_List()\fP
  418. .IP "\(bu" 2
  419. \fBFapi_Delete()\fP
  420. .PP
  421. .PP
  422. Tested Policies:
  423. .IP "\(bu" 2
  424. PolicyNameHash
  425. .IP "\(bu" 2
  426. PolicyAuthorize
  427. .IP "\(bu" 2
  428. PolicyCpHash (Not entered, only as alternative branch)
  429. .PP
  430. .PP
  431. \fBParameters:\fP
  432. .RS 4
  433. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  434. .RE
  435. .PP
  436. \fBReturn values:\fP
  437. .RS 4
  438. \fIEXIT_FAILURE\fP
  439. .br
  440. \fIEXIT_SUCCESS\fP
  441. .RE
  442. .PP
  443. .SS "test_fapi_key_create_policy_nv_sign (\fBFAPI_CONTEXT\fP * context)"
  444. Test the FAPI functions for NV writing and key usage\&.
  445. .PP
  446. Tested FAPI commands:
  447. .IP "\(bu" 2
  448. \fBFapi_Provision()\fP
  449. .IP "\(bu" 2
  450. \fBFapi_CreateKey()\fP
  451. .IP "\(bu" 2
  452. \fBFapi_NvWrite()\fP
  453. .IP "\(bu" 2
  454. \fBFapi_Import()\fP
  455. .IP "\(bu" 2
  456. \fBFapi_Sign()\fP
  457. .IP "\(bu" 2
  458. \fBFapi_Delete()\fP
  459. .PP
  460. .PP
  461. Tested Policies:
  462. .IP "\(bu" 2
  463. PolicyNv
  464. .PP
  465. .PP
  466. \fBParameters:\fP
  467. .RS 4
  468. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  469. .RE
  470. .PP
  471. \fBReturn values:\fP
  472. .RS 4
  473. \fIEXIT_FAILURE\fP
  474. .br
  475. \fIEXIT_SUCCESS\fP
  476. .RE
  477. .PP
  478. .SS "test_fapi_key_create_policy_or_sign (\fBFAPI_CONTEXT\fP * context)"
  479. Test the FAPI for PolicyOr using signing\&.
  480. .PP
  481. Tested FAPI commands:
  482. .IP "\(bu" 2
  483. \fBFapi_Provision()\fP
  484. .IP "\(bu" 2
  485. \fBFapi_Import()\fP
  486. .IP "\(bu" 2
  487. \fBFapi_CreateKey()\fP
  488. .IP "\(bu" 2
  489. \fBFapi_SetBranchCB()\fP
  490. .IP "\(bu" 2
  491. \fBFapi_Sign()\fP
  492. .IP "\(bu" 2
  493. \fBFapi_Delete()\fP
  494. .PP
  495. .PP
  496. Tested Policies:
  497. .IP "\(bu" 2
  498. PolicyOr
  499. .IP "\(bu" 2
  500. PolicyPcr
  501. .PP
  502. .PP
  503. \fBParameters:\fP
  504. .RS 4
  505. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  506. .RE
  507. .PP
  508. \fBReturn values:\fP
  509. .RS 4
  510. \fIEXIT_FAILURE\fP
  511. .br
  512. \fIEXIT_SUCCESS\fP
  513. .RE
  514. .PP
  515. .SS "test_fapi_key_create_policy_pcr_sign (\fBFAPI_CONTEXT\fP * context)"
  516. Test the FAPI functions for PolicyPCR with key creation and usage\&.
  517. .PP
  518. Tested FAPI commands:
  519. .IP "\(bu" 2
  520. \fBFapi_Provision()\fP
  521. .IP "\(bu" 2
  522. \fBFapi_Import()\fP
  523. .IP "\(bu" 2
  524. \fBFapi_CreateKey()\fP
  525. .IP "\(bu" 2
  526. \fBFapi_Sign()\fP
  527. .IP "\(bu" 2
  528. \fBFapi_ExportPolicy()\fP
  529. .IP "\(bu" 2
  530. \fBFapi_Delete()\fP
  531. .IP "\(bu" 2
  532. \fBFapi_Import()\fP
  533. .IP "\(bu" 2
  534. \fBFapi_List()\fP
  535. .PP
  536. .PP
  537. Tested Policies:
  538. .IP "\(bu" 2
  539. PolicyPcr (with currentPCRs set)
  540. .PP
  541. .PP
  542. \fBParameters:\fP
  543. .RS 4
  544. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  545. .RE
  546. .PP
  547. \fBReturn values:\fP
  548. .RS 4
  549. \fIEXIT_FAILURE\fP
  550. .br
  551. \fIEXIT_SUCCESS\fP
  552. .RE
  553. .PP
  554. .SS "test_fapi_key_create_policy_secret_nv_sign (\fBFAPI_CONTEXT\fP * context)"
  555. Test the FAPI PolicySecret and PolicyAuthValue handling\&.
  556. .PP
  557. Tested FAPI commands:
  558. .IP "\(bu" 2
  559. \fBFapi_Provision()\fP
  560. .IP "\(bu" 2
  561. \fBFapi_Import()\fP
  562. .IP "\(bu" 2
  563. \fBFapi_CreateNv()\fP
  564. .IP "\(bu" 2
  565. \fBFapi_CreateKey()\fP
  566. .IP "\(bu" 2
  567. \fBFapi_Sign()\fP
  568. .IP "\(bu" 2
  569. \fBFapi_SetAuthCB()\fP
  570. .IP "\(bu" 2
  571. \fBFapi_Delete()\fP
  572. .PP
  573. .PP
  574. Tested Policies:
  575. .IP "\(bu" 2
  576. PolicySecret
  577. .IP "\(bu" 2
  578. PolicyAuthValue
  579. .PP
  580. .PP
  581. \fBParameters:\fP
  582. .RS 4
  583. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  584. .RE
  585. .PP
  586. \fBReturn values:\fP
  587. .RS 4
  588. \fIEXIT_FAILURE\fP
  589. .br
  590. \fIEXIT_SUCCESS\fP
  591. .RE
  592. .PP
  593. .SS "test_fapi_key_create_policy_signed (\fBFAPI_CONTEXT\fP * context)"
  594. Test the FAPI functions for key creation and usage with a PolicySigned\&.
  595. .PP
  596. Tested FAPI commands:
  597. .IP "\(bu" 2
  598. \fBFapi_Provision()\fP
  599. .IP "\(bu" 2
  600. \fBFapi_Import()\fP
  601. .IP "\(bu" 2
  602. \fBFapi_CreateKey()\fP
  603. .IP "\(bu" 2
  604. \fBFapi_SetSignCB()\fP
  605. .IP "\(bu" 2
  606. \fBFapi_Sign()\fP
  607. .IP "\(bu" 2
  608. \fBFapi_Delete()\fP
  609. .IP "\(bu" 2
  610. \fBFapi_List()\fP
  611. .PP
  612. .PP
  613. Tested Policies:
  614. .IP "\(bu" 2
  615. PolicySigned
  616. .PP
  617. .PP
  618. \fBParameters:\fP
  619. .RS 4
  620. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  621. .RE
  622. .PP
  623. \fBReturn values:\fP
  624. .RS 4
  625. \fIEXIT_FAILURE\fP
  626. .br
  627. \fIEXIT_SUCCESS\fP
  628. .RE
  629. .PP
  630. .SS "test_fapi_key_create_sign (\fBFAPI_CONTEXT\fP * context)"
  631. Test the FAPI functions for TpmBlobs and certificates\&.
  632. .PP
  633. Tested FAPI commands:
  634. .IP "\(bu" 2
  635. \fBFapi_Provision()\fP
  636. .IP "\(bu" 2
  637. \fBFapi_SetAuthCB()\fP
  638. .IP "\(bu" 2
  639. \fBFapi_CreateKey()\fP
  640. .IP "\(bu" 2
  641. \fBFapi_GetTpmBlobs()\fP
  642. .IP "\(bu" 2
  643. \fBFapi_Sign()\fP
  644. .IP "\(bu" 2
  645. \fBFapi_VerifySignature()\fP
  646. .IP "\(bu" 2
  647. \fBFapi_SetCertificate()\fP
  648. .IP "\(bu" 2
  649. \fBFapi_List()\fP
  650. .IP "\(bu" 2
  651. \fBFapi_ChangeAuth()\fP
  652. .IP "\(bu" 2
  653. \fBFapi_Delete()\fP
  654. .PP
  655. .PP
  656. \fBParameters:\fP
  657. .RS 4
  658. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  659. .RE
  660. .PP
  661. \fBReturn values:\fP
  662. .RS 4
  663. \fIEXIT_FAILURE\fP
  664. .br
  665. \fIEXIT_SUCCESS\fP
  666. .RE
  667. .PP
  668. .SS "test_fapi_key_create_sign_password_provision (\fBFAPI_CONTEXT\fP * context)"
  669. Test the FAPI functions for key creation and usage with an SH password\&.
  670. .PP
  671. Tested FAPI commands:
  672. .IP "\(bu" 2
  673. \fBFapi_Provision()\fP
  674. .IP "\(bu" 2
  675. \fBFapi_SetAuthCB()\fP
  676. .IP "\(bu" 2
  677. \fBFapi_CreateKey()\fP
  678. .IP "\(bu" 2
  679. \fBFapi_GetTpmBlobs()\fP
  680. .IP "\(bu" 2
  681. \fBFapi_Sign()\fP
  682. .IP "\(bu" 2
  683. \fBFapi_SetCertificate()\fP
  684. .IP "\(bu" 2
  685. \fBFapi_List()\fP
  686. .IP "\(bu" 2
  687. \fBFapi_ChangeAuth()\fP
  688. .IP "\(bu" 2
  689. \fBFapi_Delete()\fP
  690. .PP
  691. .PP
  692. \fBParameters:\fP
  693. .RS 4
  694. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  695. .RE
  696. .PP
  697. \fBReturn values:\fP
  698. .RS 4
  699. \fIEXIT_FAILURE\fP
  700. .br
  701. \fIEXIT_SUCCESS\fP
  702. .RE
  703. .PP
  704. .SS "test_fapi_key_create_sign_policy_provision (\fBFAPI_CONTEXT\fP * context)"
  705. Test the FAPI functions for key creation and usage\&.
  706. .PP
  707. Tested FAPI commands:
  708. .IP "\(bu" 2
  709. \fBFapi_Provision()\fP
  710. .IP "\(bu" 2
  711. \fBFapi_SetAuthCB()\fP
  712. .IP "\(bu" 2
  713. \fBFapi_CreateKey()\fP
  714. .IP "\(bu" 2
  715. \fBFapi_GetTpmBlobs()\fP
  716. .IP "\(bu" 2
  717. \fBFapi_Sign()\fP
  718. .IP "\(bu" 2
  719. \fBFapi_SetCertificate()\fP
  720. .IP "\(bu" 2
  721. \fBFapi_List()\fP
  722. .IP "\(bu" 2
  723. \fBFapi_Delete()\fP
  724. .PP
  725. .PP
  726. \fBParameters:\fP
  727. .RS 4
  728. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  729. .RE
  730. .PP
  731. \fBReturn values:\fP
  732. .RS 4
  733. \fIEXIT_FAILURE\fP
  734. .br
  735. \fIEXIT_SUCCESS\fP
  736. .RE
  737. .PP
  738. .SS "test_fapi_nv_extend (\fBFAPI_CONTEXT\fP * context)"
  739. Test the FAPI function FAPI_NvExtend\&.
  740. .PP
  741. Tested FAPI commands:
  742. .IP "\(bu" 2
  743. \fBFapi_Provision()\fP
  744. .IP "\(bu" 2
  745. \fBFapi_CreateNv()\fP
  746. .IP "\(bu" 2
  747. \fBFapi_NvExtend()\fP
  748. .IP "\(bu" 2
  749. \fBFapi_Delete()\fP
  750. .IP "\(bu" 2
  751. \fBFapi_SetAuthCB()\fP
  752. .PP
  753. .PP
  754. \fBParameters:\fP
  755. .RS 4
  756. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  757. .RE
  758. .PP
  759. \fBReturn values:\fP
  760. .RS 4
  761. \fIEXIT_FAILURE\fP
  762. .br
  763. \fIEXIT_SUCCESS\fP
  764. .RE
  765. .PP
  766. .SS "test_fapi_nv_increment (\fBFAPI_CONTEXT\fP * context)"
  767. Test the FAPI function FAPI_NvIncrement\&.
  768. .PP
  769. Tested FAPI commands:
  770. .IP "\(bu" 2
  771. \fBFapi_Provision()\fP
  772. .IP "\(bu" 2
  773. \fBFapi_Import()\fP
  774. .IP "\(bu" 2
  775. \fBFapi_CreateNv()\fP
  776. .IP "\(bu" 2
  777. \fBFapi_SetAuthCB()\fP
  778. .IP "\(bu" 2
  779. \fBFapi_ChangeAuth()\fP
  780. .IP "\(bu" 2
  781. \fBFapi_Delete()\fP
  782. .IP "\(bu" 2
  783. \fBFapi_NvIncrement()\fP
  784. .PP
  785. .PP
  786. Tested Policies:
  787. .IP "\(bu" 2
  788. PolicyAuthValue
  789. .IP "\(bu" 2
  790. PolicyCommandCode
  791. .PP
  792. .PP
  793. \fBParameters:\fP
  794. .RS 4
  795. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  796. .RE
  797. .PP
  798. \fBReturn values:\fP
  799. .RS 4
  800. \fIEXIT_FAILURE\fP
  801. .br
  802. \fIEXIT_SUCCESS\fP
  803. .RE
  804. .PP
  805. .SS "test_fapi_nv_ordinary (\fBFAPI_CONTEXT\fP * context)"
  806. Test the FAPI NV functions\&.
  807. .PP
  808. Tested FAPI commands:
  809. .IP "\(bu" 2
  810. \fBFapi_Provision()\fP
  811. .IP "\(bu" 2
  812. \fBFapi_Import()\fP
  813. .IP "\(bu" 2
  814. \fBFapi_SetPolicyActionCB()\fP
  815. .IP "\(bu" 2
  816. \fBFapi_CreateNv()\fP
  817. .IP "\(bu" 2
  818. \fBFapi_NvWrite()\fP
  819. .IP "\(bu" 2
  820. \fBFapi_NvRead()\fP
  821. .IP "\(bu" 2
  822. \fBFapi_Delete()\fP
  823. .IP "\(bu" 2
  824. \fBFapi_SetDescription()\fP
  825. .IP "\(bu" 2
  826. \fBFapi_GetDescription()\fP
  827. .IP "\(bu" 2
  828. \fBFapi_SetAuthCB()\fP
  829. .PP
  830. .PP
  831. Tested Policies:
  832. .IP "\(bu" 2
  833. PolicyAction
  834. .PP
  835. .PP
  836. \fBParameters:\fP
  837. .RS 4
  838. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  839. .RE
  840. .PP
  841. \fBReturn values:\fP
  842. .RS 4
  843. \fIEXIT_FAILURE\fP
  844. .br
  845. \fIEXIT_SUCCESS\fP
  846. .RE
  847. .PP
  848. .SS "test_fapi_nv_set_bits (\fBFAPI_CONTEXT\fP * context)"
  849. Test the FAPI function Fapi_NvSetBits\&.
  850. .PP
  851. Tested FAPI commands:
  852. .IP "\(bu" 2
  853. \fBFapi_Provision()\fP
  854. .IP "\(bu" 2
  855. \fBFapi_CreateNv()\fP
  856. .IP "\(bu" 2
  857. \fBFapi_NvSetBits()\fP
  858. .IP "\(bu" 2
  859. \fBFapi_Delete()\fP
  860. .IP "\(bu" 2
  861. \fBFapi_SetAuthCB()\fP
  862. .PP
  863. .PP
  864. \fBParameters:\fP
  865. .RS 4
  866. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  867. .RE
  868. .PP
  869. \fBReturn values:\fP
  870. .RS 4
  871. \fIEXIT_FAILURE\fP
  872. .br
  873. \fIEXIT_SUCCESS\fP
  874. .RE
  875. .PP
  876. .SS "test_fapi_nv_written_policy (\fBFAPI_CONTEXT\fP * context)"
  877. Test the FAPI policy PolicyNvWritten\&.
  878. .PP
  879. Tested FAPI commands:
  880. .IP "\(bu" 2
  881. \fBFapi_Provision()\fP
  882. .IP "\(bu" 2
  883. \fBFapi_CreateNv()\fP
  884. .IP "\(bu" 2
  885. \fBFapi_SetAppData()\fP
  886. .IP "\(bu" 2
  887. \fBFapi_GetAppData()\fP
  888. .IP "\(bu" 2
  889. \fBFapi_NvWrite()\fP
  890. .IP "\(bu" 2
  891. \fBFapi_Delete()\fP
  892. .PP
  893. .PP
  894. Tested Policies:
  895. .IP "\(bu" 2
  896. PolicyNvWritten
  897. .PP
  898. .PP
  899. \fBParameters:\fP
  900. .RS 4
  901. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  902. .RE
  903. .PP
  904. \fBReturn values:\fP
  905. .RS 4
  906. \fIEXIT_FAILURE\fP
  907. .br
  908. \fIEXIT_SUCCESS\fP
  909. .RE
  910. .PP
  911. .SS "test_fapi_pcr_test (\fBFAPI_CONTEXT\fP * context)"
  912. Test the FAPI function FAPI_PcrExtend and Read\&.
  913. .PP
  914. Tested FAPI commands:
  915. .IP "\(bu" 2
  916. \fBFapi_Provision()\fP
  917. .IP "\(bu" 2
  918. \fBFapi_PcrExtend()\fP
  919. .IP "\(bu" 2
  920. \fBFapi_PcrRead()\fP
  921. .IP "\(bu" 2
  922. \fBFapi_Delete()\fP
  923. .PP
  924. .PP
  925. \fBParameters:\fP
  926. .RS 4
  927. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  928. .RE
  929. .PP
  930. \fBReturn values:\fP
  931. .RS 4
  932. \fIEXIT_FAILURE\fP
  933. .br
  934. \fIEXIT_SUCCESS\fP
  935. .RE
  936. .PP
  937. .SS "test_fapi_platform_certificates (\fBFAPI_CONTEXT\fP * context)"
  938. Test the FAPI functions for platform certificates\&.
  939. .PP
  940. Tested FAPI commands:
  941. .IP "\(bu" 2
  942. \fBFapi_Provision()\fP
  943. .IP "\(bu" 2
  944. \fBFapi_GetPlatformCertificates()\fP
  945. .IP "\(bu" 2
  946. \fBFapi_Delete()\fP
  947. .PP
  948. .PP
  949. \fBParameters:\fP
  950. .RS 4
  951. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  952. .RE
  953. .PP
  954. \fBReturn values:\fP
  955. .RS 4
  956. \fIEXIT_FAILURE\fP
  957. .br
  958. \fIEXIT_SUCCESS\fP
  959. .RE
  960. .PP
  961. .SS "test_fapi_quote (\fBFAPI_CONTEXT\fP * context)"
  962. Test the FAPI functions for quote commands\&.
  963. .PP
  964. Tested FAPI commands:
  965. .IP "\(bu" 2
  966. \fBFapi_Provision()\fP
  967. .IP "\(bu" 2
  968. \fBFapi_CreateKey()\fP
  969. .IP "\(bu" 2
  970. \fBFapi_PcrExtend()\fP
  971. .IP "\(bu" 2
  972. \fBFapi_Quote()\fP
  973. .IP "\(bu" 2
  974. \fBFapi_ExportKey()\fP
  975. .IP "\(bu" 2
  976. \fBFapi_Import()\fP
  977. .IP "\(bu" 2
  978. \fBFapi_PcrRead()\fP
  979. .IP "\(bu" 2
  980. \fBFapi_VerifyQuote()\fP
  981. .IP "\(bu" 2
  982. \fBFapi_List()\fP
  983. .IP "\(bu" 2
  984. \fBFapi_Delete()\fP
  985. .PP
  986. .PP
  987. \fBParameters:\fP
  988. .RS 4
  989. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  990. .RE
  991. .PP
  992. \fBReturn values:\fP
  993. .RS 4
  994. \fIEXIT_FAILURE\fP
  995. .br
  996. \fIEXIT_SUCCESS\fP
  997. .RE
  998. .PP
  999. .SS "test_fapi_unseal (\fBFAPI_CONTEXT\fP * context)"
  1000. Test the FAPI functions for sealing\&.
  1001. .PP
  1002. Tested FAPI commands:
  1003. .IP "\(bu" 2
  1004. \fBFapi_Provision()\fP
  1005. .IP "\(bu" 2
  1006. \fBFapi_CreateSeal()\fP
  1007. .IP "\(bu" 2
  1008. \fBFapi_Unseal()\fP
  1009. .IP "\(bu" 2
  1010. \fBFapi_Delete()\fP
  1011. .PP
  1012. .PP
  1013. \fBParameters:\fP
  1014. .RS 4
  1015. \fIcontext\fP The \fBFAPI_CONTEXT\fP\&.
  1016. .RE
  1017. .PP
  1018. \fBReturn values:\fP
  1019. .RS 4
  1020. \fIEXIT_FAILURE\fP
  1021. .br
  1022. \fIEXIT_SUCCESS\fP
  1023. .RE
  1024. .PP
  1025. .SH "Author"
  1026. .PP
  1027. Generated automatically by Doxygen for tpm2-tss from the source code\&.