comparison mod_telnet_tlsinfo/README.markdown @ 1803:4d73a1a6ba68

Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parents mod_telnet_tlsinfo/README.wiki@29f3d6b7ad16
children 8de50be756e5
comparison
equal deleted inserted replaced
1802:0ab737feada6 1803:4d73a1a6ba68
1 ---
2 summary: Telnet command for showing TLS info
3 ...
4
5 Introduction
6 ============
7
8 This module adds two commands to the telnet console, `c2s:showtls()` and
9 `s2s:showtls()`. These commands shows TLS parameters, such as ciphers
10 and key agreement protocols, of all c2s or s2s connections.
11
12 Configuration
13 =============
14
15 Just add the module to the `modules_enabled` list. There is no other
16 configuration.
17
18 modules_enabled = {
19 ...
20 "telnet_tlsinfo";
21 }
22
23 Usage
24 =====
25
26 Simply type `c2s:showtls()` to show client connections or
27 `s2s:showtls()` for server-to-server connections. These commands can
28 also take a JID for limiting output to matching users or servers.
29
30 s2s:showtls("prosody.im")
31 | example.com -> prosody.im
32 | protocol: TLSv1.1
33 | cipher: DHE-RSA-AES256-SHA
34 | encryption: AES(256)
35 | algbits: 256
36 | bits: 256
37 | authentication: RSA
38 | key: DH
39 | mac: SHA1
40 | export: false
41
42 Field Description
43 ---------------- -------------------------------------------------------------------------------------------------
44 protocol The protocol used. **Note**: With older LuaSec, this is the protocol that added the used cipher
45 cipher The OpenSSL cipher string for the currently used cipher
46 encryption Encryption algorithm used
47 bits, algbits Secret bits involved in the cipher
48 authentication The authentication algoritm used
49 mac Message authentication algorithm used
50 key Key exchange mechanism used.
51 export Whethere an export cipher is used
52
53 Compatibility
54 =============
55
56 --------------------- -------
57 0.9 with LuaSec 0.5 Works
58 --------------------- -------