annotate mod_telnet_tlsinfo.wiki @ 440:6e91b7ab36c1

update
author Kim Alvefur <zash@zash.se>
date Tue, 18 Mar 2014 15:10:53 +0100
parents b95d737dc014
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
367
11b391eb1a2a mod_telnet_tlsinfo: Add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 #summary Telnet command for showing TLS info
11b391eb1a2a mod_telnet_tlsinfo: Add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2
11b391eb1a2a mod_telnet_tlsinfo: Add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 = Introduction =
11b391eb1a2a mod_telnet_tlsinfo: Add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4
11b391eb1a2a mod_telnet_tlsinfo: Add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 This module adds two commands to the telnet console, `c2s:showtls()` and
11b391eb1a2a mod_telnet_tlsinfo: Add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6 `s2s:showtls()`. These commands shows TLS parameters, such as ciphers and key
11b391eb1a2a mod_telnet_tlsinfo: Add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 agreement protocols, of all c2s or s2s connections.
11b391eb1a2a mod_telnet_tlsinfo: Add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8
11b391eb1a2a mod_telnet_tlsinfo: Add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 = Configuration =
11b391eb1a2a mod_telnet_tlsinfo: Add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10
11b391eb1a2a mod_telnet_tlsinfo: Add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 Just add the module to the `modules_enabled` list. There is no other configuration.
11b391eb1a2a mod_telnet_tlsinfo: Add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12
11b391eb1a2a mod_telnet_tlsinfo: Add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 {{{
11b391eb1a2a mod_telnet_tlsinfo: Add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 modules_enabled = {
11b391eb1a2a mod_telnet_tlsinfo: Add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 ...
11b391eb1a2a mod_telnet_tlsinfo: Add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 "telnet_tlsinfo";
11b391eb1a2a mod_telnet_tlsinfo: Add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 }
11b391eb1a2a mod_telnet_tlsinfo: Add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 }}}
11b391eb1a2a mod_telnet_tlsinfo: Add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19
416
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
20 = Usage =
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
21
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
22 Simply type `c2s:showtls()` to show client connections or `s2s:showtls()`
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
23 for server-to-server connections. These commands can also take a JID for
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
24 limiting output to matching users or servers.
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
25
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
26 {{{
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
27 s2s:showtls("prosody.im")
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
28 | example.com -> prosody.im
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
29 | protocol: TLSv1.1
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
30 | cipher: DHE-RSA-AES256-SHA
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
31 | encryption: AES(256)
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
32 | algbits: 256
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
33 | bits: 256
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
34 | authentication: RSA
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
35 | key: DH
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
36 | mac: SHA1
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
37 | export: false
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
38 }}}
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
39
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
40 || *Field* || *Description* ||
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
41 || protocol || The protocol used. *Note*: With older LuaSec, this is the protocol that added the used cipher ||
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
42 || cipher || The OpenSSL cipher string for the currently used cipher ||
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
43 || encryption || Encryption algorithm used ||
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
44 || bits, algbits || Secret bits involved in the cipher ||
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
45 || authentication || The authentication algoritm used ||
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
46 || mac || Message authentication algorithm used ||
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
47 || key || Key exchange mechanism used. ||
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
48 || export || Whethere an export cipher is used ||
b95d737dc014 show and tell, example invocation and description of fields
Kim Alvefur <zash@zash.se>
parents: 367
diff changeset
49
367
11b391eb1a2a mod_telnet_tlsinfo: Add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
50 = Compatibility =
11b391eb1a2a mod_telnet_tlsinfo: Add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
51
11b391eb1a2a mod_telnet_tlsinfo: Add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
52 ||0.9 with LuaSec 0.5||Works||
11b391eb1a2a mod_telnet_tlsinfo: Add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
53