src/pt-tls-client/pt-tls-client.1.in

   1 .TH PT-TLS-CLIENT 1 "2017-07-15" "@PACKAGE_VERSION@" "strongSwan"
   2 .
   3 .SH "NAME"
   4 .
   5 pt-tls-client \- Simple client using PT-TLS to collect integrity information
   6 .
   7 .SH "SYNOPSIS"
   8 .
   9 .SY "pt-tls-client"
  10 .BI \-\-connect
  11 .IR hostname |\fIaddress
  12 .OP \-\-port hex
  13 .RB [ \-\-cert
  14 .IR file ]+
  15 .RB [ \-\-keyid
  16 .IR hex |\fB\-\-key
  17 .IR file ]
  18 .RB [ \-\-key-type
  19 .BR rsa |\fBecdsa\fR]
  20 .OP \-\-client client-id
  21 .OP \-\-secret password
  22 .OP \-\-mutual
  23 .OP \-\-optionsfrom filename
  24 .OP \-\-quiet
  25 .OP \-\-debug level
  26 .YS
  27 .
  28 .SY "pt-tls-client"
  29 .B \-h
  30 |
  31 .B \-\-help
  32 .YS
  33 .
  34 .SH "DESCRIPTION"
  35 .
  36 .B pt-tls-client
  37 is a simple client using the PT-TLS (RFC 6876) transport protocol to collect
  38 integrity measurements on the client platform. PT-TLS does an initial TLS
  39 handshake with certificate-based server authentication and optional
  40 certificate-based client authentication.  Alternatively simple password-based
  41 SASL client authentication protected by TLS can be used.
  42 .P
  43 Attribute requests and integrity measurements are exchanged via the PA-TNC (RFC
  44 5792) message protocol between any number of Integrity Measurement Verifiers
  45 (IMVs) residing on the remote PT-TLS server and multiple Integrity Measurement
  46 Collectors (IMCs) loaded dynamically by the PT-TLS client according to a list
  47 defined by \fI/etc/tnc_config\fR. PA-TNC messages that contain one or several
  48 PA-TNC attributes are multiplexed into PB-TNC (RFC 5793) client or server data
  49 batches which in turn are transported via PT-TLS.
  50 .
  51 .SH "OPTIONS"
  52 .
  53 .TP
  54 .B "\-h, \-\-help"
  55 Prints usage information and a short summary of the available commands.
  56 .TP
  57 .BI "\-c, \-\-connect " hostname\fR|\fIaddress
  58 Set the hostname or IP address of the PT-TLS server.
  59 .TP
  60 .BI "\-p, \-\-port " port
  61 Set the port of the PT-TLS server, default: 271.
  62 .TP
  63 .BI "\-x, \-\-cert " file
  64 Set the path to an X.509 certificate file. This option can be repeated to load
  65 multiple client and CA certificates.
  66 .TP
  67 .BI "\-k, \-\-key " file
  68 Set the path to the client's PKCS#1 or PKCS#8 private key file
  69 .TP
  70 .BI "\-t, \-\-key\-type " type
  71 Define the type of the private key if stored in PKCS#1 format. Can be omitted
  72 with PKCS#8 keys.
  73 .TP
  74 .BI "\-x, \-\-keyid " hex
  75 Set the keyid of the private key stored in a smartcard or a TPM 2.0 Trusted
  76 Platform Module.
  77 .TP
  78 .BI "\-i, \-\-client " client-id
  79 Set the username or client ID of the client required for password-based SASL
  80 authentication.
  81 .TP
  82 .BI "\-s, \-\-secret " password
  83 Set the preshared secret or client password required for password-based SASL
  84 authentication.
  85 .TP
  86 .B "\-q, \-\-mutual
  87 Enable mutual attestation between PT-TLS client and PT-TLS server.
  88 .TP
  89 .BI "\-v, \-\-debug " level
  90 Set debug level, default: 1.
  91 .TP
  92 .B "\-q, \-\-quiet
  93 Disable debug output to stderr.
  94 .TP
  95 .BI "\-+, \-\-optionsfrom " file
  96 Read command line options from \fIfile\fR.
  97 .
  98 .SH "EXAMPLES"
  99 .
 100 Connect to a PT-TLS server using certificate-based authentication,
 101 storing the private ECDSA key in a file:
 102 .PP
 103 .EX
 104   pt-tls-client \-\-connect pdp.example.com \-\-cert ca.crt \\
 105                 \-\-cert client.crt \-\-key client.key \-\-key\-type ecdsa
 106 .EE
 107 .PP
 108 Connect to a PT-TLS server using certificate-based authentication,
 109 storing the private key in a smartcard or a TPM 2.0 Trusted Platform Module:
 110 .PP
 111 .EX
 112   pt-tls-client \-\-connect pdp.example.com \-\-cert ca.crt \\
 113                 \-\-cert client.crt \-\-keyid 0x81010002
 114 .EE
 115 .PP
 116 Connect to a PT-TLS server listening on port 443, using SASL password-based
 117 authentication:
 118 .PP
 119 .EX
 120   pt-tls-client \-\-connect pdp.example.com --port 443 \-\-cert ca.crt \\
 121                 \-\-client jane \-\-password p2Nl9trKlb
 122 .EE
 123 .SH FILES
 124 .TP
 125 /etc/tnc_config
 126 .
 127 .SH "SEE ALSO"
 128 .
 129 .BR strongswan.conf (5)
 130