140 lines
4.7 KiB
Markdown
140 lines
4.7 KiB
Markdown
# AIDE
|
|
|
|
[](https://github.com/linux-system-roles/aide/actions/workflows/ansible-lint.yml) [](https://github.com/linux-system-roles/aide/actions/workflows/ansible-test.yml) [](https://github.com/linux-system-roles/aide/actions/workflows/markdownlint.yml) [](https://github.com/linux-system-roles/aide/actions/workflows/shellcheck.yml) [](https://github.com/linux-system-roles/aide/actions/workflows/tft.yml) [](https://github.com/linux-system-roles/aide/actions/workflows/tft_citest_bad.yml) [](https://github.com/linux-system-roles/aide/actions/workflows/woke.yml)
|
|
|
|
This is an ansible role that installs and configures the [Advanced Intrusion Detection Environment (AIDE)](https://aide.github.io). For Day 2 tasks it can run integrity checks and update the AIDE database.
|
|
|
|
_Notice:_ This is a very early stage of a work in progress. Please use with
|
|
extreme caution as it might break your system.
|
|
|
|
## What does this role do for you?
|
|
|
|
* It ensures that the `aide` package is installed on the remote nodes
|
|
* As an optional task it can generate the `/etc/aide.conf` file and template it out to the remote nodes
|
|
* It initializes the AIDE database
|
|
* The AIDE databases from the remote nodes are stored in a central directory on the controller node
|
|
* It runs AIDE integrity checks on the remote nodes
|
|
* It updates the AIDE databases and stores them on the controller node
|
|
|
|
## How does the role do that?
|
|
|
|
* The role is controlled by using role variables
|
|
* If you run the playbook without specifying any role variable the role will change nothing on your remote nodes
|
|
* To execute some supported use cases you need to explicitly specify one or more of the following variables
|
|
|
|
### Available tags to control and use the role
|
|
|
|
## What does this role not do for you?
|
|
|
|
* It does not explain how to create a good AIDE configuration that suits your requirements; that task remains for you to accomplish
|
|
|
|
## Requirements
|
|
|
|
This role has no special requirements as it uses `ansible.builtin` modules
|
|
only.
|
|
|
|
## Role Variables
|
|
|
|
### aide_custom_template
|
|
|
|
This variable takes a string to specify a path where the custom template for aide.conf is located.
|
|
|
|
To be sure that everething is correct, template needs to start with following snippet:
|
|
|
|
``` jinja
|
|
{{ ansible_managed | comment }}
|
|
{{ "system_role:aide" | comment(prefix="", postfix="") }}
|
|
```
|
|
|
|
Default: `null`
|
|
|
|
Type: `string`
|
|
|
|
### aide_db_fetch_dir
|
|
|
|
This variable takes a string to specify the directory on the Ansible Control
|
|
Node (ACN) where the role will store the AIDE database fetched from the remote
|
|
nodes. The default value is `files` which is expected to be a directory in the
|
|
same directory as the playbook.
|
|
|
|
In case you like to store the fetched AIDE database files somewhere else you
|
|
need to specify a different path here.
|
|
|
|
Default: `files`
|
|
|
|
Type: `string
|
|
|
|
### aide_install
|
|
|
|
With this variable the role ensures that the `aide` package is installed on the remote nodes
|
|
|
|
Default: `false`
|
|
|
|
Type: `bool`
|
|
|
|
### aide_init
|
|
|
|
Initializes the AIDE database.
|
|
|
|
Default: `false`
|
|
|
|
Type: `bool`
|
|
|
|
### aide_fetch_db
|
|
|
|
Fetches database from the remote nodes to store it on the controller node
|
|
|
|
Default: `false`
|
|
|
|
Type: `bool`
|
|
|
|
### aide_check
|
|
|
|
Runs an integrity check on the remote nodes
|
|
|
|
Default: `false`
|
|
|
|
Type: `bool`
|
|
|
|
### aide_update
|
|
|
|
Updates the AIDE database and stores it on the controller node
|
|
|
|
Default: `false`
|
|
|
|
Type: `bool`
|
|
|
|
## Example Playbook
|
|
|
|
Including an example of how to use your role (for instance, with variables
|
|
passed in as parameters) is always nice for users too:
|
|
|
|
```yaml
|
|
# SPDX-License-Identifier: MIT
|
|
---
|
|
- name: Example aide role invocation
|
|
hosts: targets
|
|
tasks:
|
|
- name: Include role aide
|
|
vars:
|
|
aide_db_fetch_dir: files
|
|
aide_install: true
|
|
aide_generate_config: true
|
|
aide_init: true
|
|
aide_check: false
|
|
aide_update: false
|
|
ansible.builtin.include_role:
|
|
name: linux-system-roles.aide
|
|
```
|
|
|
|
More examples can be found in the [`examples/`](examples) directory.
|
|
|
|
## License
|
|
|
|
MIT.
|
|
|
|
## Author Information
|
|
|
|
* Radovan Sroka
|
|
* Joerg Kastning
|