EVP_KEM_free.3ossl 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237
  1. .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
  2. .\"
  3. .\" Standard preamble:
  4. .\" ========================================================================
  5. .de Sp \" Vertical space (when we can't use .PP)
  6. .if t .sp .5v
  7. .if n .sp
  8. ..
  9. .de Vb \" Begin verbatim text
  10. .ft CW
  11. .nf
  12. .ne \\$1
  13. ..
  14. .de Ve \" End verbatim text
  15. .ft R
  16. .fi
  17. ..
  18. .\" Set up some character translations and predefined strings. \*(-- will
  19. .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20. .\" double quote, and \*(R" will give a right double quote. \*(C+ will
  21. .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
  22. .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
  23. .\" nothing in troff, for use with C<>.
  24. .tr \(*W-
  25. .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26. .ie n \{\
  27. . ds -- \(*W-
  28. . ds PI pi
  29. . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30. . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
  31. . ds L" ""
  32. . ds R" ""
  33. . ds C` ""
  34. . ds C' ""
  35. 'br\}
  36. .el\{\
  37. . ds -- \|\(em\|
  38. . ds PI \(*p
  39. . ds L" ``
  40. . ds R" ''
  41. . ds C`
  42. . ds C'
  43. 'br\}
  44. .\"
  45. .\" Escape single quotes in literal strings from groff's Unicode transform.
  46. .ie \n(.g .ds Aq \(aq
  47. .el .ds Aq '
  48. .\"
  49. .\" If the F register is >0, we'll generate index entries on stderr for
  50. .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51. .\" entries marked with X<> in POD. Of course, you'll have to process the
  52. .\" output yourself in some meaningful fashion.
  53. .\"
  54. .\" Avoid warning from groff about undefined register 'F'.
  55. .de IX
  56. ..
  57. .nr rF 0
  58. .if \n(.g .if rF .nr rF 1
  59. .if (\n(rF:(\n(.g==0)) \{\
  60. . if \nF \{\
  61. . de IX
  62. . tm Index:\\$1\t\\n%\t"\\$2"
  63. ..
  64. . if !\nF==2 \{\
  65. . nr % 0
  66. . nr F 2
  67. . \}
  68. . \}
  69. .\}
  70. .rr rF
  71. .\"
  72. .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73. .\" Fear. Run. Save yourself. No user-serviceable parts.
  74. . \" fudge factors for nroff and troff
  75. .if n \{\
  76. . ds #H 0
  77. . ds #V .8m
  78. . ds #F .3m
  79. . ds #[ \f1
  80. . ds #] \fP
  81. .\}
  82. .if t \{\
  83. . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84. . ds #V .6m
  85. . ds #F 0
  86. . ds #[ \&
  87. . ds #] \&
  88. .\}
  89. . \" simple accents for nroff and troff
  90. .if n \{\
  91. . ds ' \&
  92. . ds ` \&
  93. . ds ^ \&
  94. . ds , \&
  95. . ds ~ ~
  96. . ds /
  97. .\}
  98. .if t \{\
  99. . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  100. . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  101. . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  102. . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  103. . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  104. . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  105. .\}
  106. . \" troff and (daisy-wheel) nroff accents
  107. .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  108. .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
  109. .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
  110. .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
  111. .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
  112. .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
  113. .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
  114. .ds ae a\h'-(\w'a'u*4/10)'e
  115. .ds Ae A\h'-(\w'A'u*4/10)'E
  116. . \" corrections for vroff
  117. .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
  118. .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
  119. . \" for low resolution devices (crt and lpr)
  120. .if \n(.H>23 .if \n(.V>19 \
  121. \{\
  122. . ds : e
  123. . ds 8 ss
  124. . ds o a
  125. . ds d- d\h'-1'\(ga
  126. . ds D- D\h'-1'\(hy
  127. . ds th \o'bp'
  128. . ds Th \o'LP'
  129. . ds ae ae
  130. . ds Ae AE
  131. .\}
  132. .rm #[ #] #H #V #F C
  133. .\" ========================================================================
  134. .\"
  135. .IX Title "EVP_KEM_FREE 3ossl"
  136. .TH EVP_KEM_FREE 3ossl "2024-09-03" "3.3.2" "OpenSSL"
  137. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  138. .\" way too many mistakes in technical documents.
  139. .if n .ad l
  140. .nh
  141. .SH "NAME"
  142. EVP_KEM_fetch, EVP_KEM_free, EVP_KEM_up_ref,
  143. EVP_KEM_get0_name, EVP_KEM_is_a, EVP_KEM_get0_provider,
  144. EVP_KEM_do_all_provided, EVP_KEM_names_do_all, EVP_KEM_get0_description,
  145. EVP_KEM_gettable_ctx_params, EVP_KEM_settable_ctx_params
  146. \&\- Functions to manage EVP_KEM algorithm objects
  147. .SH "SYNOPSIS"
  148. .IX Header "SYNOPSIS"
  149. .Vb 1
  150. \& #include <openssl/evp.h>
  151. \&
  152. \& EVP_KEM *EVP_KEM_fetch(OSSL_LIB_CTX *ctx, const char *algorithm,
  153. \& const char *properties);
  154. \& void EVP_KEM_free(EVP_KEM *kem);
  155. \& int EVP_KEM_up_ref(EVP_KEM *kem);
  156. \& const char *EVP_KEM_get0_name(const EVP_KEM *kem);
  157. \& int EVP_KEM_is_a(const EVP_KEM *kem, const char *name);
  158. \& OSSL_PROVIDER *EVP_KEM_get0_provider(const EVP_KEM *kem);
  159. \& void EVP_KEM_do_all_provided(OSSL_LIB_CTX *libctx,
  160. \& void (*fn)(EVP_KEM *kem, void *arg), void *arg);
  161. \& int EVP_KEM_names_do_all(const EVP_KEM *kem,
  162. \& void (*fn)(const char *name, void *data), void *data);
  163. \& const char *EVP_KEM_get0_description(const EVP_KEM *kem);
  164. \& const OSSL_PARAM *EVP_KEM_gettable_ctx_params(const EVP_KEM *kem);
  165. \& const OSSL_PARAM *EVP_KEM_settable_ctx_params(const EVP_KEM *kem);
  166. .Ve
  167. .SH "DESCRIPTION"
  168. .IX Header "DESCRIPTION"
  169. \&\fBEVP_KEM_fetch()\fR fetches the implementation for the given \fBalgorithm\fR from any
  170. provider offering it, within the criteria given by the \fBproperties\fR and in the
  171. scope of the given library context \fBctx\fR (see \s-1\fBOSSL_LIB_CTX\s0\fR\|(3)). The algorithm
  172. will be one offering functions for performing asymmetric kem related tasks such
  173. as key encapsulation and decapsulation.
  174. See \*(L"\s-1ALGORITHM FETCHING\*(R"\s0 in \fBcrypto\fR\|(7) for further information.
  175. .PP
  176. The returned value must eventually be freed with \fBEVP_KEM_free()\fR.
  177. .PP
  178. \&\fBEVP_KEM_free()\fR decrements the reference count for the \fB\s-1EVP_KEM\s0\fR structure.
  179. Typically this structure will have been obtained from an earlier call to
  180. \&\fBEVP_KEM_fetch()\fR. If the reference count drops to 0 then the structure is freed.
  181. If the argument is \s-1NULL,\s0 nothing is done.
  182. .PP
  183. \&\fBEVP_KEM_up_ref()\fR increments the reference count for an \fB\s-1EVP_KEM\s0\fR structure.
  184. .PP
  185. \&\fBEVP_KEM_is_a()\fR returns 1 if \fIkem\fR is an implementation of an
  186. algorithm that's identifiable with \fIname\fR, otherwise 0.
  187. .PP
  188. \&\fBEVP_KEM_get0_provider()\fR returns the provider that \fIkem\fR was fetched from.
  189. .PP
  190. \&\fBEVP_KEM_do_all_provided()\fR traverses all EVP_KEMs implemented by all activated
  191. providers in the given library context \fIlibctx\fR, and for each of the
  192. implementations, calls the given function \fIfn\fR with the implementation method
  193. and the given \fIarg\fR as argument.
  194. .PP
  195. \&\fBEVP_KEM_get0_name()\fR returns the algorithm name from the provided
  196. implementation for the given \fIkem\fR. Note that the \fIkem\fR may have
  197. multiple synonyms associated with it. In this case the first name from the
  198. algorithm definition is returned. Ownership of the returned string is retained
  199. by the \fIkem\fR object and should not be freed by the caller.
  200. .PP
  201. \&\fBEVP_KEM_names_do_all()\fR traverses all names for \fIkem\fR, and calls \fIfn\fR with
  202. each name and \fIdata\fR.
  203. .PP
  204. \&\fBEVP_KEM_get0_description()\fR returns a description of the \fIkem\fR, meant for
  205. display and human consumption. The description is at the discretion of
  206. the \fIkem\fR implementation.
  207. .PP
  208. \&\fBEVP_KEM_gettable_ctx_params()\fR and \fBEVP_KEM_settable_ctx_params()\fR return
  209. a constant \s-1\fBOSSL_PARAM\s0\fR\|(3) array that describes the names and types of key
  210. parameters that can be retrieved or set by a key encapsulation algorithm using
  211. \&\fBEVP_PKEY_CTX_get_params\fR\|(3) and \fBEVP_PKEY_CTX_set_params\fR\|(3).
  212. .SH "RETURN VALUES"
  213. .IX Header "RETURN VALUES"
  214. \&\fBEVP_KEM_fetch()\fR returns a pointer to an \fB\s-1EVP_KEM\s0\fR for success or \fB\s-1NULL\s0\fR for
  215. failure.
  216. .PP
  217. \&\fBEVP_KEM_up_ref()\fR returns 1 for success or 0 otherwise.
  218. .PP
  219. \&\fBEVP_KEM_names_do_all()\fR returns 1 if the callback was called for all names. A
  220. return value of 0 means that the callback was not called for any names.
  221. .PP
  222. \&\fBEVP_KEM_gettable_ctx_params()\fR and \fBEVP_KEM_settable_ctx_params()\fR return
  223. a constant \s-1\fBOSSL_PARAM\s0\fR\|(3) array or \s-1NULL\s0 on error.
  224. .SH "SEE ALSO"
  225. .IX Header "SEE ALSO"
  226. \&\*(L"\s-1ALGORITHM FETCHING\*(R"\s0 in \fBcrypto\fR\|(7), \s-1\fBOSSL_PROVIDER\s0\fR\|(3)
  227. .SH "HISTORY"
  228. .IX Header "HISTORY"
  229. The functions described here were added in OpenSSL 3.0.
  230. .SH "COPYRIGHT"
  231. .IX Header "COPYRIGHT"
  232. Copyright 2020\-2024 The OpenSSL Project Authors. All Rights Reserved.
  233. .PP
  234. Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
  235. this file except in compliance with the License. You can obtain a copy
  236. in the file \s-1LICENSE\s0 in the source distribution or at
  237. <https://www.openssl.org/source/license.html>.