crypto/external/bsd/openssl/lib/libcrypto/man/openssl_spkac.1

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