openssl-ecparam.pod.in 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179
  1. =pod
  2. {- OpenSSL::safe::output_do_not_edit_headers(); -}
  3. =head1 NAME
  4. openssl-ecparam - EC parameter manipulation and generation
  5. =head1 SYNOPSIS
  6. B<openssl ecparam>
  7. [B<-help>]
  8. [B<-inform> B<DER>|B<PEM>]
  9. [B<-outform> B<DER>|B<PEM>]
  10. [B<-in> I<filename>]
  11. [B<-out> I<filename>]
  12. [B<-noout>]
  13. [B<-text>]
  14. [B<-check>]
  15. [B<-check_named>]
  16. [B<-name> I<arg>]
  17. [B<-list_curves>]
  18. [B<-conv_form> I<arg>]
  19. [B<-param_enc> I<arg>]
  20. [B<-no_seed>]
  21. [B<-genkey>]
  22. {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_r_synopsis -}
  23. {- $OpenSSL::safe::opt_provider_synopsis -}
  24. =for openssl ifdef engine
  25. =head1 DESCRIPTION
  26. This command is used to manipulate or generate EC parameter files.
  27. OpenSSL is currently not able to generate new groups and therefore
  28. this command can only create EC parameters from known (named) curves.
  29. =head1 OPTIONS
  30. =over 4
  31. =item B<-help>
  32. Print out a usage message.
  33. =item B<-inform> B<DER>|B<PEM>, B<-outform> B<DER>|B<PEM>
  34. The input and formats; the default is B<PEM>.
  35. See L<openssl-format-options(1)> for details.
  36. Parameters are encoded as B<EcpkParameters> as specified in IETF RFC 3279.
  37. =item B<-in> I<filename>
  38. This specifies the input filename to read parameters from or standard input if
  39. this option is not specified.
  40. =item B<-out> I<filename>
  41. This specifies the output filename parameters to. Standard output is used
  42. if this option is not present. The output filename should B<not> be the same
  43. as the input filename.
  44. =item B<-noout>
  45. This option inhibits the output of the encoded version of the parameters.
  46. =item B<-text>
  47. This option prints out the EC parameters in human readable form.
  48. =item B<-check>
  49. Validate the elliptic curve parameters.
  50. =item B<-check_named>
  51. Validate the elliptic name curve parameters by checking if the curve parameters
  52. match any built-in curves.
  53. =item B<-name> I<arg>
  54. Use the EC parameters with the specified 'short' name. Use B<-list_curves>
  55. to get a list of all currently implemented EC parameters.
  56. =item B<-list_curves>
  57. Print out a list of all currently implemented EC parameters names and exit.
  58. =item B<-conv_form> I<arg>
  59. This specifies how the points on the elliptic curve are converted
  60. into octet strings. Possible values are: B<compressed>, B<uncompressed> (the
  61. default value) and B<hybrid>. For more information regarding
  62. the point conversion forms please read the X9.62 standard.
  63. B<Note> Due to patent issues the B<compressed> option is disabled
  64. by default for binary curves and can be enabled by defining
  65. the preprocessor macro B<OPENSSL_EC_BIN_PT_COMP> at compile time.
  66. =item B<-param_enc> I<arg>
  67. This specifies how the elliptic curve parameters are encoded.
  68. Possible value are: B<named_curve>, i.e. the ec parameters are
  69. specified by an OID, or B<explicit> where the ec parameters are
  70. explicitly given (see RFC 3279 for the definition of the
  71. EC parameters structures). The default value is B<named_curve>.
  72. B<Note> the B<implicitlyCA> alternative, as specified in RFC 3279,
  73. is currently not implemented in OpenSSL.
  74. =item B<-no_seed>
  75. This option inhibits that the 'seed' for the parameter generation
  76. is included in the ECParameters structure (see RFC 3279).
  77. =item B<-genkey>
  78. This option will generate an EC private key using the specified parameters.
  79. {- $OpenSSL::safe::opt_engine_item -}
  80. {- $OpenSSL::safe::opt_r_item -}
  81. {- $OpenSSL::safe::opt_provider_item -}
  82. =back
  83. =head1 EXAMPLES
  84. Examples equivalent to these can be found in the documentation for the
  85. non-deprecated L<openssl-genpkey(1)> and L<openssl-pkeyparam(1)> commands.
  86. To create EC parameters with the group 'prime192v1':
  87. openssl ecparam -out ec_param.pem -name prime192v1
  88. To create EC parameters with explicit parameters:
  89. openssl ecparam -out ec_param.pem -name prime192v1 -param_enc explicit
  90. To validate given EC parameters:
  91. openssl ecparam -in ec_param.pem -check
  92. To create EC parameters and a private key:
  93. openssl ecparam -out ec_key.pem -name prime192v1 -genkey
  94. To change the point encoding to 'compressed':
  95. openssl ecparam -in ec_in.pem -out ec_out.pem -conv_form compressed
  96. To print out the EC parameters to standard output:
  97. openssl ecparam -in ec_param.pem -noout -text
  98. =head1 SEE ALSO
  99. L<openssl(1)>,
  100. L<openssl-pkeyparam(1)>,
  101. L<openssl-genpkey(1)>,
  102. L<openssl-ec(1)>,
  103. L<openssl-dsaparam(1)>
  104. =head1 HISTORY
  105. The B<-engine> option was deprecated in OpenSSL 3.0.
  106. The B<-C> option was removed in OpenSSL 3.0.
  107. =head1 COPYRIGHT
  108. Copyright 2003-2020 The OpenSSL Project Authors. All Rights Reserved.
  109. Licensed under the Apache License 2.0 (the "License"). You may not use
  110. this file except in compliance with the License. You can obtain a copy
  111. in the file LICENSE in the source distribution or at
  112. L<https://www.openssl.org/source/license.html>.
  113. =cut