5 ts - Time Stamping Authority tool (client/server)
11 [B<-rand> file:file...]
12 [B<-config> configfile]
13 [B<-data> file_to_hash]
14 [B<-digest> digest_bytes]
16 [B<-tspolicy> object_id]
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<-sha1|-sha224|-sha256|-sha384|-sha512>]
32 [B<-chain> certs_file.pem]
33 [B<-tspolicy> object_id]
36 [B<-out> response.tsr]
43 [B<-data> file_to_hash]
44 [B<-digest> digest_bytes]
45 [B<-queryfile> request.tsq]
48 [B<-CApath> trusted_cert_path]
49 [B<-CAfile> trusted_certs.pem]
50 [B<-untrusted> cert_file.pem]
79 [-verify_hostname hostname]
86 The B<ts> command is a basic Time Stamping Authority (TSA) client and server
87 application as specified in RFC 3161 (Time-Stamp Protocol, TSP). A
88 TSA can be part of a PKI deployment and its role is to provide long
89 term proof of the existence of a certain datum before a particular
90 time. Here is a brief description of the protocol:
96 The TSA client computes a one-way hash value for a data file and sends
101 The TSA attaches the current date and time to the received hash value,
102 signs them and sends the time stamp token back to the client. By
103 creating this token the TSA certifies the existence of the original
104 data file at the time of response generation.
108 The TSA client receives the time stamp token and verifies the
109 signature on it. It also checks if the token contains the same hash
110 value that it had sent to the TSA.
114 There is one DER encoded protocol data unit defined for transporting a time
115 stamp request to the TSA and one for sending the time stamp response
116 back to the client. The B<ts> command has three main functions:
117 creating a time stamp request based on a data file,
118 creating a time stamp response based on a request, verifying if a
119 response corresponds to a particular request or a data file.
121 There is no support for sending the requests/responses automatically
122 over HTTP or TCP yet as suggested in RFC 3161. The users must send the
123 requests either by ftp or e-mail.
127 =head2 Time Stamp Request generation
129 The B<-query> switch can be used for creating and printing a time stamp
130 request with the following options:
134 =item B<-rand> file:file...
136 The files containing random data for seeding the random number
137 generator. Multiple files can be specified, the separator is B<;> for
138 MS-Windows, B<,> for VMS and B<:> for all other platforms. (Optional)
140 =item B<-config> configfile
142 The configuration file to use.
143 Optional; for a description of the default value,
144 see L<openssl(1)/COMMAND SUMMARY>.
146 =item B<-data> file_to_hash
148 The data file for which the time stamp request needs to be
149 created. stdin is the default if neither the B<-data> nor the B<-digest>
150 parameter is specified. (Optional)
152 =item B<-digest> digest_bytes
154 It is possible to specify the message imprint explicitly without the data
155 file. The imprint must be specified in a hexadecimal format, two characters
156 per byte, the bytes optionally separated by colons (e.g. 1A:F6:01:... or
157 1AF601...). The number of bytes must match the message digest algorithm
162 The message digest to apply to the data file.
163 Any digest supported by the OpenSSL B<dgst> command can be used.
164 The default is SHA-1. (Optional)
166 =item B<-tspolicy> object_id
168 The policy that the client expects the TSA to use for creating the
169 time stamp token. Either the dotted OID notation or OID names defined
170 in the config file can be used. If no policy is requested the TSA will
171 use its own default policy. (Optional)
175 No nonce is specified in the request if this option is
176 given. Otherwise a 64 bit long pseudo-random none is
177 included in the request. It is recommended to use nonce to
178 protect against replay-attacks. (Optional)
182 The TSA is expected to include its signing certificate in the
185 =item B<-in> request.tsq
187 This option specifies a previously created time stamp request in DER
188 format that will be printed into the output file. Useful when you need
189 to examine the content of a request in human-readable
193 =item B<-out> request.tsq
195 Name of the output file to which the request will be written. Default
196 is stdout. (Optional)
200 If this option is specified the output is human-readable text format
201 instead of DER. (Optional)
205 =head2 Time Stamp Response generation
207 A time stamp response (TimeStampResp) consists of a response status
208 and the time stamp token itself (ContentInfo), if the token generation was
209 successful. The B<-reply> command is for creating a time stamp
210 response or time stamp token based on a request and printing the
211 response/token in human-readable format. If B<-token_out> is not
212 specified the output is always a time stamp response (TimeStampResp),
213 otherwise it is a time stamp token (ContentInfo).
217 =item B<-config> configfile
219 The configuration file to use.
220 Optional; for a description of the default value,
221 see L<openssl(1)/COMMAND SUMMARY>.
222 See B<CONFIGURATION FILE OPTIONS> for configurable variables.
224 =item B<-section> tsa_section
226 The name of the config file section containing the settings for the
227 response generation. If not specified the default TSA section is
228 used, see B<CONFIGURATION FILE OPTIONS> for details. (Optional)
230 =item B<-queryfile> request.tsq
232 The name of the file containing a DER encoded time stamp request. (Optional)
234 =item B<-passin> password_src
236 Specifies the password source for the private key of the TSA. See
237 B<PASS PHRASE ARGUMENTS> in L<openssl(1)>. (Optional)
239 =item B<-signer> tsa_cert.pem
241 The signer certificate of the TSA in PEM format. The TSA signing
242 certificate must have exactly one extended key usage assigned to it:
243 timeStamping. The extended key usage must also be critical, otherwise
244 the certificate is going to be refused. Overrides the B<signer_cert>
245 variable of the config file. (Optional)
247 =item B<-inkey> private.pem
249 The signer private key of the TSA in PEM format. Overrides the
250 B<signer_key> config file option. (Optional)
252 =item B<-sha1|-sha224|-sha256|-sha384|-sha512>
254 Signing digest to use. Overrides the B<signer_digest> config file
257 =item B<-chain> certs_file.pem
259 The collection of certificates in PEM format that will all
260 be included in the response in addition to the signer certificate if
261 the B<-cert> option was used for the request. This file is supposed to
262 contain the certificate chain for the signer certificate from its
263 issuer upwards. The B<-reply> command does not build a certificate
264 chain automatically. (Optional)
266 =item B<-tspolicy> object_id
268 The default policy to use for the response unless the client
269 explicitly requires a particular TSA policy. The OID can be specified
270 either in dotted notation or with its name. Overrides the
271 B<default_policy> config file option. (Optional)
273 =item B<-in> response.tsr
275 Specifies a previously created time stamp response or time stamp token
276 (if B<-token_in> is also specified) in DER format that will be written
277 to the output file. This option does not require a request, it is
278 useful e.g. when you need to examine the content of a response or
279 token or you want to extract the time stamp token from a response. If
280 the input is a token and the output is a time stamp response a default
281 'granted' status info is added to the token. (Optional)
285 This flag can be used together with the B<-in> option and indicates
286 that the input is a DER encoded time stamp token (ContentInfo) instead
287 of a time stamp response (TimeStampResp). (Optional)
289 =item B<-out> response.tsr
291 The response is written to this file. The format and content of the
292 file depends on other options (see B<-text>, B<-token_out>). The default is
297 The output is a time stamp token (ContentInfo) instead of time stamp
298 response (TimeStampResp). (Optional)
302 If this option is specified the output is human-readable text format
303 instead of DER. (Optional)
307 Specifying an engine (by its unique B<id> string) will cause B<ts>
308 to attempt to obtain a functional reference to the specified engine,
309 thus initialising it if needed. The engine will then be set as the default
310 for all available algorithms. Default is builtin. (Optional)
314 =head2 Time Stamp Response verification
316 The B<-verify> command is for verifying if a time stamp response or time
317 stamp token is valid and matches a particular time stamp request or
318 data file. The B<-verify> command does not use the configuration file.
322 =item B<-data> file_to_hash
324 The response or token must be verified against file_to_hash. The file
325 is hashed with the message digest algorithm specified in the token.
326 The B<-digest> and B<-queryfile> options must not be specified with this one.
329 =item B<-digest> digest_bytes
331 The response or token must be verified against the message digest specified
332 with this option. The number of bytes must match the message digest algorithm
333 specified in the token. The B<-data> and B<-queryfile> options must not be
334 specified with this one. (Optional)
336 =item B<-queryfile> request.tsq
338 The original time stamp request in DER format. The B<-data> and B<-digest>
339 options must not be specified with this one. (Optional)
341 =item B<-in> response.tsr
343 The time stamp response that needs to be verified in DER format. (Mandatory)
347 This flag can be used together with the B<-in> option and indicates
348 that the input is a DER encoded time stamp token (ContentInfo) instead
349 of a time stamp response (TimeStampResp). (Optional)
351 =item B<-CApath> trusted_cert_path
353 The name of the directory containing the trusted CA certificates of the
354 client. See the similar option of L<verify(1)> for additional
355 details. Either this option or B<-CAfile> must be specified. (Optional)
358 =item B<-CAfile> trusted_certs.pem
360 The name of the file containing a set of trusted self-signed CA
361 certificates in PEM format. See the similar option of
362 L<verify(1)> for additional details. Either this option
363 or B<-CApath> must be specified.
366 =item B<-untrusted> cert_file.pem
368 Set of additional untrusted certificates in PEM format which may be
369 needed when building the certificate chain for the TSA's signing
370 certificate. This file must contain the TSA signing certificate and
371 all intermediate CA certificates unless the response includes them.
374 =item I<verify options>
376 The options B<-attime timestamp>, B<-check_ss_sig>, B<-crl_check>,
377 B<-crl_check_all>, B<-explicit_policy>, B<-extended_crl>, B<-ignore_critical>,
378 B<-inhibit_any>, B<-inhibit_map>, B<-issuer_checks>, B<-no_alt_chains>,
379 B<-no_check_time>, B<-partial_chain>, B<-policy>, B<-policy_check>,
380 B<-policy_print>, B<-purpose>, B<-suiteB_128>, B<-suiteB_128_only>,
381 B<-suiteB_192>, B<-trusted_first>, B<-use_deltas>, B<-auth_level>,
382 B<-verify_depth>, B<-verify_email>, B<-verify_hostname>, B<-verify_ip>,
383 B<-verify_name>, and B<-x509_strict> can be used to control timestamp
384 verification. See L<verify(1)>.
388 =head1 CONFIGURATION FILE OPTIONS
390 The B<-query> and B<-reply> commands make use of a configuration file.
392 for a general description of the syntax of the config file. The
393 B<-query> command uses only the symbolic OID names section
394 and it can work without it. However, the B<-reply> command needs the
395 config file for its operation.
397 When there is a command line switch equivalent of a variable the
398 switch always overrides the settings in the config file.
402 =item B<tsa> section, B<default_tsa>
404 This is the main section and it specifies the name of another section
405 that contains all the options for the B<-reply> command. This default
406 section can be overridden with the B<-section> command line switch. (Optional)
410 See L<ca(1)> for description. (Optional)
414 See L<ca(1)> for description. (Optional)
418 See L<ca(1)> for description. (Optional)
422 The name of the file containing the hexadecimal serial number of the
423 last time stamp response created. This number is incremented by 1 for
424 each response. If the file does not exist at the time of response
425 generation a new file is created with serial number 1. (Mandatory)
427 =item B<crypto_device>
429 Specifies the OpenSSL engine that will be set as the default for
430 all available algorithms. The default value is builtin, you can specify
431 any other engines supported by OpenSSL (e.g. use chil for the NCipher HSM).
436 TSA signing certificate in PEM format. The same as the B<-signer>
437 command line option. (Optional)
441 A file containing a set of PEM encoded certificates that need to be
442 included in the response. The same as the B<-chain> command line
447 The private key of the TSA in PEM format. The same as the B<-inkey>
448 command line option. (Optional)
450 =item B<signer_digest>
452 Signing digest to use. The same as the
453 B<-sha1|-sha224|-sha256|-sha384|-sha512> command line option. (Optional)
455 =item B<default_policy>
457 The default policy to use when the request does not mandate any
458 policy. The same as the B<-tspolicy> command line option. (Optional)
460 =item B<other_policies>
462 Comma separated list of policies that are also acceptable by the TSA
463 and used only if the request explicitly specifies one of them. (Optional)
467 The list of message digest algorithms that the TSA accepts. At least
468 one algorithm must be specified. (Mandatory)
472 The accuracy of the time source of the TSA in seconds, milliseconds
473 and microseconds. E.g. secs:1, millisecs:500, microsecs:100. If any of
474 the components is missing zero is assumed for that field. (Optional)
476 =item B<clock_precision_digits>
478 Specifies the maximum number of digits, which represent the fraction of
479 seconds, that need to be included in the time field. The trailing zeroes
480 must be removed from the time, so there might actually be fewer digits,
481 or no fraction of seconds at all. Supported only on UNIX platforms.
482 The maximum value is 6, default is 0.
487 If this option is yes the responses generated by this TSA can always
488 be ordered, even if the time difference between two responses is less
489 than the sum of their accuracies. Default is no. (Optional)
493 Set this option to yes if the subject name of the TSA must be included in
494 the TSA name field of the response. Default is no. (Optional)
496 =item B<ess_cert_id_chain>
498 The SignedData objects created by the TSA always contain the
499 certificate identifier of the signing certificate in a signed
500 attribute (see RFC 2634, Enhanced Security Services). If this option
501 is set to yes and either the B<certs> variable or the B<-chain> option
502 is specified then the certificate identifiers of the chain will also
503 be included in the SigningCertificate signed attribute. If this
504 variable is set to no, only the signing certificate identifier is
505 included. Default is no. (Optional)
511 All the examples below presume that B<OPENSSL_CONF> is set to a proper
512 configuration file, e.g. the example configuration file
513 openssl/apps/openssl.cnf will do.
515 =head2 Time Stamp Request
517 To create a time stamp request for design1.txt with SHA-1
518 without nonce and policy and no certificate is required in the response:
520 openssl ts -query -data design1.txt -no_nonce \
523 To create a similar time stamp request with specifying the message imprint
526 openssl ts -query -digest b7e5d3f93198b38379852f2c04e78d73abdd0f4b \
527 -no_nonce -out design1.tsq
529 To print the content of the previous request in human readable format:
531 openssl ts -query -in design1.tsq -text
533 To create a time stamp request which includes the MD-5 digest
534 of design2.txt, requests the signer certificate and nonce,
535 specifies a policy id (assuming the tsa_policy1 name is defined in the
536 OID section of the config file):
538 openssl ts -query -data design2.txt -md5 \
539 -tspolicy tsa_policy1 -cert -out design2.tsq
541 =head2 Time Stamp Response
543 Before generating a response a signing certificate must be created for
544 the TSA that contains the B<timeStamping> critical extended key usage extension
545 without any other key usage extensions. You can add the
546 'extendedKeyUsage = critical,timeStamping' line to the user certificate section
547 of the config file to generate a proper certificate. See L<req(1)>,
548 L<ca(1)>, L<x509(1)> for instructions. The examples
549 below assume that cacert.pem contains the certificate of the CA,
550 tsacert.pem is the signing certificate issued by cacert.pem and
551 tsakey.pem is the private key of the TSA.
553 To create a time stamp response for a request:
555 openssl ts -reply -queryfile design1.tsq -inkey tsakey.pem \
556 -signer tsacert.pem -out design1.tsr
558 If you want to use the settings in the config file you could just write:
560 openssl ts -reply -queryfile design1.tsq -out design1.tsr
562 To print a time stamp reply to stdout in human readable format:
564 openssl ts -reply -in design1.tsr -text
566 To create a time stamp token instead of time stamp response:
568 openssl ts -reply -queryfile design1.tsq -out design1_token.der -token_out
570 To print a time stamp token to stdout in human readable format:
572 openssl ts -reply -in design1_token.der -token_in -text -token_out
574 To extract the time stamp token from a response:
576 openssl ts -reply -in design1.tsr -out design1_token.der -token_out
578 To add 'granted' status info to a time stamp token thereby creating a
581 openssl ts -reply -in design1_token.der -token_in -out design1.tsr
583 =head2 Time Stamp Verification
585 To verify a time stamp reply against a request:
587 openssl ts -verify -queryfile design1.tsq -in design1.tsr \
588 -CAfile cacert.pem -untrusted tsacert.pem
590 To verify a time stamp reply that includes the certificate chain:
592 openssl ts -verify -queryfile design2.tsq -in design2.tsr \
595 To verify a time stamp token against the original data file:
596 openssl ts -verify -data design2.txt -in design2.tsr \
599 To verify a time stamp token against a message imprint:
600 openssl ts -verify -digest b7e5d3f93198b38379852f2c04e78d73abdd0f4b \
601 -in design2.tsr -CAfile cacert.pem
603 You could also look at the 'test' directory for more examples.
607 =for comment foreign manuals: procmail(1), perl(1)
609 If you find any bugs or you have suggestions please write to
610 Zoltan Glozik <zglozik@opentsa.org>. Known issues:
614 =item * No support for time stamps over SMTP, though it is quite easy
615 to implement an automatic e-mail based TSA with L<procmail(1)>
616 and L<perl(1)>. HTTP server support is provided in the form of
617 a separate apache module. HTTP client support is provided by
618 L<tsget(1)>. Pure TCP/IP protocol is not supported.
620 =item * The file containing the last serial number of the TSA is not
621 locked when being read or written. This is a problem if more than one
622 instance of L<openssl(1)> is trying to create a time stamp
623 response at the same time. This is not an issue when using the apache
624 server module, it does proper locking.
626 =item * Look for the FIXME word in the source files.
628 =item * The source code should really be reviewed by somebody else, too.
630 =item * More testing is needed, I have done only some basic tests (see
637 L<tsget(1)>, L<openssl(1)>, L<req(1)>,
638 L<x509(1)>, L<ca(1)>, L<genrsa(1)>,
643 Copyright 2006-2016 The OpenSSL Project Authors. All Rights Reserved.
645 Licensed under the OpenSSL license (the "License"). You may not use
646 this file except in compliance with the License. You can obtain a copy
647 in the file LICENSE in the source distribution or at
648 L<https://www.openssl.org/source/license.html>.