Mercurial > prosody-modules

comparison mod_e2e_policy/README.markdown @ 2212:57dcad6543c9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_e2e_policy: Initial commit
author Michel Le Bihan <michel@lebihan.pl>
date Tue, 14 Jun 2016 18:03:05 +0200
parents
children 1815bf8b3cf9
comparison
equal deleted inserted replaced
2211:9aecf7c953ba 2212:57dcad6543c9
1 Introduction
2 ============
3
4 This module was written to encourage usage of End-to-end encryption for chat and MUC messages. It can be configured to warn the sender after every plaintext/unencrypted message or to block all plaintext/unencrypted messages. It also supports MUC and JID whitelisting, so administrators can for example whitelist public support MUCs ;-)
5
6 Configuration
7 =============
8
9 Enable the module as any other:
10
11 modules_enabled = {
12 "mod_e2e_policy";
13 }
14
15 You can then set some options to configure your desired policy:
16
17 Option Default Description
18 -------------------------------- --------------- -------------------------------------------------------------------------------------------------------------------------------------------------
19 e2e\_policy\_chat `"optional"` Policy for chat messages. Possible values: `"none"`, `"optional"` and `"required"`.
20 e2e\_policy\_muc `"optional"` Policy for MUC messages. Possible values: `"none"`, `"optional"` and `"required"`.
21 e2e\_policy\_whitelist `{ }` Make this module ignore messages sent to and from this JIDs or MUCs.
22 e2e\_policy\_message\_optional\_chat `""` Set a custom warning message for chat messages.
23 e2e\_policy\_message\_required\_chat `""` Set a custom error message for chat messages.
24 e2e\_policy\_message\_optional\_muc `""` Set a custom warning message for MUC messages.
25 e2e\_policy\_message\_required\_muc `""` Set a custom error message for MUC messages.
26
27 Some examples:
28
29 e2e_policy_chat = "optional"
30 e2e_policy_muc = "optional"
31 e2e_policy_whitelist = { "admin@example.com", "prosody@conference.prosody.im" }
32 e2e_policy_message_optional_chat = "For security reasons, OMEMO, OTR or PGP encryption is STRONGLY recommended for conversations on this server."
33 e2e_policy_message_required_chat = "For security reasons, OMEMO, OTR or PGP encryption is required for conversations on this server."
34 e2e_policy_message_optional_muc = "For security reasons, OMEMO, OTR or PGP encryption is STRONGLY recommended for MUC on this server."
35 e2e_policy_message_required_muc = "For security reasons, OMEMO, OTR or PGP encryption is required for MUC on this server."
36
37 Compatibility
38 =============
39
40 ----- -------------
41 trunk Works
42 0.10 Should work
43 0.9 Should work
44 ----- -------------
45
46