doc/invoke-gnutls-cli.texi

   1 @node gnutls-cli Invocation
   2 @section Invoking gnutls-cli
   3 @pindex gnutls-cli
   4 @cindex GnuTLS client
   5 @ignore
   6 #  -*- buffer-read-only: t -*- vi: set ro:
   7 #
   8 # DO NOT EDIT THIS FILE   (invoke-gnutls-cli.texi)
   9 #
  10 # It has been AutoGen-ed  May  9, 2012 at 08:06:11 PM by AutoGen 5.16
  11 # From the definitions    ../src/cli-args.def
  12 # and the template file   agtexi-cmd.tpl
  13 @end ignore
  14
  15
  16 Simple client program to set up a TLS connection to some other computer.
  17 It sets up a TLS connection and forwards data from the standard input to the secured socket and vice versa.
  18
  19 This section was generated by @strong{AutoGen},
  20 using the @code{agtexi-cmd} template and the option descriptions for the @code{gnutls-cli} program.
  21 This software is released under the GNU General Public License, version 3 or later.
  22
  23
  24 @anchor{gnutls-cli usage}
  25 @subheading gnutls-cli help/usage (-h)
  26 @cindex gnutls-cli help
  27
  28 This is the automatically generated usage text for gnutls-cli.
  29 The text printed is the same whether for the @code{help} option (-h) or the @code{more-help} option (-!).  @code{more-help} will print
  30 the usage text by passing it through a pager program.
  31 @code{more-help} is disabled on platforms without a working
  32 @code{fork(2)} function.  The @code{PAGER} environment variable is
  33 used to select the program, defaulting to @file{more}.  Both will exit
  34 with a status code of 0.
  35
  36 @exampleindent 0
  37 @example
  38 gnutls-cli - GnuTLS client - Ver. @@VERSION@@
  39 USAGE:  gnutls-cli [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... [hostname]
  40
  41    -d, --debug=num            Enable debugging.
  42                                 - It must be in the range:
  43                                   0 to 9999
  44    -V, --verbose              More verbose output
  45                                 - may appear multiple times
  46        --tofu                 Enable trust on first use authentication
  47                                 - disabled as --no-tofu
  48        --ocsp                 Enable OCSP certificate verification
  49                                 - disabled as --no-ocsp
  50    -r, --resume               Establish a session and resume
  51    -e, --rehandshake          Establish a session and rehandshake
  52        --noticket             Don't accept session tickets
  53    -s, --starttls             Connect, establish a plain session and start TLS.
  54    -u, --udp                  Use DTLS (datagram TLS) over UDP
  55        --mtu=num              Set MTU for datagram TLS
  56                                 - It must be in the range:
  57                                   0 to 17000
  58        --crlf                 Send CR LF instead of LF
  59        --x509fmtder           Use DER format for certificates to read from
  60    -f, --fingerprint          Send the openpgp fingerprint, instead of the key
  61        --disable-extensions   Disable all the TLS extensions
  62        --print-cert           Print peer's certificate in PEM format
  63        --recordsize=num       The maximum record size to advertize
  64                                 - It must be in the range:
  65                                   0 to 4096
  66        --priority=str         Priorities string
  67        --x509cafile=str       Certificate file or PKCS #11 URL to use
  68        --x509crlfile=file     CRL file to use
  69                                 - file must pre-exist
  70        --pgpkeyfile=file      PGP Key file to use
  71                                 - file must pre-exist
  72        --pgpkeyring=file      PGP Key ring file to use
  73                                 - file must pre-exist
  74        --pgpcertfile=file     PGP Public Key (certificate) file to use
  75                                 - file must pre-exist
  76        --x509keyfile=str      X.509 key file or PKCS #11 URL to use
  77        --x509certfile=str     X.509 Certificate file or PKCS #11 URL to use
  78        --pgpsubkey=str        PGP subkey to use (hex or auto)
  79        --srpusername=str      SRP username to use
  80        --srppasswd=str        SRP password to use
  81        --pskusername=str      PSK username to use
  82        --pskkey=str           PSK key (in hex) to use
  83    -p, --port=str             The port or service to connect to
  84        --insecure             Don't abort program if server certificate can't be validated
  85        --benchmark-ciphers    Benchmark individual ciphers
  86        --benchmark-soft-ciphers  Benchmark individual software ciphers (no hw acceleration)
  87        --benchmark-tls        Benchmark ciphers and key exchange methods in TLS
  88    -l, --list                 Print a list of the supported algorithms and modes
  89    -v, --version[=arg]        Output version information and exit
  90    -h, --help                 Display extended usage information and exit
  91    -!, --more-help            Extended usage information passed thru pager
  92
  93 Options are specified by doubled hyphens and their name or by a single
  94 hyphen and the flag character.
  95 Operands and options may be intermixed.  They will be reordered.
  96
  97
  98
  99 Simple client program to set up a TLS connection to some other computer.  It
 100 sets up a TLS connection and forwards data from the standard input to the
 101 secured socket and vice versa.
 102
 103 please send bug reports to:  bug-gnutls@@gnu.org
 104 @end example
 105 @exampleindent 4
 106
 107 @anchor{gnutls-cli debug}
 108 @subheading debug option (-d)
 109 @cindex gnutls-cli-debug
 110
 111 This is the ``enable debugging.'' option.
 112 This option takes an argument number.
 113 Specifies the debug level.
 114 @anchor{gnutls-cli tofu}
 115 @subheading tofu option
 116 @cindex gnutls-cli-tofu
 117
 118 This is the ``enable trust on first use authentication'' option.
 119 This option will, in addition to certificate authentication, perform authentication based on previously seen public keys, a model similar to SSH authentication.
 120 @anchor{gnutls-cli ocsp}
 121 @subheading ocsp option
 122 @cindex gnutls-cli-ocsp
 123
 124 This is the ``enable ocsp certificate verification'' option.
 125 This option will enable verification of the peer's certificate using ocsp
 126 @anchor{gnutls-cli resume}
 127 @subheading resume option (-r)
 128 @cindex gnutls-cli-resume
 129
 130 This is the ``establish a session and resume'' option.
 131 Connect, establish a session, reconnect and resume.
 132 @anchor{gnutls-cli rehandshake}
 133 @subheading rehandshake option (-e)
 134 @cindex gnutls-cli-rehandshake
 135
 136 This is the ``establish a session and rehandshake'' option.
 137 Connect, establish a session and rehandshake immediately.
 138 @anchor{gnutls-cli starttls}
 139 @subheading starttls option (-s)
 140 @cindex gnutls-cli-starttls
 141
 142 This is the ``connect, establish a plain session and start tls.'' option.
 143 The TLS session will be initiated when EOF or a SIGALRM is received.
 144 @anchor{gnutls-cli priority}
 145 @subheading priority option
 146 @cindex gnutls-cli-priority
 147
 148 This is the ``priorities string'' option.
 149 This option takes an argument string.
 150 TLS algorithms and protocols to enable. You can
 151 use predefined sets of ciphersuites such as PERFORMANCE,
 152 NORMAL, SECURE128, SECURE256.
 153
 154 Check  the  GnuTLS  manual  on  section  ``Priority strings'' for more
 155 information on allowed keywords
 156 @anchor{gnutls-cli list}
 157 @subheading list option (-l)
 158 @cindex gnutls-cli-list
 159
 160 This is the ``print a list of the supported algorithms and modes'' option.
 161 Print a list of the supported algorithms and modes. If a priority string is given then only the enabled ciphersuites are shown.
 162 @anchor{gnutls-cli exit status}
 163 @subheading gnutls-cli exit status
 164
 165 One of the following exit values will be returned:
 166 @table @samp
 167 @item 0 (EXIT_SUCCESS)
 168 Successful program execution.
 169 @item 1 (EXIT_FAILURE)
 170 The operation failed or the command syntax was not valid.
 171 @end table
 172 @anchor{gnutls-cli See Also}
 173 @subheading gnutls-cli See Also
 174 gnutls-cli-debug(1), gnutls-serv(1)
 175
 176 @anchor{gnutls-cli Examples}
 177 @subheading gnutls-cli Examples
 178 @subheading Connecting using PSK authentication
 179 To connect to a server using PSK authentication, you need to enable the choice of PSK by using a cipher priority parameter such as in the example below.
 180 @example
 181 $ ./gnutls-cli -p 5556 localhost --pskusername psk_identity \
 182     --pskkey 88f3824b3e5659f52d00e959bacab954b6540344 \
 183     --priority NORMAL:-KX-ALL:+ECDHE-PSK:+DHE-PSK:+PSK
 184 Resolving 'localhost'...
 185 Connecting to '127.0.0.1:5556'...
 186 - PSK authentication.
 187 - Version: TLS1.1
 188 - Key Exchange: PSK
 189 - Cipher: AES-128-CBC
 190 - MAC: SHA1
 191 - Compression: NULL
 192 - Handshake was completed
 193
 194 - Simple Client Mode:
 195 @end example
 196 By keeping the --pskusername parameter and removing the --pskkey parameter, it will query only for the password during the handshake.
 197
 198 @subheading Listing ciphersuites in a priority string
 199 To list the ciphersuites in a priority string:
 200 @example
 201 $ ./gnutls-cli --priority SECURE192 -l
 202 Cipher suites for SECURE192
 203 TLS_ECDHE_ECDSA_AES_256_CBC_SHA384         0xc0, 0x24   TLS1.2
 204 TLS_ECDHE_ECDSA_AES_256_GCM_SHA384         0xc0, 0x2e   TLS1.2
 205 TLS_ECDHE_RSA_AES_256_GCM_SHA384           0xc0, 0x30   TLS1.2
 206 TLS_DHE_RSA_AES_256_CBC_SHA256             0x00, 0x6b   TLS1.2
 207 TLS_DHE_DSS_AES_256_CBC_SHA256             0x00, 0x6a   TLS1.2
 208 TLS_RSA_AES_256_CBC_SHA256                 0x00, 0x3d   TLS1.2
 209
 210 Certificate types: CTYPE-X.509
 211 Protocols: VERS-TLS1.2, VERS-TLS1.1, VERS-TLS1.0, VERS-SSL3.0, VERS-DTLS1.0
 212 Compression: COMP-NULL
 213 Elliptic curves: CURVE-SECP384R1, CURVE-SECP521R1
 214 PK-signatures: SIGN-RSA-SHA384, SIGN-ECDSA-SHA384, SIGN-RSA-SHA512, SIGN-ECDSA-SHA512
 215 @end example
 216