| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "OPENSSL-SPKAC 1SSL" |
| 58 |
.TH OPENSSL-SPKAC 1SSL 2026-04-07 3.6.2 OpenSSL |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
openssl\-spkac \- SPKAC printing and generating command |
| 65 |
.SH SYNOPSIS |
| 66 |
.IX Header "SYNOPSIS" |
| 67 |
\&\fBopenssl\fR \fBspkac\fR |
| 68 |
[\fB\-help\fR] |
| 69 |
[\fB\-in\fR \fIfilename\fR] |
| 70 |
[\fB\-out\fR \fIfilename\fR] |
| 71 |
[\fB\-digest\fR \fIdigest\fR] |
| 72 |
[\fB\-key\fR \fIfilename\fR|\fIuri\fR] |
| 73 |
[\fB\-keyform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR|\fBENGINE\fR] |
| 74 |
[\fB\-passin\fR \fIarg\fR] |
| 75 |
[\fB\-challenge\fR \fIstring\fR] |
| 76 |
[\fB\-pubkey\fR] |
| 77 |
[\fB\-spkac\fR \fIspkacname\fR] |
| 78 |
[\fB\-spksect\fR \fIsection\fR] |
| 79 |
[\fB\-noout\fR] |
| 80 |
[\fB\-verify\fR] |
| 81 |
[\fB\-engine\fR \fIid\fR] |
| 82 |
[\fB\-provider\fR \fIname\fR] |
| 83 |
[\fB\-provider\-path\fR \fIpath\fR] |
| 84 |
[\fB\-provparam\fR \fI[name:]key=value\fR] |
| 85 |
[\fB\-propquery\fR \fIpropq\fR] |
| 86 |
.SH DESCRIPTION |
| 87 |
.IX Header "DESCRIPTION" |
| 88 |
This command processes Netscape signed public key and challenge |
| 89 |
(SPKAC) files. It can print out their contents, verify the signature and |
| 90 |
produce its own SPKACs from a supplied private key. |
| 91 |
.SH OPTIONS |
| 92 |
.IX Header "OPTIONS" |
| 93 |
.IP \fB\-help\fR 4 |
| 94 |
.IX Item "-help" |
| 95 |
Print out a usage message. |
| 96 |
.IP "\fB\-in\fR \fIfilename\fR" 4 |
| 97 |
.IX Item "-in filename" |
| 98 |
This specifies the input filename to read from or standard input if this |
| 99 |
option is not specified. Ignored if the \fB\-key\fR option is used. |
| 100 |
.IP "\fB\-out\fR \fIfilename\fR" 4 |
| 101 |
.IX Item "-out filename" |
| 102 |
Specifies the output filename to write to or standard output by |
| 103 |
default. |
| 104 |
.IP "\fB\-digest\fR \fIdigest\fR" 4 |
| 105 |
.IX Item "-digest digest" |
| 106 |
Use the specified \fIdigest\fR to sign a created SPKAC file. |
| 107 |
The default digest algorithm is MD5. |
| 108 |
.IP "\fB\-key\fR \fIfilename\fR|\fIuri\fR" 4 |
| 109 |
.IX Item "-key filename|uri" |
| 110 |
Create an SPKAC file using the private key specified by \fIfilename\fR or \fIuri\fR. |
| 111 |
The \fB\-in\fR, \fB\-noout\fR, \fB\-spksect\fR and \fB\-verify\fR options are ignored if |
| 112 |
present. |
| 113 |
.IP "\fB\-keyform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR|\fBENGINE\fR" 4 |
| 114 |
.IX Item "-keyform DER|PEM|P12|ENGINE" |
| 115 |
The key format; unspecified by default. |
| 116 |
See \fBopenssl\-format\-options\fR\|(1) for details. |
| 117 |
.IP "\fB\-passin\fR \fIarg\fR" 4 |
| 118 |
.IX Item "-passin arg" |
| 119 |
The input file password source. For more information about the format of \fIarg\fR |
| 120 |
see \fBopenssl\-passphrase\-options\fR\|(1). |
| 121 |
.IP "\fB\-challenge\fR \fIstring\fR" 4 |
| 122 |
.IX Item "-challenge string" |
| 123 |
Specifies the challenge string if an SPKAC is being created. |
| 124 |
.IP "\fB\-spkac\fR \fIspkacname\fR" 4 |
| 125 |
.IX Item "-spkac spkacname" |
| 126 |
Allows an alternative name form the variable containing the |
| 127 |
SPKAC. The default is "SPKAC". This option affects both |
| 128 |
generated and input SPKAC files. |
| 129 |
.IP "\fB\-spksect\fR \fIsection\fR" 4 |
| 130 |
.IX Item "-spksect section" |
| 131 |
Allows an alternative name form the section containing the |
| 132 |
SPKAC. The default is the default section. |
| 133 |
.IP \fB\-noout\fR 4 |
| 134 |
.IX Item "-noout" |
| 135 |
Don't output the text version of the SPKAC (not used if an |
| 136 |
SPKAC is being created). |
| 137 |
.IP \fB\-pubkey\fR 4 |
| 138 |
.IX Item "-pubkey" |
| 139 |
Output the public key of an SPKAC (not used if an SPKAC is |
| 140 |
being created). |
| 141 |
.IP \fB\-verify\fR 4 |
| 142 |
.IX Item "-verify" |
| 143 |
Verifies the digital signature on the supplied SPKAC. |
| 144 |
.IP "\fB\-engine\fR \fIid\fR" 4 |
| 145 |
.IX Item "-engine id" |
| 146 |
See "Engine Options" in \fBopenssl\fR\|(1). |
| 147 |
This option is deprecated. |
| 148 |
.IP "\fB\-provider\fR \fIname\fR" 4 |
| 149 |
.IX Item "-provider name" |
| 150 |
.PD 0 |
| 151 |
.IP "\fB\-provider\-path\fR \fIpath\fR" 4 |
| 152 |
.IX Item "-provider-path path" |
| 153 |
.IP "\fB\-provparam\fR \fI[name:]key=value\fR" 4 |
| 154 |
.IX Item "-provparam [name:]key=value" |
| 155 |
.IP "\fB\-propquery\fR \fIpropq\fR" 4 |
| 156 |
.IX Item "-propquery propq" |
| 157 |
.PD |
| 158 |
See "Provider Options" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7). |
| 159 |
.SH EXAMPLES |
| 160 |
.IX Header "EXAMPLES" |
| 161 |
Print out the contents of an SPKAC: |
| 162 |
.PP |
| 163 |
.Vb 1 |
| 164 |
\& openssl spkac \-in spkac.cnf |
| 165 |
.Ve |
| 166 |
.PP |
| 167 |
Verify the signature of an SPKAC: |
| 168 |
.PP |
| 169 |
.Vb 1 |
| 170 |
\& openssl spkac \-in spkac.cnf \-noout \-verify |
| 171 |
.Ve |
| 172 |
.PP |
| 173 |
Create an SPKAC using the challenge string "hello": |
| 174 |
.PP |
| 175 |
.Vb 1 |
| 176 |
\& openssl spkac \-key key.pem \-challenge hello \-out spkac.cnf |
| 177 |
.Ve |
| 178 |
.PP |
| 179 |
Example of an SPKAC, (long lines split up for clarity): |
| 180 |
.PP |
| 181 |
.Vb 6 |
| 182 |
\& SPKAC=MIG5MGUwXDANBgkqhkiG9w0BAQEFAANLADBIAkEA\e |
| 183 |
\& 1cCoq2Wa3Ixs47uI7FPVwHVIPDx5yso105Y6zpozam135a\e |
| 184 |
\& 8R0CpoRvkkigIyXfcCjiVi5oWk+6FfPaD03uPFoQIDAQAB\e |
| 185 |
\& FgVoZWxsbzANBgkqhkiG9w0BAQQFAANBAFpQtY/FojdwkJ\e |
| 186 |
\& h1bEIYuc2EeM2KHTWPEepWYeawvHD0gQ3DngSC75YCWnnD\e |
| 187 |
\& dq+NQ3F+X4deMx9AaEglZtULwV4= |
| 188 |
.Ve |
| 189 |
.SH NOTES |
| 190 |
.IX Header "NOTES" |
| 191 |
A created SPKAC with suitable DN components appended can be fed to |
| 192 |
\&\fBopenssl\-ca\fR\|(1). |
| 193 |
.PP |
| 194 |
SPKACs are typically generated by Netscape when a form is submitted |
| 195 |
containing the \fBKEYGEN\fR tag as part of the certificate enrollment |
| 196 |
process. |
| 197 |
.PP |
| 198 |
The challenge string permits a primitive form of proof of possession |
| 199 |
of private key. By checking the SPKAC signature and a random challenge |
| 200 |
string some guarantee is given that the user knows the private key |
| 201 |
corresponding to the public key being certified. This is important in |
| 202 |
some applications. Without this it is possible for a previous SPKAC |
| 203 |
to be used in a "replay attack". |
| 204 |
.SH "SEE ALSO" |
| 205 |
.IX Header "SEE ALSO" |
| 206 |
\&\fBopenssl\fR\|(1), |
| 207 |
\&\fBopenssl\-ca\fR\|(1) |
| 208 |
.SH HISTORY |
| 209 |
.IX Header "HISTORY" |
| 210 |
The \fB\-engine\fR option was deprecated in OpenSSL 3.0. |
| 211 |
.PP |
| 212 |
The \fB\-digest\fR option was added in OpenSSL 3.0. |
| 213 |
.SH COPYRIGHT |
| 214 |
.IX Header "COPYRIGHT" |
| 215 |
Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved. |
| 216 |
.PP |
| 217 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 218 |
this file except in compliance with the License. You can obtain a copy |
| 219 |
in the file LICENSE in the source distribution or at |
| 220 |
<https://www.openssl.org/source/license.html>. |