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

   1 .\" Automatically generated by Pod::Man version 1.15
   2 .\" Wed Feb 19 16:49:38 2003
   3 .\"
   4 .\" Standard preamble:
   5 .\" ======================================================================
   6 .de Sh \" Subsection heading
   7 .br
   8 .if t .Sp
   9 .ne 5
  10 .PP
  11 \fB\\$1\fR
  12 .PP
  13 ..
  14 .de Sp \" Vertical space (when we can't use .PP)
  15 .if t .sp .5v
  16 .if n .sp
  17 ..
  18 .de Ip \" List item
  19 .br
  20 .ie \\n(.$>=3 .ne \\$3
  21 .el .ne 3
  22 .IP "\\$1" \\$2
  23 ..
  24 .de Vb \" Begin verbatim text
  25 .ft CW
  26 .nf
  27 .ne \\$1
  28 ..
  29 .de Ve \" End verbatim text
  30 .ft R
  31
  32 .fi
  33 ..
  34 .\" Set up some character translations and predefined strings.  \*(-- will
  35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  36 .\" double quote, and \*(R" will give a right double quote.  | will give a
  37 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
  38 .\" to do unbreakable dashes and therefore won't be available.  \*(C` and
  39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
  40 .tr \(*W-|\(bv\*(Tr
  41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  42 .ie n \{\
  43 .    ds -- \(*W-
  44 .    ds PI pi
  45 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  46 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  47 .    ds L" ""
  48 .    ds R" ""
  49 .    ds C` ""
  50 .    ds C' ""
  51 'br\}
  52 .el\{\
  53 .    ds -- \|\(em\|
  54 .    ds PI \(*p
  55 .    ds L" ``
  56 .    ds R" ''
  57 'br\}
  58 .\"
  59 .\" If the F register is turned on, we'll generate index entries on stderr
  60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
  61 .\" index entries marked with X<> in POD.  Of course, you'll have to process
  62 .\" the output yourself in some meaningful fashion.
  63 .if \nF \{\
  64 .    de IX
  65 .    tm Index:\\$1\t\\n%\t"\\$2"
  66 ..
  67 .    nr % 0
  68 .    rr F
  69 .\}
  70 .\"
  71 .\" For nroff, turn off justification.  Always turn off hyphenation; it
  72 .\" makes way too many mistakes in technical documents.
  73 .hy 0
  74 .if n .na
  75 .\"
  76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  77 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  78 .bd B 3
  79 .    \" fudge factors for nroff and troff
  80 .if n \{\
  81 .    ds #H 0
  82 .    ds #V .8m
  83 .    ds #F .3m
  84 .    ds #[ \f1
  85 .    ds #] \fP
  86 .\}
  87 .if t \{\
  88 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  89 .    ds #V .6m
  90 .    ds #F 0
  91 .    ds #[ \&
  92 .    ds #] \&
  93 .\}
  94 .    \" simple accents for nroff and troff
  95 .if n \{\
  96 .    ds ' \&
  97 .    ds ` \&
  98 .    ds ^ \&
  99 .    ds , \&
 100 .    ds ~ ~
 101 .    ds /
 102 .\}
 103 .if t \{\
 104 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 105 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 106 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 107 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 108 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 109 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 110 .\}
 111 .    \" troff and (daisy-wheel) nroff accents
 112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 119 .ds ae a\h'-(\w'a'u*4/10)'e
 120 .ds Ae A\h'-(\w'A'u*4/10)'E
 121 .    \" corrections for vroff
 122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 124 .    \" for low resolution devices (crt and lpr)
 125 .if \n(.H>23 .if \n(.V>19 \
 126 \{\
 127 .    ds : e
 128 .    ds 8 ss
 129 .    ds o a
 130 .    ds d- d\h'-1'\(ga
 131 .    ds D- D\h'-1'\(hy
 132 .    ds th \o'bp'
 133 .    ds Th \o'LP'
 134 .    ds ae ae
 135 .    ds Ae AE
 136 .\}
 137 .rm #[ #] #H #V #F C
 138 .\" ======================================================================
 139 .\"
 140 .IX Title "SPKAC 1"
 141 .TH SPKAC 1 "0.9.7a" "2003-02-19" "OpenSSL"
 142 .UC
 143 .SH "NAME"
 144 spkac \- \s-1SPKAC\s0 printing and generating utility
 145 .SH "SYNOPSIS"
 146 .IX Header "SYNOPSIS"
 147 \&\fBopenssl\fR \fBspkac\fR
 148 [\fB\-in filename\fR]
 149 [\fB\-out filename\fR]
 150 [\fB\-key keyfile\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 "COMMAND OPTIONS"
 165 .IX Header "COMMAND OPTIONS"
 166 .Ip "\fB\-in filename\fR" 4
 167 .IX Item "-in filename"
 168 This specifies the input filename to read from or standard input if this
 169 option is not specified. Ignored if the \fB\-key\fR option is used.
 170 .Ip "\fB\-out filename\fR" 4
 171 .IX Item "-out filename"
 172 specifies the output filename to write to or standard output by
 173 default.
 174 .Ip "\fB\-key keyfile\fR" 4
 175 .IX Item "-key keyfile"
 176 create an \s-1SPKAC\s0 file using the private key in \fBkeyfile\fR. The
 177 \&\fB\-in\fR, \fB\-noout\fR, \fB\-spksect\fR and \fB\-verify\fR options are ignored if
 178 present.
 179 .Ip "\fB\-passin password\fR" 4
 180 .IX Item "-passin password"
 181 the input file password source. For more information about the format of \fBarg\fR
 182 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in openssl(1).
 183 .Ip "\fB\-challenge string\fR" 4
 184 .IX Item "-challenge string"
 185 specifies the challenge string if an \s-1SPKAC\s0 is being created.
 186 .Ip "\fB\-spkac spkacname\fR" 4
 187 .IX Item "-spkac spkacname"
 188 allows an alternative name form the variable containing the
 189 \&\s-1SPKAC\s0. The default is \*(L"\s-1SPKAC\s0\*(R". This option affects both
 190 generated and input \s-1SPKAC\s0 files.
 191 .Ip "\fB\-spksect section\fR" 4
 192 .IX Item "-spksect section"
 193 allows an alternative name form the section containing the
 194 \&\s-1SPKAC\s0. The default is the default section.
 195 .Ip "\fB\-noout\fR" 4
 196 .IX Item "-noout"
 197 don't output the text version of the \s-1SPKAC\s0 (not used if an
 198 \&\s-1SPKAC\s0 is being created).
 199 .Ip "\fB\-pubkey\fR" 4
 200 .IX Item "-pubkey"
 201 output the public key of an \s-1SPKAC\s0 (not used if an \s-1SPKAC\s0 is
 202 being created).
 203 .Ip "\fB\-verify\fR" 4
 204 .IX Item "-verify"
 205 verifies the digital signature on the supplied \s-1SPKAC\s0.
 206 .Ip "\fB\-engine id\fR" 4
 207 .IX Item "-engine id"
 208 specifying an engine (by it's unique \fBid\fR string) will cause \fBreq\fR
 209 to attempt to obtain a functional reference to the specified engine,
 210 thus initialising it if needed. The engine will then be set as the default
 211 for all available algorithms.
 212 .SH "EXAMPLES"
 213 .IX Header "EXAMPLES"
 214 Print out the contents of an \s-1SPKAC:\s0
 215 .PP
 216 .Vb 1
 217 \& openssl spkac -in spkac.cnf
 218 .Ve
 219 Verify the signature of an \s-1SPKAC:\s0
 220 .PP
 221 .Vb 1
 222 \& openssl spkac -in spkac.cnf -noout -verify
 223 .Ve
 224 Create an \s-1SPKAC\s0 using the challenge string \*(L"hello\*(R":
 225 .PP
 226 .Vb 1
 227 \& openssl spkac -key key.pem -challenge hello -out spkac.cnf
 228 .Ve
 229 Example of an \s-1SPKAC\s0, (long lines split up for clarity):
 230 .PP
 231 .Vb 5
 232 \& SPKAC=MIG5MGUwXDANBgkqhkiG9w0BAQEFAANLADBIAkEA1cCoq2Wa3Ixs47uI7F\e
 233 \& PVwHVIPDx5yso105Y6zpozam135a8R0CpoRvkkigIyXfcCjiVi5oWk+6FfPaD03u\e
 234 \& PFoQIDAQABFgVoZWxsbzANBgkqhkiG9w0BAQQFAANBAFpQtY/FojdwkJh1bEIYuc\e
 235 \& 2EeM2KHTWPEepWYeawvHD0gQ3DngSC75YCWnnDdq+NQ3F+X4deMx9AaEglZtULwV\e
 236 \& 4=
 237 .Ve
 238 .SH "NOTES"
 239 .IX Header "NOTES"
 240 A created \s-1SPKAC\s0 with suitable \s-1DN\s0 components appended can be fed into
 241 the \fBca\fR utility.
 242 .PP
 243 SPKACs are typically generated by Netscape when a form is submitted
 244 containing the \fB\s-1KEYGEN\s0\fR tag as part of the certificate enrollment
 245 process.
 246 .PP
 247 The challenge string permits a primitive form of proof of possession
 248 of private key. By checking the \s-1SPKAC\s0 signature and a random challenge
 249 string some guarantee is given that the user knows the private key
 250 corresponding to the public key being certified. This is important in
 251 some applications. Without this it is possible for a previous \s-1SPKAC\s0
 252 to be used in a \*(L"replay attack\*(R".
 253 .SH "SEE ALSO"
 254 .IX Header "SEE ALSO"
 255 ca(1)