| lh | 9ed821d | 2023-04-07 01:36:19 -0700 | [diff] [blame] | 1 | =pod |
| 2 | |
| 3 | =head1 NAME |
| 4 | |
| 5 | openssl-pkeyparam, |
| 6 | pkeyparam - public key algorithm parameter processing tool |
| 7 | |
| 8 | =head1 SYNOPSIS |
| 9 | |
| 10 | B<openssl> B<pkeyparam> |
| 11 | [B<-help>] |
| 12 | [B<-in filename>] |
| 13 | [B<-out filename>] |
| 14 | [B<-text>] |
| 15 | [B<-noout>] |
| 16 | [B<-engine id>] |
| 17 | [B<-check>] |
| 18 | |
| 19 | =head1 DESCRIPTION |
| 20 | |
| 21 | The B<pkeyparam> command processes public key algorithm parameters. |
| 22 | They can be checked for correctness and their components printed out. |
| 23 | |
| 24 | =head1 OPTIONS |
| 25 | |
| 26 | =over 4 |
| 27 | |
| 28 | =item B<-help> |
| 29 | |
| 30 | Print out a usage message. |
| 31 | |
| 32 | =item B<-in filename> |
| 33 | |
| 34 | This specifies the input filename to read parameters from or standard input if |
| 35 | this option is not specified. |
| 36 | |
| 37 | =item B<-out filename> |
| 38 | |
| 39 | This specifies the output filename to write parameters to or standard output if |
| 40 | this option is not specified. |
| 41 | |
| 42 | =item B<-text> |
| 43 | |
| 44 | Prints out the parameters in plain text in addition to the encoded version. |
| 45 | |
| 46 | =item B<-noout> |
| 47 | |
| 48 | Do not output the encoded version of the parameters. |
| 49 | |
| 50 | =item B<-engine id> |
| 51 | |
| 52 | Specifying an engine (by its unique B<id> string) will cause B<pkeyparam> |
| 53 | to attempt to obtain a functional reference to the specified engine, |
| 54 | thus initialising it if needed. The engine will then be set as the default |
| 55 | for all available algorithms. |
| 56 | |
| 57 | =item B<-check> |
| 58 | |
| 59 | This option checks the correctness of parameters. |
| 60 | |
| 61 | =back |
| 62 | |
| 63 | =head1 EXAMPLES |
| 64 | |
| 65 | Print out text version of parameters: |
| 66 | |
| 67 | openssl pkeyparam -in param.pem -text |
| 68 | |
| 69 | =head1 NOTES |
| 70 | |
| 71 | There are no B<-inform> or B<-outform> options for this command because only |
| 72 | PEM format is supported because the key type is determined by the PEM headers. |
| 73 | |
| 74 | =head1 SEE ALSO |
| 75 | |
| 76 | L<genpkey(1)>, L<rsa(1)>, L<pkcs8(1)>, |
| 77 | L<dsa(1)>, L<genrsa(1)>, L<gendsa(1)> |
| 78 | |
| 79 | =head1 COPYRIGHT |
| 80 | |
| 81 | Copyright 2006-2019 The OpenSSL Project Authors. All Rights Reserved. |
| 82 | |
| 83 | Licensed under the OpenSSL license (the "License"). You may not use |
| 84 | this file except in compliance with the License. You can obtain a copy |
| 85 | in the file LICENSE in the source distribution or at |
| 86 | L<https://www.openssl.org/source/license.html>. |
| 87 | |
| 88 | =cut |