iu-aide

This puppet module manages the installation and configuration of AIDE (Advance Intrusion Detection Environment)


Keywords
aide, intrusion-detection, security, file-integrity, auditing, audit, ids, cis-benchmarks, cis, puppet, puppet-module
License
BSD-3-Clause
Install
puppet module install iu-aide --version 1.0.4

Documentation

puppet-aide (AIDE - Advanced Intrusion Detection Enviroment).

Table of Contents

  1. Description
  2. Setup - The basics of getting started with aide
  3. Examples
  4. Cron Entry
  5. Reference - What the module is doing and how
  6. Assigning parameters using Hiera
  7. Limitations
  8. Contributing to the development of this module
  9. Credits

Description

This is a module for managing the installation, configuration and initial database creation of AIDE (Advanced Intrustion Detection Environment)package.

AIDE creates a database of files and their attributes from the rules that it finds in its configuration file. Once this database is initialized, it can be used to verify the integrity of the files contained within it. If the file attributes change according to the rules supplied, a summary of changes is logged and can be acted upon.

Refer to the AIDE manual for further details about configuration options.

This module will also add a cron job to periodically run the aide --check command to verify the integrity of the AIDE database. Results will be logged to the log file (defaults to /var/log/aide/aide.log) and to the AUTH log facility.

Setup Requirements

This module requires some additional modules, but it is highly likely that they are already installed on your puppet server. They are as follows:

  • puppetlabs/concat 4.0 - 8.0
  • puppetlabs/stdlib 4.0 - 8.0
  • puppet/cron 1.0 - 6.0

Examples

==========

Include the aide class and set cron run time to 6am with mail to a user other than root

class { 'aide':
  minute => 0,
  hour   => 6,
}

Watch permissions of all files on filesystem

The simplest use of iu/aide is to place a watch on the root directory, as follows.

aide::watch { 'example':
  path  => '/',
  rules => 'p'
}

This example adds the line / P which watches the permissions of all files on the operating system. Obviously, this is a simplistic non useful solution.

Note that the path parameter is optional with the default being the watch name, e.g.

aide::watch { '/etc':
  rules => 'p'
}

Watch permissions and md5sums of all files in /etc

aide::watch { 'watch etc':
  path  => '/etc',
  rules => 'p+md5'
}

This example adds the line /etc p+md5 which watches /etc with both permissions and md5sums. This could also be implemented as follows.

aide::watch { '/etc':
  rules => ['p', 'md5']
}

Create a common rule for watching multiple directories

Sometimes you wish to use the same rule to watch multiple directories and in keeping up with the Don't Repeat Yourself(DRY) viewpoint, we should create a common name for the rule. This can be done via the aide::rule stanza.

aide::rule { 'MyRule':
  name  => 'MyRule',
  rules => ['p', 'md5']
}
aide::watch { '/etc':
  rules => 'MyRule'
}
aide::watch { 'otherApp':
  path  => '/path/to/other/config/dir',
  rules => 'MyRule'
}

Here we are defining a rule called MyRule which will add the line MyRule = p+md5. The next two stanzas can reference that rule. They will show up as /etc MyRule and /path/to/other/config/dir MyRule.

Create a rule to exclude directories

aide::watch { 'Exclude /var/log':
  path => '/var/log',
  type => 'exclude'
}

This with ignore all files under /var/log. It adds the line !/var/log to the config file.

Create a rule to watch only specific files

aide::watch { '/var/log/messages':
  type => 'equals',
  rules => 'MyRule'
}

This will watch only the file /var/log/messages. It will ignore /var/log/messages/thingie. It adds the line =/var/log/messages MyRule to the config file.

Cron

A cron job is created during installation to run aide checks that use the hour and minute parameters to specify the run time.

This cron job can be disabled by setting the aide::nocheck parameter.

Reference

The following parameters are accepted by the ::aide class:

Installation Options

package

Data type: String.

AIDE package name.

Default value: aide.

version

Data type: String.

AIDE version for installation passed to Package::ensure

Default value: latest.

Configuration Options

conf_path

Data type: String.

Location of AIDE configuration file

Default value: /etc/aide.conf.

db_path

Data type: String.

Location of AIDE database file

Default value: /var/lib/aide/aide.db.

db_temp_path

Data type: String.

Location of update AIDE database file

Default value: /var/lib/aide/aide.db.new.

gzip_dbout

Data type: Boolean.

Gzip the AIDE database file (may affect performance)

Default value: false.

aide_path

Data type: String.

Location of aide binary.

Default value: /usr/sbin/aide.

mail_path

Data type: string.

Location of mail binary.

Default value: /usr/bin/mail.

config_template

Data type: String.

Template to use for aide configuration.

Default value: aide/aide.conf.erb.

Logging Options

aide_log

Data type: String.

AIDE check output log.

Default value: /var/log/aide/aide.log.

syslogout

Data type: Boolean.

Enables logging to the system logging service AUTH facility and /var/log/messages.

Default value: true.

Cron scheduling Options

minute

Data type: Integer.

Minute of cron job to run

Default value: 0.

hour

Data type: Integer.

Hour of cron job to run

Default value: 0.

nocheck

Data type: Boolean.

Whether to enable or disable scheduled checks

Default value: true.

mailto

Data type: String

Set this vaule to send email of results from aide --check in cron.

Default value: undef

mail_only_on_changes

Data type: Boolean

Whether to only send emails when changes are detected.

Default value: false

init_timeout

Data type: Integer.

Timeout of "aide --init" run.

Default value: 300.

Hiera

Values can be set using hiera, for example:

aide::syslogout: false
aide::hour: 1

Limitations

This module currently supports RedHat, CentOS, Debian and Ubuntu Linux but it has been fully tested on Ubuntu 16.04 and Ubuntu 18.04.

Contributing

Pull requests for new functionality or bug fixes are welcome but all code must meet the following requirements:

Credits

This module was adopted based on the initial refacter work of Warren Powell and Matt Lauber which uses parameter based classes rather than includes and also includes additional features for:

  • enabling gzip for database
  • allow for overrides of aide.conf and cron.d templates
  • aide logging options