|Repo Name| version | Build Status|
|---|---|---|---|
|`cd_fail2ban`| 0.0.0.6 | [![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=cd_fail2ban)](https://jenkins.confdroid.com/job/cd_fail2ban/)|

### Synopsis
Fail2Ban is an intrusion prevention software framework that protects computer servers from brute-force attacks.

`cd_fail2ban` is a Puppet module to automate installation, configuration and management of fail2ban settings and rules.

### WARNING
`**__!!! Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previuos configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production!!! __**`

### Table of Contents
* [Features](#features)
* [Repo Structure](https://gitlab.puppetsoft.com/12WW1160/cd_fail2ban/blob/master/REPOSTRUCTURE.md)
* [ Repo Documentation](#repo-documentation)
* [Dependencies](#dependencies)
* [Deployment](#deployment)
  * [native Puppet deployment](#native-puppet-deployment)
  * [through Foreman](#through-foreman)
* [Parameters](#parameters)
  * [Mandatory Parameters](#mandatory-parameters)
  * [Optional Parameters](#optional-parameters)
* [SELINUX](#selinux)
* [Known Problems](#known-problems)
* [Support](#support)
* [Tests](#tests)
* [Changelog](https://gitlab.puppetsoft.com/12WW1160/cd_fail2ban/blob/master/CHANGELOG.md)
* [Contact Us](https://confdroid.com/contact/)
* [Disclaimer](#disclaimer)


### Features
Installation
* install required binaries

Configuration
* manage directory structure  (file system permissions, selinux context)
* manage configration files   (file system permissions, selinux context, content based on parameters)

Service
* manage service status (running or stopped)


### Repo Structure
Repostructure has moved to REPOSTRUCTURE.md in repo.

### Repo Documentation
See the full Puppet documentation in docs/index.html

### Dependencies
All dependencies must be included in the catalogue.


### Deployment

##### native Puppet deployment

via site.pp or nodes.pp

```
node 'example.example.net' {
  include cd_puppetdb
}
```
#### through Foreman:
In order to apply parameters through Foreman, **__cd_fail2ban::params__** must be added to the host or hostgroup in question.

See [more details about class deployment on Confdroid.com](https://confdroid.com/2017/05/deploying-our-puppet-modules/).


### Parameters
The following parameters are editable via params.pp or through ENC (**__recommended__**). Values changed will take immediate effect at next puppet run. Services will be restarted where neccessary.

The [full list of Parameters](https://confdroid.com/2017/08/cd_fail2ban-parameters/) is available [here](https://confdroid.com/2017/08/cd_fail2ban-parameters/) and in the docs folder in the software repo.

#### Mandatory Parameters

There are currently no mandatory parameters, i.e. the module will function right out of box as is.

#### Optional Parameters



### SELINUX
All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.

### Known Problems
* firewalld: firewalld is auto-installed on CentOS7 as dependency of fail2ban by yum.

### Support
* OS: CentOS 6, 7
* Puppet 3.x


### Tests
* Puppet Lint
  * excluded tests:
    * `--no-class_inherits_from_params_class-check`:relavant only to non-supported outdated puppet versions
    * `--no-variable_scope-check`: not applicable as we are inheriting parameters from params class. the lint check does not distinguish between facts and inherited parameters.
    * `--no-80chars-check`: it is not always possible to stay within 80 characters, although typically only occurring on the parameter vault `params.pp`.
    * `--no-arrow_alignment-check`: this check leads to actually not having am easily readable arrow alignment, as this checks `per block`, not per class.
* Puppet Parser
* ERB Template Parser
* Test for unwanted UTF8 files in the Puppet code  as this causes problems with PuppetDB (see tests/UTF_Files)
### Contact Us
[contact Us](https://confdroid.com/contact/)

### Disclaimer
ConfDroid as entity is entirely independent from Puppet. We provide custom configuration modules, written for specific purposes and specific environments.
The modules are tested and supported only as documented, and require testing in designated environments  (i.e. lab or development environments) for parameter tuning etc. before deploying into production environments.