ecparam.1 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297
  1. .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
  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. .if !\nF .nr F 0
  58. .if \nF>0 \{\
  59. . de IX
  60. . tm Index:\\$1\t\\n%\t"\\$2"
  61. ..
  62. . if !\nF==2 \{\
  63. . nr % 0
  64. . nr F 2
  65. . \}
  66. .\}
  67. .\"
  68. .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69. .\" Fear. Run. Save yourself. No user-serviceable parts.
  70. . \" fudge factors for nroff and troff
  71. .if n \{\
  72. . ds #H 0
  73. . ds #V .8m
  74. . ds #F .3m
  75. . ds #[ \f1
  76. . ds #] \fP
  77. .\}
  78. .if t \{\
  79. . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80. . ds #V .6m
  81. . ds #F 0
  82. . ds #[ \&
  83. . ds #] \&
  84. .\}
  85. . \" simple accents for nroff and troff
  86. .if n \{\
  87. . ds ' \&
  88. . ds ` \&
  89. . ds ^ \&
  90. . ds , \&
  91. . ds ~ ~
  92. . ds /
  93. .\}
  94. .if t \{\
  95. . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96. . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97. . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98. . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99. . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  100. . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  101. .\}
  102. . \" troff and (daisy-wheel) nroff accents
  103. .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  104. .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
  105. .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
  106. .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
  107. .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
  108. .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
  109. .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
  110. .ds ae a\h'-(\w'a'u*4/10)'e
  111. .ds Ae A\h'-(\w'A'u*4/10)'E
  112. . \" corrections for vroff
  113. .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
  114. .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
  115. . \" for low resolution devices (crt and lpr)
  116. .if \n(.H>23 .if \n(.V>19 \
  117. \{\
  118. . ds : e
  119. . ds 8 ss
  120. . ds o a
  121. . ds d- d\h'-1'\(ga
  122. . ds D- D\h'-1'\(hy
  123. . ds th \o'bp'
  124. . ds Th \o'LP'
  125. . ds ae ae
  126. . ds Ae AE
  127. .\}
  128. .rm #[ #] #H #V #F C
  129. .\" ========================================================================
  130. .\"
  131. .IX Title "ECPARAM 1"
  132. .TH ECPARAM 1 "2019-09-12" "1.0.2g" "OpenSSL"
  133. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  134. .\" way too many mistakes in technical documents.
  135. .if n .ad l
  136. .nh
  137. .SH "NAME"
  138. ecparam \- EC parameter manipulation and generation
  139. .SH "SYNOPSIS"
  140. .IX Header "SYNOPSIS"
  141. \&\fBopenssl ecparam\fR
  142. [\fB\-inform DER|PEM\fR]
  143. [\fB\-outform DER|PEM\fR]
  144. [\fB\-in filename\fR]
  145. [\fB\-out filename\fR]
  146. [\fB\-noout\fR]
  147. [\fB\-text\fR]
  148. [\fB\-C\fR]
  149. [\fB\-check\fR]
  150. [\fB\-name arg\fR]
  151. [\fB\-list_curves\fR]
  152. [\fB\-conv_form arg\fR]
  153. [\fB\-param_enc arg\fR]
  154. [\fB\-no_seed\fR]
  155. [\fB\-rand file(s)\fR]
  156. [\fB\-genkey\fR]
  157. [\fB\-engine id\fR]
  158. .SH "DESCRIPTION"
  159. .IX Header "DESCRIPTION"
  160. This command is used to manipulate or generate \s-1EC\s0 parameter files.
  161. .SH "OPTIONS"
  162. .IX Header "OPTIONS"
  163. .IP "\fB\-inform DER|PEM\fR" 4
  164. .IX Item "-inform DER|PEM"
  165. This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN.1 DER\s0 encoded
  166. form compatible with \s-1RFC 3279\s0 EcpkParameters. The \s-1PEM\s0 form is the default
  167. format: it consists of the \fB\s-1DER\s0\fR format base64 encoded with additional
  168. header and footer lines.
  169. .IP "\fB\-outform DER|PEM\fR" 4
  170. .IX Item "-outform DER|PEM"
  171. This specifies the output format, the options have the same meaning as the
  172. \&\fB\-inform\fR option.
  173. .IP "\fB\-in filename\fR" 4
  174. .IX Item "-in filename"
  175. This specifies the input filename to read parameters from or standard input if
  176. this option is not specified.
  177. .IP "\fB\-out filename\fR" 4
  178. .IX Item "-out filename"
  179. This specifies the output filename parameters to. Standard output is used
  180. if this option is not present. The output filename should \fBnot\fR be the same
  181. as the input filename.
  182. .IP "\fB\-noout\fR" 4
  183. .IX Item "-noout"
  184. This option inhibits the output of the encoded version of the parameters.
  185. .IP "\fB\-text\fR" 4
  186. .IX Item "-text"
  187. This option prints out the \s-1EC\s0 parameters in human readable form.
  188. .IP "\fB\-C\fR" 4
  189. .IX Item "-C"
  190. This option converts the \s-1EC\s0 parameters into C code. The parameters can then
  191. be loaded by calling the \fB\f(BIget_ec_group_XXX()\fB\fR function.
  192. .IP "\fB\-check\fR" 4
  193. .IX Item "-check"
  194. Validate the elliptic curve parameters.
  195. .IP "\fB\-name arg\fR" 4
  196. .IX Item "-name arg"
  197. Use the \s-1EC\s0 parameters with the specified 'short' name. Use \fB\-list_curves\fR
  198. to get a list of all currently implemented \s-1EC\s0 parameters.
  199. .IP "\fB\-list_curves\fR" 4
  200. .IX Item "-list_curves"
  201. If this options is specified \fBecparam\fR will print out a list of all
  202. currently implemented \s-1EC\s0 parameters names and exit.
  203. .IP "\fB\-conv_form\fR" 4
  204. .IX Item "-conv_form"
  205. This specifies how the points on the elliptic curve are converted
  206. into octet strings. Possible values are: \fBcompressed\fR (the default
  207. value), \fBuncompressed\fR and \fBhybrid\fR. For more information regarding
  208. the point conversion forms please read the X9.62 standard.
  209. \&\fBNote\fR Due to patent issues the \fBcompressed\fR option is disabled
  210. by default for binary curves and can be enabled by defining
  211. the preprocessor macro \fB\s-1OPENSSL_EC_BIN_PT_COMP\s0\fR at compile time.
  212. .IP "\fB\-param_enc arg\fR" 4
  213. .IX Item "-param_enc arg"
  214. This specifies how the elliptic curve parameters are encoded.
  215. Possible value are: \fBnamed_curve\fR, i.e. the ec parameters are
  216. specified by a \s-1OID,\s0 or \fBexplicit\fR where the ec parameters are
  217. explicitly given (see \s-1RFC 3279\s0 for the definition of the
  218. \&\s-1EC\s0 parameters structures). The default value is \fBnamed_curve\fR.
  219. \&\fBNote\fR the \fBimplicitlyCA\fR alternative ,as specified in \s-1RFC 3279,\s0
  220. is currently not implemented in OpenSSL.
  221. .IP "\fB\-no_seed\fR" 4
  222. .IX Item "-no_seed"
  223. This option inhibits that the 'seed' for the parameter generation
  224. is included in the ECParameters structure (see \s-1RFC 3279\s0).
  225. .IP "\fB\-genkey\fR" 4
  226. .IX Item "-genkey"
  227. This option will generate a \s-1EC\s0 private key using the specified parameters.
  228. .IP "\fB\-rand file(s)\fR" 4
  229. .IX Item "-rand file(s)"
  230. a file or files containing random data used to seed the random number
  231. generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
  232. Multiple files can be specified separated by a OS-dependent character.
  233. The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
  234. all others.
  235. .IP "\fB\-engine id\fR" 4
  236. .IX Item "-engine id"
  237. specifying an engine (by its unique \fBid\fR string) will cause \fBecparam\fR
  238. to attempt to obtain a functional reference to the specified engine,
  239. thus initialising it if needed. The engine will then be set as the default
  240. for all available algorithms.
  241. .SH "NOTES"
  242. .IX Header "NOTES"
  243. \&\s-1PEM\s0 format \s-1EC\s0 parameters use the header and footer lines:
  244. .PP
  245. .Vb 2
  246. \& \-\-\-\-\-BEGIN EC PARAMETERS\-\-\-\-\-
  247. \& \-\-\-\-\-END EC PARAMETERS\-\-\-\-\-
  248. .Ve
  249. .PP
  250. OpenSSL is currently not able to generate new groups and therefore
  251. \&\fBecparam\fR can only create \s-1EC\s0 parameters from known (named) curves.
  252. .SH "EXAMPLES"
  253. .IX Header "EXAMPLES"
  254. To create \s-1EC\s0 parameters with the group 'prime192v1':
  255. .PP
  256. .Vb 1
  257. \& openssl ecparam \-out ec_param.pem \-name prime192v1
  258. .Ve
  259. .PP
  260. To create \s-1EC\s0 parameters with explicit parameters:
  261. .PP
  262. .Vb 1
  263. \& openssl ecparam \-out ec_param.pem \-name prime192v1 \-param_enc explicit
  264. .Ve
  265. .PP
  266. To validate given \s-1EC\s0 parameters:
  267. .PP
  268. .Vb 1
  269. \& openssl ecparam \-in ec_param.pem \-check
  270. .Ve
  271. .PP
  272. To create \s-1EC\s0 parameters and a private key:
  273. .PP
  274. .Vb 1
  275. \& openssl ecparam \-out ec_key.pem \-name prime192v1 \-genkey
  276. .Ve
  277. .PP
  278. To change the point encoding to 'compressed':
  279. .PP
  280. .Vb 1
  281. \& openssl ecparam \-in ec_in.pem \-out ec_out.pem \-conv_form compressed
  282. .Ve
  283. .PP
  284. To print out the \s-1EC\s0 parameters to standard output:
  285. .PP
  286. .Vb 1
  287. \& openssl ecparam \-in ec_param.pem \-noout \-text
  288. .Ve
  289. .SH "SEE ALSO"
  290. .IX Header "SEE ALSO"
  291. \&\fIec\fR\|(1), \fIdsaparam\fR\|(1)
  292. .SH "HISTORY"
  293. .IX Header "HISTORY"
  294. The ecparam command was first introduced in OpenSSL 0.9.8.
  295. .SH "AUTHOR"
  296. .IX Header "AUTHOR"
  297. Nils Larsch for the OpenSSL project (http://www.openssl.org)