2006-11-12 21:58:47 +00:00
# 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
# Author: Cyril Jaquier
#
2007-10-16 21:01:21 +00:00
# $Revision: 504 $
2006-11-12 21:58:47 +00:00
__author__ = " Cyril Jaquier "
2007-10-16 21:01:21 +00:00
__version__ = " $Revision: 504 $ "
__date__ = " $Date: 2006-12-23 17:37:17 +0100 (Sat, 23 Dec 2006) $ "
2006-11-12 21:58:47 +00:00
__copyright__ = " Copyright (c) 2004 Cyril Jaquier "
__license__ = " GPL "
import textwrap
##
# Describes the protocol used to communicate with the server.
protocol = [
2006-12-15 23:02:12 +00:00
[ ' ' , " Basic " , " " ] ,
2006-11-13 22:17:20 +00:00
[ " start " , " starts the server and the jails " ] ,
[ " reload " , " reloads the configuration " ] ,
[ " stop " , " stops all jails and terminate the server " ] ,
[ " status " , " gets the current status of the server " ] ,
[ " ping " , " tests if the server is alive " ] ,
2006-12-15 23:02:12 +00:00
[ ' ' , " Logging " , " " ] ,
2006-11-16 22:30:48 +00:00
[ " set loglevel <LEVEL> " , " sets logging level to <LEVEL>. 0 is minimal, 4 is debug " ] ,
2006-11-13 22:17:20 +00:00
[ " get loglevel " , " gets the logging level " ] ,
2006-11-16 22:30:48 +00:00
[ " set logtarget <TARGET> " , " sets logging target to <TARGET>. Can be STDOUT, STDERR, SYSLOG or a file " ] ,
2006-11-13 22:17:20 +00:00
[ " get logtarget " , " gets logging target " ] ,
2006-12-15 23:02:12 +00:00
[ ' ' , " Jail control " , " " ] ,
2006-11-13 22:17:20 +00:00
[ " add <JAIL> <BACKEND> " , " creates <JAIL> using <BACKEND> " ] ,
2006-12-15 23:02:12 +00:00
[ " 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 " , " " ] ,
2006-11-13 22:17:20 +00:00
[ " 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> to the monitoring list of <JAIL> " ] ,
2006-11-16 22:30:48 +00:00
[ " set <JAIL> timeregex <REGEX> " , " sets the regular expression <REGEX> to match the date format for <JAIL>. This will disable the autodetection feature. " ] ,
[ " set <JAIL> timepattern <PATTERN> " , " sets the pattern <PATTERN> to match the date format for <JAIL>. This will disable the autodetection feature. " ] ,
2006-12-23 16:31:00 +00:00
[ " 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 " ] ,
2006-11-16 22:30:48 +00:00
[ " 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> maxretry <RETRY> " , " sets the number of failures <RETRY> before banning the host 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> " ] ,
2006-12-15 23:02:12 +00:00
[ ' ' , " Jail information " , " " ] ,
2006-11-16 22:30:48 +00:00
[ " 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> timeregex " , " gets the regular expression used for the time detection for <JAIL> " ] ,
[ " get <JAIL> timepattern " , " gets the pattern used for the time detection for <JAIL> " ] ,
2006-12-23 16:31:00 +00:00
[ " 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> " ] ,
2006-11-16 22:30:48 +00:00
[ " 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> maxretry " , " gets the number of failures allowed 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> " ] ,
2006-11-12 21:58:47 +00:00
]
##
# Prints the protocol in a "man" format. This is used for the
# "-h" output of fail2ban-client.
def printFormatted ( ) :
INDENT = 4
2006-11-16 22:30:48 +00:00
MARGIN = 41
WIDTH = 34
2006-12-15 23:02:12 +00:00
firstHeading = False
2006-11-13 22:17:20 +00:00
for m in protocol :
2006-12-15 23:02:12 +00:00
if m [ 0 ] == ' ' and firstHeading :
2006-11-13 22:17:20 +00:00
print
2006-12-15 23:02:12 +00:00
firstHeading = True
2006-11-13 22:17:20 +00:00
first = True
for n in textwrap . wrap ( m [ 1 ] , WIDTH ) :
if first :
2006-12-15 23:02:12 +00:00
line = ' ' * INDENT + m [ 0 ] + ' ' * ( MARGIN - len ( m [ 0 ] ) ) + n
2006-11-13 22:17:20 +00:00
first = False
else :
2006-12-15 23:02:12 +00:00
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 ' ' ' "