ansible-collection-hardening/roles/nginx_hardening

devsec.nginx_hardening

Description

This role provides secure nginx configuration. It is intended to be compliant with the DevSec Nginx Baseline.

It works with the following nginx-roles, including, but not limited to:

• nginxinc.nginx
• geerlinggux.nginx
• jdauphant.nginx

NOTE: This role does not work with nginx 1.0.15 or older! Please use the latest version from the official nginx repositories!

Supported Operating Systems

• EL
  • 8, 9
• Ubuntu
  • focal, jammy, noble
• Debian
  • bookworm, bullseye
• Amazon

Role Variables

• nginx_add_header
  • Default: ["X-Frame-Options SAMEORIGIN", "X-Content-Type-Options nosniff", "X-XSS-Protection \"1; mode=block\"", "Content-Security-Policy \\\"script-src 'self'; object-src 'self'\\\""]
  • Description: Adds the specified field to a response header provided that the response code equals 200, 201, 204, 206, 301, 302, 303, 304, or 307. See nginx_add_header
  • Type: list
  • Required: no
• nginx_client_body_buffer_size
  • Default: 1k
  • Description: Sets buffer size for reading client request body. In case the request body is larger than the buffer, the whole body or only its part is written to a temporary file. See nginx_client_body_buffer_size
  • Type: str
  • Required: no
• nginx_client_body_timeout
  • Default: 10
  • Description: Defines a timeout for reading client request body. See nginx_client_body_timeout
  • Type: int
  • Required: no
• nginx_client_header_buffer_size
  • Default: 1k
  • Description: Sets buffer size for reading client request header. For most requests, a buffer of 1K bytes is enough. See [nginx_client_header_buffer_size](http://nginx.org/en/docs/http/ngx_http_core_module.html#client
  • Type: str
  • Required: no
• nginx_client_header_timeout
  • Default: 10
  • Description: Defines a timeout for reading client request header. See nginx_client_header_timeout
  • Type: int
  • Required: no
• nginx_client_max_body_size
  • Default: 1k
  • Description: Sets the maximum allowed size of the client request body, specified in the "Content-Length" request header field. If the size in a request exceeds the configured value, the 413 (Request Entity Too Large) error is returned to the client. See nginx_client_max_body_size
  • Type: str
  • Required: no
• nginx_configuration_dir
  • Default: /etc/nginx
  • Description: The main location for all nginx configuration files
  • Type: str
  • Required: no
• nginx_configuration_hardening_dir
  • Default: /etc/nginx
  • Description: The location for the nginx hardening configuration file (Could be different e.g. when used in jails)
  • Type: str
  • Required: no
• nginx_dh_size
  • Default: 2048
  • Description: Specifies the length of DH parameters for EDH ciphers. See nginx_dh_size
  • Type: int
  • Required: no
• nginx_keepalive_timeout
  • Default: 5 5
  • Description: The first parameter sets a timeout during which a keep-alive client connection will stay open on the server side. The zero value disables keep-alive client connections. The optional second parameter sets a value in the "Keep-Alive timeout=time" response header field. See nginx_keepalive_timeout
  • Type: str
  • Required: no
• nginx_large_client_header_buffers
  • Default: 2 1k
  • Description: Sets the maximum number and size of buffers used for reading large client request header. See nginx_large_client_header_buffers
  • Type: str
  • Required: no
• nginx_limit_conn
  • Default: default 5
  • Description: Sets the shared memory zone and the maximum allowed number of connections for a given key value. See nginx_limit_conn
  • Type: str
  • Required: no
• nginx_limit_conn_zone
  • Default: $binary_remote_addr zone=default:10m
  • Description: Sets parameters for a shared memory zone that will keep states for various keys. See nginx_limit_conn_zone
  • Type: str
  • Required: no
• nginx_owner_group
  • Default: root
  • Description: The owner group of the nginx configuration files
  • Type: str
  • Required: no
• nginx_owner_user
  • Default: root
  • Description: The owner user of the nginx configuration files
  • Type: str
  • Required: no
• nginx_remove_default_site
  • Default: true
  • Description: Disables the default site. Set to false to enable the default site in nginx.
  • Type: bool
  • Required: no
• nginx_send_timeout
  • Default: 10
  • Description: Sets a timeout for transmitting a response to the client. See nginx_send_timeout
  • Type: int
  • Required: no
• nginx_server_tokens
  • Default: off
  • Description: Disables emitting nginx version in error messages and in the "Server" response header field. Set to on to enable the nginx version in error messages and "Server" response header. See nginx_server_tokens
  • Type: str
  • Required: no
• nginx_ssl_ciphers
  • Default: ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256
  • Description: Specifies the TLS ciphers which should be used. See nginx_ssl_ciphers
  • Type: str
  • Required: no
• nginx_ssl_prefer_server_ciphers
  • Default: on
  • Description: Specifies that server ciphers should be preferred over client ciphers when using the TLS protocols. Set to false to disable it. See nginx_ssl_prefer_server_ciphers
  • Type: str
  • Required: no
• nginx_ssl_protocols
  • Default: TLSv1.2
  • Description: Specifies the SSL protocol which should be used. See nginx_ssl_protocols
  • Type: str
  • Required: no

Dependencies

None.

Example Playbook

- hosts: all
  roles:
    - name: devsec.hardening.nginx_hardening