نام (NAME)

fail2ban-client - پیکربندی و کنترل کارگزار Fail2Ban

خلاصه دستور (SYNOPSIS)

fail2ban-client [گزینه‌ها] <فرمان>

توضیحات (DESCRIPTION)

برنامه Fail2Ban v1.1.1 فایل‌های گزارشی را که حاوی گزارش شکست‌های احراز هویت (گذرواژه) هستند می‌خواند و نشانی‌های IP متناظر را با استفاده از قوانین دیواره آتش مسدود (ban) می‌کند.

گزینه‌ها (OPTIONS)

-c, --conf <DIR>

دایرکتوری پیکربندی

-s, --socket <FILE>

مسیر فایل سوکت

-p, --pidfile <FILE>

مسیر فایل شناسه فرایند (pidfile)

--pname <NAME>

نام فرایند (رشته اصلی) برای شناسایی نمونه (پیش‌فرض fail2ban-server)

--loglevel <LEVEL>

سطح ثبت گزارش

--logtarget <TARGET>

مقصد ثبت گزارش؛ استفاده از نام فایل یا stdout، stderr، syslog یا sysout.

--syslogsocket auto|<FILE>

-d

تخلیه پیکربندی؛ جهت اشکال‌زدایی

--dp, --dump-pretty

تخلیه پیکربندی با ساختاری خواناتر برای انسان

-t, --test

آزمایش پیکربندی (می‌تواند همراه با پارامترهای راه‌اندازی نیز مشخص شود)

-i

حالت تعاملی

-v

افزایش سطح پرگویی (verbosity)

-q

کاهش سطح پرگویی (verbosity)

-x

اجرای اجباری کارگزار (حذف فایل سوکت پیشین)

-b

اجرای کارگزار در پس‌زمینه (پیش‌فرض)

-f

اجرای کارگزار در پیش‌زمینه

--async

اجرای کارگزار در حالت ناهمگام (صرفاً برای استفاده داخلی، پیکربندی را نمی‌خواند)

--timeout

مدت‌زمان انتظار برای کارگزار (صرفاً برای استفاده داخلی، پیکربندی را نمی‌خواند)

--str2sec <STRING>

تبدیل قالب اختصاری زمان به ثانیه

-h, --help

نمایش این پیام راهنما

-V, --version

چاپ نسخه برنامه (گزینه -V قالب کوتاه ماشین‌خوان را برمی‌گرداند)

فرمان‌ها (COMMANDS)

پایه (BASIC)

start

کارگزار و تمام زندان‌ها را راه‌اندازی می‌کند

restart

کارگزار را مجدداً راه‌اندازی می‌کند

restart [--unban] [--if-exists] <JAIL>

زندان <JAIL> را مجدداً راه‌اندازی می‌کند (نام مستعاری برای 'reload --restart ... <JAIL>')

reload [--restart] [--unban] [--all]

پیکربندی را بدون راه‌اندازی مجدد کارگزار بازخوانی می‌کند؛ گزینه --restart راه‌اندازی مجدد کامل زندان‌های متأثر را فعال می‌کند و در نتیجه می‌تواند نشانی‌های IP را رفع مسدودیت (unban) کند (اگر گزینه --unban مشخص شده باشد)

reload [--restart] [--unban] [--if-exists] <JAIL>

زندان <JAIL> را بازخوانی کرده، یا آن را مجدداً راه‌اندازی می‌کند (اگر گزینه --restart مشخص شده باشد)

stop

تمام زندان‌ها را متوقف کرده و به کار کارگزار خاتمه می‌دهد

unban --all

رفع مسدودیت تمام نشانی‌های IP (در تمام زندان‌ها و پایگاه داده)

unban <IP> ... <IP>

رفع مسدودیت <IP> (در تمام زندان‌ها و پایگاه داده)

banned

زندان‌های دارای نشانی‌های IP مسدودشده را به صورت یک دیکشنری برمی‌گرداند

banned <IP> ... <IP>]

فهرستی از زندان‌هایی را که IPهای داده‌شده در آن‌ها مسدود هستند برمی‌گرداند

status

وضعیت کنونی کارگزار را دریافت می‌کند

status --all [FLAVOR]

وضعیت کنونی تمام زندان‌ها را با سبک خروجی اختیاری [FLAVOR] دریافت می‌کند. سبک‌ها: 'basic' (پیش‌فرض)، 'cymru'، 'short'، و 'stats'

stat[istic]s

آمار کنونی تمام زندان‌ها را در قالب یک جدول دریافت می‌کند

ping

بررسی می‌کند که آیا کارگزار فعال و پاسخگو است یا خیر

echo

برای استفاده داخلی؛ رشته داده‌شده را بازگردانده و در خروجی چاپ می‌کند

version

نسخه کارگزار را برمی‌گرداند

ثبت گزارش (LOGGING)

set loglevel <LEVEL>

سطح ثبت گزارش را روی <LEVEL> تنظیم می‌کند. سطوح: CRITICAL، ERROR، WARNING، NOTICE، INFO، DEBUG، TRACEDEBUG، HEAVYDEBUG یا مقدار عددی متناظر (50-5)

get loglevel

سطح فعلی ثبت گزارش را دریافت می‌کند

set logtarget <TARGET>

مقصد ثبت گزارش را روی <TARGET> تنظیم می‌کند. می‌تواند STDOUT، STDERR، SYSLOG، SYSTEMD-JOURNAL یا یک فایل باشد

get logtarget

مقصد فعلی ثبت گزارش را دریافت می‌کند

set syslogsocket auto|<SOCKET>

مسیر سوکت syslog را روی auto یا <SOCKET> تنظیم می‌کند. تنها زمانی استفاده می‌شود که مقصد ثبت گزارش SYSLOG باشد

get syslogsocket

مسیر سوکت syslog را دریافت می‌کند

flushlogs

در صورتی که مقصد ثبت گزارش یک فایل باشد، آن را تخلیه کرده و مجدداً باز می‌کند؛ جهت چرخش گزارش‌ها (log rotation)

پایگاه داده (DATABASE)

set dbfile <FILE>

محل ذخیره‌گاه داده‌های ماندگار fail2ban را مشخص می‌کند. برای غیرفعال‌سازی، آن را روی "None" تنظیم کنید

get dbfile

محل ذخیره‌گاه داده‌های ماندگار fail2ban را دریافت می‌کند

set dbmaxmatches <INT>

حداکثر تعداد تطابق‌های ذخیره‌شده در پایگاه داده به ازای هر بلیت (ticket) را تنظیم می‌کند

get dbmaxmatches

حداکثر تعداد تطابق‌های ذخیره‌شده در پایگاه داده به ازای هر بلیت (ticket) را دریافت می‌کند

set dbpurgeage <SECONDS>

حداکثر زمان به ثانیه (<SECONDS>) را برای نگهداری تاریخچه مسدودیت‌ها تنظیم می‌کند

get dbpurgeage

حداکثر زمان به ثانیه را برای نگهداری تاریخچه مسدودیت‌ها دریافت می‌کند

کنترل زندان (JAIL CONTROL)

add <JAIL> <BACKEND>

زندان <JAIL> را با استفاده از موتور پس‌زمینه <BACKEND> ایجاد می‌کند

start <JAIL>

زندان <JAIL> را راه‌اندازی می‌کند

stop <JAIL>

زندان <JAIL> را متوقف می‌کند؛ زندان مربوطه حذف می‌شود

status <JAIL> [FLAVOR]

وضعیت کنونی زندان <JAIL> را با سبک خروجی اختیاری [FLAVOR] دریافت می‌کند. سبک‌ها: 'basic' (پیش‌فرض)، 'cymru'، 'short'، و 'stats'

پیکربندی زندان (JAIL CONFIGURATION)

set <JAIL> idle on|off

وضعیت بیکاری (idle) زندان <JAIL> را تنظیم می‌کند

set <JAIL> ignoreself true|false

امکان نادیده گرفتن نشانی‌های IP خودی را فراهم می‌کند

set <JAIL> addignoreip <IP>

نشانی <IP> را به فهرست نادیده‌گرفته‌های زندان <JAIL> اضافه می‌کند

set <JAIL> delignoreip <IP>

نشانی <IP> را از فهرست نادیده‌گرفته‌های زندان <JAIL> حذف می‌کند

set <JAIL> ignorecommand <VALUE>

دستور نادیده‌گیری (ignorecommand) مربوط به زندان <JAIL> را تنظیم می‌کند

set <JAIL> ignorecache <VALUE>

کش نادیده‌گیری (ignorecache) مربوط به زندان <JAIL> را تنظیم می‌کند

set <JAIL> addlogpath <FILE> ['tail']

فایل <FILE> را به فهرست نظارت زندان <JAIL> اضافه می‌کند؛ به صورت اختیاری از انتهای فایل ('tail') شروع به خواندن می‌کند (پیش‌فرض 'head' است).

set <JAIL> dellogpath <FILE>

فایل <FILE> را از فهرست نظارت زندان <JAIL> حذف می‌کند

set <JAIL> logencoding <ENCODING>

کدگذاری (<ENCODING>) فایل‌های گزارش زندان <JAIL> را تنظیم می‌کند

set <JAIL> addjournalmatch <MATCH>

عبارت تطابق <MATCH> را به فیلتر ژورنال زندان <JAIL> اضافه می‌کند

set <JAIL> deljournalmatch <MATCH>

عبارت تطابق <MATCH> را از فیلتر ژورنال زندان <JAIL> حذف می‌کند

set <JAIL> addfailregex <REGEX>

عبارت باقاعده <REGEX> را که باید با شکست‌ها در زندان <JAIL> تطابق یابد اضافه می‌کند

set <JAIL> delfailregex <INDEX>

عبارت باقاعده موجود در نمایه <INDEX> را برای failregex حذف می‌کند

set <JAIL> addignoreregex <REGEX>

عبارت باقاعده <REGEX> را برای تطابق با الگوهایی که باید برای زندان <JAIL> نادیده گرفته شوند اضافه می‌کند

set <JAIL> delignoreregex <INDEX>

عبارت باقاعده موجود در نمایه <INDEX> را برای ignoreregex حذف می‌کند

set <JAIL> findtime <TIME>

مدت‌زمان به ثانیه (<TIME>) را که فیلتر برای بررسی رخدادها به گذشته می‌نگرد برای زندان <JAIL> تنظیم می‌کند

set <JAIL> bantime <TIME>

مدت‌زمان به ثانیه (<TIME>) را که یک میزبان برای زندان <JAIL> مسدود می‌ماند تنظیم می‌کند

set <JAIL> datepattern <PATTERN>

الگوی <PATTERN> مورد استفاده برای تطابق تاریخ و زمان را برای زندان <JAIL> تنظیم می‌کند

set <JAIL> usedns <VALUE>

حالت usedns را برای زندان <JAIL> تعیین می‌کند

set <JAIL> attempt <IP> [<failure1> ... <failureN>]

اعلام دستی رخداد شکست برای نشانی <IP>

set <JAIL> banip <IP> ... <IP>

مسدودسازی دستی نشانی <IP> برای زندان <JAIL>

set <JAIL> unbanip [--report-absent] <IP> ... <IP>

رفع مسدودیت دستی نشانی <IP> در زندان <JAIL>

set <JAIL> maxretry <RETRY>

تعداد شکست‌های مجاز (<RETRY>) را پیش از مسدود شدن میزبان برای زندان <JAIL> تنظیم می‌کند

set <JAIL> maxmatches <INT>

حداکثر تعداد تطابق‌های ذخیره‌شده در حافظه به ازای هر بلیت در زندان <JAIL> را تنظیم می‌کند

set <JAIL> maxlines <LINES>

تعداد خطوط (<LINES>) بافر برای جستجوی عبارت باقاعده در زندان <JAIL> را تنظیم می‌کند

set <JAIL> addaction <ACT>[ <PYTHONFILE> <JSONKWARGS>]

یک اقدام جدید به نام <ACT> برای زندان <JAIL> اضافه می‌کند. به صورت اختیاری برای یک اقدام مبتنی بر پایتون، می‌توان <PYTHONFILE> و <JSONKWARGS> را مشخص کرد؛ در غیر این صورت یک اقدام دستوری (Command Action) خواهد بود

set <JAIL> delaction <ACT>

اقدام <ACT> را از زندان <JAIL> حذف می‌کند

پیکربندی دستور اقدام (COMMAND ACTION CONFIGURATION)

set <JAIL> action <ACT> actionstart <CMD>

دستور شروع (<CMD>) اقدام <ACT> را برای زندان <JAIL> تنظیم می‌کند

set <JAIL> action <ACT> actionstop <CMD>

دستور توقف (<CMD>) اقدام <ACT> را برای زندان <JAIL> تنظیم می‌کند

set <JAIL> action <ACT> actioncheck <CMD>

دستور بررسی (<CMD>) اقدام <ACT> را برای زندان <JAIL> تنظیم می‌کند

set <JAIL> action <ACT> actionban <CMD>

دستور مسدودسازی (<CMD>) اقدام <ACT> را برای زندان <JAIL> تنظیم می‌کند

set <JAIL> action <ACT> actionunban <CMD>

دستور رفع مسدودیت (<CMD>) اقدام <ACT> را برای زندان <JAIL> تنظیم می‌کند

set <JAIL> action <ACT> timeout <TIMEOUT>

مهلت زمانی اجرای دستور (<TIMEOUT>) به ثانیه را برای اقدام <ACT> در زندان <JAIL> تعیین می‌کند

پیکربندی عمومی اقدام (GENERAL ACTION CONFIGURATION)

set <JAIL> action <ACT> <PROPERTY> <VALUE>

مقدار <VALUE> ویژگی <PROPERTY> را برای اقدام <ACT> در زندان <JAIL> تنظیم می‌کند

set <JAIL> action <ACT> <METHOD>[ <JSONKWARGS>]

متد <METHOD> را با آرگومان‌های <JSONKWARGS> برای اقدام <ACT> در زندان <JAIL> فراخوانی می‌کند

اطلاعات زندان (JAIL INFORMATION)

get <JAIL> banned

نشانی‌های IP مسدودشده زندان <JAIL> را برمی‌گرداند

get <JAIL> banned <IP> ... <IP>]

اگر نشانی IP در زندان <JAIL> مسدود باشد مقدار 1 و در غیر این صورت 0، یا فهرستی از 1/0 را برای چندین IP برمی‌گرداند

get <JAIL> logpath

فهرست فایل‌های تحت نظارت را برای زندان <JAIL> دریافت می‌کند

get <JAIL> logencoding

کدگذاری فایل‌های گزارش را برای زندان <JAIL> دریافت می‌کند

get <JAIL> journalmatch

تطابق فیلتر ژورنال را برای زندان <JAIL> دریافت می‌کند

get <JAIL> ignoreself

مقدار کنونی نادیده‌گیری نشانی‌های IP خودی را دریافت می‌کند

get <JAIL> ignoreip

فهرست نشانی‌های IP نادیده‌گرفته‌شده را برای زندان <JAIL> دریافت می‌کند

get <JAIL> ignorecommand

دستور نادیده‌گیری (ignorecommand) مربوط به زندان <JAIL> را دریافت می‌کند

get <JAIL> failregex

فهرست عبارات باقاعده‌ای را که با شکست‌ها در زندان <JAIL> مطابقت دارند دریافت می‌کند

get <JAIL> ignoreregex

فهرست عبارات باقاعده‌ای را که با الگوهای نادیده‌گیری در زندان <JAIL> مطابقت دارند دریافت می‌کند

get <JAIL> findtime

مدت‌زمانی را که فیلتر برای یافتن شکست‌ها در زندان <JAIL> به عقب بررسی می‌کند دریافت می‌کند

get <JAIL> bantime

مدت‌زمانی را که یک میزبان در زندان <JAIL> مسدود می‌ماند دریافت می‌کند

get <JAIL> datepattern

الگوی مورد استفاده برای مطابقت تاریخ و زمان در زندان <JAIL> را دریافت می‌کند

get <JAIL> usedns

تنظیمات usedns را برای زندان <JAIL> دریافت می‌کند

get <JAIL> banip [<SEP>|--with-time]

فهرست نشانی‌های IP مسدودشده را برای زندان <JAIL> دریافت می‌کند. به صورت اختیاری می‌توان نویسه جداکننده ('<SEP>'، پیش‌فرض فاصله است) یا گزینه --with-time (جهت چاپ زمان‌های مسدودیت) را مشخص کرد. نشانی‌های IP بر اساس زمان پایان مسدودیت مرتب می‌شوند.

get <JAIL> maxretry

تعداد شکست‌های مجاز برای زندان <JAIL> را دریافت می‌کند

get <JAIL> maxmatches

حداکثر تعداد تطابق‌های ذخیره‌شده در حافظه به ازای هر بلیت در زندان <JAIL> را دریافت می‌کند

get <JAIL> maxlines

تعداد خطوط بافر برای زندان <JAIL> را دریافت می‌کند

get <JAIL> actions

فهرستی از اقدام‌های تعریف‌شده برای زندان <JAIL> را دریافت می‌کند

اطلاعات دستور اقدام (COMMAND ACTION INFORMATION)

get <JAIL> action <ACT> actionstart

دستور شروع اقدام <ACT> را برای زندان <JAIL> دریافت می‌کند

get <JAIL> action <ACT> actionstop

دستور توقف اقدام <ACT> را برای زندان <JAIL> دریافت می‌کند

get <JAIL> action <ACT> actioncheck

دستور بررسی اقدام <ACT> را برای زندان <JAIL> دریافت می‌کند

get <JAIL> action <ACT> actionban

دستور مسدودسازی اقدام <ACT> را برای زندان <JAIL> دریافت می‌کند

get <JAIL> action <ACT> actionunban

دستور رفع مسدودیت اقدام <ACT> را برای زندان <JAIL> دریافت می‌کند

get <JAIL> action <ACT> timeout

مهلت زمانی اجرای دستور را به ثانیه برای اقدام <ACT> در زندان <JAIL> دریافت می‌کند

اطلاعات عمومی اقدام (GENERAL ACTION INFORMATION)

get <JAIL> actionproperties <ACT>

فهرستی از ویژگی‌های اقدام <ACT> را برای زندان <JAIL> دریافت می‌کند

get <JAIL> actionmethods <ACT>

فهرستی از متدهای اقدام <ACT> را برای زندان <JAIL> دریافت می‌کند

get <JAIL> action <ACT> <PROPERTY>

مقدار ویژگی <PROPERTY> را برای اقدام <ACT> در زندان <JAIL> دریافت می‌کند

فایل‌ها (FILES)

/etc/fail2ban/*

گزارش خطاها (REPORTING BUGS)

گزارش اشکالات و خطاها را به نشانی زیر ارسال کنید:
https://github.com/fail2ban/fail2ban/issues

همچنین ببینید (SEE ALSO)

fail2ban-server(1)، jail.conf(5)