view mod_limit_auth/README.markdown @ 4451:f1a63271dcfc

Add tag 'Statistics' to some modules to ease discoverability Description doesn't mention stats or statistics, so doesn't show up if you search for that.
author Kim Alvefur <zash@zash.se>
date Fri, 19 Feb 2021 23:42:12 +0100
parents 4916c1b6517f
children
line wrap: on
line source

---
summary: Throttle authentication attempts with optional tarpit
...

Introduction
============

This module lets you put a per-IP limit on the number of failed
authentication attempts.

It features an optioanal
[tarpit](https://en.wikipedia.org/wiki/Tarpit_%28networking%29), i.e.
waiting some time before returning an "authentication failed" response.

Configuration
=============

``` {.lua}
modules_enabled = {
  -- your other modules
  "limit_auth";
}

limit_auth_period = 30 -- over 30 seconds

limit_auth_max = 5 -- tolerate no more than 5 failed attempts

 -- Will only work with Prosody trunk:
limit_auth_tarpit_delay = 10 -- delay answer this long
```

Compatibility
=============

Requires 0.9 or later. The tarpit feature requires Prosody trunk.