diff options
Diffstat (limited to 'secure/usr.bin/openssl/man/openssl-ecparam.1')
| -rw-r--r-- | secure/usr.bin/openssl/man/openssl-ecparam.1 | 185 |
1 files changed, 57 insertions, 128 deletions
diff --git a/secure/usr.bin/openssl/man/openssl-ecparam.1 b/secure/usr.bin/openssl/man/openssl-ecparam.1 index c70f0cf69653..1cba12694b7c 100644 --- a/secure/usr.bin/openssl/man/openssl-ecparam.1 +++ b/secure/usr.bin/openssl/man/openssl-ecparam.1 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,82 +52,22 @@ . \} .\} .rr rF -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "OPENSSL-ECPARAM 1ossl" -.TH OPENSSL-ECPARAM 1ossl "2023-09-22" "3.0.11" "OpenSSL" +.TH OPENSSL-ECPARAM 1ossl 2025-07-24 3.5.1 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "NAME" +.SH NAME openssl\-ecparam \- EC parameter manipulation and generation -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBopenssl ecparam\fR [\fB\-help\fR] -[\fB\-inform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR] -[\fB\-outform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR] +[\fB\-inform\fR \fBDER\fR|\fBPEM\fR] +[\fB\-outform\fR \fBDER\fR|\fBPEM\fR] [\fB\-in\fR \fIfilename\fR] [\fB\-out\fR \fIfilename\fR] [\fB\-noout\fR] @@ -161,57 +85,60 @@ openssl\-ecparam \- EC parameter manipulation and generation [\fB\-writerand\fR \fIfile\fR] [\fB\-provider\fR \fIname\fR] [\fB\-provider\-path\fR \fIpath\fR] +[\fB\-provparam\fR \fI[name:]key=value\fR] [\fB\-propquery\fR \fIpropq\fR] -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" -This command is used to manipulate or generate \s-1EC\s0 parameter files. +This command is used to manipulate or generate EC parameter files. .PP OpenSSL is currently not able to generate new groups and therefore -this command can only create \s-1EC\s0 parameters from known (named) curves. -.SH "OPTIONS" +this command can only create EC parameters from known (named) curves. +.SH OPTIONS .IX Header "OPTIONS" -.IP "\fB\-help\fR" 4 +.IP \fB\-help\fR 4 .IX Item "-help" Print out a usage message. -.IP "\fB\-inform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR" 4 +.IP "\fB\-inform\fR \fBDER\fR|\fBPEM\fR" 4 .IX Item "-inform DER|PEM" -The \s-1EC\s0 parameters input format; unspecified by default. +The EC parameters input format; unspecified by default. See \fBopenssl\-format\-options\fR\|(1) for details. -.IP "\fB\-outform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR" 4 +.IP "\fB\-outform\fR \fBDER\fR|\fBPEM\fR" 4 .IX Item "-outform DER|PEM" -The \s-1EC\s0 parameters output format; the default is \fB\s-1PEM\s0\fR. +The EC parameters output format; the default is \fBPEM\fR. See \fBopenssl\-format\-options\fR\|(1) for details. .Sp -Parameters are encoded as \fBEcpkParameters\fR as specified in \s-1IETF RFC 3279.\s0 +Parameters are encoded as \fBEcpkParameters\fR as specified in IETF RFC 3279. .IP "\fB\-in\fR \fIfilename\fR" 4 .IX Item "-in filename" -This specifies the input filename to read parameters from or standard input if +This specifies the input file to read parameters from or standard input if this option is not specified. .IP "\fB\-out\fR \fIfilename\fR" 4 .IX Item "-out filename" This specifies the output filename parameters to. Standard output is used -if this option is not present. The output filename should \fBnot\fR be the same -as the input filename. -.IP "\fB\-noout\fR" 4 +if this option is not present. +The output filename can be the same as the input filename, +which leads to replacing the file contents. +Note that file I/O is not atomic. The output file is truncated and then written. +.IP \fB\-noout\fR 4 .IX Item "-noout" This option inhibits the output of the encoded version of the parameters. -.IP "\fB\-text\fR" 4 +.IP \fB\-text\fR 4 .IX Item "-text" -This option prints out the \s-1EC\s0 parameters in human readable form. -.IP "\fB\-check\fR" 4 +This option prints out the EC parameters in human readable form. +.IP \fB\-check\fR 4 .IX Item "-check" Validate the elliptic curve parameters. -.IP "\fB\-check_named\fR" 4 +.IP \fB\-check_named\fR 4 .IX Item "-check_named" Validate the elliptic name curve parameters by checking if the curve parameters match any built-in curves. .IP "\fB\-name\fR \fIarg\fR" 4 .IX Item "-name arg" -Use the \s-1EC\s0 parameters with the specified 'short' name. Use \fB\-list_curves\fR -to get a list of all currently implemented \s-1EC\s0 parameters. -.IP "\fB\-list_curves\fR" 4 +Use the EC parameters with the specified 'short' name. Use \fB\-list_curves\fR +to get a list of all currently implemented EC parameters. +.IP \fB\-list_curves\fR 4 .IX Item "-list_curves" -Print out a list of all currently implemented \s-1EC\s0 parameters names and exit. +Print out a list of all currently implemented EC parameters names and exit. .IP "\fB\-conv_form\fR \fIarg\fR" 4 .IX Item "-conv_form arg" This specifies how the points on the elliptic curve are converted @@ -220,67 +147,69 @@ default value) and \fBhybrid\fR. For more information regarding the point conversion forms please read the X9.62 standard. \&\fBNote\fR Due to patent issues the \fBcompressed\fR option is disabled by default for binary curves and can be enabled by defining -the preprocessor macro \fB\s-1OPENSSL_EC_BIN_PT_COMP\s0\fR at compile time. +the preprocessor macro \fBOPENSSL_EC_BIN_PT_COMP\fR at compile time. .IP "\fB\-param_enc\fR \fIarg\fR" 4 .IX Item "-param_enc arg" This specifies how the elliptic curve parameters are encoded. Possible value are: \fBnamed_curve\fR, i.e. the ec parameters are -specified by an \s-1OID,\s0 or \fBexplicit\fR where the ec parameters are -explicitly given (see \s-1RFC 3279\s0 for the definition of the -\&\s-1EC\s0 parameters structures). The default value is \fBnamed_curve\fR. -\&\fBNote\fR the \fBimplicitlyCA\fR alternative, as specified in \s-1RFC 3279,\s0 +specified by an OID, or \fBexplicit\fR where the ec parameters are +explicitly given (see RFC 3279 for the definition of the +EC parameters structures). The default value is \fBnamed_curve\fR. +\&\fBNote\fR the \fBimplicitlyCA\fR alternative, as specified in RFC 3279, is currently not implemented in OpenSSL. -.IP "\fB\-no_seed\fR" 4 +.IP \fB\-no_seed\fR 4 .IX Item "-no_seed" This option inhibits that the 'seed' for the parameter generation -is included in the ECParameters structure (see \s-1RFC 3279\s0). -.IP "\fB\-genkey\fR" 4 +is included in the ECParameters structure (see RFC 3279). +.IP \fB\-genkey\fR 4 .IX Item "-genkey" -This option will generate an \s-1EC\s0 private key using the specified parameters. +This option will generate an EC private key using the specified parameters. .IP "\fB\-engine\fR \fIid\fR" 4 .IX Item "-engine id" -See \*(L"Engine Options\*(R" in \fBopenssl\fR\|(1). +See "Engine Options" in \fBopenssl\fR\|(1). This option is deprecated. .IP "\fB\-rand\fR \fIfiles\fR, \fB\-writerand\fR \fIfile\fR" 4 .IX Item "-rand files, -writerand file" -See \*(L"Random State Options\*(R" in \fBopenssl\fR\|(1) for details. +See "Random State Options" in \fBopenssl\fR\|(1) for details. .IP "\fB\-provider\fR \fIname\fR" 4 .IX Item "-provider name" .PD 0 .IP "\fB\-provider\-path\fR \fIpath\fR" 4 .IX Item "-provider-path path" +.IP "\fB\-provparam\fR \fI[name:]key=value\fR" 4 +.IX Item "-provparam [name:]key=value" .IP "\fB\-propquery\fR \fIpropq\fR" 4 .IX Item "-propquery propq" .PD -See \*(L"Provider Options\*(R" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7). +See "Provider Options" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7). .PP The \fBopenssl\-genpkey\fR\|(1) and \fBopenssl\-pkeyparam\fR\|(1) commands are capable of performing all the operations this command can, as well as supporting other public key types. -.SH "EXAMPLES" +.SH EXAMPLES .IX Header "EXAMPLES" The documentation for the \fBopenssl\-genpkey\fR\|(1) and \fBopenssl\-pkeyparam\fR\|(1) commands contains examples equivalent to the ones listed here. .PP -To create \s-1EC\s0 parameters with the group 'prime192v1': +To create EC parameters with the group 'prime192v1': .PP .Vb 1 \& openssl ecparam \-out ec_param.pem \-name prime192v1 .Ve .PP -To create \s-1EC\s0 parameters with explicit parameters: +To create EC parameters with explicit parameters: .PP .Vb 1 \& openssl ecparam \-out ec_param.pem \-name prime192v1 \-param_enc explicit .Ve .PP -To validate given \s-1EC\s0 parameters: +To validate given EC parameters: .PP .Vb 1 \& openssl ecparam \-in ec_param.pem \-check .Ve .PP -To create \s-1EC\s0 parameters and a private key: +To create EC parameters and a private key: .PP .Vb 1 \& openssl ecparam \-out ec_key.pem \-name prime192v1 \-genkey @@ -292,7 +221,7 @@ To change the point encoding to 'compressed': \& openssl ecparam \-in ec_in.pem \-out ec_out.pem \-conv_form compressed .Ve .PP -To print out the \s-1EC\s0 parameters to standard output: +To print out the EC parameters to standard output: .PP .Vb 1 \& openssl ecparam \-in ec_param.pem \-noout \-text @@ -304,16 +233,16 @@ To print out the \s-1EC\s0 parameters to standard output: \&\fBopenssl\-genpkey\fR\|(1), \&\fBopenssl\-ec\fR\|(1), \&\fBopenssl\-dsaparam\fR\|(1) -.SH "HISTORY" +.SH HISTORY .IX Header "HISTORY" The \fB\-engine\fR option was deprecated in OpenSSL 3.0. .PP The \fB\-C\fR option was removed in OpenSSL 3.0. -.SH "COPYRIGHT" +.SH COPYRIGHT .IX Header "COPYRIGHT" Copyright 2003\-2021 The OpenSSL Project Authors. All Rights Reserved. .PP -Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use +Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy -in the file \s-1LICENSE\s0 in the source distribution or at +in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>. |