spkac.pod 3.6 KB
Newer Older
1 2 3 4 5 6 7 8 9
=pod

=head1 NAME

spkac - SPKAC printing and generating utility

=head1 SYNOPSIS

B<openssl> B<spkac>
10
[B<-help>]
11 12 13
[B<-in filename>]
[B<-out filename>]
[B<-key keyfile>]
D
Dr. Stephen Henson 已提交
14
[B<-passin arg>]
15
[B<-challenge string>]
D
 
Dr. Stephen Henson 已提交
16
[B<-pubkey>]
17 18 19 20
[B<-spkac spkacname>]
[B<-spksect section>]
[B<-noout>]
[B<-verify>]
21
[B<-engine id>]
22 23 24 25 26 27 28

=head1 DESCRIPTION

The B<spkac> command processes Netscape signed public key and challenge
(SPKAC) files. It can print out their contents, verify the signature and
produce its own SPKACs from a supplied private key.

R
Rich Salz 已提交
29
=head1 OPTIONS
30 31 32

=over 4

33 34 35 36
=item B<-help>

Print out a usage message.

37 38 39 40 41 42 43
=item B<-in filename>

This specifies the input filename to read from or standard input if this
option is not specified. Ignored if the B<-key> option is used.

=item B<-out filename>

P
Pauli 已提交
44
Specifies the output filename to write to or standard output by
45 46 47 48
default.

=item B<-key keyfile>

P
Pauli 已提交
49
Create an SPKAC file using the private key in B<keyfile>. The
50 51 52
B<-in>, B<-noout>, B<-spksect> and B<-verify> options are ignored if
present.

53 54
=item B<-passin password>

P
Pauli 已提交
55
The input file password source. For more information about the format of B<arg>
R
Rich Salz 已提交
56
see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
57

58 59
=item B<-challenge string>

P
Pauli 已提交
60
Specifies the challenge string if an SPKAC is being created.
61 62 63

=item B<-spkac spkacname>

P
Pauli 已提交
64
Allows an alternative name form the variable containing the
65 66 67 68 69
SPKAC. The default is "SPKAC". This option affects both
generated and input SPKAC files.

=item B<-spksect section>

P
Pauli 已提交
70
Allows an alternative name form the section containing the
71 72 73 74
SPKAC. The default is the default section.

=item B<-noout>

P
Pauli 已提交
75
Don't output the text version of the SPKAC (not used if an
76 77
SPKAC is being created).

D
 
Dr. Stephen Henson 已提交
78 79
=item B<-pubkey>

P
Pauli 已提交
80
Output the public key of an SPKAC (not used if an SPKAC is
D
 
Dr. Stephen Henson 已提交
81 82
being created).

83 84
=item B<-verify>

P
Pauli 已提交
85
Verifies the digital signature on the supplied SPKAC.
86

87 88
=item B<-engine id>

P
Pauli 已提交
89
Specifying an engine (by its unique B<id> string) will cause B<spkac>
90 91 92
to attempt to obtain a functional reference to the specified engine,
thus initialising it if needed. The engine will then be set as the default
for all available algorithms.
93 94 95 96 97 98 99

=back

=head1 EXAMPLES

Print out the contents of an SPKAC:

100
 openssl spkac -in spkac.cnf
101 102 103

Verify the signature of an SPKAC:

104
 openssl spkac -in spkac.cnf -noout -verify
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135

Create an SPKAC using the challenge string "hello":

 openssl spkac -key key.pem -challenge hello -out spkac.cnf

Example of an SPKAC, (long lines split up for clarity):

 SPKAC=MIG5MGUwXDANBgkqhkiG9w0BAQEFAANLADBIAkEA1cCoq2Wa3Ixs47uI7F\
 PVwHVIPDx5yso105Y6zpozam135a8R0CpoRvkkigIyXfcCjiVi5oWk+6FfPaD03u\
 PFoQIDAQABFgVoZWxsbzANBgkqhkiG9w0BAQQFAANBAFpQtY/FojdwkJh1bEIYuc\
 2EeM2KHTWPEepWYeawvHD0gQ3DngSC75YCWnnDdq+NQ3F+X4deMx9AaEglZtULwV\
 4=

=head1 NOTES

A created SPKAC with suitable DN components appended can be fed into
the B<ca> utility.

SPKACs are typically generated by Netscape when a form is submitted
containing the B<KEYGEN> tag as part of the certificate enrollment
process.

The challenge string permits a primitive form of proof of possession
of private key. By checking the SPKAC signature and a random challenge
string some guarantee is given that the user knows the private key
corresponding to the public key being certified. This is important in
some applications. Without this it is possible for a previous SPKAC
to be used in a "replay attack".

=head1 SEE ALSO

R
Rich Salz 已提交
136
L<ca(1)>
137

R
Rich Salz 已提交
138 139
=head1 COPYRIGHT

P
Pauli 已提交
140
Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
R
Rich Salz 已提交
141 142 143 144 145 146 147

Licensed under the OpenSSL license (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut