ec.1 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311
  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 "EC 1"
  132. .TH EC 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. ec \- EC key processing
  139. .SH "SYNOPSIS"
  140. .IX Header "SYNOPSIS"
  141. \&\fBopenssl\fR \fBec\fR
  142. [\fB\-inform PEM|DER\fR]
  143. [\fB\-outform PEM|DER\fR]
  144. [\fB\-in filename\fR]
  145. [\fB\-passin arg\fR]
  146. [\fB\-out filename\fR]
  147. [\fB\-passout arg\fR]
  148. [\fB\-des\fR]
  149. [\fB\-des3\fR]
  150. [\fB\-idea\fR]
  151. [\fB\-text\fR]
  152. [\fB\-noout\fR]
  153. [\fB\-param_out\fR]
  154. [\fB\-pubin\fR]
  155. [\fB\-pubout\fR]
  156. [\fB\-conv_form arg\fR]
  157. [\fB\-param_enc arg\fR]
  158. [\fB\-engine id\fR]
  159. .SH "DESCRIPTION"
  160. .IX Header "DESCRIPTION"
  161. The \fBec\fR command processes \s-1EC\s0 keys. They can be converted between various
  162. forms and their components printed out. \fBNote\fR OpenSSL uses the
  163. private key format specified in '\s-1SEC 1:\s0 Elliptic Curve Cryptography'
  164. (http://www.secg.org/). To convert a OpenSSL \s-1EC\s0 private key into the
  165. PKCS#8 private key format use the \fBpkcs8\fR command.
  166. .SH "COMMAND OPTIONS"
  167. .IX Header "COMMAND OPTIONS"
  168. .IP "\fB\-inform DER|PEM\fR" 4
  169. .IX Item "-inform DER|PEM"
  170. This specifies the input format. The \fB\s-1DER\s0\fR option with a private key uses
  171. an \s-1ASN.1 DER\s0 encoded \s-1SEC1\s0 private key. When used with a public key it
  172. uses the SubjectPublicKeyInfo structure as specified in \s-1RFC 3280.\s0
  173. The \fB\s-1PEM\s0\fR form is the default format: it consists of the \fB\s-1DER\s0\fR format base64
  174. encoded with additional header and footer lines. In the case of a private key
  175. PKCS#8 format is also accepted.
  176. .IP "\fB\-outform DER|PEM\fR" 4
  177. .IX Item "-outform DER|PEM"
  178. This specifies the output format, the options have the same meaning as the
  179. \&\fB\-inform\fR option.
  180. .IP "\fB\-in filename\fR" 4
  181. .IX Item "-in filename"
  182. This specifies the input filename to read a key from or standard input if this
  183. option is not specified. If the key is encrypted a pass phrase will be
  184. prompted for.
  185. .IP "\fB\-passin arg\fR" 4
  186. .IX Item "-passin arg"
  187. the input file password source. For more information about the format of \fBarg\fR
  188. see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
  189. .IP "\fB\-out filename\fR" 4
  190. .IX Item "-out filename"
  191. This specifies the output filename to write a key to or standard output by
  192. is not specified. If any encryption options are set then a pass phrase will be
  193. prompted for. The output filename should \fBnot\fR be the same as the input
  194. filename.
  195. .IP "\fB\-passout arg\fR" 4
  196. .IX Item "-passout arg"
  197. the output file password source. For more information about the format of \fBarg\fR
  198. see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
  199. .IP "\fB\-des|\-des3|\-idea\fR" 4
  200. .IX Item "-des|-des3|-idea"
  201. These options encrypt the private key with the \s-1DES,\s0 triple \s-1DES, IDEA\s0 or
  202. any other cipher supported by OpenSSL before outputting it. A pass phrase is
  203. prompted for.
  204. If none of these options is specified the key is written in plain text. This
  205. means that using the \fBec\fR utility to read in an encrypted key with no
  206. encryption option can be used to remove the pass phrase from a key, or by
  207. setting the encryption options it can be use to add or change the pass phrase.
  208. These options can only be used with \s-1PEM\s0 format output files.
  209. .IP "\fB\-text\fR" 4
  210. .IX Item "-text"
  211. prints out the public, private key components and parameters.
  212. .IP "\fB\-noout\fR" 4
  213. .IX Item "-noout"
  214. this option prevents output of the encoded version of the key.
  215. .IP "\fB\-modulus\fR" 4
  216. .IX Item "-modulus"
  217. this option prints out the value of the public key component of the key.
  218. .IP "\fB\-pubin\fR" 4
  219. .IX Item "-pubin"
  220. by default a private key is read from the input file: with this option a
  221. public key is read instead.
  222. .IP "\fB\-pubout\fR" 4
  223. .IX Item "-pubout"
  224. by default a private key is output. With this option a public
  225. key will be output instead. This option is automatically set if the input is
  226. a public key.
  227. .IP "\fB\-conv_form\fR" 4
  228. .IX Item "-conv_form"
  229. This specifies how the points on the elliptic curve are converted
  230. into octet strings. Possible values are: \fBcompressed\fR (the default
  231. value), \fBuncompressed\fR and \fBhybrid\fR. For more information regarding
  232. the point conversion forms please read the X9.62 standard.
  233. \&\fBNote\fR Due to patent issues the \fBcompressed\fR option is disabled
  234. by default for binary curves and can be enabled by defining
  235. the preprocessor macro \fB\s-1OPENSSL_EC_BIN_PT_COMP\s0\fR at compile time.
  236. .IP "\fB\-param_enc arg\fR" 4
  237. .IX Item "-param_enc arg"
  238. This specifies how the elliptic curve parameters are encoded.
  239. Possible value are: \fBnamed_curve\fR, i.e. the ec parameters are
  240. specified by a \s-1OID,\s0 or \fBexplicit\fR where the ec parameters are
  241. explicitly given (see \s-1RFC 3279\s0 for the definition of the
  242. \&\s-1EC\s0 parameters structures). The default value is \fBnamed_curve\fR.
  243. \&\fBNote\fR the \fBimplicitlyCA\fR alternative ,as specified in \s-1RFC 3279,\s0
  244. is currently not implemented in OpenSSL.
  245. .IP "\fB\-engine id\fR" 4
  246. .IX Item "-engine id"
  247. specifying an engine (by its unique \fBid\fR string) will cause \fBec\fR
  248. to attempt to obtain a functional reference to the specified engine,
  249. thus initialising it if needed. The engine will then be set as the default
  250. for all available algorithms.
  251. .SH "NOTES"
  252. .IX Header "NOTES"
  253. The \s-1PEM\s0 private key format uses the header and footer lines:
  254. .PP
  255. .Vb 2
  256. \& \-\-\-\-\-BEGIN EC PRIVATE KEY\-\-\-\-\-
  257. \& \-\-\-\-\-END EC PRIVATE KEY\-\-\-\-\-
  258. .Ve
  259. .PP
  260. The \s-1PEM\s0 public key format uses the header and footer lines:
  261. .PP
  262. .Vb 2
  263. \& \-\-\-\-\-BEGIN PUBLIC KEY\-\-\-\-\-
  264. \& \-\-\-\-\-END PUBLIC KEY\-\-\-\-\-
  265. .Ve
  266. .SH "EXAMPLES"
  267. .IX Header "EXAMPLES"
  268. To encrypt a private key using triple \s-1DES:\s0
  269. .PP
  270. .Vb 1
  271. \& openssl ec \-in key.pem \-des3 \-out keyout.pem
  272. .Ve
  273. .PP
  274. To convert a private key from \s-1PEM\s0 to \s-1DER\s0 format:
  275. .PP
  276. .Vb 1
  277. \& openssl ec \-in key.pem \-outform DER \-out keyout.der
  278. .Ve
  279. .PP
  280. To print out the components of a private key to standard output:
  281. .PP
  282. .Vb 1
  283. \& openssl ec \-in key.pem \-text \-noout
  284. .Ve
  285. .PP
  286. To just output the public part of a private key:
  287. .PP
  288. .Vb 1
  289. \& openssl ec \-in key.pem \-pubout \-out pubkey.pem
  290. .Ve
  291. .PP
  292. To change the parameters encoding to \fBexplicit\fR:
  293. .PP
  294. .Vb 1
  295. \& openssl ec \-in key.pem \-param_enc explicit \-out keyout.pem
  296. .Ve
  297. .PP
  298. To change the point conversion form to \fBcompressed\fR:
  299. .PP
  300. .Vb 1
  301. \& openssl ec \-in key.pem \-conv_form compressed \-out keyout.pem
  302. .Ve
  303. .SH "SEE ALSO"
  304. .IX Header "SEE ALSO"
  305. \&\fIecparam\fR\|(1), \fIdsa\fR\|(1), \fIrsa\fR\|(1)
  306. .SH "HISTORY"
  307. .IX Header "HISTORY"
  308. The ec command was first introduced in OpenSSL 0.9.8.
  309. .SH "AUTHOR"
  310. .IX Header "AUTHOR"
  311. Nils Larsch for the OpenSSL project (http://www.openssl.org).