secure/usr.bin/openssl/man/spkac.1

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.41)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "SPKAC 1"
 136 .TH SPKAC 1 "2020-12-08" "1.1.1i" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 openssl\-spkac, spkac \- SPKAC printing and generating utility
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 \&\fBopenssl\fR \fBspkac\fR
 146 [\fB\-help\fR]
 147 [\fB\-in filename\fR]
 148 [\fB\-out filename\fR]
 149 [\fB\-key keyfile\fR]
 150 [\fB\-keyform PEM|DER|ENGINE\fR]
 151 [\fB\-passin arg\fR]
 152 [\fB\-challenge string\fR]
 153 [\fB\-pubkey\fR]
 154 [\fB\-spkac spkacname\fR]
 155 [\fB\-spksect section\fR]
 156 [\fB\-noout\fR]
 157 [\fB\-verify\fR]
 158 [\fB\-engine id\fR]
 159 .SH "DESCRIPTION"
 160 .IX Header "DESCRIPTION"
 161 The \fBspkac\fR command processes Netscape signed public key and challenge
 162 (\s-1SPKAC\s0) files. It can print out their contents, verify the signature and
 163 produce its own SPKACs from a supplied private key.
 164 .SH "OPTIONS"
 165 .IX Header "OPTIONS"
 166 .IP "\fB\-help\fR" 4
 167 .IX Item "-help"
 168 Print out a usage message.
 169 .IP "\fB\-in filename\fR" 4
 170 .IX Item "-in filename"
 171 This specifies the input filename to read from or standard input if this
 172 option is not specified. Ignored if the \fB\-key\fR option is used.
 173 .IP "\fB\-out filename\fR" 4
 174 .IX Item "-out filename"
 175 Specifies the output filename to write to or standard output by
 176 default.
 177 .IP "\fB\-key keyfile\fR" 4
 178 .IX Item "-key keyfile"
 179 Create an \s-1SPKAC\s0 file using the private key in \fBkeyfile\fR. The
 180 \&\fB\-in\fR, \fB\-noout\fR, \fB\-spksect\fR and \fB\-verify\fR options are ignored if
 181 present.
 182 .IP "\fB\-keyform PEM|DER|ENGINE\fR" 4
 183 .IX Item "-keyform PEM|DER|ENGINE"
 184 Whether the key format is \s-1PEM, DER,\s0 or an engine-backed key.
 185 The default is \s-1PEM.\s0
 186 .IP "\fB\-passin password\fR" 4
 187 .IX Item "-passin password"
 188 The input file password source. For more information about the format of \fBarg\fR
 189 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fBopenssl\fR\|(1).
 190 .IP "\fB\-challenge string\fR" 4
 191 .IX Item "-challenge string"
 192 Specifies the challenge string if an \s-1SPKAC\s0 is being created.
 193 .IP "\fB\-spkac spkacname\fR" 4
 194 .IX Item "-spkac spkacname"
 195 Allows an alternative name form the variable containing the
 196 \&\s-1SPKAC.\s0 The default is \*(L"\s-1SPKAC\*(R".\s0 This option affects both
 197 generated and input \s-1SPKAC\s0 files.
 198 .IP "\fB\-spksect section\fR" 4
 199 .IX Item "-spksect section"
 200 Allows an alternative name form the section containing the
 201 \&\s-1SPKAC.\s0 The default is the default section.
 202 .IP "\fB\-noout\fR" 4
 203 .IX Item "-noout"
 204 Don't output the text version of the \s-1SPKAC\s0 (not used if an
 205 \&\s-1SPKAC\s0 is being created).
 206 .IP "\fB\-pubkey\fR" 4
 207 .IX Item "-pubkey"
 208 Output the public key of an \s-1SPKAC\s0 (not used if an \s-1SPKAC\s0 is
 209 being created).
 210 .IP "\fB\-verify\fR" 4
 211 .IX Item "-verify"
 212 Verifies the digital signature on the supplied \s-1SPKAC.\s0
 213 .IP "\fB\-engine id\fR" 4
 214 .IX Item "-engine id"
 215 Specifying an engine (by its unique \fBid\fR string) will cause \fBspkac\fR
 216 to attempt to obtain a functional reference to the specified engine,
 217 thus initialising it if needed. The engine will then be set as the default
 218 for all available algorithms.
 219 .SH "EXAMPLES"
 220 .IX Header "EXAMPLES"
 221 Print out the contents of an \s-1SPKAC:\s0
 222 .PP
 223 .Vb 1
 224 \& openssl spkac \-in spkac.cnf
 225 .Ve
 226 .PP
 227 Verify the signature of an \s-1SPKAC:\s0
 228 .PP
 229 .Vb 1
 230 \& openssl spkac \-in spkac.cnf \-noout \-verify
 231 .Ve
 232 .PP
 233 Create an \s-1SPKAC\s0 using the challenge string \*(L"hello\*(R":
 234 .PP
 235 .Vb 1
 236 \& openssl spkac \-key key.pem \-challenge hello \-out spkac.cnf
 237 .Ve
 238 .PP
 239 Example of an \s-1SPKAC,\s0 (long lines split up for clarity):
 240 .PP
 241 .Vb 6
 242 \& SPKAC=MIG5MGUwXDANBgkqhkiG9w0BAQEFAANLADBIAkEA\e
 243 \& 1cCoq2Wa3Ixs47uI7FPVwHVIPDx5yso105Y6zpozam135a\e
 244 \& 8R0CpoRvkkigIyXfcCjiVi5oWk+6FfPaD03uPFoQIDAQAB\e
 245 \& FgVoZWxsbzANBgkqhkiG9w0BAQQFAANBAFpQtY/FojdwkJ\e
 246 \& h1bEIYuc2EeM2KHTWPEepWYeawvHD0gQ3DngSC75YCWnnD\e
 247 \& dq+NQ3F+X4deMx9AaEglZtULwV4=
 248 .Ve
 249 .SH "NOTES"
 250 .IX Header "NOTES"
 251 A created \s-1SPKAC\s0 with suitable \s-1DN\s0 components appended can be fed into
 252 the \fBca\fR utility.
 253 .PP
 254 SPKACs are typically generated by Netscape when a form is submitted
 255 containing the \fB\s-1KEYGEN\s0\fR tag as part of the certificate enrollment
 256 process.
 257 .PP
 258 The challenge string permits a primitive form of proof of possession
 259 of private key. By checking the \s-1SPKAC\s0 signature and a random challenge
 260 string some guarantee is given that the user knows the private key
 261 corresponding to the public key being certified. This is important in
 262 some applications. Without this it is possible for a previous \s-1SPKAC\s0
 263 to be used in a \*(L"replay attack\*(R".
 264 .SH "SEE ALSO"
 265 .IX Header "SEE ALSO"
 266 \&\fBca\fR\|(1)
 267 .SH "COPYRIGHT"
 268 .IX Header "COPYRIGHT"
 269 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
 270 .PP
 271 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 272 this file except in compliance with the License.  You can obtain a copy
 273 in the file \s-1LICENSE\s0 in the source distribution or at
 274 <https://www.openssl.org/source/license.html>.