Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

tsget (1openssl)

Name

tsget - Time Stamping HTTP/HTTPS client

Synopsis

tsget -h server_url [-e extension] [-o output] [-v] [-d] [-k
private_key.pem] [-p key_password] [-c client_cert.pem] [-C
CA_certs.pem] [-P CA_path] [-r file:file...]  [-g EGD_socket]
[request]...

Description

TSGET(1openssl)                     OpenSSL                    TSGET(1openssl)



NAME
       openssl-tsget, tsget - Time Stamping HTTP/HTTPS client

SYNOPSIS
       tsget -h server_url [-e extension] [-o output] [-v] [-d] [-k
       private_key.pem] [-p key_password] [-c client_cert.pem] [-C
       CA_certs.pem] [-P CA_path] [-r file:file...]  [-g EGD_socket]
       [request]...

DESCRIPTION
       The tsget command can be used for sending a time stamp request, as
       specified in RFC 3161, to a time stamp server over HTTP or HTTPS and
       storing the time stamp response in a file. This tool cannot be used for
       creating the requests and verifying responses, you can use the OpenSSL
       ts(1) command to do that. tsget can send several requests to the server
       without closing the TCP connection if more than one requests are
       specified on the command line.

       The tool sends the following HTTP request for each time stamp request:

               POST url HTTP/1.1
               User-Agent: OpenTSA tsget.pl/<version>
               Host: <host>:<port>
               Pragma: no-cache
               Content-Type: application/timestamp-query
               Accept: application/timestamp-reply
               Content-Length: length of body

               ...binary request specified by the user...

       tsget expects a response of type application/timestamp-reply, which is
       written to a file without any interpretation.

OPTIONS
       -h server_url
           The URL of the HTTP/HTTPS server listening for time stamp requests.

       -e extension
           If the -o option is not given this argument specifies the extension
           of the output files. The base name of the output file will be the
           same as those of the input files. Default extension is '.tsr'.
           (Optional)

       -o output
           This option can be specified only when just one request is sent to
           the server. The time stamp response will be written to the given
           output file. '-' means standard output. In case of multiple time
           stamp requests or the absence of this argument the names of the
           output files will be derived from the names of the input files and
           the default or specified extension argument. (Optional)

       -v  The name of the currently processed request is printed on standard
           error. (Optional)

       -d  Switches on verbose mode for the underlying curl library. You can
           see detailed debug messages for the connection. (Optional)

       -k private_key.pem
           (HTTPS) In case of certificate-based client authentication over
           HTTPS <private_key.pem> must contain the private key of the user.
           The private key file can optionally be protected by a passphrase.
           The -c option must also be specified. (Optional)

       -p key_password
           (HTTPS) Specifies the passphrase for the private key specified by
           the -k argument. If this option is omitted and the key is
           passphrase protected tsget will ask for it. (Optional)

       -c client_cert.pem
           (HTTPS) In case of certificate-based client authentication over
           HTTPS <client_cert.pem> must contain the X.509 certificate of the
           user.  The -k option must also be specified. If this option is not
           specified no certificate-based client authentication will take
           place. (Optional)

       -C CA_certs.pem
           (HTTPS) The trusted CA certificate store. The certificate chain of
           the peer's certificate must include one of the CA certificates
           specified in this file.  Either option -C or option -P must be
           given in case of HTTPS. (Optional)

       -P CA_path
           (HTTPS) The path containing the trusted CA certificates to verify
           the peer's certificate. The directory must be prepared with the
           c_rehash OpenSSL utility. Either option -C or option -P must be
           given in case of HTTPS. (Optional)

       -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 VMS and : for all other platforms. (Optional)

       -g EGD_socket
           The name of an EGD socket to get random data from. (Optional)

       [request]...
           List of files containing RFC 3161 DER-encoded time stamp requests.
           If no requests are specified only one request will be sent to the
           server and it will be read from the standard input. (Optional)

ENVIRONMENT VARIABLES
       The TSGET environment variable can optionally contain default
       arguments. The content of this variable is added to the list of command
       line arguments.

EXAMPLES
       The examples below presume that file1.tsq and file2.tsq contain valid
       time stamp requests, tsa.opentsa.org listens at port 8080 for HTTP
       requests and at port 8443 for HTTPS requests, the TSA service is
       available at the /tsa absolute path.

       Get a time stamp response for file1.tsq over HTTP, output is written to
       file1.tsr:

         tsget -h http://tsa.opentsa.org:8080/tsa file1.tsq

       Get a time stamp response for file1.tsq and file2.tsq over HTTP showing
       progress, output is written to file1.reply and file2.reply
       respectively:

         tsget -h http://tsa.opentsa.org:8080/tsa -v -e .reply \
               file1.tsq file2.tsq

       Create a time stamp request, write it to file3.tsq, send it to the
       server and write the response to file3.tsr:

         openssl ts -query -data file3.txt -cert | tee file3.tsq \
               | tsget -h http://tsa.opentsa.org:8080/tsa \
               -o file3.tsr

       Get a time stamp response for file1.tsq over HTTPS without client
       authentication:

         tsget -h https://tsa.opentsa.org:8443/tsa \
               -C cacerts.pem file1.tsq

       Get a time stamp response for file1.tsq over HTTPS with certificate-
       based client authentication (it will ask for the passphrase if
       client_key.pem is protected):

         tsget -h https://tsa.opentsa.org:8443/tsa -C cacerts.pem \
               -k client_key.pem -c client_cert.pem file1.tsq

       You can shorten the previous command line if you make use of the TSGET
       environment variable. The following commands do the same as the
       previous example:

         TSGET='-h https://tsa.opentsa.org:8443/tsa -C cacerts.pem \
               -k client_key.pem -c client_cert.pem'
         export TSGET
         tsget file1.tsq

AUTHOR
       Zoltan Glozik <zglozik@opentsa.org>, OpenTSA project
       (http://www.opentsa.org)


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | library/security/openssl |
       +---------------+--------------------------+
       |Stability      | Pass-through uncommitted |
       +---------------+--------------------------+

SEE ALSO
       openssl(1), ts(1), curl(1), RFC 3161



NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       https://www.openssl.org/source/openssl-1.0.2ze.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.openssl.org/.



1.0.2ze                           2022-05-03                   TSGET(1openssl)