mirror of
https://github.com/fail2ban/fail2ban.git
synced 2026-03-11 08:55:31 +00:00
abd56dbedf
* master: (26 commits) DOC: added a note that coverage script is python-coverage on Debian systems Fixed typos Added additional Transmitter tests, and some associated fixes TODO: test filters/examples files add corresponding ChangeLog entry do catch all exception ENH: typo + head -1 has been deprecated for 10+ years. ENH: add help command BF: allow more than single word for command action[start,stop,ban,unban,check] and for setcinfo too BF: general Exception catch was excessive. Only IOError and OSError are possible and has different meanings Add development documentation and framework for code coverage measurement FSF address changes missing from previous refresh generated manpages (since 0.8.2 state) Downgrade log rotation detection message to DEBUG level from INFO. Closes: gh-129 BF: do not shutdown logging until all jails stop -- so move into Server.quit() BF: safeguard closing of log handlers + close in reverse order Added transmitter get cinfo option for action Fix for missing value in transmitter delaction Rewrite and enable server testcase for Transmitter ENH: adding more of diagnostic messages into -client while starting the daemon ...
144 lines
6.6 KiB
Python
144 lines
6.6 KiB
Python
# emacs: -*- mode: python; py-indent-offset: 4; indent-tabs-mode: t -*-
|
|
# vi: set ft=python sts=4 ts=4 sw=4 noet :
|
|
|
|
# This file is part of Fail2Ban.
|
|
#
|
|
# 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-1301, USA.
|
|
|
|
# Author: Cyril Jaquier
|
|
#
|
|
# $Revision$
|
|
|
|
__author__ = "Cyril Jaquier"
|
|
__version__ = "$Revision$"
|
|
__date__ = "$Date$"
|
|
__copyright__ = "Copyright (c) 2004 Cyril Jaquier"
|
|
__license__ = "GPL"
|
|
|
|
import textwrap
|
|
|
|
##
|
|
# Describes the protocol used to communicate with the server.
|
|
|
|
protocol = [
|
|
['', "BASIC", ""],
|
|
["start", "starts the server and the jails"],
|
|
["reload", "reloads the configuration"],
|
|
["reload <JAIL>", "reloads the jail <JAIL>"],
|
|
["stop", "stops all jails and terminate the server"],
|
|
["status", "gets the current status of the server"],
|
|
["ping", "tests if the server is alive"],
|
|
["help", "return this output"],
|
|
['', "LOGGING", ""],
|
|
["set loglevel <LEVEL>", "sets logging level to <LEVEL>. 0 is minimal, 4 is debug"],
|
|
["get loglevel", "gets the logging level"],
|
|
["set logtarget <TARGET>", "sets logging target to <TARGET>. Can be STDOUT, STDERR, SYSLOG or a file"],
|
|
["get logtarget", "gets logging target"],
|
|
['', "JAIL CONTROL", ""],
|
|
["add <JAIL> <BACKEND>", "creates <JAIL> using <BACKEND>"],
|
|
["start <JAIL>", "starts the jail <JAIL>"],
|
|
["stop <JAIL>", "stops the jail <JAIL>. The jail is removed"],
|
|
["status <JAIL>", "gets the current status of <JAIL>"],
|
|
['', "JAIL CONFIGURATION", ""],
|
|
["set <JAIL> idle on|off", "sets the idle state of <JAIL>"],
|
|
["set <JAIL> addignoreip <IP>", "adds <IP> to the ignore list of <JAIL>"],
|
|
["set <JAIL> delignoreip <IP>", "removes <IP> from the ignore list of <JAIL>"],
|
|
["set <JAIL> addlogpath <FILE>", "adds <FILE> to the monitoring list of <JAIL>"],
|
|
["set <JAIL> dellogpath <FILE>", "removes <FILE> from the monitoring list of <JAIL>"],
|
|
["set <JAIL> addfailregex <REGEX>", "adds the regular expression <REGEX> which must match failures for <JAIL>"],
|
|
["set <JAIL> delfailregex <INDEX>", "removes the regular expression at <INDEX> for failregex"],
|
|
["set <JAIL> addignoreregex <REGEX>", "adds the regular expression <REGEX> which should match pattern to exclude for <JAIL>"],
|
|
["set <JAIL> delignoreregex <INDEX>", "removes the regular expression at <INDEX> for ignoreregex"],
|
|
["set <JAIL> findtime <TIME>", "sets the number of seconds <TIME> for which the filter will look back for <JAIL>"],
|
|
["set <JAIL> bantime <TIME>", "sets the number of seconds <TIME> a host will be banned for <JAIL>"],
|
|
["set <JAIL> usedns <VALUE>", "sets the usedns mode for <JAIL>"],
|
|
["set <JAIL> banip <IP>", "manually Ban <IP> for <JAIL>"],
|
|
["set <JAIL> unbanip <IP>", "manually Unban <IP> in <JAIL>"],
|
|
["set <JAIL> maxretry <RETRY>", "sets the number of failures <RETRY> before banning the host for <JAIL>"],
|
|
["set <JAIL> maxlines <LINES>", "sets the number of <LINES> to buffer for regex search for <JAIL>"],
|
|
["set <JAIL> addaction <ACT>", "adds a new action named <NAME> for <JAIL>"],
|
|
["set <JAIL> delaction <ACT>", "removes the action <NAME> from <JAIL>"],
|
|
["set <JAIL> setcinfo <ACT> <KEY> <VALUE>", "sets <VALUE> for <KEY> of the action <NAME> for <JAIL>"],
|
|
["set <JAIL> delcinfo <ACT> <KEY>", "removes <KEY> for the action <NAME> for <JAIL>"],
|
|
["set <JAIL> actionstart <ACT> <CMD>", "sets the start command <CMD> of the action <ACT> for <JAIL>"],
|
|
["set <JAIL> actionstop <ACT> <CMD>", "sets the stop command <CMD> of the action <ACT> for <JAIL>"],
|
|
["set <JAIL> actioncheck <ACT> <CMD>", "sets the check command <CMD> of the action <ACT> for <JAIL>"],
|
|
["set <JAIL> actionban <ACT> <CMD>", "sets the ban command <CMD> of the action <ACT> for <JAIL>"],
|
|
["set <JAIL> actionunban <ACT> <CMD>", "sets the unban command <CMD> of the action <ACT> for <JAIL>"],
|
|
['', "JAIL INFORMATION", ""],
|
|
["get <JAIL> logpath", "gets the list of the monitored files for <JAIL>"],
|
|
["get <JAIL> ignoreip", "gets the list of ignored IP addresses for <JAIL>"],
|
|
["get <JAIL> failregex", "gets the list of regular expressions which matches the failures for <JAIL>"],
|
|
["get <JAIL> ignoreregex", "gets the list of regular expressions which matches patterns to ignore for <JAIL>"],
|
|
["get <JAIL> findtime", "gets the time for which the filter will look back for failures for <JAIL>"],
|
|
["get <JAIL> bantime", "gets the time a host is banned for <JAIL>"],
|
|
["get <JAIL> usedns", "gets the usedns setting for <JAIL>"],
|
|
["get <JAIL> maxretry", "gets the number of failures allowed for <JAIL>"],
|
|
["get <JAIL> maxlines", "gets the number of lines to buffer for <JAIL>"],
|
|
["get <JAIL> addaction", "gets the last action which has been added for <JAIL>"],
|
|
["get <JAIL> actionstart <ACT>", "gets the start command for the action <ACT> for <JAIL>"],
|
|
["get <JAIL> actionstop <ACT>", "gets the stop command for the action <ACT> for <JAIL>"],
|
|
["get <JAIL> actioncheck <ACT>", "gets the check command for the action <ACT> for <JAIL>"],
|
|
["get <JAIL> actionban <ACT>", "gets the ban command for the action <ACT> for <JAIL>"],
|
|
["get <JAIL> actionunban <ACT>", "gets the unban command for the action <ACT> for <JAIL>"],
|
|
["get <JAIL> cinfo <ACT> <KEY>", "gets the value for <KEY> for the action <ACT> for <JAIL>"],
|
|
]
|
|
|
|
##
|
|
# Prints the protocol in a "man" format. This is used for the
|
|
# "-h" output of fail2ban-client.
|
|
|
|
def printFormatted():
|
|
INDENT=4
|
|
MARGIN=41
|
|
WIDTH=34
|
|
firstHeading = False
|
|
for m in protocol:
|
|
if m[0] == '' and firstHeading:
|
|
print
|
|
firstHeading = True
|
|
first = True
|
|
for n in textwrap.wrap(m[1], WIDTH):
|
|
if first:
|
|
line = ' ' * INDENT + m[0] + ' ' * (MARGIN - len(m[0])) + n
|
|
first = False
|
|
else:
|
|
line = ' ' * (INDENT + MARGIN) + n
|
|
print line
|
|
|
|
##
|
|
# Prints the protocol in a "mediawiki" format.
|
|
|
|
def printWiki():
|
|
firstHeading = False
|
|
for m in protocol:
|
|
if m[0] == '':
|
|
if firstHeading:
|
|
print "|}"
|
|
__printWikiHeader(m[1], m[2])
|
|
firstHeading = True
|
|
else:
|
|
print "|-"
|
|
print "| <span style=\"white-space:nowrap;\"><tt>" + m[0] + "</tt></span> || || " + m[1]
|
|
print "|}"
|
|
|
|
def __printWikiHeader(section, desc):
|
|
print
|
|
print "=== " + section + " ==="
|
|
print
|
|
print desc
|
|
print
|
|
print "{|"
|
|
print "| '''Command''' || || '''Description'''"
|