confdroid_fail2ban/README.md

# Readme

[![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_fail2ban&style=plastic)](https://jenkins.confdroid.com/job/confdroid_fail2ban/)
[![Security Hotspots](https://sonarqube.confdroid.com/api/project_badges/measure?project=confdroid_fail2ban&metric=security_hotspots&token=sqb_9fa4789fabfda384f78fcdeb3ade3efce6225e64)](https://sonarqube.confdroid.com/dashboard?id=confdroid_fail2ban)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/grizzlycoda/puppet_collection)

- [Readme](#readme)
  - [Synopsis](#synopsis)
  - [WARNING](#warning)
  - [Features](#features)
    - [Installation](#installation)
    - [Configuration](#configuration)
      - [Core](#core)
      - [Optional](#optional)
    - [Service](#service)
  - [Dependencies](#dependencies)
  - [Deployment](#deployment)
  - [Parameters](#parameters)
  - [SELINUX](#selinux)
  - [Known Problems](#known-problems)
  - [Support](#support)
  - [Tests](#tests)
  - [Contact Us](#contact-us)
  - [Disclaimer](#disclaimer)

## Synopsis

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

`confdroid_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 previous 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**

## Features

### Installation

- install required binaries

### Configuration

#### Core

- manage directory structure  (file system permissions, selinux context)
- manage configuration files   (file system permissions, selinux context, content based on parameters)
  - fail2ban.conf
  - fail2ban.local (overrides default settings in fail2ban.conf)
  - jail.conf
  - jail.local ( overrides default settings in jail.conf)

> Every setting in .local files has a parameter in params.pp, which can be overridden in ENC based on fqdn, hostgroup etc. (recommended) or directly in params.pp. Typical parameters to override are:

- `fn_destemail`: the email address to be notified
- `fn_bantime`: the the time an attacker IP is banned.

#### Optional

- enable nagios monitoring of the fail2ban service, where the number of minimum allowed processes can be configured with `fn_procs_allowed`.

### Service

- manage service status

Sometimes it is required to have the service on a host stopped for some reason, i.e. for troubleshooting fail2ban.  In that case you can simply set `fn_enable_service`to `stopped` via ENC.

## Dependencies

All dependencies must be included in the catalogue.

- puppetlabs-firewall to manage firewall settings (optional)

## Deployment

- native Puppet deployment

via site.pp or nodes.pp

```bash
node 'example.example.net' {
  include cd_elasticsearch
}
```

- through Foreman:

In order to apply parameters through Foreman, **confdroid_fail2ban::params** must be added to the host or host group in question.

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

## Parameters

The parameters are documented via puppet strings and [listed here](/docs/index.html). Simply open in web browser.

## SELINUX

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

## Known Problems

## Support

- OS: Rocky 9
- Puppet 8

## Tests

- Puppet Lint
  - excluded tests:
    - `--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.
- Puppet Parser
- ERB Template Parser
- Sonar Quality Gate

## Contact Us

[contact Us](https://confdroid.com/contact/)
[Feedback Portal](https://feedback.confdroid.com/)

## 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.