Forge Home

aide

Install and manage AIDE rules, init Database and create cron job

7,347 downloads

6,771 latest version

4.6 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 1.0.3 (latest)
  • 1.0.2
  • 1.0.1
  • 1.0.0
released Feb 23rd 2017
This version is compatible with:
  • , , , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'lhinds-aide', '1.0.3'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add lhinds-aide
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install lhinds-aide --version 1.0.3

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

lhinds/aide — version 1.0.3 Feb 23rd 2017

Puppet AIDE - Advanced Intrusion Detection Enviroment.

Build Status

Table of Contents

  1. Description
  2. Examples
  3. Cron - CRON Entries
  4. Hiera - Populating parameters using Hiera data
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module
  7. Credits

Description

A Puppet module for the management of AIDE - Advanced Intrusion Detection Enviroment.

This module will install the AIDE package, populate rules into aide.conf and initiate a new database.

A CRON job is created to allow a perodic run of aide --check with the results logged to /var/log/audit or via an emailed report.

If at any time, the rules parameters are changed, the module will re-initiate the AIDE database to implement the new rules.

Examples

Basic Rule Entry

A series of rules can be passed to aide.conf by supplying each rule to the aide::rule class:

aide::rule { 'etc rule':
  content => '/etc p+sha256',
  order   => 1,
}
aide::rule { 'boot rule':
  content => '/boot p+sha256',
  order   => 2,
}

The order denotes the sequence of rule placement within aide.conf

Basic Rule using alias

Rules can be grouped under a common alias, to allow easy repetition:

aide::rule { 'MyComplexRule':
  content => 'p+i+l+n+u+g+s+m+c+sha256',
  order   => 1,
}
aide::rule { 'boot':
  content => '/boot MyComplexRule',
  order   => 2,
}
aide::rule { 'etc ':
  content => '/etc MyComplexRule',
  order   => 3,
}

Note: Custom rule declarations need to be placed at order 1.

Rules provided as a hash

Rules can also be passed as a hash:

rules => {
  'MyRule' => {
    content => 'MyRule = p+sha256',
    order   => 1,
  },
  'etc' => {
    content => '/etc MyRule',
    order   => 2,
  },
  'boot'  => {
    content => '/boot MyRule',
    order   => 3,
  },
}

More examples can be found in aide/examples

CRON

A cron entry is made using the parameters hourand minute.

If the parameter email is set, then mailx will be installed and an entry will be made to crontab as follows:

0 1 * * * /usr/sbin/aide --check --config=/etc/aide.conf | /bin/mail -s "$HOSTNAME - Daily AIDE integrity check" your_email@example.com

HIERA

Values can be set using hiera, for example:

aide::email: 'your_email@example.com'

Limitations

Currently supports RedHat / CentOS 7 and Debian 8.

Currently travis build tests run against Puppet 4, but I have used this module with no issues on Puppet 3.

Contributors

Pull requests are welcome. Please ensure any code follows the Puppet Style Guide and that new functionality is provided with unit tests when possible.

Credits

Some of the design ideas are thanks to Matt Lauber. This version is a refactor of his earlier module, but with hashes, spec tests, cron, hiera and other features added.