doc/man1/openssl-spkac.pod.in

   1 =pod
   2
   3 =begin comment
   4 {- join("\n", @autowarntext) -}
   5
   6 =end comment
   7
   8 =head1 NAME
   9
  10 openssl-spkac - SPKAC printing and generating command
  11
  12 =head1 SYNOPSIS
  13
  14 B<openssl> B<spkac>
  15 [B<-help>]
  16 [B<-in> I<filename>]
  17 [B<-out> I<filename>]
  18 [B<-key> I<filename>|I<uri>]
  19 [B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>]
  20 [B<-passin> I<arg>]
  21 [B<-challenge> I<string>]
  22 [B<-pubkey>]
  23 [B<-spkac> I<spkacname>]
  24 [B<-spksect> I<section>]
  25 [B<-noout>]
  26 [B<-verify>]
  27 {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
  28
  29 =for openssl ifdef engine
  30
  31 =head1 DESCRIPTION
  32
  33 This command processes Netscape signed public key and challenge
  34 (SPKAC) files. It can print out their contents, verify the signature and
  35 produce its own SPKACs from a supplied private key.
  36
  37 =head1 OPTIONS
  38
  39 =over 4
  40
  41 =item B<-help>
  42
  43 Print out a usage message.
  44
  45 =item B<-in> I<filename>
  46
  47 This specifies the input filename to read from or standard input if this
  48 option is not specified. Ignored if the B<-key> option is used.
  49
  50 =item B<-out> I<filename>
  51
  52 Specifies the output filename to write to or standard output by
  53 default.
  54
  55 =item B<-key> I<filename>|I<uri>
  56
  57 Create an SPKAC file using the private key specified by I<filename> or I<uri>.
  58 The B<-in>, B<-noout>, B<-spksect> and B<-verify> options are ignored if
  59 present.
  60
  61 =item B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
  62
  63 The key format; unspecified by default.
  64 See L<openssl-format-options(1)> for details.
  65
  66 =item B<-passin> I<arg>
  67
  68 The input file password source. For more information about the format of I<arg>
  69 see L<openssl-passphrase-options(1)>.
  70
  71 =item B<-challenge> I<string>
  72
  73 Specifies the challenge string if an SPKAC is being created.
  74
  75 =item B<-spkac> I<spkacname>
  76
  77 Allows an alternative name form the variable containing the
  78 SPKAC. The default is "SPKAC". This option affects both
  79 generated and input SPKAC files.
  80
  81 =item B<-spksect> I<section>
  82
  83 Allows an alternative name form the section containing the
  84 SPKAC. The default is the default section.
  85
  86 =item B<-noout>
  87
  88 Don't output the text version of the SPKAC (not used if an
  89 SPKAC is being created).
  90
  91 =item B<-pubkey>
  92
  93 Output the public key of an SPKAC (not used if an SPKAC is
  94 being created).
  95
  96 =item B<-verify>
  97
  98 Verifies the digital signature on the supplied SPKAC.
  99
 100 {- $OpenSSL::safe::opt_engine_item -}
 101
 102 {- $OpenSSL::safe::opt_provider_item -}
 103
 104 =back
 105
 106 =head1 EXAMPLES
 107
 108 Print out the contents of an SPKAC:
 109
 110  openssl spkac -in spkac.cnf
 111
 112 Verify the signature of an SPKAC:
 113
 114  openssl spkac -in spkac.cnf -noout -verify
 115
 116 Create an SPKAC using the challenge string "hello":
 117
 118  openssl spkac -key key.pem -challenge hello -out spkac.cnf
 119
 120 Example of an SPKAC, (long lines split up for clarity):
 121
 122  SPKAC=MIG5MGUwXDANBgkqhkiG9w0BAQEFAANLADBIAkEA\
 123  1cCoq2Wa3Ixs47uI7FPVwHVIPDx5yso105Y6zpozam135a\
 124  8R0CpoRvkkigIyXfcCjiVi5oWk+6FfPaD03uPFoQIDAQAB\
 125  FgVoZWxsbzANBgkqhkiG9w0BAQQFAANBAFpQtY/FojdwkJ\
 126  h1bEIYuc2EeM2KHTWPEepWYeawvHD0gQ3DngSC75YCWnnD\
 127  dq+NQ3F+X4deMx9AaEglZtULwV4=
 128
 129 =head1 NOTES
 130
 131 A created SPKAC with suitable DN components appended can be fed to
 132 L<openssl-ca(1)>.
 133
 134 SPKACs are typically generated by Netscape when a form is submitted
 135 containing the B<KEYGEN> tag as part of the certificate enrollment
 136 process.
 137
 138 The challenge string permits a primitive form of proof of possession
 139 of private key. By checking the SPKAC signature and a random challenge
 140 string some guarantee is given that the user knows the private key
 141 corresponding to the public key being certified. This is important in
 142 some applications. Without this it is possible for a previous SPKAC
 143 to be used in a "replay attack".
 144
 145 =head1 SEE ALSO
 146
 147 L<openssl(1)>,
 148 L<openssl-ca(1)>
 149
 150 =head1 HISTORY
 151
 152 The B<-engine> option was deprecated in OpenSSL 3.0.
 153
 154 =head1 COPYRIGHT
 155
 156 Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
 157
 158 Licensed under the Apache License 2.0 (the "License").  You may not use
 159 this file except in compliance with the License.  You can obtain a copy
 160 in the file LICENSE in the source distribution or at
 161 L<https://www.openssl.org/source/license.html>.
 162
 163 =cut