tsget.1 11 KB

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