diff options
Diffstat (limited to 'secure/usr.bin/openssl/man/openssl-pkey.1')
| -rw-r--r-- | secure/usr.bin/openssl/man/openssl-pkey.1 | 187 |
1 files changed, 60 insertions, 127 deletions
diff --git a/secure/usr.bin/openssl/man/openssl-pkey.1 b/secure/usr.bin/openssl/man/openssl-pkey.1 index 398ef5d56757..ea3b9f88be87 100644 --- a/secure/usr.bin/openssl/man/openssl-pkey.1 +++ b/secure/usr.bin/openssl/man/openssl-pkey.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,93 +52,34 @@ . \} .\} .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-PKEY 1ossl" -.TH OPENSSL-PKEY 1ossl "2023-09-22" "3.0.11" "OpenSSL" +.TH OPENSSL-PKEY 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\-pkey \- public or private key processing command -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBopenssl\fR \fBpkey\fR [\fB\-help\fR] [\fB\-engine\fR \fIid\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] [\fB\-check\fR] [\fB\-pubcheck\fR] [\fB\-in\fR \fIfilename\fR|\fIuri\fR] -[\fB\-inform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fBP12\fR|\fB\s-1ENGINE\s0\fR] +[\fB\-inform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR|\fBENGINE\fR] [\fB\-passin\fR \fIarg\fR] [\fB\-pubin\fR] [\fB\-out\fR \fIfilename\fR] -[\fB\-outform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR] -[\fB\-\f(BIcipher\fB\fR] +[\fB\-outform\fR \fBDER\fR|\fBPEM\fR] +[\fB\-\fR\f(BIcipher\fR] [\fB\-passout\fR \fIarg\fR] [\fB\-traditional\fR] [\fB\-pubout\fR] @@ -163,35 +88,37 @@ openssl\-pkey \- public or private key processing command [\fB\-text_pub\fR] [\fB\-ec_conv_form\fR \fIarg\fR] [\fB\-ec_param_enc\fR \fIarg\fR] -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" This command processes public or private keys. They can be converted between various forms and their components printed. -.SH "OPTIONS" +.SH OPTIONS .IX Header "OPTIONS" .SS "General options" .IX Subsection "General options" -.IP "\fB\-help\fR" 4 +.IP \fB\-help\fR 4 .IX Item "-help" Print out a usage message. .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\-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). -.IP "\fB\-check\fR" 4 +See "Provider Options" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7). +.IP \fB\-check\fR 4 .IX Item "-check" This option checks the consistency of a key pair for both public and private components. -.IP "\fB\-pubcheck\fR" 4 +.IP \fB\-pubcheck\fR 4 .IX Item "-pubcheck" This option checks the correctness of either a public key or the public component of a key pair. @@ -199,11 +126,12 @@ or the public component of a key pair. .IX Subsection "Input options" .IP "\fB\-in\fR \fIfilename\fR|\fIuri\fR" 4 .IX Item "-in filename|uri" -This specifies the input to read a key from +This specifies the input file to read a key from or standard input if this option is not specified. +.Sp If the key input is encrypted and \fB\-passin\fR is not given a pass phrase will be prompted for. -.IP "\fB\-inform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fBP12\fR|\fB\s-1ENGINE\s0\fR" 4 +.IP "\fB\-inform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR|\fBENGINE\fR" 4 .IX Item "-inform DER|PEM|P12|ENGINE" The key input format; unspecified by default. See \fBopenssl\-format\-options\fR\|(1) for details. @@ -213,58 +141,63 @@ The password source for the key input. .Sp For more information about the format of \fBarg\fR see \fBopenssl\-passphrase\-options\fR\|(1). -.IP "\fB\-pubin\fR" 4 +.IP \fB\-pubin\fR 4 .IX Item "-pubin" By default a private key is read from the input. -With this option only the public components are read. +With this option a public key is read instead. +If the input contains no public key but a private key, its public part is used. .SS "Output options" .IX Subsection "Output options" .IP "\fB\-out\fR \fIfilename\fR" 4 .IX Item "-out filename" -This specifies the output filename to save the encoded and/or text output of key +This specifies the output file to save the encoded and/or text output of key or standard output if this option is not specified. +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. +.Sp If any cipher option is set but no \fB\-passout\fR is given then a pass phrase will be prompted for. -The output filename should \fBnot\fR be the same as the input filename. -.IP "\fB\-outform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR" 4 +When password input is interrupted, the output file is not touched. +.IP "\fB\-outform\fR \fBDER\fR|\fBPEM\fR" 4 .IX Item "-outform DER|PEM" -The key output format; the default is \fB\s-1PEM\s0\fR. +The key output format; the default is \fBPEM\fR. See \fBopenssl\-format\-options\fR\|(1) for details. -.IP "\fB\-\f(BIcipher\fB\fR" 4 +.IP \fB\-\fR\f(BIcipher\fR 4 .IX Item "-cipher" -Encrypt the \s-1PEM\s0 encoded private key with the supplied cipher. Any algorithm +Encrypt the PEM encoded private key with the supplied cipher. Any algorithm name accepted by \fBEVP_get_cipherbyname()\fR is acceptable such as \fBaes128\fR. -Encryption is not supported for \s-1DER\s0 output. +Encryption is not supported for DER output. .IP "\fB\-passout\fR \fIarg\fR" 4 .IX Item "-passout arg" The password source for the output file. .Sp For more information about the format of \fBarg\fR see \fBopenssl\-passphrase\-options\fR\|(1). -.IP "\fB\-traditional\fR" 4 +.IP \fB\-traditional\fR 4 .IX Item "-traditional" Normally a private key is written using standard format: this is PKCS#8 form with the appropriate encryption algorithm (if any). If the \fB\-traditional\fR -option is specified then the older \*(L"traditional\*(R" format is used instead. -.IP "\fB\-pubout\fR" 4 +option is specified then the older "traditional" format is used instead. +.IP \fB\-pubout\fR 4 .IX Item "-pubout" By default the private and public key is output; this option restricts the output to the public components. This option is automatically set if the input is a public key. .Sp When combined with \fB\-text\fR, this is equivalent to \fB\-text_pub\fR. -.IP "\fB\-noout\fR" 4 +.IP \fB\-noout\fR 4 .IX Item "-noout" Do not output the key in encoded form. -.IP "\fB\-text\fR" 4 +.IP \fB\-text\fR 4 .IX Item "-text" Output the various key components in plain text -(possibly in addition to the \s-1PEM\s0 encoded form). -This cannot be combined with encoded output in \s-1DER\s0 format. -.IP "\fB\-text_pub\fR" 4 +(possibly in addition to the PEM encoded form). +This cannot be combined with encoded output in DER format. +.IP \fB\-text_pub\fR 4 .IX Item "-text_pub" Output in text form only the public key components (also for private keys). -This cannot be combined with encoded output in \s-1DER\s0 format. +This cannot be combined with encoded output in DER format. .IP "\fB\-ec_conv_form\fR \fIarg\fR" 4 .IX Item "-ec_conv_form arg" This option only applies to elliptic-curve based keys. @@ -275,19 +208,19 @@ value), \fBuncompressed\fR 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\-ec_param_enc\fR \fIarg\fR" 4 .IX Item "-ec_param_enc arg" This option only applies to elliptic curve based public and private keys. .Sp 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. -.SH "EXAMPLES" +.SH EXAMPLES .IX Header "EXAMPLES" To remove the pass phrase on a private key: .PP @@ -295,13 +228,13 @@ To remove the pass phrase on a private key: \& openssl pkey \-in key.pem \-out keyout.pem .Ve .PP -To encrypt a private key using triple \s-1DES:\s0 +To encrypt a private key using triple DES: .PP .Vb 1 \& openssl pkey \-in key.pem \-des3 \-out keyout.pem .Ve .PP -To convert a private key from \s-1PEM\s0 to \s-1DER\s0 format: +To convert a private key from PEM to DER format: .PP .Vb 1 \& openssl pkey \-in key.pem \-outform DER \-out keyout.der @@ -325,13 +258,13 @@ To just output the public part of a private key: \& openssl pkey \-in key.pem \-pubout \-out pubkey.pem .Ve .PP -To change the \s-1EC\s0 parameters encoding to \fBexplicit\fR: +To change the EC parameters encoding to \fBexplicit\fR: .PP .Vb 1 \& openssl pkey \-in key.pem \-ec_param_enc explicit \-out keyout.pem .Ve .PP -To change the \s-1EC\s0 point conversion form to \fBcompressed\fR: +To change the EC point conversion form to \fBcompressed\fR: .PP .Vb 1 \& openssl pkey \-in key.pem \-ec_conv_form compressed \-out keyout.pem @@ -345,14 +278,14 @@ To change the \s-1EC\s0 point conversion form to \fBcompressed\fR: \&\fBopenssl\-dsa\fR\|(1), \&\fBopenssl\-genrsa\fR\|(1), \&\fBopenssl\-gendsa\fR\|(1) -.SH "HISTORY" +.SH HISTORY .IX Header "HISTORY" The \fB\-engine\fR option was deprecated in OpenSSL 3.0. -.SH "COPYRIGHT" +.SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2006\-2021 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2006\-2023 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>. |