HSTS header in Nginx - Mini Project: Build & Apply

Configure HSTS Header in nginx

📖 Scenario: You are managing a website server using nginx. To improve security, you want to add the HTTP Strict Transport Security (HSTS) header. This header tells browsers to always use HTTPS when connecting to your site, preventing insecure connections.

🎯 Goal: Configure nginx to send the HSTS header with a max age of 31536000 seconds (1 year) and include subdomains.

📋 What You'll Learn

Create a basic nginx server block for example.com

Add a variable for the HSTS max age value

Add the HSTS header with the max age and includeSubDomains directive

Print the final nginx server block configuration

💡 Why This Matters

🌍 Real World

Web servers use HSTS headers to force browsers to use secure HTTPS connections, protecting users from attacks like man-in-the-middle.

💼 Career

Configuring security headers like HSTS is a common task for DevOps engineers and system administrators to harden web servers.

1

Create basic nginx server block

Create a server block for example.com listening on port 443 with SSL enabled. Use ssl_certificate set to /etc/ssl/certs/example.crt and ssl_certificate_key set to /etc/ssl/private/example.key. Inside the server block, add a location / that returns status 200 with text "Welcome to example.com".

Nginx

# Your code here

Hint

Use server { ... } block with listen 443 ssl; and specify SSL certificate paths.

2

Add HSTS max age variable

Add a variable called hsts_max_age and set it to 31536000 (seconds in one year) above the server block.

Nginx

hsts_max_age 31536000;

server {
    listen 443 ssl;
    server_name example.com;

    ssl_certificate /etc/ssl/certs/example.crt;
    ssl_certificate_key /etc/ssl/private/example.key;

    location / {
        return 200 "Welcome to example.com";
    }
}
# Your code here

Hint

Define hsts_max_age 31536000; before the server block.

3

Add HSTS header to server block

Inside the server block, add the header Strict-Transport-Security with the value "max-age=${hsts_max_age}; includeSubDomains" using the add_header directive.

Nginx

hsts_max_age 31536000;

server {
    listen 443 ssl;
    server_name example.com;

    ssl_certificate /etc/ssl/certs/example.crt;
    ssl_certificate_key /etc/ssl/private/example.key;

    add_header Strict-Transport-Security "max-age=${hsts_max_age}; includeSubDomains";

    location / {
        return 200 "Welcome to example.com";
    }
}
# Your code here

Hint

Use add_header Strict-Transport-Security "max-age=${hsts_max_age}; includeSubDomains"; inside the server block.

4

Print the final nginx configuration

Print the entire nginx configuration stored in the variable nginx_config which contains the full server block with the HSTS header.

Nginx

nginx_config = '''
hsts_max_age 31536000;

server {
    listen 443 ssl;
    server_name example.com;

    ssl_certificate /etc/ssl/certs/example.crt;
    ssl_certificate_key /etc/ssl/private/example.key;

    add_header Strict-Transport-Security "max-age=${hsts_max_age}; includeSubDomains";

    location / {
        return 200 "Welcome to example.com";
    }
}
'''

# Print the nginx configuration below
# Your code here

Hint

Assign the full config string to nginx_config and print it.

Practice

1. What is the main purpose of the Strict-Transport-Security (HSTS) header in nginx?

easy

A. To force browsers to use HTTPS instead of HTTP for the site

B. To redirect HTTP requests to a different domain

C. To enable caching of static files in the browser

D. To compress responses sent to the client

Solution

1. Step 1: Understand HSTS header purpose

   The HSTS header tells browsers to only use HTTPS for the site, improving security.

2. Step 2: Compare options with HSTS function

   Only To force browsers to use HTTPS instead of HTTP for the site matches this purpose; others describe unrelated features.

3. Final Answer:

   To force browsers to use HTTPS instead of HTTP for the site -> Option A

4. Quick Check:

   HSTS = Force HTTPS [OK]

Hint: HSTS means browsers must use HTTPS always [OK]

Common Mistakes:

• Confusing HSTS with redirects
• Thinking HSTS controls caching
• Assuming HSTS compresses data

2. Which of the following is the correct nginx syntax to add an HSTS header that lasts for 1 year and applies to all subdomains?

easy

A. add_header Strict-Transport-Security max-age=31536000 includeSubDomains always;

B. add_header Strict-Transport-Security "max-age=31536000; includeSubDomains" always;

C. add_header Strict-Transport-Security "max-age=31536000 includeSubDomains";

D. add_header Strict-Transport-Security max-age=31536000; includeSubDomains always;

Solution

1. Step 1: Check correct syntax for add_header

   The header value must be a quoted string with directives separated by semicolons, and 'always;' ensures it is added on all responses.

2. Step 2: Validate option formatting

   add_header Strict-Transport-Security "max-age=31536000; includeSubDomains" always; correctly quotes the value and uses semicolon between directives with 'always;'. Others miss quotes or semicolons or misplace 'always'.

3. Final Answer:

   add_header Strict-Transport-Security "max-age=31536000; includeSubDomains" always; -> Option B

4. Quick Check:

   Quotes + semicolon + always = add_header Strict-Transport-Security "max-age=31536000; includeSubDomains" always; [OK]

Hint: Use quotes and semicolons inside add_header value [OK]

Common Mistakes:

• Missing quotes around header value
• Forgetting semicolon between directives
• Placing 'always' inside quotes

3. Given this nginx config snippet:

add_header Strict-Transport-Security "max-age=86400; includeSubDomains" always;

What is the effect on browsers visiting the site?

medium

A. Browsers will enforce HTTPS for 1 day on the site and all subdomains

B. Browsers will enforce HTTPS for 1 year on the site only

C. Browsers will ignore the header because max-age is too low

D. Browsers will enforce HTTPS for 1 day on the site only

Solution

1. Step 1: Interpret max-age and includeSubDomains

   max-age=86400 means 86400 seconds = 1 day. includeSubDomains applies to all subdomains.

2. Step 2: Understand browser behavior

   Browsers will enforce HTTPS for 1 day on the site and all its subdomains as per header.

3. Final Answer:

   Browsers will enforce HTTPS for 1 day on the site and all subdomains -> Option A

4. Quick Check:

   86400 seconds = 1 day + includeSubDomains = Browsers will enforce HTTPS for 1 day on the site and all subdomains [OK]

Hint: max-age in seconds; 86400 = 1 day [OK]

Common Mistakes:

• Confusing seconds with days
• Ignoring includeSubDomains effect
• Assuming max-age too low disables HSTS

4. You added this line in nginx:

add_header Strict-Transport-Security max-age=31536000 includeSubDomains always;

Why is the HSTS header not sent to clients?

medium

A. includeSubDomains is not a valid directive

B. The 'always' directive must be inside the quotes

C. max-age value is too large and rejected by nginx

D. The header value is missing quotes, causing syntax error

Solution

1. Step 1: Check syntax for add_header directive

   The header value must be enclosed in quotes. Missing quotes cause nginx to ignore the header.

2. Step 2: Validate other parts

   'always' must be outside quotes, max-age=31536000 is valid, includeSubDomains is valid directive.

3. Final Answer:

   The header value is missing quotes, causing syntax error -> Option D

4. Quick Check:

   Quotes missing = header not sent [OK]

Hint: Always quote header values in add_header [OK]

Common Mistakes:

• Placing 'always' inside quotes
• Not quoting header value
• Misunderstanding valid directives

5. You want to preload your site in browsers' HSTS preload list. Which nginx header configuration is correct to achieve this for 6 months including subdomains?

hard

A. add_header Strict-Transport-Security "max-age=31536000; includeSubDomains; preload" always;

B. add_header Strict-Transport-Security "max-age=15768000; preload" always;

C. add_header Strict-Transport-Security "max-age=15768000; includeSubDomains; preload" always;

D. add_header Strict-Transport-Security "max-age=15768000; includeSubDomains" always;

Solution

1. Step 1: Calculate max-age for 6 months

   6 months ≈ 15768000 seconds (6 * 30 * 24 * 3600).

2. Step 2: Include required directives for preload

   Preload requires max-age, includeSubDomains, and preload directive all present.

3. Step 3: Verify syntax correctness

   add_header Strict-Transport-Security "max-age=15768000; includeSubDomains; preload" always; correctly quotes the value, uses semicolons, includes all directives, and uses 'always;'.

4. Final Answer:

   add_header Strict-Transport-Security "max-age=15768000; includeSubDomains; preload" always; -> Option C

5. Quick Check:

   Preload + includeSubDomains + 6 months = add_header Strict-Transport-Security "max-age=15768000; includeSubDomains; preload" always; [OK]

Hint: Preload needs max-age, includeSubDomains, preload keywords [OK]

Common Mistakes:

• Using wrong max-age for 6 months
• Omitting preload directive
• Not quoting header value