auditd

Table of Contents

1. Overview
2. Module Description - What the module does and why it is useful
3. Setup - The basics of getting started with auditd
   • What auditd affects
   • Beginning with auditd
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing and how
6. Limitations - OS compatibility, etc.
7. Development - Guide for contributing to the module
8. Acknowledgements

Overview

This module will install a basic template for auditd rules on CentOS / Ubuntu

Module Description

This module edits the default /etc/audit/auditd.conf, adds a /etc/audit/audit.rules file to the server and restarts auditd.

Setup

If you wish to use your own ruleset, it must be passed to the auditd classes $auditd_rules parameter as an array of rules. This ruleset will over-write the default rules, so must be the full ruleset you intend to implement. E.g.:

class {'auditd':
  auditd_rules => [
    '-a always,exit -F arch=b32 -S adjtimex -S settimeofday -k time-change',
    '-w /etc/passwd -p wa -k identity',
  ],
}

Config values for the auditd.conf file can be passed in as a hash to the $auditd_conf parameter, where the key is the setting name and the value is the value. This will not completely over-write the default ruleset, only add new settings to the default list, or override values for existing settings. The default list can be found in the in-module Hiera data. E.g.

class {'auditd':
  auditd_conf => {
    'log_file' => '/var/log/some-other-auditd.log',
  }
}

What auditd affects

• /etc/audit/auditd.conf
• /etc/audit/audit.rules
• RPM Package audit will be installed
• Service auditd will be turned on and started

Beginning with auditd

Install module with sudo puppet module install auditd or use r10k.

Usage

Use the following syntax to get this module working:

include auditd

or

class { 'auditd': }

Reference

Classes

Public Classes

• auditd: Installs and configures auditd on your server.

Private Classes

• auditd::config: Configures the module.
• auditd::install: Installs auditd package on your server.
• auditd::service: Configures auditd service.

Limitations

This module has only been tested on RedHat 7 & 8 / Ubuntu 14 & 16 & 18. For other distributions, the module have to be tested.

Development

This module is public and can be found on github here

Acknowledgements

This module is a fork of https://github.com/lgbarn/auditd.

Changelog

1.0.1

• Changed name of some parameters to be consistent with others.
• Added further class documentation

1.0.0

• Initial release