doc/man1/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<-tspolicy> 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<-sha1|-sha224|-sha256|-sha384|-sha512>]
  32 [B<-chain> certs_file.pem]
  33 [B<-tspolicy> 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 [I<verify options>]
  52
  53 I<verify options:>
  54 [-attime timestamp]
  55 [-check_ss_sig]
  56 [-crl_check]
  57 [-crl_check_all]
  58 [-explicit_policy]
  59 [-extended_crl]
  60 [-ignore_critical]
  61 [-inhibit_any]
  62 [-inhibit_map]
  63 [-issuer_checks]
  64 [-no_alt_chains]
  65 [-no_check_time]
  66 [-partial_chain]
  67 [-policy arg]
  68 [-policy_check]
  69 [-policy_print]
  70 [-purpose purpose]
  71 [-suiteB_128]
  72 [-suiteB_128_only]
  73 [-suiteB_192]
  74 [-trusted_first]
  75 [-use_deltas]
  76 [-auth_level num]
  77 [-verify_depth num]
  78 [-verify_email email]
  79 [-verify_hostname hostname]
  80 [-verify_ip ip]
  81 [-verify_name name]
  82 [-x509_strict]
  83
  84 =head1 DESCRIPTION
  85
  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:
  91
  92 =over 4
  93
  94 =item 1.
  95
  96 The TSA client computes a one-way hash value for a data file and sends
  97 the hash to the TSA.
  98
  99 =item 2.
 100
 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.
 105
 106 =item 3.
 107
 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.
 111
 112 =back
 113
 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.
 120
 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.
 124
 125 =head1 OPTIONS
 126
 127 =head2 Time Stamp Request generation
 128
 129 The B<-query> switch can be used for creating and printing a time stamp
 130 request with the following options:
 131
 132 =over 4
 133
 134 =item B<-rand> file:file...
 135
 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)
 139
 140 =item B<-config> configfile
 141
 142 The configuration file to use.
 143 Optional; for a description of the default value,
 144 see L<openssl(1)/COMMAND SUMMARY>.
 145
 146 =item B<-data> file_to_hash
 147
 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)
 151
 152 =item B<-digest> digest_bytes
 153
 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
 158 in use. (Optional)
 159
 160 =item B<-[digest]>
 161
 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)
 165
 166 =item B<-tspolicy> object_id
 167
 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)
 172
 173 =item B<-no_nonce>
 174
 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)
 179
 180 =item B<-cert>
 181
 182 The TSA is expected to include its signing certificate in the
 183 response. (Optional)
 184
 185 =item B<-in> request.tsq
 186
 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
 190
 191 format. (Optional)
 192
 193 =item B<-out> request.tsq
 194
 195 Name of the output file to which the request will be written. Default
 196 is stdout. (Optional)
 197
 198 =item B<-text>
 199
 200 If this option is specified the output is human-readable text format
 201 instead of DER. (Optional)
 202
 203 =back
 204
 205 =head2 Time Stamp Response generation
 206
 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).
 214
 215 =over 4
 216
 217 =item B<-config> configfile
 218
 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.
 223
 224 =item B<-section> tsa_section
 225
 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)
 229
 230 =item B<-queryfile> request.tsq
 231
 232 The name of the file containing a DER encoded time stamp request. (Optional)
 233
 234 =item B<-passin> password_src
 235
 236 Specifies the password source for the private key of the TSA. See
 237 B<PASS PHRASE ARGUMENTS> in L<openssl(1)>. (Optional)
 238
 239 =item B<-signer> tsa_cert.pem
 240
 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)
 246
 247 =item B<-inkey> private.pem
 248
 249 The signer private key of the TSA in PEM format. Overrides the
 250 B<signer_key> config file option. (Optional)
 251
 252 =item B<-sha1|-sha224|-sha256|-sha384|-sha512>
 253
 254 Signing digest to use. Overrides the B<signer_digest> config file
 255 option. (Optional)
 256
 257 =item B<-chain> certs_file.pem
 258
 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)
 265
 266 =item B<-tspolicy> object_id
 267
 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)
 272
 273 =item B<-in> response.tsr
 274
 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)
 282
 283 =item B<-token_in>
 284
 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)
 288
 289 =item B<-out> response.tsr
 290
 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
 293 stdout. (Optional)
 294
 295 =item B<-token_out>
 296
 297 The output is a time stamp token (ContentInfo) instead of time stamp
 298 response (TimeStampResp). (Optional)
 299
 300 =item B<-text>
 301
 302 If this option is specified the output is human-readable text format
 303 instead of DER. (Optional)
 304
 305 =item B<-engine> id
 306
 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)
 311
 312 =back
 313
 314 =head2 Time Stamp Response verification
 315
 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.
 319
 320 =over 4
 321
 322 =item B<-data> file_to_hash
 323
 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.
 327 (Optional)
 328
 329 =item B<-digest> digest_bytes
 330
 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)
 335
 336 =item B<-queryfile> request.tsq
 337
 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)
 340
 341 =item B<-in> response.tsr
 342
 343 The time stamp response that needs to be verified in DER format. (Mandatory)
 344
 345 =item B<-token_in>
 346
 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)
 350
 351 =item B<-CApath> trusted_cert_path
 352
 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)
 356
 357
 358 =item B<-CAfile> trusted_certs.pem
 359
 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.
 364 (Optional)
 365
 366 =item B<-untrusted> cert_file.pem
 367
 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.
 372 (Optional)
 373
 374 =item I<verify options>
 375
 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)>.
 385
 386 =back
 387
 388 =head1 CONFIGURATION FILE OPTIONS
 389
 390 The B<-query> and B<-reply> commands make use of a configuration file.
 391 See L<config(5)>
 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.
 396
 397 When there is a command line switch equivalent of a variable the
 398 switch always overrides the settings in the config file.
 399
 400 =over 4
 401
 402 =item B<tsa> section, B<default_tsa>
 403
 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)
 407
 408 =item B<oid_file>
 409
 410 See L<ca(1)> for description. (Optional)
 411
 412 =item B<oid_section>
 413
 414 See L<ca(1)> for description. (Optional)
 415
 416 =item B<RANDFILE>
 417
 418 See L<ca(1)> for description. (Optional)
 419
 420 =item B<serial>
 421
 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)
 426
 427 =item B<crypto_device>
 428
 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).
 432 (Optional)
 433
 434 =item B<signer_cert>
 435
 436 TSA signing certificate in PEM format. The same as the B<-signer>
 437 command line option. (Optional)
 438
 439 =item B<certs>
 440
 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
 443 option. (Optional)
 444
 445 =item B<signer_key>
 446
 447 The private key of the TSA in PEM format. The same as the B<-inkey>
 448 command line option. (Optional)
 449
 450 =item B<signer_digest>
 451
 452 Signing digest to use. The same as the
 453 B<-sha1|-sha224|-sha256|-sha384|-sha512> command line option. (Optional)
 454
 455 =item B<default_policy>
 456
 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)
 459
 460 =item B<other_policies>
 461
 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)
 464
 465 =item B<digests>
 466
 467 The list of message digest algorithms that the TSA accepts. At least
 468 one algorithm must be specified. (Mandatory)
 469
 470 =item B<accuracy>
 471
 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)
 475
 476 =item B<clock_precision_digits>
 477
 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.
 483 (Optional)
 484
 485 =item B<ordering>
 486
 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)
 490
 491 =item B<tsa_name>
 492
 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)
 495
 496 =item B<ess_cert_id_chain>
 497
 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)
 506
 507 =back
 508
 509 =head1 EXAMPLES
 510
 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.
 514
 515 =head2 Time Stamp Request
 516
 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:
 519
 520   openssl ts -query -data design1.txt -no_nonce \
 521         -out design1.tsq
 522
 523 To create a similar time stamp request with specifying the message imprint
 524 explicitly:
 525
 526   openssl ts -query -digest b7e5d3f93198b38379852f2c04e78d73abdd0f4b \
 527          -no_nonce -out design1.tsq
 528
 529 To print the content of the previous request in human readable format:
 530
 531   openssl ts -query -in design1.tsq -text
 532
 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):
 537
 538   openssl ts -query -data design2.txt -md5 \
 539         -tspolicy tsa_policy1 -cert -out design2.tsq
 540
 541 =head2 Time Stamp Response
 542
 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.
 552
 553 To create a time stamp response for a request:
 554
 555   openssl ts -reply -queryfile design1.tsq -inkey tsakey.pem \
 556         -signer tsacert.pem -out design1.tsr
 557
 558 If you want to use the settings in the config file you could just write:
 559
 560   openssl ts -reply -queryfile design1.tsq -out design1.tsr
 561
 562 To print a time stamp reply to stdout in human readable format:
 563
 564   openssl ts -reply -in design1.tsr -text
 565
 566 To create a time stamp token instead of time stamp response:
 567
 568   openssl ts -reply -queryfile design1.tsq -out design1_token.der -token_out
 569
 570 To print a time stamp token to stdout in human readable format:
 571
 572   openssl ts -reply -in design1_token.der -token_in -text -token_out
 573
 574 To extract the time stamp token from a response:
 575
 576   openssl ts -reply -in design1.tsr -out design1_token.der -token_out
 577
 578 To add 'granted' status info to a time stamp token thereby creating a
 579 valid response:
 580
 581   openssl ts -reply -in design1_token.der -token_in -out design1.tsr
 582
 583 =head2 Time Stamp Verification
 584
 585 To verify a time stamp reply against a request:
 586
 587   openssl ts -verify -queryfile design1.tsq -in design1.tsr \
 588         -CAfile cacert.pem -untrusted tsacert.pem
 589
 590 To verify a time stamp reply that includes the certificate chain:
 591
 592   openssl ts -verify -queryfile design2.tsq -in design2.tsr \
 593         -CAfile cacert.pem
 594
 595 To verify a time stamp token against the original data file:
 596   openssl ts -verify -data design2.txt -in design2.tsr \
 597         -CAfile cacert.pem
 598
 599 To verify a time stamp token against a message imprint:
 600   openssl ts -verify -digest b7e5d3f93198b38379852f2c04e78d73abdd0f4b \
 601          -in design2.tsr -CAfile cacert.pem
 602
 603 You could also look at the 'test' directory for more examples.
 604
 605 =head1 BUGS
 606
 607 =for comment foreign manuals: procmail(1), perl(1)
 608
 609 If you find any bugs or you have suggestions please write to
 610 Zoltan Glozik <zglozik@opentsa.org>. Known issues:
 611
 612 =over 4
 613
 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.
 619
 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.
 625
 626 =item * Look for the FIXME word in the source files.
 627
 628 =item * The source code should really be reviewed by somebody else, too.
 629
 630 =item * More testing is needed, I have done only some basic tests (see
 631 test/testtsa).
 632
 633 =back
 634
 635 =head1 SEE ALSO
 636
 637 L<tsget(1)>, L<openssl(1)>, L<req(1)>,
 638 L<x509(1)>, L<ca(1)>, L<genrsa(1)>,
 639 L<config(5)>
 640
 641 =head1 COPYRIGHT
 642
 643 Copyright 2006-2016 The OpenSSL Project Authors. All Rights Reserved.
 644
 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>.
 649
 650 =cut