1 #summary Telnet command for showing TLS info

     2 

     3 = Introduction =

     4 

     5 This module adds two commands to the telnet console, `c2s:showtls()` and

     6 `s2s:showtls()`.  These commands shows TLS parameters, such as ciphers and key

     7 agreement protocols, of all c2s or s2s connections.

     8 

     9 = Configuration =

    10 

    11 Just add the module to the `modules_enabled` list.  There is no other configuration.

    12 

    13 {{{

    14 	modules_enabled = {

    15 		...

    16 			"telnet_tlsinfo";

    17 	}

    18 }}}

    19 

    20 = Usage =

    21 

    22 Simply type `c2s:showtls()` to show client connections or `s2s:showtls()`

    23 for server-to-server connections.  These commands can also take a JID for

    24 limiting output to matching users or servers.

    25 

    26 {{{

    27 s2s:showtls("prosody.im")

    28 | example.com	->	prosody.im

    29 |             protocol: TLSv1.1

    30 |               cipher: DHE-RSA-AES256-SHA

    31 |           encryption: AES(256)

    32 |              algbits: 256

    33 |                 bits: 256

    34 |       authentication: RSA

    35 |                  key: DH

    36 |                  mac: SHA1

    37 |               export: false

    38 }}}

    39 

    40 || *Field*        || *Description*                    ||

    41 ||       protocol || The protocol used. *Note*: With older LuaSec, this is the protocol that added the used cipher ||

    42 ||         cipher || The OpenSSL cipher string for the currently used cipher ||

    43 ||     encryption || Encryption algorithm used ||

    44 ||  bits, algbits || Secret bits involved in the cipher ||

    45 || authentication || The authentication algoritm used ||

    46 ||            mac || Message authentication algorithm used ||

    47 ||            key || Key exchange mechanism used. ||

    48 ||         export || Whethere an export cipher is used ||

    49 

    50 = Compatibility =

    51 

    52 ||0.9 with LuaSec 0.5||Works||

    53