Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)

Standard preamble:
========================================================================
..

..

.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "TS 1" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
openssl-ts, ts - Time Stamping Authority tool (client/server) Header "SYNOPSIS" \fBopenssl ts \fB-query [-rand file:file...] [-config configfile] [-data file_to_hash] [-digest digest_bytes] [-md2|-md4|-md5|-sha|-sha1|-mdc2|-ripemd160|...] [-policy object_id] [-no_nonce] [-cert] [-in request.tsq] [-out request.tsq] [-text]

\fBopenssl ts \fB-reply [-config configfile] [-section tsa_section] [-queryfile request.tsq] [-passin password_src] [-signer tsa_cert.pem] [-inkey private.pem] [-chain certs_file.pem] [-policy object_id] [-in response.tsr] [-token_in] [-out response.tsr] [-token_out] [-text] [-engine id]

\fBopenssl ts \fB-verify [-data file_to_hash] [-digest digest_bytes] [-queryfile request.tsq] [-in response.tsr] [-token_in] [-CApath trusted_cert_path] [-CAfile trusted_certs.pem] [-untrusted cert_file.pem]

Header "DESCRIPTION" The ts command is a basic Time Stamping Authority (\s-1TSA\s0) client and server application as specified in \s-1RFC 3161\s0 (Time-Stamp Protocol, \s-1TSP\s0). A \s-1TSA\s0 can be part of a \s-1PKI\s0 deployment and its role is to provide long term proof of the existence of a certain datum before a particular time. Here is a brief description of the protocol: The \s-1TSA\s0 client computes a one-way hash value for a data file and sends the hash to the \s-1TSA.\s0 The \s-1TSA\s0 attaches the current date and time to the received hash value, signs them and sends the time stamp token back to the client. By creating this token the \s-1TSA\s0 certifies the existence of the original data file at the time of response generation. The \s-1TSA\s0 client receives the time stamp token and verifies the signature on it. It also checks if the token contains the same hash value that it had sent to the \s-1TSA.\s0

There is one \s-1DER\s0 encoded protocol data unit defined for transporting a time stamp request to the \s-1TSA\s0 and one for sending the time stamp response back to the client. The ts command has three main functions: creating a time stamp request based on a data file, creating a time stamp response based on a request, verifying if a response corresponds to a particular request or a data file.

There is no support for sending the requests/responses automatically over \s-1HTTP\s0 or \s-1TCP\s0 yet as suggested in \s-1RFC 3161.\s0 The users must send the requests either by ftp or e-mail.

Header "OPTIONS" Subsection "Time Stamp Request generation" The -query switch can be used for creating and printing a time stamp request with the following options: Item "-rand file:file..." The files containing random data for seeding the random number generator. Multiple files can be specified, the separator is ; for MS-Windows, , for \s-1VMS\s0 and : for all other platforms. (Optional) Item "-config configfile" The configuration file to use, this option overrides the \fB\s-1OPENSSL_CONF\s0 environment variable. Only the \s-1OID\s0 section of the config file is used with the -query command. (Optional) Item "-data file_to_hash" The data file for which the time stamp request needs to be created. stdin is the default if neither the -data nor the -digest parameter is specified. (Optional) Item "-digest digest_bytes" It is possible to specify the message imprint explicitly without the data file. The imprint must be specified in a hexadecimal format, two characters per byte, the bytes optionally separated by colons (e.g. 1A:F6:01:... or 1AF601...). The number of bytes must match the message digest algorithm in use. (Optional) Item "-md2|-md4|-md5|-sha|-sha1|-mdc2|-ripemd160|..." The message digest to apply to the data file, it supports all the message digest algorithms that are supported by the openssl dgst command. The default is \s-1SHA-1.\s0 (Optional) Item "-policy object_id" The policy that the client expects the \s-1TSA\s0 to use for creating the time stamp token. Either the dotted \s-1OID\s0 notation or \s-1OID\s0 names defined in the config file can be used. If no policy is requested the \s-1TSA\s0 will use its own default policy. (Optional) Item "-no_nonce" No nonce is specified in the request if this option is given. Otherwise a 64 bit long pseudo-random none is included in the request. It is recommended to use nonce to protect against replay-attacks. (Optional) Item "-cert" The \s-1TSA\s0 is expected to include its signing certificate in the response. (Optional) Item "-in request.tsq" This option specifies a previously created time stamp request in \s-1DER\s0 format that will be printed into the output file. Useful when you need to examine the content of a request in human-readable .Sp format. (Optional) Item "-out request.tsq" Name of the output file to which the request will be written. Default is stdout. (Optional) Item "-text" If this option is specified the output is human-readable text format instead of \s-1DER.\s0 (Optional) Subsection "Time Stamp Response generation" A time stamp response (TimeStampResp) consists of a response status and the time stamp token itself (ContentInfo), if the token generation was successful. The -reply command is for creating a time stamp response or time stamp token based on a request and printing the response/token in human-readable format. If -token_out is not specified the output is always a time stamp response (TimeStampResp), otherwise it is a time stamp token (ContentInfo). Item "-config configfile" The configuration file to use, this option overrides the \fB\s-1OPENSSL_CONF\s0 environment variable. See \s-1CONFIGURATION FILE OPTIONS\s0 for configurable variables. (Optional) Item "-section tsa_section" The name of the config file section conatining the settings for the response generation. If not specified the default \s-1TSA\s0 section is used, see \s-1CONFIGURATION FILE OPTIONS\s0 for details. (Optional) Item "-queryfile request.tsq" The name of the file containing a \s-1DER\s0 encoded time stamp request. (Optional) Item "-passin password_src" Specifies the password source for the private key of the \s-1TSA.\s0 See \fB\s-1PASS PHRASE ARGUMENTS\s0 in openssl\|(1). (Optional) Item "-signer tsa_cert.pem" The signer certificate of the \s-1TSA\s0 in \s-1PEM\s0 format. The \s-1TSA\s0 signing certificate must have exactly one extended key usage assigned to it: timeStamping. The extended key usage must also be critical, otherwise the certificate is going to be refused. Overrides the signer_cert variable of the config file. (Optional) Item "-inkey private.pem" The signer private key of the \s-1TSA\s0 in \s-1PEM\s0 format. Overrides the \fBsigner_key config file option. (Optional) Item "-chain certs_file.pem" The collection of certificates in \s-1PEM\s0 format that will all be included in the response in addition to the signer certificate if the -cert option was used for the request. This file is supposed to contain the certificate chain for the signer certificate from its issuer upwards. The -reply command does not build a certificate chain automatically. (Optional) Item "-policy object_id" The default policy to use for the response unless the client explicitly requires a particular \s-1TSA\s0 policy. The \s-1OID\s0 can be specified either in dotted notation or with its name. Overrides the \fBdefault_policy config file option. (Optional) Item "-in response.tsr" Specifies a previously created time stamp response or time stamp token (if -token_in is also specified) in \s-1DER\s0 format that will be written to the output file. This option does not require a request, it is useful e.g. when you need to examine the content of a response or token or you want to extract the time stamp token from a response. If the input is a token and the output is a time stamp response a default 'granted' status info is added to the token. (Optional) Item "-token_in" This flag can be used together with the -in option and indicates that the input is a \s-1DER\s0 encoded time stamp token (ContentInfo) instead of a time stamp response (TimeStampResp). (Optional) Item "-out response.tsr" The response is written to this file. The format and content of the file depends on other options (see -text, -token_out). The default is stdout. (Optional) Item "-token_out" The output is a time stamp token (ContentInfo) instead of time stamp response (TimeStampResp). (Optional) Item "-text" If this option is specified the output is human-readable text format instead of \s-1DER.\s0 (Optional) Item "-engine id" Specifying an engine (by its unique id string) will cause ts to attempt to obtain a functional reference to the specified engine, thus initialising it if needed. The engine will then be set as the default for all available algorithms. Default is builtin. (Optional) Subsection "Time Stamp Response verification" The -verify command is for verifying if a time stamp response or time stamp token is valid and matches a particular time stamp request or data file. The -verify command does not use the configuration file. Item "-data file_to_hash" The response or token must be verified against file_to_hash. The file is hashed with the message digest algorithm specified in the token. The -digest and -queryfile options must not be specified with this one. (Optional) Item "-digest digest_bytes" The response or token must be verified against the message digest specified with this option. The number of bytes must match the message digest algorithm specified in the token. The -data and -queryfile options must not be specified with this one. (Optional) Item "-queryfile request.tsq" The original time stamp request in \s-1DER\s0 format. The -data and -digest options must not be specified with this one. (Optional) Item "-in response.tsr" The time stamp response that needs to be verified in \s-1DER\s0 format. (Mandatory) Item "-token_in" This flag can be used together with the -in option and indicates that the input is a \s-1DER\s0 encoded time stamp token (ContentInfo) instead of a time stamp response (TimeStampResp). (Optional) Item "-CApath trusted_cert_path" The name of the directory containing the trused \s-1CA\s0 certificates of the client. See the similar option of verify\|(1) for additional details. Either this option or -CAfile must be specified. (Optional) Item "-CAfile trusted_certs.pem" The name of the file containing a set of trusted self-signed \s-1CA\s0 certificates in \s-1PEM\s0 format. See the similar option of \fBverify\|(1) for additional details. Either this option or -CApath must be specified. (Optional) Item "-untrusted cert_file.pem" Set of additional untrusted certificates in \s-1PEM\s0 format which may be needed when building the certificate chain for the \s-1TSA\s0's signing certificate. This file must contain the \s-1TSA\s0 signing certificate and all intermediate \s-1CA\s0 certificates unless the response includes them. (Optional) Header "CONFIGURATION FILE OPTIONS" The -query and -reply commands make use of a configuration file defined by the \s-1OPENSSL_CONF\s0 environment variable. See config\|(5) for a general description of the syntax of the config file. The \fB-query command uses only the symbolic \s-1OID\s0 names section and it can work without it. However, the -reply command needs the config file for its operation.

When there is a command line switch equivalent of a variable the switch always overrides the settings in the config file.

Item "tsa section, default_tsa" This is the main section and it specifies the name of another section that contains all the options for the -reply command. This default section can be overridden with the -section command line switch. (Optional) Item "oid_file" See ca\|(1) for description. (Optional) Item "oid_section" See ca\|(1) for description. (Optional) Item "RANDFILE" See ca\|(1) for description. (Optional) Item "serial" The name of the file containing the hexadecimal serial number of the last time stamp response created. This number is incremented by 1 for each response. If the file does not exist at the time of response generation a new file is created with serial number 1. (Mandatory) Item "crypto_device" Specifies the OpenSSL engine that will be set as the default for all available algorithms. The default value is builtin, you can specify any other engines supported by OpenSSL (e.g. use chil for the NCipher \s-1HSM\s0). (Optional) Item "signer_cert" \s-1TSA\s0 signing certificate in \s-1PEM\s0 format. The same as the -signer command line option. (Optional) Item "certs" A file containing a set of \s-1PEM\s0 encoded certificates that need to be included in the response. The same as the -chain command line option. (Optional) Item "signer_key" The private key of the \s-1TSA\s0 in \s-1PEM\s0 format. The same as the -inkey command line option. (Optional) Item "default_policy" The default policy to use when the request does not mandate any policy. The same as the -policy command line option. (Optional) Item "other_policies" Comma separated list of policies that are also acceptable by the \s-1TSA\s0 and used only if the request explicitly specifies one of them. (Optional) Item "digests" The list of message digest algorithms that the \s-1TSA\s0 accepts. At least one algorithm must be specified. (Mandatory) Item "accuracy" The accuracy of the time source of the \s-1TSA\s0 in seconds, milliseconds and microseconds. E.g. secs:1, millisecs:500, microsecs:100. If any of the components is missing zero is assumed for that field. (Optional) Item "clock_precision_digits" Specifies the maximum number of digits, which represent the fraction of seconds, that need to be included in the time field. The trailing zeroes must be removed from the time, so there might actually be fewer digits, or no fraction of seconds at all. Supported only on \s-1UNIX\s0 platforms. The maximum value is 6, default is 0. (Optional) Item "ordering" If this option is yes the responses generated by this \s-1TSA\s0 can always be ordered, even if the time difference between two responses is less than the sum of their accuracies. Default is no. (Optional) Item "tsa_name" Set this option to yes if the subject name of the \s-1TSA\s0 must be included in the \s-1TSA\s0 name field of the response. Default is no. (Optional) Item "ess_cert_id_chain" The SignedData objects created by the \s-1TSA\s0 always contain the certificate identifier of the signing certificate in a signed attribute (see \s-1RFC 2634,\s0 Enhanced Security Services). If this option is set to yes and either the certs variable or the -chain option is specified then the certificate identifiers of the chain will also be included in the SigningCertificate signed attribute. If this variable is set to no, only the signing certificate identifier is included. Default is no. (Optional) Header "ENVIRONMENT VARIABLES" \fB\s-1OPENSSL_CONF\s0 contains the path of the configuration file and can be overridden by the -config command line option. Header "EXAMPLES" All the examples below presume that \s-1OPENSSL_CONF\s0 is set to a proper configuration file, e.g. the example configuration file openssl/apps/openssl.cnf will do. Subsection "Time Stamp Request" To create a time stamp request for design1.txt with \s-1SHA-1\s0 without nonce and policy and no certificate is required in the response:

.Vb 2 openssl ts -query -data design1.txt -no_nonce \e -out design1.tsq .Ve

To create a similar time stamp request with specifying the message imprint explicitly:

.Vb 2 openssl ts -query -digest b7e5d3f93198b38379852f2c04e78d73abdd0f4b \e -no_nonce -out design1.tsq .Ve

To print the content of the previous request in human readable format:

.Vb 1 openssl ts -query -in design1.tsq -text .Ve

To create a time stamp request which includes the \s-1MD-5\s0 digest of design2.txt, requests the signer certificate and nonce, specifies a policy id (assuming the tsa_policy1 name is defined in the \s-1OID\s0 section of the config file):

.Vb 2 openssl ts -query -data design2.txt -md5 \e -policy tsa_policy1 -cert -out design2.tsq .Ve

Subsection "Time Stamp Response" Before generating a response a signing certificate must be created for the \s-1TSA\s0 that contains the timeStamping critical extended key usage extension without any other key usage extensions. You can add the 'extendedKeyUsage = critical,timeStamping' line to the user certificate section of the config file to generate a proper certificate. See req\|(1), \fBca\|(1), x509\|(1) for instructions. The examples below assume that cacert.pem contains the certificate of the \s-1CA,\s0 tsacert.pem is the signing certificate issued by cacert.pem and tsakey.pem is the private key of the \s-1TSA.\s0

To create a time stamp response for a request:

.Vb 2 openssl ts -reply -queryfile design1.tsq -inkey tsakey.pem \e -signer tsacert.pem -out design1.tsr .Ve

If you want to use the settings in the config file you could just write:

.Vb 1 openssl ts -reply -queryfile design1.tsq -out design1.tsr .Ve

To print a time stamp reply to stdout in human readable format:

.Vb 1 openssl ts -reply -in design1.tsr -text .Ve

To create a time stamp token instead of time stamp response:

.Vb 1 openssl ts -reply -queryfile design1.tsq -out design1_token.der -token_out .Ve

To print a time stamp token to stdout in human readable format:

.Vb 1 openssl ts -reply -in design1_token.der -token_in -text -token_out .Ve

To extract the time stamp token from a response:

.Vb 1 openssl ts -reply -in design1.tsr -out design1_token.der -token_out .Ve

To add 'granted' status info to a time stamp token thereby creating a valid response:

.Vb 1 openssl ts -reply -in design1_token.der -token_in -out design1.tsr .Ve

Subsection "Time Stamp Verification" To verify a time stamp reply against a request:

.Vb 2 openssl ts -verify -queryfile design1.tsq -in design1.tsr \e -CAfile cacert.pem -untrusted tsacert.pem .Ve

To verify a time stamp reply that includes the certificate chain:

.Vb 2 openssl ts -verify -queryfile design2.tsq -in design2.tsr \e -CAfile cacert.pem .Ve

To verify a time stamp token against the original data file: openssl ts -verify -data design2.txt -in design2.tsr \e -CAfile cacert.pem

To verify a time stamp token against a message imprint: openssl ts -verify -digest b7e5d3f93198b38379852f2c04e78d73abdd0f4b \e -in design2.tsr -CAfile cacert.pem

You could also look at the 'test' directory for more examples.

Header "BUGS" If you find any bugs or you have suggestions please write to Zoltan Glozik <zglozik@opentsa.org>. Known issues: No support for time stamps over \s-1SMTP,\s0 though it is quite easy to implement an automatic e-mail based \s-1TSA\s0 with procmail\|(1) and perl\|(1). \s-1HTTP\s0 server support is provided in the form of a separate apache module. \s-1HTTP\s0 client support is provided by \fBtsget\|(1). Pure \s-1TCP/IP\s0 protocol is not supported. The file containing the last serial number of the \s-1TSA\s0 is not locked when being read or written. This is a problem if more than one instance of openssl\|(1) is trying to create a time stamp response at the same time. This is not an issue when using the apache server module, it does proper locking. Look for the \s-1FIXME\s0 word in the source files. The source code should really be reviewed by somebody else, too. More testing is needed, I have done only some basic tests (see test/testtsa). Header "AUTHOR" Zoltan Glozik <zglozik@opentsa.org>, OpenTSA project (http://www.opentsa.org) Header "SEE ALSO" \fBtsget\|(1), openssl\|(1), req\|(1), \fBx509\|(1), ca\|(1), genrsa\|(1), \fBconfig\|(5)