doc/man1/openssl-pkeyparam.pod

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