alphagov / chef-auditd

Install and configure user mode auditd tools

auditd Cookbook

A simple cookbook to install auditd and provided rulesets. Rulesets included in the OS auditd/audit package as examples are based on 4 established standards:

• Controlled Access Protection Profile (CAPP)
• Labeled Security Protection Profile (LSPP)
• National Industrial Security Program Operating Manual (NISPOM)
• Security Technical Implementation Guides

The OS package provides the client side tools for working with the linux kernel audit framework.

Requirements

Platforms

• Debian/Ubuntu
• RHEL/CentOS/Scientific/Amazon/Oracle 6+

Chef

• Chef 12.5+

Cookbooks

• none

Attributes

• node['auditd']['ruleset'] - ruleset to use, either "default" (the default if unset) or one of the provided examples
• node['auditd']['backlog'] - backlog size, default is 320 should be larger for busy systems
• node['auditd']['additional_lines'] - (array of strings) enables the addition of extra lines to the rendered ERB template that you may wish to include as well as those in the selected rulebase.

Usage

If you're using one of the default rulesets set the correct attribute based on the ruleset desired, one of:

• "capp" : Controlled Access Protection Profile
• "lspp" : Labeled Security Protection Profile
• "nispom" : National Industrial Security Program Operating Manual (NISPOM)
• "stig" : Security Technical Implementation Guides
• "cis" : Center for Internet Security auditd recommendations

And include recipe[auditd::rules] in your run list. You can also set the attribute node['auditd']['ruleset'] to the name of a custom rule template to be used instead of one of the default rules.

If you are using the recipe from a wrapper cookbook, include the default recipe recipe[auditd] to setup the service and use the auditd_ruleset resource to place your rule template of choice.

If you are not satisfied with any of the provided templates, you can specify the cookbook attribute in auditd_ruleset to use your own set of rules. In this case, do not include recipe[auditd::rules].

Use the auditd::remove recipe to uninstall auditd.

License & Authors

Author: Cookbook Engineering Team ([email protected])

Copyright: 2016, Chef Software, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.