OSSL_PROVIDER-base.7ossl 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205
  1. .\" -*- mode: troff; coding: utf-8 -*-
  2. .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
  3. .\"
  4. .\" Standard preamble:
  5. .\" ========================================================================
  6. .de Sp \" Vertical space (when we can't use .PP)
  7. .if t .sp .5v
  8. .if n .sp
  9. ..
  10. .de Vb \" Begin verbatim text
  11. .ft CW
  12. .nf
  13. .ne \\$1
  14. ..
  15. .de Ve \" End verbatim text
  16. .ft R
  17. .fi
  18. ..
  19. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
  20. .ie n \{\
  21. . ds C` ""
  22. . ds C' ""
  23. 'br\}
  24. .el\{\
  25. . ds C`
  26. . ds C'
  27. 'br\}
  28. .\"
  29. .\" Escape single quotes in literal strings from groff's Unicode transform.
  30. .ie \n(.g .ds Aq \(aq
  31. .el .ds Aq '
  32. .\"
  33. .\" If the F register is >0, we'll generate index entries on stderr for
  34. .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  35. .\" entries marked with X<> in POD. Of course, you'll have to process the
  36. .\" output yourself in some meaningful fashion.
  37. .\"
  38. .\" Avoid warning from groff about undefined register 'F'.
  39. .de IX
  40. ..
  41. .nr rF 0
  42. .if \n(.g .if rF .nr rF 1
  43. .if (\n(rF:(\n(.g==0)) \{\
  44. . if \nF \{\
  45. . de IX
  46. . tm Index:\\$1\t\\n%\t"\\$2"
  47. ..
  48. . if !\nF==2 \{\
  49. . nr % 0
  50. . nr F 2
  51. . \}
  52. . \}
  53. .\}
  54. .rr rF
  55. .\" ========================================================================
  56. .\"
  57. .IX Title "OSSL_PROVIDER-BASE 7ossl"
  58. .TH OSSL_PROVIDER-BASE 7ossl 2025-01-17 3.4.0 OpenSSL
  59. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  60. .\" way too many mistakes in technical documents.
  61. .if n .ad l
  62. .nh
  63. .SH NAME
  64. OSSL_PROVIDER\-base \- OpenSSL base provider
  65. .SH DESCRIPTION
  66. .IX Header "DESCRIPTION"
  67. The OpenSSL base provider supplies the encoding for OpenSSL's
  68. asymmetric cryptography.
  69. .SS Properties
  70. .IX Subsection "Properties"
  71. The implementations in this provider specifically have this property
  72. defined:
  73. .IP """provider=base""" 4
  74. .IX Item """provider=base"""
  75. .PP
  76. It may be used in a property query string with fetching functions.
  77. .PP
  78. It isn't mandatory to query for this property, except to make sure to get
  79. implementations of this provider and none other.
  80. .IP """type=parameters""" 4
  81. .IX Item """type=parameters"""
  82. .PD 0
  83. .IP """type=private""" 4
  84. .IX Item """type=private"""
  85. .IP """type=public""" 4
  86. .IX Item """type=public"""
  87. .PD
  88. .PP
  89. These may be used in a property query string with fetching functions to select
  90. which data are to be encoded. Either the private key material, the public
  91. key material or the domain parameters can be selected.
  92. .IP """format=der""" 4
  93. .IX Item """format=der"""
  94. .PD 0
  95. .IP """format=pem""" 4
  96. .IX Item """format=pem"""
  97. .IP """format=text""" 4
  98. .IX Item """format=text"""
  99. .PD
  100. .PP
  101. These may be used in a property query string with fetching functions to select
  102. the encoding output format. Either the DER, PEM and plaintext are
  103. currently permitted.
  104. .SH "OPERATIONS AND ALGORITHMS"
  105. .IX Header "OPERATIONS AND ALGORITHMS"
  106. The OpenSSL base provider supports these operations and algorithms:
  107. .SS "Random Number Generation"
  108. .IX Subsection "Random Number Generation"
  109. .IP "SEED-SRC, see \fBEVP_RAND\-SEED\-SRC\fR\|(7)" 4
  110. .IX Item "SEED-SRC, see EVP_RAND-SEED-SRC"
  111. .PD 0
  112. .IP "JITTER, see \fBEVP_RAND\-JITTER\fR\|(7)" 4
  113. .IX Item "JITTER, see EVP_RAND-JITTER"
  114. .PD
  115. .PP
  116. In addition to this provider, the "SEED-SRC" and "JITTER" algorithms
  117. are also available in the default provider.
  118. .SS "Asymmetric Key Encoder"
  119. .IX Subsection "Asymmetric Key Encoder"
  120. .IP RSA 4
  121. .IX Item "RSA"
  122. .PD 0
  123. .IP RSA-PSS 4
  124. .IX Item "RSA-PSS"
  125. .IP DH 4
  126. .IX Item "DH"
  127. .IP DHX 4
  128. .IX Item "DHX"
  129. .IP DSA 4
  130. .IX Item "DSA"
  131. .IP EC 4
  132. .IX Item "EC"
  133. .IP ED25519 4
  134. .IX Item "ED25519"
  135. .IP ED448 4
  136. .IX Item "ED448"
  137. .IP X25519 4
  138. .IX Item "X25519"
  139. .IP X448 4
  140. .IX Item "X448"
  141. .IP SM2 4
  142. .IX Item "SM2"
  143. .PD
  144. .PP
  145. In addition to this provider, all of these encoding algorithms are also
  146. available in the default provider. Some of these algorithms may be used in
  147. combination with the FIPS provider.
  148. .SS "Asymmetric Key Decoder"
  149. .IX Subsection "Asymmetric Key Decoder"
  150. .IP RSA 4
  151. .IX Item "RSA"
  152. .PD 0
  153. .IP RSA-PSS 4
  154. .IX Item "RSA-PSS"
  155. .IP DH 4
  156. .IX Item "DH"
  157. .IP DHX 4
  158. .IX Item "DHX"
  159. .IP DSA 4
  160. .IX Item "DSA"
  161. .IP EC 4
  162. .IX Item "EC"
  163. .IP ED25519 4
  164. .IX Item "ED25519"
  165. .IP ED448 4
  166. .IX Item "ED448"
  167. .IP X25519 4
  168. .IX Item "X25519"
  169. .IP X448 4
  170. .IX Item "X448"
  171. .IP SM2 4
  172. .IX Item "SM2"
  173. .IP DER 4
  174. .IX Item "DER"
  175. .PD
  176. .PP
  177. In addition to this provider, all of these decoding algorithms are also
  178. available in the default provider. Some of these algorithms may be used in
  179. combination with the FIPS provider.
  180. .SS Stores
  181. .IX Subsection "Stores"
  182. .IP file 4
  183. .IX Item "file"
  184. .PD 0
  185. .IP "org.openssl.winstore, see \fBOSSL_STORE\-winstore\fR\|(7)" 4
  186. .IX Item "org.openssl.winstore, see OSSL_STORE-winstore"
  187. .PD
  188. .PP
  189. In addition to this provider, all of these store algorithms are also
  190. available in the default provider.
  191. .SH "SEE ALSO"
  192. .IX Header "SEE ALSO"
  193. \&\fBOSSL_PROVIDER\-default\fR\|(7), \fBopenssl\-core.h\fR\|(7),
  194. \&\fBopenssl\-core_dispatch.h\fR\|(7), \fBprovider\fR\|(7)
  195. .SH HISTORY
  196. .IX Header "HISTORY"
  197. This functionality was added in OpenSSL 3.0.
  198. .SH COPYRIGHT
  199. .IX Header "COPYRIGHT"
  200. Copyright 2020\-2024 The OpenSSL Project Authors. All Rights Reserved.
  201. .PP
  202. Licensed under the Apache License 2.0 (the "License"). You may not use
  203. this file except in compliance with the License. You can obtain a copy
  204. in the file LICENSE in the source distribution or at
  205. <https://www.openssl.org/source/license.html>.