Mercurial > prosody-modules

comparison mod_limit_auth/README.markdown @ 1858:5daabb5fe24a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_limit_auth: Add README
author Kim Alvefur <zash@zash.se>
date Mon, 14 Sep 2015 13:36:29 +0200
parents
children 4916c1b6517f
comparison
equal deleted inserted replaced
1857:5a19ccd8457a 1858:5daabb5fe24a
1 ---
2 summary: Throttle authentication attempts with optional tarpit
3 ...
4
5 Introduction
6 ============
7
8 This module lets you put a per-IP limit on the number of failed
9 authentication attempts.
10
11 It features an optioanal
12 [tarpit](https://en.wikipedia.org/wiki/Tarpit_%28networking%29), i.e.
13 waiting some time before returning an "authentication failed" response.
14
15 Configuration
16 =============
17
18 ``` {.lua}
19 modules_enabled = {
20 -- your other modules
21 "limit_auth";
22 }
23
24 limit_auth_period = 30 -- over 30 seconds
25
26 limit_auth_max = 5 -- tolerate no more than 5 failed attempts
27
28 -- Will only work with Prosody 0.10:
29 limit_auth_tarpit_delay = 10 -- delay answer this long
30 ```
31
32 Compatibility
33 =============
34
35 Requires 0.9 or later. The tarpit feature requires Prosody 0.10 or
36 later.