Fail2ban

`services.fail2ban.banaction`

Default banning action (e.g. iptables, iptables-new, iptables-multiport, iptables-ipset-proto6-allports, shorewall, etc). It is used to define action_* variables. Can be overridden globally or per section within jail.local file

Type: string

Default

if config.networking.nftables.enable then "nftables-multiport" else "iptables-multiport"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/fail2ban.nix

`services.fail2ban.banaction-allports`

Default banning action (e.g. iptables, iptables-new, iptables-multiport, shorewall, etc) for "allports" jails. It is used to define action_* variables. Can be overridden globally or per section within jail.local file

Type: string

Default

if config.networking.nftables.enable then "nftables-allports" else "iptables-allports"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/fail2ban.nix

`services.fail2ban.bantime`

Number of seconds that a host is banned. Type: string

Default

"10m"

Example

"1h"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/fail2ban.nix

`services.fail2ban.bantime-increment.enable`

"bantime.increment" allows to use database for searching of previously banned ip's to increase a default ban time using special formula, default it is banTime * 1, 2, 4, 8, 16, 32 ...

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/fail2ban.nix

`services.fail2ban.bantime-increment.factor`

"bantime.factor" is a coefficient to calculate exponent growing of the formula or common multiplier, default value of factor is 1 and with default value of formula, the ban time grows by 1, 2, 4, 8, 16 ...

Type: null or string

Default

null

Example

"4"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/fail2ban.nix

`services.fail2ban.bantime-increment.formula`

"bantime.formula" used by default to calculate next value of ban time, default value bellow, the same ban time growing will be reached by multipliers 1, 2, 4, 8, 16, 32 ...

Type: null or string

Default

null

Example

"ban.Time * math.exp(float(ban.Count+1)*banFactor)/math.exp(1*banFactor)"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/fail2ban.nix

`services.fail2ban.bantime-increment.maxtime`

"bantime.maxtime" is the max number of seconds using the ban time can reach (don't grows further)

Type: null or string

Default

null

Example

"48h"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/fail2ban.nix

`services.fail2ban.bantime-increment.multipliers`

"bantime.multipliers" used to calculate next value of ban time instead of formula, corresponding previously ban count and given "bantime.factor" (for multipliers default is 1); following example grows ban time by 1, 2, 4, 8, 16 ... and if last ban count greater as multipliers count, always used last multiplier (64 in example), for factor '1' and original ban time 600 - 10.6 hours

Type: null or string

Default

null

Example

"1 2 4 8 16 32 64"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/fail2ban.nix

`services.fail2ban.bantime-increment.overalljails`

"bantime.overalljails" (if true) specifies the search of IP in the database will be executed cross over all jails, if false (default), only current jail of the ban IP will be searched.

Type: null or boolean

Default

null

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/fail2ban.nix

`services.fail2ban.bantime-increment.rndtime`

"bantime.rndtime" is the max number of seconds using for mixing with random time to prevent "clever" botnets calculate exact time IP can be unbanned again

Type: null or string

Default

null

Example

"8m"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/fail2ban.nix

`services.fail2ban.daemonSettings`

The contents of Fail2ban's main configuration file. It's generally not necessary to change it.

Type: attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string))

Default

{Definition = {logtarget = "SYSLOG";socket = "/run/fail2ban/fail2ban.sock";pidfile = "/run/fail2ban/fail2ban.pid";dbfile = "/var/lib/fail2ban/fail2ban.sqlite3";};}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/fail2ban.nix

`services.fail2ban.enable`

Whether to enable the fail2ban service.

See the documentation of {option}services.fail2ban.jails for what jails are enabled by default.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/fail2ban.nix

`services.fail2ban.extraPackages`

Extra packages to be made available to the fail2ban service. The example contains the packages needed by the iptables-ipset-proto6 action.

Type: list of package

Default

[ ]

Example

[ pkgs.ipset ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/fail2ban.nix

`services.fail2ban.ignoreIP`

"ignoreIP" can be a list of IP addresses, CIDR masks or DNS hosts. Fail2ban will not ban a host which matches an address in this list. Several addresses can be defined using space (and/or comma) separator.

Type: list of string

Default

[ ]

Example

["192.168.0.0/16""2001:DB8::42"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/fail2ban.nix

`services.fail2ban.jails`

The configuration of each Fail2ban “jail”. A jail consists of an action (such as blocking a port using {command}iptables) that is triggered when a filter applied to a log file triggers more than a certain number of times in a certain time period. Actions are defined in {file}/etc/fail2ban/action.d, while filters are defined in {file}/etc/fail2ban/filter.d.

NixOS comes with a default sshd jail; for it to work well, {option}services.openssh.logLevel should be set to "VERBOSE" or higher so that fail2ban can observe failed login attempts. This module sets it to "VERBOSE" if not set otherwise, so enabling fail2ban can make SSH logs more verbose.

Type: attribute set of (strings concatenated with "\n" or (submodule))

Default

{ }

Example

{apache-nohome-iptables = {settings = {# Block an IP address if it accesses a non-existent# home directory more than 5 times in 10 minutes,# since that indicates that it's scanning.filter = "apache-nohome";action = ''iptables-multiport[name=HTTP, port="http,https"]'';logpath = "/var/log/httpd/error_log*";backend = "auto";findtime = 600;bantime = 600;maxretry = 5;};};dovecot = {settings = {# block IPs which failed to log-in# aggressive mode add blocking for aborted connectionsfilter = "dovecot[mode=aggressive]";maxretry = 3;};};};