The audit cookbook allows you to run InSpec profiles as part of a Chef Client run. It downloads configured profiles from various sources like Chef Compliance, Chef Supermarket or Git and reports audit runs to Chef Compliance or Chef Automate.
The audit cookbook supports a number of different reporters and fetchers which can be confusing. Please see the supported configurations documentation which has a few copy/paste examples to get you started quickly.
- Chef Client >=12.5.1
| Automate version | InSpec version | Audit Cookbook version |
|---|---|---|
| < 0.8.0 | ≤ 1.23.0 | ≤ 3.1.0 |
| ≥ 0.8.0 | ≥ 1.24.0 | ≥ 4.0.0 |
| Chef Compliance version | InSpec version | Audit Cookbook version |
|---|---|---|
| ≤ 1.1.23 | = 0.20.1 | = 0.7.0 |
| > 1.1.23 | ≥ 0.22.1 | = 0.8.0 |
| ≥ 1.6.8 | ≥ 1.2.0 | > 1.0.2 |
With version 3.1.0 the use of the collector attribute is deprecated. Please use reporter instead. The collector attribute will be removed in the next major version.
"audit": {
"collector": "chef-server-compliance",
becomes:
"audit": {
"reporter": "chef-server-compliance",
With version 3.1.0 the reporter attribute deprecates the values chef-server-visibility and chef-visibility. They have been renamed:
chef-server-visibility=>chef-server-automatechef-visibility=>chef-automate
The support for values chef-server-visibility and chef-visibility will be removed in the next major version.
┌──────────────────────┐ ┌──────────────────────┐ ┌─────────────────────┐
│ Chef Client │ │ Chef Server Proxy │ │ Chef Compliance │
│ │ │ (optional) │ │ or Chef Automate │
│ ┌──────────────────┐ │ │ │ │ │
│ │ │◀┼────┼──────────────────────┼────│ Profiles │
│ │ audit cookbook │ │ │ │ │ │
│ │ │─┼────┼──────────────────────┼───▶│ Reports │
│ └──────────────────┘ │ │ │ │ │
│ │ │ │ │ │
└──────────────────────┘ └──────────────────────┘ └─────────────────────┘
Inspec Profiles can be hosted from a variety of locations:
┌──────────────────────┐ ┌─────────────────────┐
│ Chef Client │ ┌───────────────────────┐ │ Chef Compliance │
│ │ ┌──│ Profiles(Supermarket, │ │ or Chef Automate │
│ ┌──────────────────┐ │ │ │ Github, local, etc) │ │ │
│ │ │◀┼──┘ └───────────────────────┘ │ │
│ │ audit cookbook │◀┼────────────────────────────────│ Profiles │
│ │ │─┼───────────────────────────────▶│ Reports │
│ └──────────────────┘ │ │ │
│ │ │ │
└──────────────────────┘ └─────────────────────┘
The audit cookbook needs to be configured for each node where the chef-client runs. The audit cookbook can be reused for all nodes, all node-specific configuration is done via Chef attributes.
Beginning with version 3.x of the audit cookbook, the cookbook will first check to see if InSpec is already installed. If it is, it will not attempt to install it. Future releases of the Chef omnibus package are expected to include InSpec so this will reduce audit run times and also ensure that Chef users in air-gapped or firewalled environments can still use the audit cookbook without requiring gem mirrors, etc.
Also beginning with version 3.x of the audit cookbook, the default version of the InSpec gem to be installed (if it isn't already installed) is the latest version. Prior versions of the audit cookbook were version-locked to inspec version 1.15.0.
To install a different version of the InSpec gem, or to force installation of the gem, set the node['audit']['inspec_version'] attribute to the version you wish to be installed.
Note on AIX Support:
- InSpec is only supported via the bundled InSpec gem shipped with version >= 13 of the chef-client package.
- Standalone InSpec gem installation or upgrade is not supported.
- The default
nilvalue ofnode['audit']['inspec_version']will ensure the above behavior is adhered to.
Once the cookbook is available in Chef Server, you need to add the audit::default recipe to the run-list of each node. The profiles are selected via the node['audit']['profiles'] attribute. A complete list of the possible configuration are documented in Supported Configurations. For example you can define the attributes in a role or environment file like this:
node.default['audit']['profiles'].push("path": "#{PROFILES_PATH}/mylinux-failure-success")
"audit": {
"reporter": "chef-server-compliance",
"inspec_version": "1.29.0",
"profiles": [
# profile from Chef Compliance
{
"name": "linux",
"compliance": "base/linux"
},
# profile from Chef Compliance at a particular version
{
"name": "linux-baseline",
"compliance": "user/linux-baseline",
"version": "2.1.0"
},
# profile from supermarket
# note: If reporting to Compliance, the Supermarket profile needs to be uploaded to Chef Compliance first
{
"name": "ssh",
"supermarket": "hardening/ssh-hardening"
},
# local Windows path
{
"name": "brewinc/win2012_audit",
# filesystem path
"path": "E:/profiles/win2012_audit"
},
# github
{
"name": "ssl",
"git": "https://github.com/dev-sec/ssl-benchmark.git"
},
# url
{
"name": "ssh",
"url": "https://github.com/dev-sec/tests-ssh-hardening/archive/master.zip"
}
]
}You can also configure in a policyfile like this:
default["audit"] = {
"reporter" => "chef-server-compliance",
"profiles" => [
{
"name": "linux",
"compliance": "base/linux"
},
{
"name": "ssh",
"compliance": "base/ssh"
}
]
}You can also pass in InSpec Attributes to your audit run. You do this by defining the attributes here:
default['audit']['attributes'] = {
first_attribute: 'some vaule',
second_attribute: 'another value',
}If you want the audit cookbook to retrieve compliance profiles and report to Chef Automate (Visibility) through Chef Server, set the reporter and profiles attributes.
This requires Chef Client >= 12.16.42. Also requires Chef Server version 12.11.1 and Chef Automate 0.6.6 or newer, as well as integration between the two. More details here.
Chef Automate is not shipping with build-in profiles at the moment. To upload profiles, you can use the Automate API or the inspec compliance subcommands (requires InSpec 1.7.2 or newer).
Attributes example of fetching from Automate, reporting to Automate both via Chef Server:
"audit": {
"reporter": "chef-server-automate",
"fetcher": "chef-server",
"insecure": false,
"profiles": [
{
"name": "my-profile",
"compliance": "john/my-profile"
}
]
}If you want the audit cookbook to directly report to Chef Compliance, set the reporter, server, owner, refresh_token and profiles attributes.
reporter- 'chef-compliance' to report to Chef Complianceserver- url of Chef Compliance server with/apiowner- Chef Compliance user or organization that will receive this scan reportrefresh_token- refresh token for Chef Compliance API (inspec/inspec#690)- note: A UI logout revokes the refresh_token. Workaround by logging in once in a private browser session, grab the token and then close the browser without logging out
insecure- atruevalue will skip the SSL certificate verification when retrieving access token. Default value isfalse
"audit": {
"reporter": "chef-compliance",
"server": "https://compliance-fqdn/api",
"owner": "my-comp-org",
"refresh_token": "5/4T...g==",
"insecure": false,
"profiles": [
{
"name": "windows",
"compliance": "base/windows"
}
]
}Instead of a refresh token, it is also possible to use a token that expires in 12h after creation .
"audit": {
"reporter": "chef-compliance",
"server": "https://compliance-fqdn/api",
"owner": "my-comp-org",
"token": "eyJ........................YQ",
"profiles": [
{
"name": "windows",
"compliance": "base/windows"
}
]
}If you want the audit cookbook to directly report to Chef Automate, set the reporter attribute to 'chef-automate'. Also specify where to retrieve the profiles from.
insecure- atruevalue will skip the SSL certificate verification. Default value isfalse
This method is sending the report using the data_collector.server_url and data_collector.token, defined in client.rb. It requires inspec version 0.27.1 or greater. Further information is available at Chef Docs: Configure a Data Collector token in Chef Automate
"audit": {
"reporter": "chef-automate",
"insecure": "false",
"profiles": [
{
"name": "brewinc/tmp_compliance_profile",
"url": "https://github.com/nathenharvey/tmp_compliance_profile"
}
]
}If you are using a self-signed certificate, please also read how to add the Chef Automate certificate to the trusted_certs directory
Version compatibility matrix:
| Automate version | InSpec version | Audit Cookbook version |
|---|---|---|
| < 0.8.0 | ≤ 1.23.0 | ≤ 3.1.0 |
| ≥ 0.8.0 | ≥ 1.24.0 | ≥ 4.0.0 |
The size of the report being generated from running the compliance scan is influenced by a few factors like:
- number of controls and tests in a profile
- number of profile failures for the node
- controls metadata (title, description, tags, etc)
- number of resources (users, processes, etc) that are being tested
Depending on your setup, there are some limits you need to be aware of. A common one is Chef Server default (1MB) request size. Exceeding this limit will reject the report with ERROR: 413 "Request Entity Too Large". For more details about these limits, please refer to TROUBLESHOOTING.md.
To write the report to a file on disk, simply set the reporter to 'json-file' like so:
audit: {
reporter: 'json-file',
profiles: [
{
'name': 'admin/ssh2',
'path': '/some/base_ssh.tar.gz'
}
]
}The resulting file will be written to <chef_cache_path>/cookbooks/audit/inspec-<YYYYMMDDHHMMSS>.json. The path will also be output to the Chef log:
[2017-08-29T00:22:10+00:00] INFO: Reporting to json-file
[2017-08-29T00:22:10+00:00] INFO: Writing report to /opt/kitchen/cache/cookbooks/audit/inspec-20170829002210.json
[2017-08-29T00:22:10+00:00] INFO: Report handlers complete
To enable multiple reporters, simply define multiple reporters with all the necessary information for each one. For example, to report to chef-compliance and write to json file on disk:
"audit": {
"reporter": [ "chef-compliance", "json-file" ]
"server": "https://compliance-fqdn/api",
"owner": "my-comp-org",
"refresh_token": "5/4T...g==",
"insecure": false,
"profiles": [
{
"name": "windows",
"compliance": "base/windows"
}
]
}To enable reporting to Chef Automate with profiles from Chef Compliance or Chef Automate, you need to have Chef Server integrated with Chef Compliance or Chef Automate. You can then set the fetcher attribute to 'chef-server'.
This will allow the audit cookbook to fetch profiles stored in Chef Compliance. For example:
"audit": {
"fetcher": "chef-server",
"reporter": "chef-server-automate",
"profiles": [
{
"name": "ssh",
"compliance": "base/ssh"
}
]
}This method is fetching profiles using the data_collector.server_url and data_collector.token, defined in client.rb. It requires inspec version 0.27.1 or greater. Further information is available at Chef Docs: Configure a Data Collector token in Chef Automate
"audit": {
"fetcher": "chef-automate",
"reporter": "chef-automate",
"profiles": [
{
"name": "ssh",
"compliance": "base/ssh"
}
]
}In order to support build cookbook mode, the compliance_profile resource has an upload action that allows uploading a compressed
inspec compliance profile to the Compliance Server.
Simply include the upload recipe in the run_list, with attribute overrides for the audit hash like so:
audit: {
server: 'https://compliance-server.test/api',
reporter: 'chef-compliance',
refresh_token: '21/XMEK3...',
profiles: [
{
'name': 'admin/ssh2',
'path': '/some/base_ssh.tar.gz'
}
]
}The following tables compares the Chef Client audit mode with this audit cookbook.
| audit mode | audit cookbook | |
|---|---|---|
| Works with Chef Compliance | No | Yes |
| Execution Engine | Serverspec | InSpec |
| Execute InSpec Compliance Profiles | No | Yes |
| Execute tests embedded in Chef recipes | Yes | No |
Eventually the audit cookbook will replace audit mode. The only drawback is that you will not be able to execute tests in Chef recipes, but since you will be running these tests in production, you will want to have a straightforward, consistent process by which you include these tests throughout your development lifecycle. Within Chef Compliance, this is a profile.
We will improve the migration and help to ease the process and to reuse existing audit mode test as much as possible. At this point of time, an existing audit-mode test like:
control_group 'Check SSH Port' do
control 'SSH' do
it 'should be listening on port 22' do
expect(port(22)).to be_listening
end
end
end
can be re-written in InSpec as follows:
# rename `control_group` to `control` and use a unique identifier
control "blog-1" do
title 'Check SSH Port' # add the title from `control_group`
# rename the old `control` to `describe`
describe 'SSH' do
it 'should be listening on port 22' do
expect(port(22)).to be_listening
end
end
end
or even simplified to:
control "blog-1" do
title 'SSH should be listening on port 22'
describe port(22) do
it { should be_listening }
end
end
The audit cookbook and Chef's own "Audit Mode" are not compatible due to global state management done by RSpec which is used by both implementations. To prevent unexpected results, the audit cookbook will prevent Chef from continuing if "Audit Mode" is not disabled.
You can use the chef-client cookbook to disable "Audit Mode" on all of your nodes to permit use of the audit cookbook. As an example, when using the chef-client cookbook you can add this configuration to default_attributes section of a role and add the chef-client cookbook to the run list.
"chef_client": {
"config": {
"audit_mode": ":disabled"
}
},
If you have long running audit profiles that you don't wish to execute on every chef-client run, you can enable an interval:
default['audit']['interval']['enabled'] = true
default['audit']['interval']['time'] = 1440 # once a day, the default value
The time attribute is in minutes.
You can enable the interval and set the interval time, along with your desired profiles, in an environment or role like this:
"audit": {
"profiles": [
{
"name": "ssh",
"compliance": "base/ssh"
},
{
"name": "linux",
"compliance": "base/linux"
}
],
"interval": {
"enabled": true,
"time": 1440
}
}
If you are not able or do not wish to pull the inspec gem from rubygems.org,
you may specify an alternate source using:
# URI to alternate gem source (e.g. http://gems.server.com or filesytem location)
# root of location must host the *specs.4.8.gz source index
default['audit']['inspec_gem_source'] = 'http://internal.gem.server.com/gems'
Please note that all dependencies to the inspec gem must also be hosted in this location.
While it is recommended that InSpec profiles should be self-contained and not rely on external data unless necessary, there are valid use cases where a profile's test may exhibit different behavior depending on aspects of the node under test.
There are two primary ways to pass Chef data to the InSpec run via the audit cookbook.
Any data added to the node['audit']['attributes'] hash will be passed as individual InSpec attributes.
This provides a clean interface between the Chef run and InSpec profile, allowing for easy assignment
of sane default values in the InSpec profile. This method is especially recommended if the InSpec profile
is expected to be used outside of the context of the audit cookbook so it's extra clear to profile
consumers what attributes are necessary.
In a wrapper cookbook or similar, set your Chef attributes:
node.normal['audit']['attributes']['key1'] = 'value1'
node.normal['audit']['attributes']['debug_enabled'] = node['my_cookbook']['debug_enabled']
node.normal['audit']['attributes']['environment'] = node.chef_environment... and then use them in your InSpec profile:
environment = attribute('environment', description: 'The chef environment for the node', default: 'dev')
control 'debug-disabled-in-production' do
title 'Debug logs disabled in production'
desc 'Debug logs contain potentially sensitive information and should not be on in prod.'
impact 1.0
describe file('/path/to/my/app/config') do
its('content') { should_not include "debug=true" }
end
only_if { environment == 'production' }
endIn the event where it is not practical to opt-in to pass certain attributes and data, the audit cookbook will
pass the Chef node object as an InSpec attribute named chef_node.
While this provides the ability to write more flexible profiles, it makes it more difficult to reuse profiles outside of an audit cookbook run, requiring the profile user to know how to pass in a single attribute containing Chef-like data. Therefore, it is recommended to use Option 1 whenever possible.
To use this option, first enable it in a wrapper cookbook or similar:
node.override['audit']['chef_node_attribute_enabled'] = true... and then use it in your profile:
chef_node = attribute('chef_node', description: 'Chef Node')
control 'no-password-auth-in-prod' do
title 'No Password Authentication in Production'
desc 'Password authentication is allowed in all environments except production'
impact 1.0
describe sshd_config do
its('PasswordAuthentication') { should cmp 'No' }
end
only_if { chef_node['chef_environment'] == 'production' }
endIntroduced in Audit Cookbook v6.0.0 and InSpec v1.47.0
InSpec v1.47.0 provides the ability to cache the result of commands executed on the node being tested. This drastically improves InSpec performance when slower-running commands are run multiple times during execution.
This feature is enabled by default in the audit cookbook. If your profile runs a command multiple times and expects output to be different each time, you may have to disable this feature. To do so, set the inspec_backend_cache attribute to false:
node.normal['audit']['inspec_backend_cache'] = falsePlease refer to TROUBLESHOOTING.md.
Please let us know if you have any issues, we are happy to help.
bundle install
bundle exec rake style
# run all ChefSpec tests
bundle exec rspec
# run a specific test
bundle exec rspec ./spec/unit/libraries/automate_spec.rb- Cookbook source located here: (https://github.com/chef-cookbooks/audit)
- Hosted Chef users("collaborators") that can publish it to supermarket.chef.io:
apop,arlimus,chris-rock,sr. Add more collaborators fromSupermarket>Manage Cookbook>Add Collaborator
Releasing a new cookbook version:
- version bump the metadata.rb and updated changelog (
bundle exec rake changelog) - Get your changes merged into master
- Go to the
auditcookbook directory and pull from master - Run
bundle install - Use stove to publish the cookbook(including git version tag). You must point to the private key of your hosted chef user. For example:
bundle exec stove --username apop --key ~/git/chef-repo/.chef/apop.pem
| Author: | Stephan Renatus (srenatus@chef.io) |
| Author: | Christoph Hartmann (chartmann@chef.io) |
| Copyright: | Copyright (c) 2015 Chef Software Inc. |
| License: | Apache License, Version 2.0 |
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.