Mercurial > prosody-wiki

annotate mod_s2s_blackwhitelist.wiki @ 213:7c960f1b4cf8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
added summary.
author maranda3985@gmail.com
date Sun, 11 Sep 2011 00:30:49 +0000
parents 9afa02b561fa
children 85a5bc45b8b9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
144
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
1 #summary Module for setting blacklist and whitelist on new server to server connections
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
2
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
3 = Introduction =
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
4
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
5 This module adds the functionality of blacklist and whitelist for new server to server connections (federation).
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
6
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
7
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
8 = Details =
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
9
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
10 If the configuration is changed then you can use console to issue "config:reload()" and this plugin will automatically reload the black/whitelists.
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
11
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
12 You can either choose whitelist or blacklist functionality (both can't co-exist).
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
13
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
14 Note: If a host with existing connections is blacklisted then this module will not tear down existing connection since that was created when the connection agreement was valid. You will need to use "s2s:close" command on console to manually close those connections.
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
15
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
16 = Configuration =
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
17
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
18 First define whether you need blacklist or whitelist,
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
19
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
20 {{{
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
21 s2s_enable_blackwhitelist = "whitelist" -- enable whitelist. use blacklist to use blacklists
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
22 }}}
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
23
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
24 Now create populate an array of domains in those lists
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
25
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
26 For whitelist,
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
27
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
28 {{{
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
29 s2s_whitelist = { "abc.net", "gmail.com", "xyz.net" }
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
30 }}}
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
31
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
32 For blacklist,
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
33
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
34 {{{
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
35 s2s_blacklist = { "gmail.com", "xyz.com" }
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
36 }}}
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
37
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
38 You can change configuration at runtime but need to use console plugin to reload configuration via "config:reload" command.
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
39
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
40 = Compatibility =
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
41
9afa02b561fa Created wiki page through web user interface.
gauravsri@gmail.com
parents:
diff changeset
42 || 0.7 || tested to work with dialbacks ||