openssl-ecparam.1ossl 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321
  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 "OPENSSL-ECPARAM 1ossl"
  136. .TH OPENSSL-ECPARAM 1ossl "2025-06-29" "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. openssl\-ecparam \- EC parameter manipulation and generation
  143. .SH "SYNOPSIS"
  144. .IX Header "SYNOPSIS"
  145. \&\fBopenssl ecparam\fR
  146. [\fB\-help\fR]
  147. [\fB\-inform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR]
  148. [\fB\-outform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR]
  149. [\fB\-in\fR \fIfilename\fR]
  150. [\fB\-out\fR \fIfilename\fR]
  151. [\fB\-noout\fR]
  152. [\fB\-text\fR]
  153. [\fB\-check\fR]
  154. [\fB\-check_named\fR]
  155. [\fB\-name\fR \fIarg\fR]
  156. [\fB\-list_curves\fR]
  157. [\fB\-conv_form\fR \fIarg\fR]
  158. [\fB\-param_enc\fR \fIarg\fR]
  159. [\fB\-no_seed\fR]
  160. [\fB\-genkey\fR]
  161. [\fB\-engine\fR \fIid\fR]
  162. [\fB\-rand\fR \fIfiles\fR]
  163. [\fB\-writerand\fR \fIfile\fR]
  164. [\fB\-provider\fR \fIname\fR]
  165. [\fB\-provider\-path\fR \fIpath\fR]
  166. [\fB\-propquery\fR \fIpropq\fR]
  167. .SH "DESCRIPTION"
  168. .IX Header "DESCRIPTION"
  169. This command is used to manipulate or generate \s-1EC\s0 parameter files.
  170. .PP
  171. OpenSSL is currently not able to generate new groups and therefore
  172. this command can only create \s-1EC\s0 parameters from known (named) curves.
  173. .SH "OPTIONS"
  174. .IX Header "OPTIONS"
  175. .IP "\fB\-help\fR" 4
  176. .IX Item "-help"
  177. Print out a usage message.
  178. .IP "\fB\-inform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR" 4
  179. .IX Item "-inform DER|PEM"
  180. The \s-1EC\s0 parameters input format; unspecified by default.
  181. See \fBopenssl\-format\-options\fR\|(1) for details.
  182. .IP "\fB\-outform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR" 4
  183. .IX Item "-outform DER|PEM"
  184. The \s-1EC\s0 parameters output format; the default is \fB\s-1PEM\s0\fR.
  185. See \fBopenssl\-format\-options\fR\|(1) for details.
  186. .Sp
  187. Parameters are encoded as \fBEcpkParameters\fR as specified in \s-1IETF RFC 3279.\s0
  188. .IP "\fB\-in\fR \fIfilename\fR" 4
  189. .IX Item "-in filename"
  190. This specifies the input filename to read parameters from or standard input if
  191. this option is not specified.
  192. .IP "\fB\-out\fR \fIfilename\fR" 4
  193. .IX Item "-out filename"
  194. This specifies the output filename parameters to. Standard output is used
  195. if this option is not present. The output filename should \fBnot\fR be the same
  196. as the input filename.
  197. .IP "\fB\-noout\fR" 4
  198. .IX Item "-noout"
  199. This option inhibits the output of the encoded version of the parameters.
  200. .IP "\fB\-text\fR" 4
  201. .IX Item "-text"
  202. This option prints out the \s-1EC\s0 parameters in human readable form.
  203. .IP "\fB\-check\fR" 4
  204. .IX Item "-check"
  205. Validate the elliptic curve parameters.
  206. .IP "\fB\-check_named\fR" 4
  207. .IX Item "-check_named"
  208. Validate the elliptic name curve parameters by checking if the curve parameters
  209. match any built-in curves.
  210. .IP "\fB\-name\fR \fIarg\fR" 4
  211. .IX Item "-name arg"
  212. Use the \s-1EC\s0 parameters with the specified 'short' name. Use \fB\-list_curves\fR
  213. to get a list of all currently implemented \s-1EC\s0 parameters.
  214. .IP "\fB\-list_curves\fR" 4
  215. .IX Item "-list_curves"
  216. Print out a list of all currently implemented \s-1EC\s0 parameters names and exit.
  217. .IP "\fB\-conv_form\fR \fIarg\fR" 4
  218. .IX Item "-conv_form arg"
  219. This specifies how the points on the elliptic curve are converted
  220. into octet strings. Possible values are: \fBcompressed\fR, \fBuncompressed\fR (the
  221. default value) and \fBhybrid\fR. For more information regarding
  222. the point conversion forms please read the X9.62 standard.
  223. \&\fBNote\fR Due to patent issues the \fBcompressed\fR option is disabled
  224. by default for binary curves and can be enabled by defining
  225. the preprocessor macro \fB\s-1OPENSSL_EC_BIN_PT_COMP\s0\fR at compile time.
  226. .IP "\fB\-param_enc\fR \fIarg\fR" 4
  227. .IX Item "-param_enc arg"
  228. This specifies how the elliptic curve parameters are encoded.
  229. Possible value are: \fBnamed_curve\fR, i.e. the ec parameters are
  230. specified by an \s-1OID,\s0 or \fBexplicit\fR where the ec parameters are
  231. explicitly given (see \s-1RFC 3279\s0 for the definition of the
  232. \&\s-1EC\s0 parameters structures). The default value is \fBnamed_curve\fR.
  233. \&\fBNote\fR the \fBimplicitlyCA\fR alternative, as specified in \s-1RFC 3279,\s0
  234. is currently not implemented in OpenSSL.
  235. .IP "\fB\-no_seed\fR" 4
  236. .IX Item "-no_seed"
  237. This option inhibits that the 'seed' for the parameter generation
  238. is included in the ECParameters structure (see \s-1RFC 3279\s0).
  239. .IP "\fB\-genkey\fR" 4
  240. .IX Item "-genkey"
  241. This option will generate an \s-1EC\s0 private key using the specified parameters.
  242. .IP "\fB\-engine\fR \fIid\fR" 4
  243. .IX Item "-engine id"
  244. See \*(L"Engine Options\*(R" in \fBopenssl\fR\|(1).
  245. This option is deprecated.
  246. .IP "\fB\-rand\fR \fIfiles\fR, \fB\-writerand\fR \fIfile\fR" 4
  247. .IX Item "-rand files, -writerand file"
  248. See \*(L"Random State Options\*(R" in \fBopenssl\fR\|(1) for details.
  249. .IP "\fB\-provider\fR \fIname\fR" 4
  250. .IX Item "-provider name"
  251. .PD 0
  252. .IP "\fB\-provider\-path\fR \fIpath\fR" 4
  253. .IX Item "-provider-path path"
  254. .IP "\fB\-propquery\fR \fIpropq\fR" 4
  255. .IX Item "-propquery propq"
  256. .PD
  257. See \*(L"Provider Options\*(R" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7).
  258. .PP
  259. The \fBopenssl\-genpkey\fR\|(1) and \fBopenssl\-pkeyparam\fR\|(1) commands are capable
  260. of performing all the operations this command can, as well as supporting
  261. other public key types.
  262. .SH "EXAMPLES"
  263. .IX Header "EXAMPLES"
  264. The documentation for the \fBopenssl\-genpkey\fR\|(1) and \fBopenssl\-pkeyparam\fR\|(1)
  265. commands contains examples equivalent to the ones listed here.
  266. .PP
  267. To create \s-1EC\s0 parameters with the group 'prime192v1':
  268. .PP
  269. .Vb 1
  270. \& openssl ecparam \-out ec_param.pem \-name prime192v1
  271. .Ve
  272. .PP
  273. To create \s-1EC\s0 parameters with explicit parameters:
  274. .PP
  275. .Vb 1
  276. \& openssl ecparam \-out ec_param.pem \-name prime192v1 \-param_enc explicit
  277. .Ve
  278. .PP
  279. To validate given \s-1EC\s0 parameters:
  280. .PP
  281. .Vb 1
  282. \& openssl ecparam \-in ec_param.pem \-check
  283. .Ve
  284. .PP
  285. To create \s-1EC\s0 parameters and a private key:
  286. .PP
  287. .Vb 1
  288. \& openssl ecparam \-out ec_key.pem \-name prime192v1 \-genkey
  289. .Ve
  290. .PP
  291. To change the point encoding to 'compressed':
  292. .PP
  293. .Vb 1
  294. \& openssl ecparam \-in ec_in.pem \-out ec_out.pem \-conv_form compressed
  295. .Ve
  296. .PP
  297. To print out the \s-1EC\s0 parameters to standard output:
  298. .PP
  299. .Vb 1
  300. \& openssl ecparam \-in ec_param.pem \-noout \-text
  301. .Ve
  302. .SH "SEE ALSO"
  303. .IX Header "SEE ALSO"
  304. \&\fBopenssl\fR\|(1),
  305. \&\fBopenssl\-pkeyparam\fR\|(1),
  306. \&\fBopenssl\-genpkey\fR\|(1),
  307. \&\fBopenssl\-ec\fR\|(1),
  308. \&\fBopenssl\-dsaparam\fR\|(1)
  309. .SH "HISTORY"
  310. .IX Header "HISTORY"
  311. The \fB\-engine\fR option was deprecated in OpenSSL 3.0.
  312. .PP
  313. The \fB\-C\fR option was removed in OpenSSL 3.0.
  314. .SH "COPYRIGHT"
  315. .IX Header "COPYRIGHT"
  316. Copyright 2003\-2021 The OpenSSL Project Authors. All Rights Reserved.
  317. .PP
  318. Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
  319. this file except in compliance with the License. You can obtain a copy
  320. in the file \s-1LICENSE\s0 in the source distribution or at
  321. <https://www.openssl.org/source/license.html>.