fail2ban/common/protocol.py

# 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
# 
# $Revision: 456 $

__author__ = "Cyril Jaquier"
__version__ = "$Revision: 456 $"
__date__ = "$Date: 2006-11-12 11:56:40 +0100 (Sun, 12 Nov 2006) $"
__copyright__ = "Copyright (c) 2004 Cyril Jaquier"
__license__ = "GPL"

import textwrap

##
# Describes the protocol used to communicate with the server.

protocol = [
["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"], 
['', ''], 
["set loglevel <LEVEL>", "sets logging level to <LEVEL>"], 
["get loglevel", "gets the logging level"], 
["set logtarget <TARGET>", "sets logging target to <TARGET>"], 
["get logtarget", "gets logging target"], 
['', ''], 
["add <JAIL> <BACKEND>", "creates <JAIL> using <BACKEND>"], 
['', ''], 
["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>"], 
["set <JAIL> timeregex <REGEX>", "sets the regular expression <REGEX> to match the date format for <JAIL>"], 
["set <JAIL> timepattern <PATTERN>", "sets the pattern <PATTERN> to match the date format for <JAIL>"], 
["set <JAIL> failregex <REGEX>", "sets the regular expression <REGEX> which must match failures for <JAIL>"], 
["set <JAIL> ignoreregex <REGEX>", "sets the regular expression <REGEX> which should match pattern to exclude for <JAIL>"], 
["set <JAIL> maxtime <TIME>", "TODO"], 
["set <JAIL> findtime <TIME>", "TODO"], 
["set <JAIL> bantime <TIME>", "TODO"], 
["set <JAIL> maxretry <RETRY>", "TODO"], 
["set <JAIL> addaction <NAME>", "TODO"], 
["set <JAIL> delaction <NAME>", "TODO"], 
["set <JAIL> setcinfo <NAME> <VALUE>", "TODO"], 
["set <JAIL> delcinfo <NAME> <VALUE>", "TODO"], 
["set <JAIL> actionstart <NAME> <CMD>", "TODO"], 
["set <JAIL> actionstop <NAME> <CMD>", "TODO"], 
["set <JAIL> actioncheck <NAME> <CMD>", "TODO"], 
["set <JAIL> actionban <NAME> <CMD>", "TODO"],
["set <JAIL> actionunban <NAME> <CMD>", "TODO"], 
['', ''], 
["get <JAIL> <CMD>", "gets the <CMD> value for <JAIL>"],
["get <JAIL> logpath", "TODO"],
["get <JAIL> ignoreip", "TODO"],
["get <JAIL> timeregex", "TODO"],
["get <JAIL> timepattern", "TODO"],
["get <JAIL> failregex", "TODO"],
["get <JAIL> ignoreregex", "TODO"],
["get <JAIL> maxtime", "TODO"],
["get <JAIL> findtime", "TODO"],
["get <JAIL> bantime", "TODO"],
["get <JAIL> maxretry", "TODO"],
["get <JAIL> addaction", "TODO"],
["get <JAIL> actionstart <NAME>", "TODO"],
["get <JAIL> actionstop <NAME>", "TODO"],
["get <JAIL> actioncheck <NAME>", "TODO"],
["get <JAIL> actionban <NAME>", "TODO"],
["get <JAIL> actionunban <NAME>", "TODO"],
['', ''], 
["start <JAIL>", "starts <JAIL>"], 
["stop <JAIL>", "stops <JAIL>. The jail is removed"], 
["status <JAIL>", "gets the current status of <JAIL>"]
]

##
# Prints the protocol in a "man" format. This is used for the
# "-h" output of fail2ban-client.

def printFormatted():
	INDENT=4
	MARGIN=37
	WIDTH=38
	for m in protocol:
		if m[0] == '':
			print
		first = True
		for n in textwrap.wrap(m[1], WIDTH):
			if first:
				n = ' ' * INDENT + m[0] + ' ' * (MARGIN - len(m[0])) + n
				first = False
			else:
				n = ' ' * (INDENT + MARGIN) + n
			print n