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<keyfile>]
  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<keyfile>
  56
  57 Create an SPKAC file using the private key in I<keyfile>. The
  58 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; the default is B<PEM>.
  64 The only value with effect is B<ENGINE>; all others have become obsolete.
  65 See L<openssl(1)/Format Options> for details.
  66
  67 =item B<-passin> I<arg>
  68
  69 The input file password source. For more information about the format of I<arg>
  70 see L<openssl(1)/Pass Phrase Options>.
  71
  72 =item B<-challenge> I<string>
  73
  74 Specifies the challenge string if an SPKAC is being created.
  75
  76 =item B<-spkac> I<spkacname>
  77
  78 Allows an alternative name form the variable containing the
  79 SPKAC. The default is "SPKAC". This option affects both
  80 generated and input SPKAC files.
  81
  82 =item B<-spksect> I<section>
  83
  84 Allows an alternative name form the section containing the
  85 SPKAC. The default is the default section.
  86
  87 =item B<-noout>
  88
  89 Don't output the text version of the SPKAC (not used if an
  90 SPKAC is being created).
  91
  92 =item B<-pubkey>
  93
  94 Output the public key of an SPKAC (not used if an SPKAC is
  95 being created).
  96
  97 =item B<-verify>
  98
  99 Verifies the digital signature on the supplied SPKAC.
 100
 101 {- $OpenSSL::safe::opt_engine_item -}
 102
 103 {- $OpenSSL::safe::opt_provider_item -}
 104
 105 =back
 106
 107 =head1 EXAMPLES
 108
 109 Print out the contents of an SPKAC:
 110
 111  openssl spkac -in spkac.cnf
 112
 113 Verify the signature of an SPKAC:
 114
 115  openssl spkac -in spkac.cnf -noout -verify
 116
 117 Create an SPKAC using the challenge string "hello":
 118
 119  openssl spkac -key key.pem -challenge hello -out spkac.cnf
 120
 121 Example of an SPKAC, (long lines split up for clarity):
 122
 123  SPKAC=MIG5MGUwXDANBgkqhkiG9w0BAQEFAANLADBIAkEA\
 124  1cCoq2Wa3Ixs47uI7FPVwHVIPDx5yso105Y6zpozam135a\
 125  8R0CpoRvkkigIyXfcCjiVi5oWk+6FfPaD03uPFoQIDAQAB\
 126  FgVoZWxsbzANBgkqhkiG9w0BAQQFAANBAFpQtY/FojdwkJ\
 127  h1bEIYuc2EeM2KHTWPEepWYeawvHD0gQ3DngSC75YCWnnD\
 128  dq+NQ3F+X4deMx9AaEglZtULwV4=
 129
 130 =head1 NOTES
 131
 132 A created SPKAC with suitable DN components appended can be fed to
 133 L<openssl-ca(1)>.
 134
 135 SPKACs are typically generated by Netscape when a form is submitted
 136 containing the B<KEYGEN> tag as part of the certificate enrollment
 137 process.
 138
 139 The challenge string permits a primitive form of proof of possession
 140 of private key. By checking the SPKAC signature and a random challenge
 141 string some guarantee is given that the user knows the private key
 142 corresponding to the public key being certified. This is important in
 143 some applications. Without this it is possible for a previous SPKAC
 144 to be used in a "replay attack".
 145
 146 =head1 SEE ALSO
 147
 148 L<openssl(1)>,
 149 L<openssl-ca(1)>
 150
 151 =head1 HISTORY
 152
 153 All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0
 154 and have no effect.
 155
 156 The B<-engine> option was deprecated in OpenSSL 3.0.
 157
 158 =head1 COPYRIGHT
 159
 160 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
 161
 162 Licensed under the Apache License 2.0 (the "License").  You may not use
 163 this file except in compliance with the License.  You can obtain a copy
 164 in the file LICENSE in the source distribution or at
 165 L<https://www.openssl.org/source/license.html>.
 166
 167 =cut