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

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