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

   1 .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
   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 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "TSGET 1"
 127 .TH TSGET 1 "2010-06-01" "1.0.0a" "OpenSSL"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 tsget \- Time Stamping HTTP/HTTPS client
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 \&\fBtsget\fR
 137 \&\fB\-h\fR server_url
 138 [\fB\-e\fR extension]
 139 [\fB\-o\fR output]
 140 [\fB\-v\fR]
 141 [\fB\-d\fR]
 142 [\fB\-k\fR private_key.pem]
 143 [\fB\-p\fR key_password]
 144 [\fB\-c\fR client_cert.pem]
 145 [\fB\-C\fR CA_certs.pem]
 146 [\fB\-P\fR CA_path]
 147 [\fB\-r\fR file:file...]
 148 [\fB\-g\fR EGD_socket]
 149 [request]...
 150 .SH "DESCRIPTION"
 151 .IX Header "DESCRIPTION"
 152 The \fBtsget\fR command can be used for sending a time stamp request, as
 153 specified in \fB\s-1RFC\s0 3161\fR, to a time stamp server over \s-1HTTP\s0 or \s-1HTTPS\s0 and storing
 154 the time stamp response in a file. This tool cannot be used for creating the
 155 requests and verifying responses, you can use the OpenSSL \fB\f(BIts\fB\|(1)\fR command to
 156 do that. \fBtsget\fR can send several requests to the server without closing
 157 the \s-1TCP\s0 connection if more than one requests are specified on the command
 158 line.
 159 .PP
 160 The tool sends the following \s-1HTTP\s0 request for each time stamp request:
 161 .PP
 162 .Vb 7
 163 \&        POST url HTTP/1.1
 164 \&        User\-Agent: OpenTSA tsget.pl/<version>
 165 \&        Host: <host>:<port>
 166 \&        Pragma: no\-cache
 167 \&        Content\-Type: application/timestamp\-query
 168 \&        Accept: application/timestamp\-reply
 169 \&        Content\-Length: length of body
 170 \&
 171 \&        ...binary request specified by the user...
 172 .Ve
 173 .PP
 174 \&\fBtsget\fR expects a response of type application/timestamp\-reply, which is
 175 written to a file without any interpretation.
 176 .SH "OPTIONS"
 177 .IX Header "OPTIONS"
 178 .IP "\fB\-h\fR server_url" 4
 179 .IX Item "-h server_url"
 180 The \s-1URL\s0 of the \s-1HTTP/HTTPS\s0 server listening for time stamp requests.
 181 .IP "\fB\-e\fR extension" 4
 182 .IX Item "-e extension"
 183 If the \fB\-o\fR option is not given this argument specifies the extension of the
 184 output files. The base name of the output file will be the same as those of
 185 the input files. Default extension is '.tsr'. (Optional)
 186 .IP "\fB\-o\fR output" 4
 187 .IX Item "-o output"
 188 This option can be specified only when just one request is sent to the
 189 server. The time stamp response will be written to the given output file. '\-'
 190 means standard output. In case of multiple time stamp requests or the absence
 191 of this argument the names of the output files will be derived from the names
 192 of the input files and the default or specified extension argument. (Optional)
 193 .IP "\fB\-v\fR" 4
 194 .IX Item "-v"
 195 The name of the currently processed request is printed on standard
 196 error. (Optional)
 197 .IP "\fB\-d\fR" 4
 198 .IX Item "-d"
 199 Switches on verbose mode for the underlying \fBcurl\fR library. You can see
 200 detailed debug messages for the connection. (Optional)
 201 .IP "\fB\-k\fR private_key.pem" 4
 202 .IX Item "-k private_key.pem"
 203 (\s-1HTTPS\s0) In case of certificate-based client authentication over \s-1HTTPS\s0
 204 <private_key.pem> must contain the private key of the user. The private key
 205 file can optionally be protected by a passphrase. The \fB\-c\fR option must also
 206 be specified. (Optional)
 207 .IP "\fB\-p\fR key_password" 4
 208 .IX Item "-p key_password"
 209 (\s-1HTTPS\s0) Specifies the passphrase for the private key specified by the \fB\-k\fR
 210 argument. If this option is omitted and the key is passphrase protected \fBtsget\fR
 211 will ask for it. (Optional)
 212 .IP "\fB\-c\fR client_cert.pem" 4
 213 .IX Item "-c client_cert.pem"
 214 (\s-1HTTPS\s0) In case of certificate-based client authentication over \s-1HTTPS\s0
 215 <client_cert.pem> must contain the X.509 certificate of the user.  The \fB\-k\fR
 216 option must also be specified. If this option is not specified no
 217 certificate-based client authentication will take place. (Optional)
 218 .IP "\fB\-C\fR CA_certs.pem" 4
 219 .IX Item "-C CA_certs.pem"
 220 (\s-1HTTPS\s0) The trusted \s-1CA\s0 certificate store. The certificate chain of the peer's
 221 certificate must include one of the \s-1CA\s0 certificates specified in this file.
 222 Either option \fB\-C\fR or option \fB\-P\fR must be given in case of \s-1HTTPS\s0. (Optional)
 223 .IP "\fB\-P\fR CA_path" 4
 224 .IX Item "-P CA_path"
 225 (\s-1HTTPS\s0) The path containing the trusted \s-1CA\s0 certificates to verify the peer's
 226 certificate. The directory must be prepared with the \fBc_rehash\fR
 227 OpenSSL utility. Either option \fB\-C\fR or option \fB\-P\fR must be given in case of
 228 \&\s-1HTTPS\s0. (Optional)
 229 .IP "\fB\-rand\fR file:file..." 4
 230 .IX Item "-rand file:file..."
 231 The files containing random data for seeding the random number
 232 generator. Multiple files can be specified, the separator is \fB;\fR for
 233 MS-Windows, \fB,\fR for \s-1VMS\s0 and \fB:\fR for all other platforms. (Optional)
 234 .IP "\fB\-g\fR EGD_socket" 4
 235 .IX Item "-g EGD_socket"
 236 The name of an \s-1EGD\s0 socket to get random data from. (Optional)
 237 .IP "[request]..." 4
 238 .IX Item "[request]..."
 239 List of files containing \fB\s-1RFC\s0 3161\fR DER-encoded time stamp requests. If no
 240 requests are specifed only one request will be sent to the server and it will be
 241 read from the standard input. (Optional)
 242 .SH "ENVIRONMENT VARIABLES"
 243 .IX Header "ENVIRONMENT VARIABLES"
 244 The \fB\s-1TSGET\s0\fR environment variable can optionally contain default
 245 arguments. The content of this variable is added to the list of command line
 246 arguments.
 247 .SH "EXAMPLES"
 248 .IX Header "EXAMPLES"
 249 The examples below presume that \fBfile1.tsq\fR and \fBfile2.tsq\fR contain valid
 250 time stamp requests, tsa.opentsa.org listens at port 8080 for \s-1HTTP\s0 requests
 251 and at port 8443 for \s-1HTTPS\s0 requests, the \s-1TSA\s0 service is available at the /tsa
 252 absolute path.
 253 .PP
 254 Get a time stamp response for file1.tsq over \s-1HTTP\s0, output is written to
 255 file1.tsr:
 256 .PP
 257 .Vb 1
 258 \&  tsget \-h http://tsa.opentsa.org:8080/tsa file1.tsq
 259 .Ve
 260 .PP
 261 Get a time stamp response for file1.tsq and file2.tsq over \s-1HTTP\s0 showing
 262 progress, output is written to file1.reply and file2.reply respectively:
 263 .PP
 264 .Vb 2
 265 \&  tsget \-h http://tsa.opentsa.org:8080/tsa \-v \-e .reply \e
 266 \&        file1.tsq file2.tsq
 267 .Ve
 268 .PP
 269 Create a time stamp request, write it to file3.tsq, send it to the server and
 270 write the response to file3.tsr:
 271 .PP
 272 .Vb 3
 273 \&  openssl ts \-query \-data file3.txt \-cert | tee file3.tsq \e
 274 \&        | tsget \-h http://tsa.opentsa.org:8080/tsa \e
 275 \&        \-o file3.tsr
 276 .Ve
 277 .PP
 278 Get a time stamp response for file1.tsq over \s-1HTTPS\s0 without client
 279 authentication:
 280 .PP
 281 .Vb 2
 282 \&  tsget \-h https://tsa.opentsa.org:8443/tsa \e
 283 \&        \-C cacerts.pem file1.tsq
 284 .Ve
 285 .PP
 286 Get a time stamp response for file1.tsq over \s-1HTTPS\s0 with certificate-based
 287 client authentication (it will ask for the passphrase if client_key.pem is
 288 protected):
 289 .PP
 290 .Vb 2
 291 \&  tsget \-h https://tsa.opentsa.org:8443/tsa \-C cacerts.pem \e
 292 \&        \-k client_key.pem \-c client_cert.pem file1.tsq
 293 .Ve
 294 .PP
 295 You can shorten the previous command line if you make use of the \fB\s-1TSGET\s0\fR
 296 environment variable. The following commands do the same as the previous
 297 example:
 298 .PP
 299 .Vb 4
 300 \&  TSGET=\*(Aq\-h https://tsa.opentsa.org:8443/tsa \-C cacerts.pem \e
 301 \&        \-k client_key.pem \-c client_cert.pem\*(Aq
 302 \&  export TSGET
 303 \&  tsget file1.tsq
 304 .Ve
 305 .SH "AUTHOR"
 306 .IX Header "AUTHOR"
 307 Zoltan Glozik <zglozik@opentsa.org>, OpenTSA project (http://www.opentsa.org)
 308 .SH "SEE ALSO"
 309 .IX Header "SEE ALSO"
 310 \&\fIopenssl\fR\|(1), \fIts\fR\|(1), \fIcurl\fR\|(1),
 311 \&\fB\s-1RFC\s0 3161\fR