life_cycle-pkey.pod 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713
  1. =pod
  2. =head1 NAME
  3. life_cycle-pkey - The PKEY algorithm life-cycle
  4. =head1 DESCRIPTION
  5. All public keys (PKEYs) go through a number of stages in their life-cycle:
  6. =over 4
  7. =item start
  8. This state represents the PKEY before it has been allocated. It is the
  9. starting state for any life-cycle transitions.
  10. =item newed
  11. This state represents the PKEY after it has been allocated.
  12. =item decapsulate
  13. This state represents the PKEY when it is ready to perform a private key decapsulation
  14. opeartion.
  15. =item decrypt
  16. This state represents the PKEY when it is ready to decrypt some ciphertext.
  17. =item derive
  18. This state represents the PKEY when it is ready to derive a shared secret.
  19. =item digest sign
  20. This state represents the PKEY when it is ready to perform a private key signature
  21. operation.
  22. =item encapsulate
  23. This state represents the PKEY when it is ready to perform a public key encapsulation
  24. opeartion.
  25. =item encrypt
  26. This state represents the PKEY when it is ready to encrypt some plaintext.
  27. =item key generation
  28. This state represents the PKEY when it is ready to generate a new public/private key.
  29. =item parameter generation
  30. This state represents the PKEY when it is ready to generate key parameters.
  31. =item verify
  32. This state represents the PKEY when it is ready to verify a public key signature.
  33. =item verify recover
  34. This state represents the PKEY when it is ready to recover a public key signature data.
  35. =item freed
  36. This state is entered when the PKEY is freed. It is the terminal state
  37. for all life-cycle transitions.
  38. =back
  39. =head2 State Transition Diagram
  40. The usual life-cycle of a PKEY object is illustrated:
  41. =begin man
  42. +-------------+
  43. | |
  44. | start |
  45. | |
  46. EVP_PKEY_derive +-------------+
  47. +-------------+ EVP_PKEY_derive_set_peer | +-------------+
  48. | |----------------------------+ | +----------------------------| |
  49. | derive | | | | EVP_PKEY_verify | verify |
  50. | |<---------------------------+ | +--------------------------->| |
  51. +-------------+ | +-------------+
  52. ^ | ^
  53. | EVP_PKEY_derive_init | EVP_PKEY_verify_init |
  54. +---------------------------------------+ | +---------------------------------------+
  55. | | |
  56. +-------------+ | | | +-------------+
  57. | |----------------------------+ | | | +----------------------------| |
  58. | digest sign | EVP_PKEY_sign | | | | | EVP_PKEY_verify_recover | verify |
  59. | |<---------------------------+ | | | +--------------------------->| recover |
  60. +-------------+ | | | +-------------+
  61. ^ | | | ^
  62. | EVP_PKEY_sign_init | | | EVP_PKEY_verify_recover_init |
  63. +---------------------------------+ | | | +---------------------------------+
  64. | | | | |
  65. +-------------+ | | | | | +-------------+
  66. | |----------------------------+ | | | | | +----------------------------| |
  67. | decapsulate | EVP_PKEY_decapsulate | | | | | | | EVP_PKEY_decrypt | decrypt |
  68. | |<---------------------------+ | | v | | +--------------------------->| |
  69. +-------------+ | +-------------+ | +-------------+
  70. ^ +---| |---+ ^
  71. | EVP_PKEY_decapsulate_init | | EVP_PKEY_decrypt_init |
  72. +-------------------------------------| newed |-------------------------------------+
  73. | |
  74. +---| |---+
  75. +-------------+ | +-------------+ | +-------------+
  76. | |----------------------------+ | | | | +----------------------------| |
  77. | encapsulate | EVP_PKEY_encapsulate | | | | | | EVP_PKEY_encrypt | encrypt |
  78. | |<---------------------------+ | | | | +--------------------------->| |
  79. +-------------+ | | | | +-------------+
  80. ^ | | | | ^
  81. | EVP_PKEY_encapsulate_init | | | | EVP_PKEY_encrypt_init |
  82. +---------------------------------+ | | +---------------------------------+
  83. | |
  84. +---------------------------------------+ +---------------------------------------+
  85. | EVP_PKEY_paramgen_init EVP_PKEY_keygen_init |
  86. v v
  87. +-------------+ +-------------+
  88. | |----------------------------+ +----------------------------| |
  89. | parameter | | | | key |
  90. | generation |<---------------------------+ +--------------------------->| generation |
  91. +-------------+ EVP_PKEY_paramgen EVP_PKEY_keygen +-------------+
  92. EVP_PKEY_gen EVP_PKEY_gen
  93. + - - - - - + +-----------+
  94. ' ' EVP_PKEY_CTX_free | |
  95. ' any state '------------------->| freed |
  96. ' ' | |
  97. + - - - - - + +-----------+
  98. =end man
  99. =for html <img src="img/pkey.png">
  100. =head2 Formal State Transitions
  101. This section defines all of the legal state transitions.
  102. This is the canonical list.
  103. =begin man
  104. Function Call ---------------------------------------------------------------------- Current State ----------------------------------------------------------------------
  105. start newed digest verify verify encrypt decrypt derive encapsulate decapsulate parameter key freed
  106. sign recover generation generation
  107. EVP_PKEY_CTX_new newed
  108. EVP_PKEY_CTX_new_id newed
  109. EVP_PKEY_CTX_new_from_name newed
  110. EVP_PKEY_CTX_new_from_pkey newed
  111. EVP_PKEY_sign_init digest digest digest digest digest digest digest digest digest digest digest
  112. sign sign sign sign sign sign sign sign sign sign sign
  113. EVP_PKEY_sign digest
  114. sign
  115. EVP_PKEY_verify_init verify verify verify verify verify verify verify verify verify verify verify
  116. EVP_PKEY_verify verify
  117. EVP_PKEY_verify_recover_init verify verify verify verify verify verify verify verify verify verify verify
  118. recover recover recover recover recover recover recover recover recover recover recover
  119. EVP_PKEY_verify_recover verify
  120. recover
  121. EVP_PKEY_encrypt_init encrypt encrypt encrypt encrypt encrypt encrypt encrypt encrypt encrypt encrypt encrypt
  122. EVP_PKEY_encrypt encrypt
  123. EVP_PKEY_decrypt_init decrypt decrypt decrypt decrypt decrypt decrypt decrypt decrypt decrypt decrypt decrypt
  124. EVP_PKEY_decrypt decrypt
  125. EVP_PKEY_derive_init derive derive derive derive derive derive derive derive derive derive derive
  126. EVP_PKEY_derive_set_peer derive
  127. EVP_PKEY_derive derive
  128. EVP_PKEY_encapsulate_init encapsulate encapsulate encapsulate encapsulate encapsulate encapsulate encapsulate encapsulate encapsulate encapsulate encapsulate
  129. EVP_PKEY_encapsulate encapsulate
  130. EVP_PKEY_decapsulate_init decapsulate decapsulate decapsulate decapsulate decapsulate decapsulate decapsulate decapsulate decapsulate decapsulate decapsulate
  131. EVP_PKEY_decapsulate decapsulate
  132. EVP_PKEY_paramgen_init parameter parameter parameter parameter parameter parameter parameter parameter parameter parameter parameter
  133. generation generation generation generation generation generation generation generation generation generation generation
  134. EVP_PKEY_paramgen parameter
  135. generation
  136. EVP_PKEY_keygen_init key key key key key key key key key key key
  137. generation generation generation generation generation generation generation generation generation generation generation
  138. EVP_PKEY_keygen key
  139. generation
  140. EVP_PKEY_gen parameter key
  141. generation generation
  142. EVP_PKEY_CTX_get_params newed digest verify verify encrypt decrypt derive encapsulate decapsulate parameter key
  143. sign recover generation generation
  144. EVP_PKEY_CTX_set_params newed digest verify verify encrypt decrypt derive encapsulate decapsulate parameter key
  145. sign recover generation generation
  146. EVP_PKEY_CTX_gettable_params newed digest verify verify encrypt decrypt derive encapsulate decapsulate parameter key
  147. sign recover generation generation
  148. EVP_PKEY_CTX_settable_params newed digest verify verify encrypt decrypt derive encapsulate decapsulate parameter key
  149. sign recover generation generation
  150. EVP_PKEY_CTX_free freed freed freed freed freed freed freed freed freed freed freed freed
  151. =end man
  152. =begin html
  153. <table style="border:1px solid; border-collapse:collapse">
  154. <tr><th style="border:1px solid" align="left">Function Call</th>
  155. <th style="border:1px solid" colspan="13">Current State</th></tr>
  156. <tr><th style="border:1px solid"></th>
  157. <th style="border:1px solid" align="center">start</th>
  158. <th style="border:1px solid" align="center">newed</th>
  159. <th style="border:1px solid" align="center">digest<br>sign</th>
  160. <th style="border:1px solid" align="center">verify</th>
  161. <th style="border:1px solid" align="center">verify<br>recover</th>
  162. <th style="border:1px solid" align="center">encrypt</th>
  163. <th style="border:1px solid" align="center">decrypt</th>
  164. <th style="border:1px solid" align="center">derive</th>
  165. <th style="border:1px solid" align="center">encapsulate</th>
  166. <th style="border:1px solid" align="center">decapsulate</th>
  167. <th style="border:1px solid" align="center">parameter<br>generation</th>
  168. <th style="border:1px solid" align="center">key<br>generation</th>
  169. <th style="border:1px solid" align="center">freed</th>
  170. </tr>
  171. <tr><th style="border:1px solid" align="left">EVP_PKEY_CTX_new</th>
  172. <td style="border:1px solid" align="center">newed</td>
  173. <td style="border:1px solid" align="center"></td>
  174. <td style="border:1px solid" align="center"></td>
  175. <td style="border:1px solid" align="center"></td>
  176. <td style="border:1px solid" align="center"></td>
  177. <td style="border:1px solid" align="center"></td>
  178. <td style="border:1px solid" align="center"></td>
  179. <td style="border:1px solid" align="center"></td>
  180. <td style="border:1px solid" align="center"></td>
  181. <td style="border:1px solid" align="center"></td>
  182. <td style="border:1px solid" align="center"></td>
  183. <td style="border:1px solid" align="center"></td>
  184. <td style="border:1px solid" align="center"></td>
  185. </tr>
  186. <tr><th style="border:1px solid" align="left">EVP_PKEY_CTX_new_id</th>
  187. <td style="border:1px solid" align="center">newed</td>
  188. <td style="border:1px solid" align="center"></td>
  189. <td style="border:1px solid" align="center"></td>
  190. <td style="border:1px solid" align="center"></td>
  191. <td style="border:1px solid" align="center"></td>
  192. <td style="border:1px solid" align="center"></td>
  193. <td style="border:1px solid" align="center"></td>
  194. <td style="border:1px solid" align="center"></td>
  195. <td style="border:1px solid" align="center"></td>
  196. <td style="border:1px solid" align="center"></td>
  197. <td style="border:1px solid" align="center"></td>
  198. <td style="border:1px solid" align="center"></td>
  199. <td style="border:1px solid" align="center"></td>
  200. </tr>
  201. <tr><th style="border:1px solid" align="left">EVP_PKEY_CTX_new_from_name</th>
  202. <td style="border:1px solid" align="center">newed</td>
  203. <td style="border:1px solid" align="center"></td>
  204. <td style="border:1px solid" align="center"></td>
  205. <td style="border:1px solid" align="center"></td>
  206. <td style="border:1px solid" align="center"></td>
  207. <td style="border:1px solid" align="center"></td>
  208. <td style="border:1px solid" align="center"></td>
  209. <td style="border:1px solid" align="center"></td>
  210. <td style="border:1px solid" align="center"></td>
  211. <td style="border:1px solid" align="center"></td>
  212. <td style="border:1px solid" align="center"></td>
  213. <td style="border:1px solid" align="center"></td>
  214. <td style="border:1px solid" align="center"></td>
  215. </tr>
  216. <tr><th style="border:1px solid" align="left">EVP_PKEY_CTX_new_from_pkey</th>
  217. <td style="border:1px solid" align="center">newed</td>
  218. <td style="border:1px solid" align="center"></td>
  219. <td style="border:1px solid" align="center"></td>
  220. <td style="border:1px solid" align="center"></td>
  221. <td style="border:1px solid" align="center"></td>
  222. <td style="border:1px solid" align="center"></td>
  223. <td style="border:1px solid" align="center"></td>
  224. <td style="border:1px solid" align="center"></td>
  225. <td style="border:1px solid" align="center"></td>
  226. <td style="border:1px solid" align="center"></td>
  227. <td style="border:1px solid" align="center"></td>
  228. <td style="border:1px solid" align="center"></td>
  229. <td style="border:1px solid" align="center"></td>
  230. </tr>
  231. <tr><th style="border:1px solid" align="left">EVP_PKEY_sign_init</th>
  232. <td style="border:1px solid" align="center"></td>
  233. <td style="border:1px solid" align="center">digest<br>sign</td>
  234. <td style="border:1px solid" align="center">digest<br>sign</td>
  235. <td style="border:1px solid" align="center">digest<br>sign</td>
  236. <td style="border:1px solid" align="center">digest<br>sign</td>
  237. <td style="border:1px solid" align="center">digest<br>sign</td>
  238. <td style="border:1px solid" align="center">digest<br>sign</td>
  239. <td style="border:1px solid" align="center">digest<br>sign</td>
  240. <td style="border:1px solid" align="center">digest<br>sign</td>
  241. <td style="border:1px solid" align="center">digest<br>sign</td>
  242. <td style="border:1px solid" align="center">digest<br>sign</td>
  243. <td style="border:1px solid" align="center">digest<br>sign</td>
  244. <td style="border:1px solid" align="center"></td>
  245. </tr>
  246. <tr><th style="border:1px solid" align="left">EVP_PKEY_sign</th>
  247. <td style="border:1px solid" align="center"></td>
  248. <td style="border:1px solid" align="center"></td>
  249. <td style="border:1px solid" align="center">digest<br>sign</td>
  250. <td style="border:1px solid" align="center"></td>
  251. <td style="border:1px solid" align="center"></td>
  252. <td style="border:1px solid" align="center"></td>
  253. <td style="border:1px solid" align="center"></td>
  254. <td style="border:1px solid" align="center"></td>
  255. <td style="border:1px solid" align="center"></td>
  256. <td style="border:1px solid" align="center"></td>
  257. <td style="border:1px solid" align="center"></td>
  258. <td style="border:1px solid" align="center"></td>
  259. <td style="border:1px solid" align="center"></td>
  260. </tr>
  261. <tr><th style="border:1px solid" align="left">EVP_PKEY_verify_init</th>
  262. <td style="border:1px solid" align="center"></td>
  263. <td style="border:1px solid" align="center">verify</td>
  264. <td style="border:1px solid" align="center">verify</td>
  265. <td style="border:1px solid" align="center">verify</td>
  266. <td style="border:1px solid" align="center">verify</td>
  267. <td style="border:1px solid" align="center">verify</td>
  268. <td style="border:1px solid" align="center">verify</td>
  269. <td style="border:1px solid" align="center">verify</td>
  270. <td style="border:1px solid" align="center">verify</td>
  271. <td style="border:1px solid" align="center">verify</td>
  272. <td style="border:1px solid" align="center">verify</td>
  273. <td style="border:1px solid" align="center">verify</td>
  274. <td style="border:1px solid" align="center"></td>
  275. </tr>
  276. <tr><th style="border:1px solid" align="left">EVP_PKEY_verify</th>
  277. <td style="border:1px solid" align="center"></td>
  278. <td style="border:1px solid" align="center"></td>
  279. <td style="border:1px solid" align="center"></td>
  280. <td style="border:1px solid" align="center">verify</td>
  281. <td style="border:1px solid" align="center"></td>
  282. <td style="border:1px solid" align="center"></td>
  283. <td style="border:1px solid" align="center"></td>
  284. <td style="border:1px solid" align="center"></td>
  285. <td style="border:1px solid" align="center"></td>
  286. <td style="border:1px solid" align="center"></td>
  287. <td style="border:1px solid" align="center"></td>
  288. <td style="border:1px solid" align="center"></td>
  289. <td style="border:1px solid" align="center"></td>
  290. </tr>
  291. <tr><th style="border:1px solid" align="left">EVP_PKEY_verify_recover_init</th>
  292. <td style="border:1px solid" align="center"></td>
  293. <td style="border:1px solid" align="center">verify<br>recover</td>
  294. <td style="border:1px solid" align="center">verify<br>recover</td>
  295. <td style="border:1px solid" align="center">verify<br>recover</td>
  296. <td style="border:1px solid" align="center">verify<br>recover</td>
  297. <td style="border:1px solid" align="center">verify<br>recover</td>
  298. <td style="border:1px solid" align="center">verify<br>recover</td>
  299. <td style="border:1px solid" align="center">verify<br>recover</td>
  300. <td style="border:1px solid" align="center">verify<br>recover</td>
  301. <td style="border:1px solid" align="center">verify<br>recover</td>
  302. <td style="border:1px solid" align="center">verify<br>recover</td>
  303. <td style="border:1px solid" align="center">verify<br>recover</td>
  304. <td style="border:1px solid" align="center"></td>
  305. </tr>
  306. <tr><th style="border:1px solid" align="left">EVP_PKEY_verify_recover</th>
  307. <td style="border:1px solid" align="center"></td>
  308. <td style="border:1px solid" align="center"></td>
  309. <td style="border:1px solid" align="center"></td>
  310. <td style="border:1px solid" align="center"></td>
  311. <td style="border:1px solid" align="center">verify<br>recover</td>
  312. <td style="border:1px solid" align="center"></td>
  313. <td style="border:1px solid" align="center"></td>
  314. <td style="border:1px solid" align="center"></td>
  315. <td style="border:1px solid" align="center"></td>
  316. <td style="border:1px solid" align="center"></td>
  317. <td style="border:1px solid" align="center"></td>
  318. <td style="border:1px solid" align="center"></td>
  319. <td style="border:1px solid" align="center"></td>
  320. </tr>
  321. <tr><th style="border:1px solid" align="left">EVP_PKEY_encrypt_init</th>
  322. <td style="border:1px solid" align="center"></td>
  323. <td style="border:1px solid" align="center">encrypt</td>
  324. <td style="border:1px solid" align="center">encrypt</td>
  325. <td style="border:1px solid" align="center">encrypt</td>
  326. <td style="border:1px solid" align="center">encrypt</td>
  327. <td style="border:1px solid" align="center">encrypt</td>
  328. <td style="border:1px solid" align="center">encrypt</td>
  329. <td style="border:1px solid" align="center">encrypt</td>
  330. <td style="border:1px solid" align="center">encrypt</td>
  331. <td style="border:1px solid" align="center">encrypt</td>
  332. <td style="border:1px solid" align="center">encrypt</td>
  333. <td style="border:1px solid" align="center">encrypt</td>
  334. <td style="border:1px solid" align="center"></td>
  335. </tr>
  336. <tr><th style="border:1px solid" align="left">EVP_PKEY_encrypt</th>
  337. <td style="border:1px solid" align="center"></td>
  338. <td style="border:1px solid" align="center"></td>
  339. <td style="border:1px solid" align="center"></td>
  340. <td style="border:1px solid" align="center"></td>
  341. <td style="border:1px solid" align="center"></td>
  342. <td style="border:1px solid" align="center">encrypt</td>
  343. <td style="border:1px solid" align="center"></td>
  344. <td style="border:1px solid" align="center"></td>
  345. <td style="border:1px solid" align="center"></td>
  346. <td style="border:1px solid" align="center"></td>
  347. <td style="border:1px solid" align="center"></td>
  348. <td style="border:1px solid" align="center"></td>
  349. <td style="border:1px solid" align="center"></td>
  350. </tr>
  351. <tr><th style="border:1px solid" align="left">EVP_PKEY_decrypt_init</th>
  352. <td style="border:1px solid" align="center"></td>
  353. <td style="border:1px solid" align="center">decrypt</td>
  354. <td style="border:1px solid" align="center">decrypt</td>
  355. <td style="border:1px solid" align="center">decrypt</td>
  356. <td style="border:1px solid" align="center">decrypt</td>
  357. <td style="border:1px solid" align="center">decrypt</td>
  358. <td style="border:1px solid" align="center">decrypt</td>
  359. <td style="border:1px solid" align="center">decrypt</td>
  360. <td style="border:1px solid" align="center">decrypt</td>
  361. <td style="border:1px solid" align="center">decrypt</td>
  362. <td style="border:1px solid" align="center">decrypt</td>
  363. <td style="border:1px solid" align="center">decrypt</td>
  364. <td style="border:1px solid" align="center"></td>
  365. </tr>
  366. <tr><th style="border:1px solid" align="left">EVP_PKEY_decrypt</th>
  367. <td style="border:1px solid" align="center"></td>
  368. <td style="border:1px solid" align="center"></td>
  369. <td style="border:1px solid" align="center"></td>
  370. <td style="border:1px solid" align="center"></td>
  371. <td style="border:1px solid" align="center"></td>
  372. <td style="border:1px solid" align="center"></td>
  373. <td style="border:1px solid" align="center">decrypt</td>
  374. <td style="border:1px solid" align="center"></td>
  375. <td style="border:1px solid" align="center"></td>
  376. <td style="border:1px solid" align="center"></td>
  377. <td style="border:1px solid" align="center"></td>
  378. <td style="border:1px solid" align="center"></td>
  379. <td style="border:1px solid" align="center"></td>
  380. </tr>
  381. <tr><th style="border:1px solid" align="left">EVP_PKEY_derive_init</th>
  382. <td style="border:1px solid" align="center"></td>
  383. <td style="border:1px solid" align="center">derive</td>
  384. <td style="border:1px solid" align="center">derive</td>
  385. <td style="border:1px solid" align="center">derive</td>
  386. <td style="border:1px solid" align="center">derive</td>
  387. <td style="border:1px solid" align="center">derive</td>
  388. <td style="border:1px solid" align="center">derive</td>
  389. <td style="border:1px solid" align="center">derive</td>
  390. <td style="border:1px solid" align="center">derive</td>
  391. <td style="border:1px solid" align="center">derive</td>
  392. <td style="border:1px solid" align="center">derive</td>
  393. <td style="border:1px solid" align="center">derive</td>
  394. <td style="border:1px solid" align="center"></td>
  395. </tr>
  396. <tr><th style="border:1px solid" align="left">EVP_PKEY_derive_set_peer</th>
  397. <td style="border:1px solid" align="center"></td>
  398. <td style="border:1px solid" align="center"></td>
  399. <td style="border:1px solid" align="center"></td>
  400. <td style="border:1px solid" align="center"></td>
  401. <td style="border:1px solid" align="center"></td>
  402. <td style="border:1px solid" align="center"></td>
  403. <td style="border:1px solid" align="center"></td>
  404. <td style="border:1px solid" align="center">derive</td>
  405. <td style="border:1px solid" align="center"></td>
  406. <td style="border:1px solid" align="center"></td>
  407. <td style="border:1px solid" align="center"></td>
  408. <td style="border:1px solid" align="center"></td>
  409. <td style="border:1px solid" align="center"></td>
  410. </tr>
  411. <tr><th style="border:1px solid" align="left">EVP_PKEY_derive</th>
  412. <td style="border:1px solid" align="center"></td>
  413. <td style="border:1px solid" align="center"></td>
  414. <td style="border:1px solid" align="center"></td>
  415. <td style="border:1px solid" align="center"></td>
  416. <td style="border:1px solid" align="center"></td>
  417. <td style="border:1px solid" align="center"></td>
  418. <td style="border:1px solid" align="center"></td>
  419. <td style="border:1px solid" align="center">derive</td>
  420. <td style="border:1px solid" align="center"></td>
  421. <td style="border:1px solid" align="center"></td>
  422. <td style="border:1px solid" align="center"></td>
  423. <td style="border:1px solid" align="center"></td>
  424. <td style="border:1px solid" align="center"></td>
  425. </tr>
  426. <tr><th style="border:1px solid" align="left">EVP_PKEY_encapsulate_init</th>
  427. <td style="border:1px solid" align="center"></td>
  428. <td style="border:1px solid" align="center">encapsulate</td>
  429. <td style="border:1px solid" align="center">encapsulate</td>
  430. <td style="border:1px solid" align="center">encapsulate</td>
  431. <td style="border:1px solid" align="center">encapsulate</td>
  432. <td style="border:1px solid" align="center">encapsulate</td>
  433. <td style="border:1px solid" align="center">encapsulate</td>
  434. <td style="border:1px solid" align="center">encapsulate</td>
  435. <td style="border:1px solid" align="center">encapsulate</td>
  436. <td style="border:1px solid" align="center">encapsulate</td>
  437. <td style="border:1px solid" align="center">encapsulate</td>
  438. <td style="border:1px solid" align="center">encapsulate</td>
  439. <td style="border:1px solid" align="center"></td>
  440. </tr>
  441. <tr><th style="border:1px solid" align="left">EVP_PKEY_encapsulate</th>
  442. <td style="border:1px solid" align="center"></td>
  443. <td style="border:1px solid" align="center"></td>
  444. <td style="border:1px solid" align="center"></td>
  445. <td style="border:1px solid" align="center"></td>
  446. <td style="border:1px solid" align="center"></td>
  447. <td style="border:1px solid" align="center"></td>
  448. <td style="border:1px solid" align="center"></td>
  449. <td style="border:1px solid" align="center"></td>
  450. <td style="border:1px solid" align="center">encapsulate</td>
  451. <td style="border:1px solid" align="center"></td>
  452. <td style="border:1px solid" align="center"></td>
  453. <td style="border:1px solid" align="center"></td>
  454. <td style="border:1px solid" align="center"></td>
  455. </tr>
  456. <tr><th style="border:1px solid" align="left">EVP_PKEY_decapsulate_init</th>
  457. <td style="border:1px solid" align="center"></td>
  458. <td style="border:1px solid" align="center">decapsulate</td>
  459. <td style="border:1px solid" align="center">decapsulate</td>
  460. <td style="border:1px solid" align="center">decapsulate</td>
  461. <td style="border:1px solid" align="center">decapsulate</td>
  462. <td style="border:1px solid" align="center">decapsulate</td>
  463. <td style="border:1px solid" align="center">decapsulate</td>
  464. <td style="border:1px solid" align="center">decapsulate</td>
  465. <td style="border:1px solid" align="center">decapsulate</td>
  466. <td style="border:1px solid" align="center">decapsulate</td>
  467. <td style="border:1px solid" align="center">decapsulate</td>
  468. <td style="border:1px solid" align="center">decapsulate</td>
  469. <td style="border:1px solid" align="center"></td>
  470. </tr>
  471. <tr><th style="border:1px solid" align="left">EVP_PKEY_decapsulate</th>
  472. <td style="border:1px solid" align="center"></td>
  473. <td style="border:1px solid" align="center"></td>
  474. <td style="border:1px solid" align="center"></td>
  475. <td style="border:1px solid" align="center"></td>
  476. <td style="border:1px solid" align="center"></td>
  477. <td style="border:1px solid" align="center"></td>
  478. <td style="border:1px solid" align="center"></td>
  479. <td style="border:1px solid" align="center"></td>
  480. <td style="border:1px solid" align="center"></td>
  481. <td style="border:1px solid" align="center">decapsulate</td>
  482. <td style="border:1px solid" align="center"></td>
  483. <td style="border:1px solid" align="center"></td>
  484. <td style="border:1px solid" align="center"></td>
  485. </tr>
  486. <tr><th style="border:1px solid" align="left">EVP_PKEY_paramgen_init</th>
  487. <td style="border:1px solid" align="center"></td>
  488. <td style="border:1px solid" align="center">parameter<br>generation</td>
  489. <td style="border:1px solid" align="center">parameter<br>generation</td>
  490. <td style="border:1px solid" align="center">parameter<br>generation</td>
  491. <td style="border:1px solid" align="center">parameter<br>generation</td>
  492. <td style="border:1px solid" align="center">parameter<br>generation</td>
  493. <td style="border:1px solid" align="center">parameter<br>generation</td>
  494. <td style="border:1px solid" align="center">parameter<br>generation</td>
  495. <td style="border:1px solid" align="center">parameter<br>generation</td>
  496. <td style="border:1px solid" align="center">parameter<br>generation</td>
  497. <td style="border:1px solid" align="center">parameter<br>generation</td>
  498. <td style="border:1px solid" align="center">parameter<br>generation</td>
  499. <td style="border:1px solid" align="center"></td>
  500. </tr>
  501. <tr><th style="border:1px solid" align="left">EVP_PKEY_paramgen</th>
  502. <td style="border:1px solid" align="center"></td>
  503. <td style="border:1px solid" align="center"></td>
  504. <td style="border:1px solid" align="center"></td>
  505. <td style="border:1px solid" align="center"></td>
  506. <td style="border:1px solid" align="center"></td>
  507. <td style="border:1px solid" align="center"></td>
  508. <td style="border:1px solid" align="center"></td>
  509. <td style="border:1px solid" align="center"></td>
  510. <td style="border:1px solid" align="center"></td>
  511. <td style="border:1px solid" align="center"></td>
  512. <td style="border:1px solid" align="center">parameter<br>generation</td>
  513. <td style="border:1px solid" align="center"></td>
  514. <td style="border:1px solid" align="center"></td>
  515. </tr>
  516. <tr><th style="border:1px solid" align="left">EVP_PKEY_keygen_init</th>
  517. <td style="border:1px solid" align="center"></td>
  518. <td style="border:1px solid" align="center">key<br>generation</td>
  519. <td style="border:1px solid" align="center">key<br>generation</td>
  520. <td style="border:1px solid" align="center">key<br>generation</td>
  521. <td style="border:1px solid" align="center">key<br>generation</td>
  522. <td style="border:1px solid" align="center">key<br>generation</td>
  523. <td style="border:1px solid" align="center">key<br>generation</td>
  524. <td style="border:1px solid" align="center">key<br>generation</td>
  525. <td style="border:1px solid" align="center">key<br>generation</td>
  526. <td style="border:1px solid" align="center">key<br>generation</td>
  527. <td style="border:1px solid" align="center">key<br>generation</td>
  528. <td style="border:1px solid" align="center">key<br>generation</td>
  529. <td style="border:1px solid" align="center"></td>
  530. </tr>
  531. <tr><th style="border:1px solid" align="left">EVP_PKEY_keygen</th>
  532. <td style="border:1px solid" align="center"></td>
  533. <td style="border:1px solid" align="center"></td>
  534. <td style="border:1px solid" align="center"></td>
  535. <td style="border:1px solid" align="center"></td>
  536. <td style="border:1px solid" align="center"></td>
  537. <td style="border:1px solid" align="center"></td>
  538. <td style="border:1px solid" align="center"></td>
  539. <td style="border:1px solid" align="center"></td>
  540. <td style="border:1px solid" align="center"></td>
  541. <td style="border:1px solid" align="center"></td>
  542. <td style="border:1px solid" align="center"></td>
  543. <td style="border:1px solid" align="center">key<br>generation</td>
  544. <td style="border:1px solid" align="center"></td>
  545. </tr>
  546. <tr><th style="border:1px solid" align="left">EVP_PKEY_gen</th>
  547. <td style="border:1px solid" align="center"></td>
  548. <td style="border:1px solid" align="center"></td>
  549. <td style="border:1px solid" align="center"></td>
  550. <td style="border:1px solid" align="center"></td>
  551. <td style="border:1px solid" align="center"></td>
  552. <td style="border:1px solid" align="center"></td>
  553. <td style="border:1px solid" align="center"></td>
  554. <td style="border:1px solid" align="center"></td>
  555. <td style="border:1px solid" align="center"></td>
  556. <td style="border:1px solid" align="center"></td>
  557. <td style="border:1px solid" align="center">parameter<br>generation</td>
  558. <td style="border:1px solid" align="center">key<br>generation</td>
  559. <td style="border:1px solid" align="center"></td>
  560. </tr>
  561. <tr><th style="border:1px solid" align="left">EVP_PKEY_CTX_get_params</th>
  562. <td style="border:1px solid" align="center"></td>
  563. <td style="border:1px solid" align="center">newed</td>
  564. <td style="border:1px solid" align="center">digest<br>sign</td>
  565. <td style="border:1px solid" align="center">verify</td>
  566. <td style="border:1px solid" align="center">verify<br>recover</td>
  567. <td style="border:1px solid" align="center">encrypt</td>
  568. <td style="border:1px solid" align="center">decrypt</td>
  569. <td style="border:1px solid" align="center">derive</td>
  570. <td style="border:1px solid" align="center">encapsulate</td>
  571. <td style="border:1px solid" align="center">decapsulate</td>
  572. <td style="border:1px solid" align="center">parameter<br>generation</td>
  573. <td style="border:1px solid" align="center">key<br>generation</td>
  574. <td style="border:1px solid" align="center"></td>
  575. </tr>
  576. <tr><th style="border:1px solid" align="left">EVP_PKEY_CTX_set_params</th>
  577. <td style="border:1px solid" align="center"></td>
  578. <td style="border:1px solid" align="center">newed</td>
  579. <td style="border:1px solid" align="center">digest<br>sign</td>
  580. <td style="border:1px solid" align="center">verify</td>
  581. <td style="border:1px solid" align="center">verify<br>recover</td>
  582. <td style="border:1px solid" align="center">encrypt</td>
  583. <td style="border:1px solid" align="center">decrypt</td>
  584. <td style="border:1px solid" align="center">derive</td>
  585. <td style="border:1px solid" align="center">encapsulate</td>
  586. <td style="border:1px solid" align="center">decapsulate</td>
  587. <td style="border:1px solid" align="center">parameter<br>generation</td>
  588. <td style="border:1px solid" align="center">key<br>generation</td>
  589. <td style="border:1px solid" align="center"></td>
  590. </tr>
  591. <tr><th style="border:1px solid" align="left">EVP_PKEY_CTX_gettable_params</th>
  592. <td style="border:1px solid" align="center"></td>
  593. <td style="border:1px solid" align="center">newed</td>
  594. <td style="border:1px solid" align="center">digest<br>sign</td>
  595. <td style="border:1px solid" align="center">verify</td>
  596. <td style="border:1px solid" align="center">verify<br>recover</td>
  597. <td style="border:1px solid" align="center">encrypt</td>
  598. <td style="border:1px solid" align="center">decrypt</td>
  599. <td style="border:1px solid" align="center">derive</td>
  600. <td style="border:1px solid" align="center">encapsulate</td>
  601. <td style="border:1px solid" align="center">decapsulate</td>
  602. <td style="border:1px solid" align="center">parameter<br>generation</td>
  603. <td style="border:1px solid" align="center">key<br>generation</td>
  604. <td style="border:1px solid" align="center"></td>
  605. </tr>
  606. <tr><th style="border:1px solid" align="left">EVP_PKEY_CTX_settable_params</th>
  607. <td style="border:1px solid" align="center"></td>
  608. <td style="border:1px solid" align="center">newed</td>
  609. <td style="border:1px solid" align="center">digest<br>sign</td>
  610. <td style="border:1px solid" align="center">verify</td>
  611. <td style="border:1px solid" align="center">verify<br>recover</td>
  612. <td style="border:1px solid" align="center">encrypt</td>
  613. <td style="border:1px solid" align="center">decrypt</td>
  614. <td style="border:1px solid" align="center">derive</td>
  615. <td style="border:1px solid" align="center">encapsulate</td>
  616. <td style="border:1px solid" align="center">decapsulate</td>
  617. <td style="border:1px solid" align="center">parameter<br>generation</td>
  618. <td style="border:1px solid" align="center">key<br>generation</td>
  619. <td style="border:1px solid" align="center"></td>
  620. </tr>
  621. <tr><th style="border:1px solid" align="left">EVP_PKEY_CTX_free</th>
  622. <td style="border:1px solid" align="center">freed</td>
  623. <td style="border:1px solid" align="center">freed</td>
  624. <td style="border:1px solid" align="center">freed</td>
  625. <td style="border:1px solid" align="center">freed</td>
  626. <td style="border:1px solid" align="center">freed</td>
  627. <td style="border:1px solid" align="center">freed</td>
  628. <td style="border:1px solid" align="center">freed</td>
  629. <td style="border:1px solid" align="center">freed</td>
  630. <td style="border:1px solid" align="center">freed</td>
  631. <td style="border:1px solid" align="center">freed</td>
  632. <td style="border:1px solid" align="center">freed</td>
  633. <td style="border:1px solid" align="center">freed</td>
  634. <td style="border:1px solid" align="center"></td>
  635. </tr>
  636. </table>
  637. =end html
  638. =head1 NOTES
  639. At some point the EVP layer will begin enforcing the transitions described
  640. herein.
  641. =head1 SEE ALSO
  642. L<EVP_PKEY_new(3)>,
  643. L<EVP_PKEY_decapsulate(3)>, L<EVP_PKEY_decrypt(3)>, L<EVP_PKEY_encapsulate(3)>,
  644. L<EVP_PKEY_encrypt(3)>, L<EVP_PKEY_derive(3)>, L<EVP_PKEY_keygen(3)>,
  645. L<EVP_PKEY_sign(3)>, L<EVP_PKEY_verify(3)>, L<EVP_PKEY_verify_recover(3)>
  646. =head1 HISTORY
  647. The provider PKEY interface was introduced in OpenSSL 3.0.
  648. =head1 COPYRIGHT
  649. Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
  650. Licensed under the Apache License 2.0 (the "License"). You may not use
  651. this file except in compliance with the License. You can obtain a copy
  652. in the file LICENSE in the source distribution or at
  653. L<https://www.openssl.org/source/license.html>.
  654. =cut