annotate mod_host_guard.wiki @ 240:8b15faa008e3

added wiki.
author Marco Cirillo <maranda@lightwitch.org>
date Sun, 04 Dec 2011 15:49:27 +0000
parents
children 012884e6ba5d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
240
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
1 #summary Granular remote host blacklisting plugin
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
2 #labels Stage-Stable
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
3
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
4 = Details =
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
5
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
6 As often it's undesiderable to employ whitelisting logics in public environments, this module let's you more selectively
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
7 restrict access to your hosts (component or server host) either disallowing access completely or blacklisting certain sources.
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
8
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
9 = Usage =
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
10
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
11 Copy the plugin into your prosody's modules directory.
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
12 And add it between your enabled modules into the global section (modules_enabled):
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
13
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
14 * The plugin can work either by blocking all remote access (s2s) to a certain resource (useful for components)
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
15 * Or by selectively blocking certain remote hosts through blacklisting (by using host_guard_selective and host_guard_blacklisting)
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
16
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
17 Syntax:
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
18 {{{
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
19 host_guard_blockall = { "no_access.yourhost.com", "no_access2.yourhost.com" }
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
20 host_guard_selective = { "no_access_from_blsted.myhost.com", "no_access_from_blsted.mycomponent.com" }
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
21 host_guard_blacklist = { "remoterogueserver.com", "remoterogueserver2.com" }
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
22 }}}
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
23
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
24 = Compatibility =
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
25
8b15faa008e3 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
26 * Works with 0.8.x, successive versions and trunk.