inspec/docs/resources/apache_conf.md.erb

79 lines
2 KiB
Text
Raw Normal View History

2016-09-22 12:43:57 +00:00
---
title: About the apache_conf Resource
platform: linux
2016-09-22 12:43:57 +00:00
---
# apache_conf
Use the `apache_conf` Chef InSpec audit resource to test the configuration settings for Apache. This file is typically located under `/etc/apache2` on the Debian and Ubuntu platforms and under `/etc/httpd` on the Fedora, CentOS, RedHat Enterprise Linux, and ArchLinux platforms. The configuration settings may vary significantly from platform to platform.
2016-09-22 12:43:57 +00:00
<br>
## Availability
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
2016-09-22 12:43:57 +00:00
An `apache_conf` Chef InSpec audit resource block declares configuration settings that should be tested:
2016-09-22 12:43:57 +00:00
describe apache_conf('path') do
its('setting_name') { should eq 'value' }
end
where
* `'setting_name'` is a configuration setting defined in the Apache configuration file
* `('path')` is the non-default path to the Apache configuration file
* `{ should eq 'value' }` is the value that is expected
<br>
2016-09-22 12:43:57 +00:00
## Examples
2016-09-22 12:43:57 +00:00
The following examples show how to use this Chef InSpec audit resource.
2016-09-22 12:43:57 +00:00
### Test for blocking .htaccess files on CentOS
2016-09-22 12:43:57 +00:00
describe apache_conf do
its('AllowOverride') { should cmp 'None' }
end
2016-09-22 12:43:57 +00:00
### Test ports for SSL
2016-09-22 12:43:57 +00:00
describe apache_conf do
its('Listen') { should cmp '443' }
end
### Test multiple ports are listening
describe apache_conf do
its('Listen') { should =~ [ '80', '443' ] }
2016-09-22 12:43:57 +00:00
end
<br>
2016-09-22 12:43:57 +00:00
## Matchers
2016-09-22 12:43:57 +00:00
For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
This Chef InSpec audit resource matches any service that is listed in the Apache configuration file:
2016-09-22 12:43:57 +00:00
its('PidFile') { should_not eq '/var/run/httpd.pid' }
2016-09-22 12:43:57 +00:00
or:
2016-09-22 12:43:57 +00:00
its('Timeout') { should cmp '300' }
2016-09-22 12:43:57 +00:00
For example:
2016-09-22 12:43:57 +00:00
describe apache_conf do
its('MaxClients') { should cmp '100' }
its('Listen') { should cmp '443' }
2016-09-22 12:43:57 +00:00
end