mirror of
https://github.com/QuasarApp/openssl.git
synced 2025-05-01 20:19:39 +00:00
b6b66573bd
Initially, the manual page entry for the 'openssl cmd' command used to be available at 'cmd(1)'. Later, the aliases 'openssl-cmd(1)' was introduced, which made it easier to group the openssl commands using the 'apropos(1)' command or the shell's tab completion. In order to reduce cluttering of the global manual page namespace, the manual page entries without the 'openssl-' prefix have been deprecated in OpenSSL 3.0 and will be removed in OpenSSL 4.0. Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/9666)
156 lines
3.8 KiB
Plaintext
156 lines
3.8 KiB
Plaintext
=pod
|
|
|
|
=head1 NAME
|
|
|
|
openssl-spkac - SPKAC printing and generating utility
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
B<openssl> B<spkac>
|
|
[B<-help>]
|
|
[B<-in filename>]
|
|
[B<-out filename>]
|
|
[B<-key keyfile>]
|
|
[B<-keyform PEM|DER|ENGINE>]
|
|
[B<-passin arg>]
|
|
[B<-challenge string>]
|
|
[B<-pubkey>]
|
|
[B<-spkac spkacname>]
|
|
[B<-spksect section>]
|
|
[B<-noout>]
|
|
[B<-verify>]
|
|
[B<-engine id>]
|
|
|
|
=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.
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 4
|
|
|
|
=item B<-help>
|
|
|
|
Print out a usage message.
|
|
|
|
=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>
|
|
|
|
Specifies the output filename to write to or standard output by
|
|
default.
|
|
|
|
=item B<-key keyfile>
|
|
|
|
Create an SPKAC file using the private key in B<keyfile>. The
|
|
B<-in>, B<-noout>, B<-spksect> and B<-verify> options are ignored if
|
|
present.
|
|
|
|
=item B<-keyform PEM|DER|ENGINE>
|
|
|
|
Whether the key format is PEM, DER, or an engine-backed key.
|
|
The default is PEM.
|
|
|
|
=item B<-passin password>
|
|
|
|
The input file password source. For more information about the format of B<arg>
|
|
see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
|
|
|
|
=item B<-challenge string>
|
|
|
|
Specifies the challenge string if an SPKAC is being created.
|
|
|
|
=item B<-spkac spkacname>
|
|
|
|
Allows an alternative name form the variable containing the
|
|
SPKAC. The default is "SPKAC". This option affects both
|
|
generated and input SPKAC files.
|
|
|
|
=item B<-spksect section>
|
|
|
|
Allows an alternative name form the section containing the
|
|
SPKAC. The default is the default section.
|
|
|
|
=item B<-noout>
|
|
|
|
Don't output the text version of the SPKAC (not used if an
|
|
SPKAC is being created).
|
|
|
|
=item B<-pubkey>
|
|
|
|
Output the public key of an SPKAC (not used if an SPKAC is
|
|
being created).
|
|
|
|
=item B<-verify>
|
|
|
|
Verifies the digital signature on the supplied SPKAC.
|
|
|
|
=item B<-engine id>
|
|
|
|
Specifying an engine (by its unique B<id> string) will cause B<spkac>
|
|
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.
|
|
|
|
=back
|
|
|
|
=head1 EXAMPLES
|
|
|
|
Print out the contents of an SPKAC:
|
|
|
|
openssl spkac -in spkac.cnf
|
|
|
|
Verify the signature of an SPKAC:
|
|
|
|
openssl spkac -in spkac.cnf -noout -verify
|
|
|
|
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=MIG5MGUwXDANBgkqhkiG9w0BAQEFAANLADBIAkEA\
|
|
1cCoq2Wa3Ixs47uI7FPVwHVIPDx5yso105Y6zpozam135a\
|
|
8R0CpoRvkkigIyXfcCjiVi5oWk+6FfPaD03uPFoQIDAQAB\
|
|
FgVoZWxsbzANBgkqhkiG9w0BAQQFAANBAFpQtY/FojdwkJ\
|
|
h1bEIYuc2EeM2KHTWPEepWYeawvHD0gQ3DngSC75YCWnnD\
|
|
dq+NQ3F+X4deMx9AaEglZtULwV4=
|
|
|
|
=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
|
|
|
|
L<openssl(1)>,
|
|
L<openssl-ca(1)>
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
|
|
|
|
Licensed under the Apache License 2.0 (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
|