confdroid/confdroid_fail2ban
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

adjust everything for compliance with puppet-lint

Browse Source
This commit is contained in:
Arne Teuke
2025-05-15 14:07:31 +02:00
parent 277759e2d1
commit 573a4acb27
25 changed files with 38 additions and 4212 deletions
Download Patch File Download Diff File Expand all files Collapse all files

73
manifests/params.pp
View File

@@ -2,42 +2,42 @@
# Module name: fail2ban_cd
# Author: Arne Teuke (arne_teuke@confdroid.com)
# @summary Class holds all parameters for the fail2ban_cd module
# @param [string] pkg_ensure
# @param [String] pkg_ensure
# which [package type](https://confdroid.com/2017/05/puppet-type-package/)
# to choose, i.e. `latest` or `present`.
# @param [array] reqpackages the packages to install.
# @param [boolean] fn_manage_config Whether to manage the fail2ban
# configuration files. If set to false, fail2ban will be installed, but the
# configuration will not be managed.
# @param [string] fn_enable_service Whether to enable/start or disable/stop
# @param [String] fn_enable_service Whether to enable/start or disable/stop
# the fail2ban service. Valid options are `running` or `stopped`.
# @param [string] fn_loglevel Set the log level output. Valid options are
# @param [String] fn_loglevel Set the log level output. Valid options are
# `CRITICAL`,`ERROR`,`WARNING`,`NOTICE`,`INFO` and `DEBUG`.
# @param [string] fn_logtarget Set the log target. This could be a file,
# @param [String] fn_logtarget Set the log target. This could be a file,
# SYSLOG, STDERR or STDOUT. Only one log target can be specified.
# @param [string] fn_syslogsocket Set the syslog socket file. Only used when
# @param [String] fn_syslogsocket Set the syslog socket file. Only used when
# logtarget is SYSLOG. auto uses platform.system() to determine predefined
# paths Valid options: [ auto | FILE ].
# @param [string] fn_socket Set the socket file to communicate with the daemon.
# @param [string] fn_pidfile Set the PID file to store the process ID of the
# @param [String] fn_socket Set the socket file to communicate with the daemon.
# @param [String] fn_pidfile Set the PID file to store the process ID of the
# fail2ban server.
# @param [string] fn_dbfile file for the fail2ban persistent data to be stored.
# @param [String] fn_dbfile file for the fail2ban persistent data to be stored.
# A value of ":memory:" means database is only stored in memory
# and data is lost when fail2ban is stopped.
# A value of "None" disables the database.
# @param [string] fn_dbpurgeage age in seconds at which bans should be purged
# @param [String] fn_dbpurgeage age in seconds at which bans should be purged
# from the database.
# @param [string] fn_ignoreip can be an IP address, a CIDR mask or a DNS host.
# @param [String] fn_ignoreip can be an IP address, a CIDR mask or a DNS host.
# Fail2ban will not ban a host which matches an address in this list. Several
# addresses can be defined using space (and/or comma) separator.
# @param [string] fn_ignorecommand External command that will take an
# @param [String] fn_ignorecommand External command that will take an
# tagged arguments to ignore, e.g. <ip>,and return true if the IP is to be
# ignored. False otherwise.
# @param [string] fn_bantime number of seconds that a host is banned.
# @param [string] fn_findtime A host is banned if it has generated "maxretry"
# @param [String] fn_bantime number of seconds that a host is banned.
# @param [String] fn_findtime A host is banned if it has generated "maxretry"
# during the last "findtime" seconds.
# @param [string] fn_maxretry number of failures before a host get banned.
# @param [string] fn_backend specifies the backend used to get files
# @param [String] fn_maxretry number of failures before a host get banned.
# @param [String] fn_backend specifies the backend used to get files
# modification. options are "pyinotify", "gamin", "polling", "systemd" and
# "auto".
# pyinotify: requires pyinotify (a file alteration monitor) to be installed.
@@ -50,7 +50,7 @@
# See "journalmatch" in the jails associated filter config
# auto: will try to use the following backends, in order:
# pyinotify, gamin, polling.
# @param [string] fn_usedns specifies if jails should trust hostnames in logs,
# @param [String] fn_usedns specifies if jails should trust hostnames in logs,
# warn when DNS lookups are performed, or ignore all hostnames in logs
# yes: if a hostname is encountered, a DNS lookup will be performed.
# warn: if a hostname is encountered, a DNS lookup will be performed,
@@ -59,7 +59,7 @@
# but it will be logged as info.
# raw: use raw value (no hostname), allow use it for no-host filters/actions
# (example user)
# @param [string] fn_logencoding specifies the encoding of the log files
# @param [String] fn_logencoding specifies the encoding of the log files
# handled by the jail This is used to decode the lines from the log file.
# Typical examples: "ascii", "utf-8"
# auto: will use the system locale setting
@@ -68,39 +68,38 @@
# Enable only relevant to your setup jails in your .local or jail.d/*.conf
# true: jail will be enabled and log files will get monitored for changes
# false: jail is not enabled
# @param [string] fn_filter defines the filter to use by the jail.
# @param [String] fn_filter defines the filter to use by the jail.
# By default jails have names matching their filter name
# @param [string] fn_destemail Destination email address used solely for the
# @param [String] fn_destemail Destination email address used solely for the
# interpolations in jail.{conf.local.d/*} configuration files.
# @param [string] fn_sender Sender email address used solely for some actions
# @param [string] fn_mta E-mail action. Since 0.8.1 Fail2Ban uses sendmail MTA
# @param [String] fn_mta E-mail action. Since 0.8.1 Fail2Ban uses sendmail MTA
# for the mailing. Change mta configuration parameter to mail if you want to
# revert to conventional 'mail'.
# @param [string] fn_protocol Default protocol.
# @param [string] fn_chain Specify chain where jumps would need to be added in
# @param [String] fn_protocol Default protocol.
# @param [String] fn_chain Specify chain where jumps would need to be added in
# iptables-* actions.
# @param [string] fn_port # Ports to be banned Usually should be overridden
# @param [String] fn_port # Ports to be banned Usually should be overridden
# in a particular jail
# @param [string] fn_fail2ban_agent Format of user-agent
# @param [String] fn_fail2ban_agent Format of user-agent
# https://tools.ietf.org/html/rfc7231#section-5.5.3
# @param [string] fn_banaction Default banning action
# @param [string] fn_banaction_allports Default banning action
# @param [string] fn_action_ ban only
# @param [string] fn_action_mw ban & send an e-mail with whois report to the
# @param [String] fn_banaction Default banning action
# @param [String] fn_banaction_allports Default banning action
# @param [String] fn_action_ ban only
# @param [String] fn_action_mw ban & send an e-mail with whois report to the
# destemail.
# @param [string] fn_action_mwl ban & send an e-mail with whois report and
# @param [String] fn_action_mwl ban & send an e-mail with whois report and
# relevant log lines
# @param [string] fn_action_xarf ban & send a xarf e-mail to abuse contact of
# @param [String] fn_action_xarf ban & send a xarf e-mail to abuse contact of
# IP address and include relevant log lines.
# @param [string] fn_action_cf_mwl ban IP on CloudFlare & send an e-mail with
# @param [String] fn_action_cf_mwl ban IP on CloudFlare & send an e-mail with
# whois report and relevant log lines.
# @param [string] fn_action_blocklist_de Report block via blocklist.de fail2ban
# @param [String] fn_action_blocklist_de Report block via blocklist.de fail2ban
# reporting service API
# @param [string] fn_action_badips string to be be used in config files
# @param [string] fn_action_badips_report # Report ban via badips.com
# @param [String] fn_action_badips String to be be used in config files
# @param [String] fn_action_badips_report # Report ban via badips.com
# (uses action.d/badips.conf for reporting only).
# @param [string] fn_default_action Choose default action.
# @param [string] fn_jail_paths the fail path. defaults to fedora.
# @param [String] fn_default_action Choose default action.
# @param [String] fn_jail_paths the fail path. defaults to fedora.
###############################################################################
class fail2ban_cd::params (