Go to file
sebres cd17906afe Merge branch '0.11' 2022-11-08 19:03:01 +01:00
.github Revert "check large nofile limit issue (#3334)" (back to original open files limit) 2022-08-17 16:04:10 +02:00
bin DOC: minor typos spotted around comments etc 2018-01-22 21:39:56 -05:00
config `filter.d/named-refused.conf` extended (closes gh-3388): 2022-11-03 11:41:21 +01:00
doc - performance of fail2ban optimized 2015-12-29 12:49:19 +01:00
fail2ban Merge branch '0.11' 2022-11-08 19:03:01 +01:00
files Merge pull request #2182 from orlitzky/openrc-improvements 2022-01-10 14:39:11 +01:00
man version bump 2022-09-27 22:57:50 +02:00
.coveragerc coverage 2018-07-04 20:16:11 +02:00
.gitattributes Revert "highlighting got broken, so comment out unless GH/linguist gets fixed" 2022-02-22 18:19:44 +01:00
.gitignore Add .idea dir to .gitignore 2014-12-30 17:52:45 -05:00
.mailmap ENH: .mailmap file to bring some names together for git shortlog -sn 2015-11-01 11:28:58 -05:00
.project - Added Eclipse project file 2006-10-17 21:24:27 +00:00
.pylintrc ENH: added a .pylintrc to help with consistent appearance and catch obvious problems 2011-10-04 10:55:16 -04:00
.travis.yml drop support for python 2.6 (hardly possible in modern CIs, new features would expect OrderedDicts, etc) 2022-02-10 15:48:51 +01:00
CONTRIBUTING.md Added to CONTRIBUTING.md minimal guidelines for PRs 2015-02-03 20:14:53 -05:00
COPYING - Added ISO 8601 date/time format. 2008-05-18 19:53:18 +00:00
ChangeLog `filter.d/named-refused.conf` extended (closes gh-3388): 2022-11-03 11:41:21 +01:00
DEVELOP Update information reg. ipdns.py as successor for dnsutils.py 2018-12-19 12:17:44 +01:00
FILTERS Add blank line so markdown renders correctly 2021-01-09 13:38:33 +01:00
MANIFEST release 1.0.1 -- energy-equals-mass-times-the-speed-of-light-squared 2022-09-27 18:27:51 +02:00
MANIFEST.in Add ignorecommands to MANIFEST*'s 2015-02-02 15:03:44 -05:00
README.Solaris DOC: minor changes just to trigger the build 2014-04-17 14:34:26 -04:00
README.md drop support for python 2.6 (hardly possible in modern CIs, new features would expect OrderedDicts, etc) 2022-02-10 15:48:51 +01:00
RELEASE Merge branch '0.9-fix-regex-using-journal' into 0.10-fix-regex-using-journal (merge point against 0.9 after back-porting gh-1660 from 0.10) 2017-01-10 11:25:41 +01:00
THANKS New logtarget: systemd-journal; 2022-08-29 12:30:05 +02:00
TODO DOC: deadlock resolved with locking introduced in 3a58d0e and d07df66 now uses subprocess.Popen. 2014-03-15 09:38:20 +11:00
Vagrantfile Vagrant with two Ubuntu Trusty64 boxes 2014-07-18 17:51:06 +02:00
fail2ban-2to3 TST: Fix up fail2ban python3 scripts 2013-04-13 17:01:18 +01:00
fail2ban-testcases-all ENH+TST: Move fail2ban-* scripts to bin/ 2013-04-01 19:06:13 +01:00
fail2ban-testcases-all-python3 TST: Fix up fail2ban python3 scripts 2013-04-13 17:01:18 +01:00
kill-server - Initial commit of the new development release 0.7 2006-06-26 20:05:00 +00:00
setup.cfg Merge branch 'master' into 0.9 2013-05-02 23:55:26 -04:00
setup.py Merge pull request #2182 from orlitzky/openrc-improvements 2022-01-10 14:39:11 +01:00

README.md

                     __      _ _ ___ _               
                    / _|__ _(_) |_  ) |__  __ _ _ _  
                   |  _/ _` | | |/ /| '_ \/ _` | ' \ 
                   |_| \__,_|_|_/___|_.__/\__,_|_||_|
                   v1.0.1.dev1            20??/??/??

Fail2Ban: ban hosts that cause multiple authentication errors

Fail2Ban scans log files like /var/log/auth.log and bans IP addresses conducting too many failed login attempts. It does this by updating system firewall rules to reject new connections from those IP addresses, for a configurable amount of time. Fail2Ban comes out-of-the-box ready to read many standard log files, such as those for sshd and Apache, and is easily configured to read any log file of your choosing, for any error you wish.

Though Fail2Ban is able to reduce the rate of incorrect authentication attempts, it cannot eliminate the risk presented by weak authentication. Set up services to use only two factor, or public/private authentication mechanisms if you really want to protect services.

Since v0.10 fail2ban supports the matching of IPv6 addresses.

This README is a quick introduction to Fail2Ban. More documentation, FAQ, and HOWTOs to be found on fail2ban(1) manpage, Wiki, Developers documentation and the website: https://www.fail2ban.org

Installation:

It is possible that Fail2Ban is already packaged for your distribution. In this case, you should use that instead.

Required:

Optional:

To install:

tar xvfj fail2ban-1.0.1.tar.bz2
cd fail2ban-1.0.1
sudo python setup.py install

Alternatively, you can clone the source from GitHub to a directory of Your choice, and do the install from there. Pick the correct branch, for example, master or 0.11

git clone https://github.com/fail2ban/fail2ban.git
cd fail2ban
sudo python setup.py install 

This will install Fail2Ban into the python library directory. The executable scripts are placed into /usr/bin, and configuration in /etc/fail2ban.

Fail2Ban should be correctly installed now. Just type:

fail2ban-client -h

to see if everything is alright. You should always use fail2ban-client and never call fail2ban-server directly. You can verify that you have the correct version installed with

fail2ban-client version

Please note that the system init/service script is not automatically installed. To enable fail2ban as an automatic service, simply copy the script for your distro from the files directory to /etc/init.d. Example (on a Debian-based system):

cp files/debian-initd /etc/init.d/fail2ban
update-rc.d fail2ban defaults
service fail2ban start

Configuration:

You can configure Fail2Ban using the files in /etc/fail2ban. It is possible to configure the server using commands sent to it by fail2ban-client. The available commands are described in the fail2ban-client(1) manpage. Also see fail2ban(1) and jail.conf(5) manpages for further references.

Code status:

  • travis-ci.org: tests status / tests status (0.11 branch) / tests status (0.10 branch)

  • coveralls.io: Coverage Status / Coverage Status (0.11 branch) / Coverage Status / (0.10 branch)

  • codecov.io: codecov.io / codecov.io (0.11 branch) / codecov.io (0.10 branch)

Contact:

Bugs, feature requests, discussions?

See CONTRIBUTING.md

You just appreciate this program:

Send kudos to the original author (Cyril Jaquier) or better to the mailing list since Fail2Ban is "community-driven" for years now.

Thanks:

See THANKS file.

License:

Fail2Ban is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Fail2Ban is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Fail2Ban; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA