mirror of
https://github.com/inspec/inspec
synced 2024-11-14 17:07:09 +00:00
89 lines
2 KiB
Text
89 lines
2 KiB
Text
---
|
|
title: The Nginx Resource
|
|
platform: linux
|
|
---
|
|
|
|
# nginx
|
|
|
|
Use the `nginx` InSpec audit resource to test the fields and validity of nginx.
|
|
|
|
Nginx resource extracts and exposes data reported by the command 'nginx -V'
|
|
|
|
<br>
|
|
|
|
## Availability
|
|
|
|
### Installation
|
|
|
|
This resource is distributed along with InSpec itself. You can use it automatically.
|
|
|
|
### Version
|
|
|
|
This resource first became available in v1.37.6 of InSpec.
|
|
|
|
## Syntax
|
|
|
|
An `nginx` InSpec audit resource block extracts configuration settings that should be tested:
|
|
|
|
describe nginx do
|
|
its('attribute') { should eq 'value' }
|
|
end
|
|
|
|
describe nginx('path to nginx') do
|
|
its('attribute') { should eq 'value' }
|
|
end
|
|
|
|
where
|
|
|
|
* `'attribute'` is a configuration parsed from result of the command 'nginx -V'
|
|
* `'value'` is the value that is expected of the attribute
|
|
|
|
<br>
|
|
|
|
## Properties
|
|
|
|
* `compiler_info`, `error_log_path`, `http_client_body_temp_path`, `http_fastcgi_temp_path`, `http_log_path`, `http_proxy_temp_path`, `http_scgi_temp_path`, `http_uwsgi_temp_path`, `lock_path`, `modules`, `modules_path`, `openssl_version`, `prefix`, `sbin_path`, `service`, `support_info`, `version`
|
|
|
|
<br>
|
|
|
|
## Property Examples
|
|
|
|
### version(String)
|
|
|
|
`version` returns a string of the version of the running nginx instance
|
|
|
|
describe nginx do
|
|
its('version') { should eq '1.12.0' }
|
|
end
|
|
|
|
### modules(String)
|
|
|
|
`modules` returns a array modules in the running nginx instance
|
|
|
|
describe nginx do
|
|
its('modules') { should include 'my_module' }
|
|
end
|
|
|
|
### openssl_version(Hash)
|
|
|
|
`openssl_version ` returns a hash with 'version' and 'date' as keys
|
|
|
|
describe nginx do
|
|
its('openssl_version.date') { should eq '11 Feb 2013' }
|
|
end
|
|
|
|
### compiler_info(Hash)
|
|
|
|
`compiler_info ` returns a hash with 'compiler' , version' and 'date' as keys
|
|
|
|
describe nginx do
|
|
its('compiler_info.compiler') { should eq 'gcc' }
|
|
end
|
|
|
|
### support_info(String)
|
|
|
|
`support_info ` returns a string containing supported protocols
|
|
|
|
describe nginx do
|
|
its('support_info') { should match /TLS/ }
|
|
end
|