2017-08-03 14:12:32 +02:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
|
<title>
|
|
|
|
|
Puppet Class: cd_fail2ban::params
|
|
|
|
|
|
|
|
|
|
— Documentation by YARD 0.9.9
|
|
|
|
|
|
|
|
|
|
</title>
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" charset="utf-8">
|
|
|
|
|
pathId = "puppet_classes::cd_fail2ban::params";
|
|
|
|
|
relpath = '../';
|
|
|
|
|
</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<div class="nav_wrap">
|
|
|
|
|
<iframe id="nav" src="../puppet_class_list.html?1"></iframe>
|
|
|
|
|
<div id="resizer"></div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div id="main" tabindex="-1">
|
|
|
|
|
<div id="header">
|
|
|
|
|
<div id="menu">
|
|
|
|
|
|
|
|
|
|
<a href="../_index.html">Index (c)</a> »
|
|
|
|
|
<span class='title'><span class='object_link'>Puppet Classes</span></span>
|
|
|
|
|
»
|
|
|
|
|
<span class="title">cd_fail2ban::params</span>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div id="search">
|
|
|
|
|
|
|
|
|
|
<a class="full_list_link" id="puppet_class_list_link"
|
|
|
|
|
href="../puppet_class_list.html">
|
|
|
|
|
|
|
|
|
|
<svg width="24" height="24">
|
|
|
|
|
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
|
|
|
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
|
|
|
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
|
|
|
</svg>
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
<div class="clear"></div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div id="content"><h1>Puppet Class: cd_fail2ban::params</h1>
|
|
|
|
|
<div class="box_info">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl>
|
|
|
|
|
<dt>Inherited by:</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
|
|
|
|
|
<span class='object_link'><a href="cd_fail2ban_3A_3Amain_3A_3Adirs.html" title="puppet_classes::cd_fail2ban::main::dirs (puppet_class)">cd_fail2ban::main::dirs</a></span><br/>
|
|
|
|
|
|
|
|
|
|
<span class='object_link'><a href="cd_fail2ban_3A_3Amain_3A_3Afiles.html" title="puppet_classes::cd_fail2ban::main::files (puppet_class)">cd_fail2ban::main::files</a></span><br/>
|
|
|
|
|
|
|
|
|
|
<span class='object_link'><a href="cd_fail2ban_3A_3Amain_3A_3Aconfig.html" title="puppet_classes::cd_fail2ban::main::config (puppet_class)">cd_fail2ban::main::config</a></span><br/>
|
|
|
|
|
|
|
|
|
|
<span class='object_link'><a href="cd_fail2ban_3A_3Amain_3A_3Ainstall.html" title="puppet_classes::cd_fail2ban::main::install (puppet_class)">cd_fail2ban::main::install</a></span><br/>
|
|
|
|
|
|
|
|
|
|
<span class='object_link'><a href="cd_fail2ban_3A_3Amain_3A_3Aservice.html" title="puppet_classes::cd_fail2ban::main::service (puppet_class)">cd_fail2ban::main::service</a></span><br/>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<dl>
|
|
|
|
|
<dt>Defined in:</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
manifests/params.pp
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h2>Summary</h2>
|
|
|
|
|
Class holds all parameters for the cd_fail2ban module and is
|
|
|
|
|
inherited by all classes except defines.
|
|
|
|
|
|
|
|
|
|
<h2>Overview</h2>
|
|
|
|
|
<div class="docstring">
|
|
|
|
|
<div class="discussion">
|
|
|
|
|
|
|
|
|
|
<p>cd_fail2ban::params.pp
|
|
|
|
|
Module name: cd_fail2ban
|
|
|
|
|
Author: Arne Teuke
|
|
|
|
|
(arne_teuke@confdroid.com)
|
|
|
|
|
License:
|
|
|
|
|
This file is part of cd_fail2ban.</p>
|
|
|
|
|
|
|
|
|
|
<p>cd_fail2ban is used for providing automatic configuration of Fail2Ban
|
|
|
|
|
|
|
|
|
|
Copyright (C) 2017 confdroid (copyright@confdroid.com)
|
|
|
|
|
This program 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 3 of the License, or
|
|
|
|
|
(at your option) any later
|
|
|
|
|
version.</p>
|
|
|
|
|
|
|
|
|
|
<p>This program 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.</p>
|
|
|
|
|
|
|
|
|
|
<p>You should have received a copy of the GNU General Public License
|
|
|
|
|
along
|
|
|
|
|
with this program. If not, see <a
|
2017-08-03 16:28:57 +02:00
|
|
|
href="http://www.gnu.org/licenses">www.gnu.org/licenses</a>/.
|
|
|
|
|
<code>CRITICAL</code>,<code>ERROR</code>,<code>WARNING</code>,<code>NOTICE</code>,<code>INFO</code>
|
|
|
|
|
and <code>DEBUG</code>.</p>
|
2017-08-03 14:12:32 +02:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="tags">
|
|
|
|
|
<p class="tag_title">Parameters:</p>
|
|
|
|
|
<ul class="param">
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
<span class='name'>pkg_ensure</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<em class="default">(defaults to: <tt>'latest'</tt>)</em>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
—
|
|
|
|
|
<div class='inline'>
|
|
|
|
|
<p>which <a href="https://confdroid.com/2017/05/puppet-type-package/">package
|
|
|
|
|
type</a>
|
|
|
|
|
to choose, i.e. <code>latest</code> or <code>present</code>.</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
2017-08-03 16:28:57 +02:00
|
|
|
<span class='name'>fn_manage_config</span>
|
2017-08-03 14:12:32 +02:00
|
|
|
|
|
|
|
|
|
2017-08-03 16:28:57 +02:00
|
|
|
<span class='type'>(<tt>boolean</tt>)</span>
|
2017-08-03 14:12:32 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
<em class="default">(defaults to: <tt>true</tt>)</em>
|
|
|
|
|
|
|
|
|
|
|
2017-08-03 16:28:57 +02:00
|
|
|
—
|
|
|
|
|
<div class='inline'>
|
|
|
|
|
<p>Whether to manage the fail2ban
|
|
|
|
|
configuration files. If set to false,
|
|
|
|
|
fail2ban will be installed, but the
|
|
|
|
|
configuration will not be managed.</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
<span class='name'>fn_enable_service</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<em class="default">(defaults to: <tt>'running'</tt>)</em>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
—
|
|
|
|
|
<div class='inline'>
|
|
|
|
|
<p>Whether to enable/start or disable/stop
|
|
|
|
|
the fail2ban service. Valid options
|
|
|
|
|
are <code>running</code> or <code>stopped</code>.</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
<span class='name'>fn_loglevel</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<em class="default">(defaults to: <tt>'INFO'</tt>)</em>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
—
|
|
|
|
|
<div class='inline'>
|
|
|
|
|
<p>Set the log level output. Valid options are</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
<span class='name'>fn_logtarget</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<em class="default">(defaults to: <tt>'SYSLOG'</tt>)</em>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
—
|
|
|
|
|
<div class='inline'>
|
|
|
|
|
<p>Set the log target. This could be a file,
|
|
|
|
|
SYSLOG, STDERR or STDOUT. Only
|
|
|
|
|
one log target can be specified.</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
<span class='name'>fn_syslogsocket</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<em class="default">(defaults to: <tt>'auto'</tt>)</em>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
—
|
|
|
|
|
<div class='inline'>
|
|
|
|
|
<p>Set the syslog socket file. Only used when
|
|
|
|
|
logtarget is SYSLOG. auto uses
|
|
|
|
|
platform.system() to determine predefined
|
|
|
|
|
paths Valid options: [ auto |
|
|
|
|
|
FILE ].</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
<span class='name'>fn_socket</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<em class="default">(defaults to: <tt>'/var/run/fail2ban/fail2ban.sock'</tt>)</em>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
—
|
|
|
|
|
<div class='inline'>
|
|
|
|
|
<p>Set the socket file to communicate with the daemon.</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
<span class='name'>fn_pidfile</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<em class="default">(defaults to: <tt>'/var/run/fail2ban/fail2ban.pid'</tt>)</em>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
—
|
|
|
|
|
<div class='inline'>
|
|
|
|
|
<p>Set the PID file to store the process ID of the
|
|
|
|
|
fail2ban server.</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
<span class='name'>fn_dbfile</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<em class="default">(defaults to: <tt>'/var/lib/fail2ban/fail2ban.sqlite3'</tt>)</em>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
—
|
|
|
|
|
<div class='inline'>
|
|
|
|
|
<p>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.</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
<span class='name'>fn_dbpurgeage</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<em class="default">(defaults to: <tt>'86400'</tt>)</em>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
—
|
|
|
|
|
<div class='inline'>
|
|
|
|
|
<p>age in seconds at which bans should be purged
|
|
|
|
|
from the database.</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
2017-08-03 14:12:32 +02:00
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div><div class="method_details_list">
|
|
|
|
|
<table class="source_code">
|
|
|
|
|
<tr>
|
|
|
|
|
<td>
|
|
|
|
|
<pre class="lines">
|
|
|
|
|
|
|
|
|
|
|
2017-08-03 15:01:03 +02:00
|
|
|
48
|
|
|
|
|
49
|
|
|
|
|
50
|
|
|
|
|
51
|
|
|
|
|
52
|
|
|
|
|
53
|
|
|
|
|
54
|
|
|
|
|
55
|
|
|
|
|
56
|
|
|
|
|
57
|
|
|
|
|
58
|
|
|
|
|
59
|
|
|
|
|
60
|
|
|
|
|
61
|
2017-08-03 16:28:57 +02:00
|
|
|
62
|
|
|
|
|
63
|
|
|
|
|
64
|
|
|
|
|
65
|
|
|
|
|
66
|
|
|
|
|
67
|
|
|
|
|
68
|
|
|
|
|
69
|
|
|
|
|
70
|
|
|
|
|
71
|
|
|
|
|
72
|
|
|
|
|
73
|
|
|
|
|
74
|
|
|
|
|
75
|
|
|
|
|
76
|
|
|
|
|
77
|
|
|
|
|
78
|
|
|
|
|
79
|
|
|
|
|
80
|
|
|
|
|
81
|
|
|
|
|
82
|
|
|
|
|
83
|
|
|
|
|
84
|
|
|
|
|
85
|
|
|
|
|
86
|
|
|
|
|
87
|
|
|
|
|
88
|
|
|
|
|
89
|
|
|
|
|
90
|
|
|
|
|
91
|
|
|
|
|
92
|
|
|
|
|
93
|
|
|
|
|
94
|
2017-08-03 16:51:10 +02:00
|
|
|
95</pre>
|
2017-08-03 14:12:32 +02:00
|
|
|
</td>
|
|
|
|
|
<td>
|
2017-08-03 16:28:57 +02:00
|
|
|
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 48</span>
|
2017-08-03 14:12:32 +02:00
|
|
|
|
|
|
|
|
class cd_fail2ban::params (
|
|
|
|
|
|
2017-08-03 16:28:57 +02:00
|
|
|
$pkg_ensure = 'latest',
|
|
|
|
|
|
|
|
|
|
$fn_manage_config = true,
|
|
|
|
|
$fn_enable_service = 'running',
|
|
|
|
|
$fn_loglevel = 'INFO',
|
|
|
|
|
$fn_logtarget = 'SYSLOG',
|
|
|
|
|
$fn_syslogsocket = 'auto',
|
|
|
|
|
$fn_socket = '/var/run/fail2ban/fail2ban.sock',
|
|
|
|
|
$fn_pidfile = '/var/run/fail2ban/fail2ban.pid',
|
|
|
|
|
$fn_dbfile = '/var/lib/fail2ban/fail2ban.sqlite3',
|
|
|
|
|
$fn_dbpurgeage = '86400',
|
2017-08-03 14:12:32 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
) {
|
|
|
|
|
|
|
|
|
|
# installation section
|
|
|
|
|
$reqpackages = $::operatingsystem ? {
|
2017-08-03 15:01:03 +02:00
|
|
|
/(?i-mx:centos|fedora|redhat)/ => ['fail2ban','fail2ban-firewalld',
|
|
|
|
|
'fail2ban-sendmail',
|
|
|
|
|
'fail2ban-server.noarch'],
|
2017-08-03 14:12:32 +02:00
|
|
|
}
|
|
|
|
|
|
2017-08-03 15:01:03 +02:00
|
|
|
|
2017-08-03 14:12:32 +02:00
|
|
|
# service
|
2017-08-03 16:28:57 +02:00
|
|
|
$fn_service = 'fail2ban'
|
2017-08-03 15:01:03 +02:00
|
|
|
|
|
|
|
|
# directories
|
2017-08-03 16:28:57 +02:00
|
|
|
$fn_main_dir = '/etc/fail2ban'
|
|
|
|
|
$fn_action_d_dir = "${fn_main_dir}/action.d"
|
|
|
|
|
$fn_fail2ban_d_dir = "${fn_main_dir}/fail2ban.d"
|
|
|
|
|
$fn_filter_d_dir = "${fn_main_dir}/filter.d"
|
|
|
|
|
$fn_jail_d_dir = "${fn_main_dir}/jail.d"
|
|
|
|
|
$fn_var_lib_dir = '/var/lib/fail2ban'
|
|
|
|
|
$fn_var_run_dir = '/var/run/fail2ban'
|
2017-08-03 15:01:03 +02:00
|
|
|
|
|
|
|
|
# files
|
2017-08-03 16:51:10 +02:00
|
|
|
$fn_fail2ban_conf_file = "${fn_main_dir}/fail2ban.conf"
|
2017-08-03 16:28:57 +02:00
|
|
|
$fn_fail2ban_conf_erb = 'cd_fail2ban/fail2ban_conf.erb'
|
2017-08-03 16:51:10 +02:00
|
|
|
$fn_fail2ban_local_file = "${fn_main_dir}/fail2ban.local"
|
2017-08-03 16:28:57 +02:00
|
|
|
$fn_fail2ban_local_erb = 'cd_fail2ban/fail2ban_local.erb'
|
2017-08-03 14:12:32 +02:00
|
|
|
|
|
|
|
|
# includes must be last
|
|
|
|
|
|
|
|
|
|
include cd_fail2ban::main::config
|
|
|
|
|
|
|
|
|
|
}</pre>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div id="footer">
|
2017-08-03 16:51:10 +02:00
|
|
|
Generated on Thu Aug 3 16:51:08 2017 by
|
2017-08-03 14:12:32 +02:00
|
|
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
|
|
|
0.9.9 (ruby-2.0.0).
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
