Add support for signer_digest option in TS.
[openssl.git] / doc / apps / ts.pod
1 =pod
2
3 =head1 NAME
4
5 ts - Time Stamping Authority tool (client/server)
6
7 =head1 SYNOPSIS
8
9 B<openssl> B<ts>
10 B<-query>
11 [B<-rand> file:file...]
12 [B<-config> configfile]
13 [B<-data> file_to_hash]
14 [B<-digest> digest_bytes]
15 [B<-[digest]>]
16 [B<-policy> object_id]
17 [B<-no_nonce>]
18 [B<-cert>]
19 [B<-in> request.tsq]
20 [B<-out> request.tsq]
21 [B<-text>]
22
23 B<openssl> B<ts>
24 B<-reply>
25 [B<-config> configfile]
26 [B<-section> tsa_section]
27 [B<-queryfile> request.tsq]
28 [B<-passin> password_src]
29 [B<-signer> tsa_cert.pem]
30 [B<-inkey> private.pem]
31 [B<-md2>|B<-md4>|B<-md5>|B<-sha>|B<-sha1>|B<-mdc2>|B<-ripemd160>|B<...>]
32 [B<-chain> certs_file.pem]
33 [B<-policy> object_id]
34 [B<-in> response.tsr]
35 [B<-token_in>]
36 [B<-out> response.tsr]
37 [B<-token_out>]
38 [B<-text>]
39 [B<-engine> id]
40
41 B<openssl> B<ts>
42 B<-verify>
43 [B<-data> file_to_hash]
44 [B<-digest> digest_bytes]
45 [B<-queryfile> request.tsq]
46 [B<-in> response.tsr]
47 [B<-token_in>]
48 [B<-CApath> trusted_cert_path]
49 [B<-CAfile> trusted_certs.pem]
50 [B<-untrusted> cert_file.pem]
51
52 =head1 DESCRIPTION
53
54 The B<ts> command is a basic Time Stamping Authority (TSA) client and server
55 application as specified in RFC 3161 (Time-Stamp Protocol, TSP). A
56 TSA can be part of a PKI deployment and its role is to provide long
57 term proof of the existence of a certain datum before a particular
58 time. Here is a brief description of the protocol:
59
60 =over 4
61
62 =item 1.
63
64 The TSA client computes a one-way hash value for a data file and sends
65 the hash to the TSA.
66
67 =item 2.
68
69 The TSA attaches the current date and time to the received hash value,
70 signs them and sends the time stamp token back to the client. By
71 creating this token the TSA certifies the existence of the original
72 data file at the time of response generation.
73
74 =item 3.
75
76 The TSA client receives the time stamp token and verifies the
77 signature on it. It also checks if the token contains the same hash
78 value that it had sent to the TSA.
79
80 =back
81
82 There is one DER encoded protocol data unit defined for transporting a time
83 stamp request to the TSA and one for sending the time stamp response
84 back to the client. The B<ts> command has three main functions:
85 creating a time stamp request based on a data file,
86 creating a time stamp response based on a request, verifying if a
87 response corresponds to a particular request or a data file.
88
89 There is no support for sending the requests/responses automatically
90 over HTTP or TCP yet as suggested in RFC 3161. The users must send the
91 requests either by ftp or e-mail.
92
93 =head1 OPTIONS
94
95 =head2 Time Stamp Request generation
96
97 The B<-query> switch can be used for creating and printing a time stamp
98 request with the following options:
99
100 =over 4
101
102 =item B<-rand> file:file...
103
104 The files containing random data for seeding the random number
105 generator. Multiple files can be specified, the separator is B<;> for
106 MS-Windows, B<,> for VMS and B<:> for all other platforms. (Optional)
107
108 =item B<-config> configfile
109
110 The configuration file to use, this option overrides the
111 B<OPENSSL_CONF> environment variable. Only the OID section
112 of the config file is used with the B<-query> command. (Optional)
113
114 =item B<-data> file_to_hash
115
116 The data file for which the time stamp request needs to be
117 created. stdin is the default if neither the B<-data> nor the B<-digest>
118 parameter is specified. (Optional)
119
120 =item B<-digest> digest_bytes
121
122 It is possible to specify the message imprint explicitly without the data
123 file. The imprint must be specified in a hexadecimal format, two characters
124 per byte, the bytes optionally separated by colons (e.g. 1A:F6:01:... or
125 1AF601...). The number of bytes must match the message digest algorithm
126 in use. (Optional)
127
128 =item B<-[digest]>
129
130 The message digest to apply to the data file.
131 Any digest supported by the OpenSSL B<dgst> command can be used.
132 The default is SHA-1. (Optional)
133
134 =item B<-policy> object_id
135
136 The policy that the client expects the TSA to use for creating the
137 time stamp token. Either the dotted OID notation or OID names defined
138 in the config file can be used. If no policy is requested the TSA will
139 use its own default policy. (Optional)
140
141 =item B<-no_nonce>
142
143 No nonce is specified in the request if this option is
144 given. Otherwise a 64 bit long pseudo-random none is
145 included in the request. It is recommended to use nonce to
146 protect against replay-attacks. (Optional)
147
148 =item B<-cert>
149
150 The TSA is expected to include its signing certificate in the
151 response. (Optional)
152
153 =item B<-in> request.tsq
154
155 This option specifies a previously created time stamp request in DER
156 format that will be printed into the output file. Useful when you need
157 to examine the content of a request in human-readable
158
159 format. (Optional)
160
161 =item B<-out> request.tsq
162
163 Name of the output file to which the request will be written. Default
164 is stdout. (Optional)
165
166 =item B<-text>
167
168 If this option is specified the output is human-readable text format
169 instead of DER. (Optional)
170
171 =back
172
173 =head2 Time Stamp Response generation
174
175 A time stamp response (TimeStampResp) consists of a response status
176 and the time stamp token itself (ContentInfo), if the token generation was
177 successful. The B<-reply> command is for creating a time stamp
178 response or time stamp token based on a request and printing the
179 response/token in human-readable format. If B<-token_out> is not
180 specified the output is always a time stamp response (TimeStampResp),
181 otherwise it is a time stamp token (ContentInfo).
182
183 =over 4
184
185 =item B<-config> configfile
186
187 The configuration file to use, this option overrides the
188 B<OPENSSL_CONF> environment variable. See B<CONFIGURATION FILE
189 OPTIONS> for configurable variables. (Optional)
190
191 =item B<-section> tsa_section
192
193 The name of the config file section containing the settings for the
194 response generation. If not specified the default TSA section is
195 used, see B<CONFIGURATION FILE OPTIONS> for details. (Optional)
196
197 =item B<-queryfile> request.tsq
198
199 The name of the file containing a DER encoded time stamp request. (Optional)
200
201 =item B<-passin> password_src
202
203 Specifies the password source for the private key of the TSA. See
204 B<PASS PHRASE ARGUMENTS> in L<openssl(1)>. (Optional)
205
206 =item B<-signer> tsa_cert.pem
207
208 The signer certificate of the TSA in PEM format. The TSA signing
209 certificate must have exactly one extended key usage assigned to it:
210 timeStamping. The extended key usage must also be critical, otherwise
211 the certificate is going to be refused. Overrides the B<signer_cert>
212 variable of the config file. (Optional)
213
214 =item B<-inkey> private.pem
215
216 The signer private key of the TSA in PEM format. Overrides the
217 B<signer_key> config file option. (Optional)
218
219 =item B<-md2>|B<-md4>|B<-md5>|B<-sha>|B<-sha1>|B<-mdc2>|B<-ripemd160>|B<...>
220
221 Signing digest to use. Overrides the B<signer_digest> config file
222 option. (Optional)
223
224 =item B<-chain> certs_file.pem
225
226 The collection of certificates in PEM format that will all
227 be included in the response in addition to the signer certificate if
228 the B<-cert> option was used for the request. This file is supposed to
229 contain the certificate chain for the signer certificate from its
230 issuer upwards. The B<-reply> command does not build a certificate
231 chain automatically. (Optional)
232
233 =item B<-policy> object_id
234
235 The default policy to use for the response unless the client
236 explicitly requires a particular TSA policy. The OID can be specified
237 either in dotted notation or with its name. Overrides the
238 B<default_policy> config file option. (Optional)
239
240 =item B<-in> response.tsr
241
242 Specifies a previously created time stamp response or time stamp token
243 (if B<-token_in> is also specified) in DER format that will be written
244 to the output file. This option does not require a request, it is
245 useful e.g. when you need to examine the content of a response or
246 token or you want to extract the time stamp token from a response. If
247 the input is a token and the output is a time stamp response a default
248 'granted' status info is added to the token. (Optional)
249
250 =item B<-token_in>
251
252 This flag can be used together with the B<-in> option and indicates
253 that the input is a DER encoded time stamp token (ContentInfo) instead
254 of a time stamp response (TimeStampResp). (Optional)
255
256 =item B<-out> response.tsr
257
258 The response is written to this file. The format and content of the
259 file depends on other options (see B<-text>, B<-token_out>). The default is
260 stdout. (Optional)
261
262 =item B<-token_out>
263
264 The output is a time stamp token (ContentInfo) instead of time stamp
265 response (TimeStampResp). (Optional)
266
267 =item B<-text>
268
269 If this option is specified the output is human-readable text format
270 instead of DER. (Optional)
271
272 =item B<-engine> id
273
274 Specifying an engine (by its unique B<id> string) will cause B<ts>
275 to attempt to obtain a functional reference to the specified engine,
276 thus initialising it if needed. The engine will then be set as the default
277 for all available algorithms. Default is builtin. (Optional)
278
279 =back
280
281 =head2 Time Stamp Response verification
282
283 The B<-verify> command is for verifying if a time stamp response or time
284 stamp token is valid and matches a particular time stamp request or
285 data file. The B<-verify> command does not use the configuration file.
286
287 =over 4
288
289 =item B<-data> file_to_hash
290
291 The response or token must be verified against file_to_hash. The file
292 is hashed with the message digest algorithm specified in the token.
293 The B<-digest> and B<-queryfile> options must not be specified with this one.
294 (Optional)
295
296 =item B<-digest> digest_bytes
297
298 The response or token must be verified against the message digest specified
299 with this option. The number of bytes must match the message digest algorithm
300 specified in the token. The B<-data> and B<-queryfile> options must not be
301 specified with this one. (Optional)
302
303 =item B<-queryfile> request.tsq
304
305 The original time stamp request in DER format. The B<-data> and B<-digest>
306 options must not be specified with this one. (Optional)
307
308 =item B<-in> response.tsr
309
310 The time stamp response that needs to be verified in DER format. (Mandatory)
311
312 =item B<-token_in>
313
314 This flag can be used together with the B<-in> option and indicates
315 that the input is a DER encoded time stamp token (ContentInfo) instead
316 of a time stamp response (TimeStampResp). (Optional)
317
318 =item B<-CApath> trusted_cert_path
319
320 The name of the directory containing the trusted CA certificates of the
321 client. See the similar option of L<verify(1)> for additional
322 details. Either this option or B<-CAfile> must be specified. (Optional)
323
324
325 =item B<-CAfile> trusted_certs.pem
326
327 The name of the file containing a set of trusted self-signed CA
328 certificates in PEM format. See the similar option of
329 L<verify(1)> for additional details. Either this option
330 or B<-CApath> must be specified.
331 (Optional)
332
333 =item B<-untrusted> cert_file.pem
334
335 Set of additional untrusted certificates in PEM format which may be
336 needed when building the certificate chain for the TSA's signing
337 certificate. This file must contain the TSA signing certificate and
338 all intermediate CA certificates unless the response includes them.
339 (Optional)
340
341 =back
342
343 =head1 CONFIGURATION FILE OPTIONS
344
345 The B<-query> and B<-reply> commands make use of a configuration file
346 defined by the B<OPENSSL_CONF> environment variable. See L<config(5)>
347 for a general description of the syntax of the config file. The
348 B<-query> command uses only the symbolic OID names section
349 and it can work without it. However, the B<-reply> command needs the
350 config file for its operation.
351
352 When there is a command line switch equivalent of a variable the
353 switch always overrides the settings in the config file.
354
355 =over 4
356
357 =item B<tsa> section, B<default_tsa>
358
359 This is the main section and it specifies the name of another section
360 that contains all the options for the B<-reply> command. This default
361 section can be overridden with the B<-section> command line switch. (Optional)
362
363 =item B<oid_file>
364
365 See L<ca(1)> for description. (Optional)
366
367 =item B<oid_section>
368
369 See L<ca(1)> for description. (Optional)
370
371 =item B<RANDFILE>
372
373 See L<ca(1)> for description. (Optional)
374
375 =item B<serial>
376
377 The name of the file containing the hexadecimal serial number of the
378 last time stamp response created. This number is incremented by 1 for
379 each response. If the file does not exist at the time of response
380 generation a new file is created with serial number 1. (Mandatory)
381
382 =item B<crypto_device>
383
384 Specifies the OpenSSL engine that will be set as the default for
385 all available algorithms. The default value is builtin, you can specify
386 any other engines supported by OpenSSL (e.g. use chil for the NCipher HSM).
387 (Optional)
388
389 =item B<signer_cert>
390
391 TSA signing certificate in PEM format. The same as the B<-signer>
392 command line option. (Optional)
393
394 =item B<certs>
395
396 A file containing a set of PEM encoded certificates that need to be
397 included in the response. The same as the B<-chain> command line
398 option. (Optional)
399
400 =item B<signer_key>
401
402 The private key of the TSA in PEM format. The same as the B<-inkey>
403 command line option. (Optional)
404
405 =item B<signer_digest>
406
407 Signing digest to use. The same as the
408 B<-md2>|B<-md4>|B<-md5>|B<-sha>|B<-sha1>|B<-mdc2>|B<-ripemd160>|B<...>
409 command line option. (Optional)
410
411 =item B<default_policy>
412
413 The default policy to use when the request does not mandate any
414 policy. The same as the B<-policy> command line option. (Optional)
415
416 =item B<other_policies>
417
418 Comma separated list of policies that are also acceptable by the TSA
419 and used only if the request explicitly specifies one of them. (Optional)
420
421 =item B<digests>
422
423 The list of message digest algorithms that the TSA accepts. At least
424 one algorithm must be specified. (Mandatory)
425
426 =item B<accuracy>
427
428 The accuracy of the time source of the TSA in seconds, milliseconds
429 and microseconds. E.g. secs:1, millisecs:500, microsecs:100. If any of
430 the components is missing zero is assumed for that field. (Optional)
431
432 =item B<clock_precision_digits>
433
434 Specifies the maximum number of digits, which represent the fraction of
435 seconds, that  need to be included in the time field. The trailing zeroes
436 must be removed from the time, so there might actually be fewer digits,
437 or no fraction of seconds at all. Supported only on UNIX platforms.
438 The maximum value is 6, default is 0.
439 (Optional)
440
441 =item B<ordering>
442
443 If this option is yes the responses generated by this TSA can always
444 be ordered, even if the time difference between two responses is less
445 than the sum of their accuracies. Default is no. (Optional)
446
447 =item B<tsa_name>
448
449 Set this option to yes if the subject name of the TSA must be included in
450 the TSA name field of the response. Default is no. (Optional)
451
452 =item B<ess_cert_id_chain>
453
454 The SignedData objects created by the TSA always contain the
455 certificate identifier of the signing certificate in a signed
456 attribute (see RFC 2634, Enhanced Security Services). If this option
457 is set to yes and either the B<certs> variable or the B<-chain> option
458 is specified then the certificate identifiers of the chain will also
459 be included in the SigningCertificate signed attribute. If this
460 variable is set to no, only the signing certificate identifier is
461 included. Default is no. (Optional)
462
463 =back
464
465 =head1 ENVIRONMENT VARIABLES
466
467 B<OPENSSL_CONF> contains the path of the configuration file and can be
468 overridden by the B<-config> command line option.
469
470 =head1 EXAMPLES
471
472 All the examples below presume that B<OPENSSL_CONF> is set to a proper
473 configuration file, e.g. the example configuration file
474 openssl/apps/openssl.cnf will do.
475
476 =head2 Time Stamp Request
477
478 To create a time stamp request for design1.txt with SHA-1
479 without nonce and policy and no certificate is required in the response:
480
481   openssl ts -query -data design1.txt -no_nonce \
482         -out design1.tsq
483
484 To create a similar time stamp request with specifying the message imprint
485 explicitly:
486
487   openssl ts -query -digest b7e5d3f93198b38379852f2c04e78d73abdd0f4b \
488          -no_nonce -out design1.tsq
489
490 To print the content of the previous request in human readable format:
491
492   openssl ts -query -in design1.tsq -text
493
494 To create a time stamp request which includes the MD-5 digest
495 of design2.txt, requests the signer certificate and nonce,
496 specifies a policy id (assuming the tsa_policy1 name is defined in the
497 OID section of the config file):
498
499   openssl ts -query -data design2.txt -md5 \
500         -policy tsa_policy1 -cert -out design2.tsq
501
502 =head2 Time Stamp Response
503
504 Before generating a response a signing certificate must be created for
505 the TSA that contains the B<timeStamping> critical extended key usage extension
506 without any other key usage extensions. You can add the
507 'extendedKeyUsage = critical,timeStamping' line to the user certificate section
508 of the config file to generate a proper certificate. See L<req(1)>,
509 L<ca(1)>, L<x509(1)> for instructions. The examples
510 below assume that cacert.pem contains the certificate of the CA,
511 tsacert.pem is the signing certificate issued by cacert.pem and
512 tsakey.pem is the private key of the TSA.
513
514 To create a time stamp response for a request:
515
516   openssl ts -reply -queryfile design1.tsq -inkey tsakey.pem \
517         -signer tsacert.pem -out design1.tsr
518
519 If you want to use the settings in the config file you could just write:
520
521   openssl ts -reply -queryfile design1.tsq -out design1.tsr
522
523 To print a time stamp reply to stdout in human readable format:
524
525   openssl ts -reply -in design1.tsr -text
526
527 To create a time stamp token instead of time stamp response:
528
529   openssl ts -reply -queryfile design1.tsq -out design1_token.der -token_out
530
531 To print a time stamp token to stdout in human readable format:
532
533   openssl ts -reply -in design1_token.der -token_in -text -token_out
534
535 To extract the time stamp token from a response:
536
537   openssl ts -reply -in design1.tsr -out design1_token.der -token_out
538
539 To add 'granted' status info to a time stamp token thereby creating a
540 valid response:
541
542   openssl ts -reply -in design1_token.der -token_in -out design1.tsr
543
544 =head2 Time Stamp Verification
545
546 To verify a time stamp reply against a request:
547
548   openssl ts -verify -queryfile design1.tsq -in design1.tsr \
549         -CAfile cacert.pem -untrusted tsacert.pem
550
551 To verify a time stamp reply that includes the certificate chain:
552
553   openssl ts -verify -queryfile design2.tsq -in design2.tsr \
554         -CAfile cacert.pem
555
556 To verify a time stamp token against the original data file:
557   openssl ts -verify -data design2.txt -in design2.tsr \
558         -CAfile cacert.pem
559
560 To verify a time stamp token against a message imprint:
561   openssl ts -verify -digest b7e5d3f93198b38379852f2c04e78d73abdd0f4b \
562          -in design2.tsr -CAfile cacert.pem
563
564 You could also look at the 'test' directory for more examples.
565
566 =head1 BUGS
567
568 If you find any bugs or you have suggestions please write to
569 Zoltan Glozik <zglozik@opentsa.org>. Known issues:
570
571 =over 4
572
573 =item * No support for time stamps over SMTP, though it is quite easy
574 to implement an automatic e-mail based TSA with L<procmail(1)>
575 and L<perl(1)>. HTTP server support is provided in the form of
576 a separate apache module. HTTP client support is provided by
577 L<tsget(1)>. Pure TCP/IP protocol is not supported.
578
579 =item * The file containing the last serial number of the TSA is not
580 locked when being read or written. This is a problem if more than one
581 instance of L<openssl(1)> is trying to create a time stamp
582 response at the same time. This is not an issue when using the apache
583 server module, it does proper locking.
584
585 =item * Look for the FIXME word in the source files.
586
587 =item * The source code should really be reviewed by somebody else, too.
588
589 =item * More testing is needed, I have done only some basic tests (see
590 test/testtsa).
591
592 =back
593
594 =cut
595
596 =head1 SEE ALSO
597
598 L<tsget(1)>, L<openssl(1)>, L<req(1)>,
599 L<x509(1)>, L<ca(1)>, L<genrsa(1)>,
600 L<config(5)>
601
602 =cut