Come aggiungere un header di risposta personalizzato in Nginx con proxy_pass?

Configurare Nginx Per Intestazioni Personalizzate

La direttiva add_header in Nginx funziona con proxy_pass, permettendo di aggiungere intestazioni personalizzate alle risposte dai server upstream. Questa funzionalità è utile per aggiungere informazioni extra o modificare la risposta prima che raggiunga il client.

Per usare add_header con proxy_pass, includilo nello stesso blocco location della direttiva proxy_pass. Ecco un esempio di configurazione Nginx:

server {
    server_name example.com;

    location / {
        proxy_pass http://backend_server;
        add_header X-Custom-Header "Valore Personalizzato";
    }
}

In questa configurazione, Nginx aggiungerà l'intestazione X-Custom-Header con il valore "Valore Personalizzato" a tutte le risposte dal backend_server. Questa intestazione sarà nella risposta inviata al client, sia che la risposta sia stata generata da Nginx o dal server upstream.

La direttiva add_header si applica al livello corrente e a tutti i livelli inferiori, a meno che non venga sovrascritta. Se vuoi aggiungere intestazioni solo per specifiche location, posiziona la direttiva add_header nel blocco location appropriato.

location / {
    proxy_pass http://backend_server;
    add_header X-Response-Time $request_time;
    add_header X-Cache-Status $upstream_cache_status;
}

Guida Passo Passo

Per aggiungere intestazioni personalizzate quando si usa proxy_pass in Nginx, segui questi passaggi:

1. Modifica il file di configurazione di Nginx: Apri il file di configurazione di Nginx con un editor di testo. Il file si trova solitamente in /etc/nginx/nginx.conf o /usr/local/nginx/conf/nginx.conf.

2. Aggiungi la direttiva add_header: Nel blocco server o location, aggiungi la direttiva add_header. Posizionala dopo la direttiva proxy_pass per applicarla alle risposte inoltrate.

3. Imposta l'intestazione personalizzata e il suo valore: Definisci il nome e il valore della tua intestazione personalizzata usando la direttiva add_header. La sintassi è:

   add_header <nome_intestazione> <valore_intestazione>;

Ecco un esempio di come potrebbe apparire la tua configurazione:

server {
    listen 80;
    server_name example.com;

    location / {
        proxy_pass http://backend_server;
        add_header X-Custom-Header "Valore Personalizzato";
        add_header X-Served-By $hostname;
    }
}

In questo esempio, vengono aggiunte due intestazioni personalizzate:

• X-Custom-Header con un valore statico "Valore Personalizzato"
• X-Served-By con il valore della variabile $hostname, che contiene il nome del server Nginx

Dopo aver apportato queste modifiche, salva il file di configurazione e ricarica Nginx per applicare le nuove impostazioni:

sudo nginx -t
sudo nginx -s reload

Il primo comando controlla la configurazione per eventuali errori di sintassi, mentre il secondo ricarica Nginx con la nuova configurazione.

add_header X-Request-ID $request_id;
add_header X-Client-IP $remote_addr;

Usare Il Parametro 'always'

Il parametro 'always' nella direttiva add_header di Nginx permette di aggiungere intestazioni personalizzate a tutte le risposte, incluse le risposte di errore. Questa funzionalità è utile quando vuoi che le tue intestazioni personalizzate siano presenti in ogni risposta, indipendentemente dal codice di stato.

Per impostazione predefinita, Nginx aggiunge intestazioni personalizzate solo alle risposte di successo (codici di stato 2xx e 3xx). Per includere intestazioni personalizzate anche nelle risposte di errore (codici di stato 4xx e 5xx), usa il parametro 'always'.

Ecco come usare il parametro 'always':

location / {
    proxy_pass http://backend_server;
    add_header X-Custom-Header "Valore Personalizzato" always;
}

In questa configurazione, l'intestazione X-Custom-Header verrà aggiunta a tutte le risposte, incluse quelle di errore.

Puoi usare il parametro 'always' con più intestazioni:

location / {
    proxy_pass http://backend_server;
    add_header X-Custom-Header1 "Valore1" always;
    add_header X-Custom-Header2 "Valore2" always;
    add_header X-Server-Name $hostname always;
}

Questa configurazione aggiunge tre intestazioni personalizzate a tutte le risposte, incluse quelle con codici di stato di errore.

location / {
    proxy_pass http://backend_server;
    add_header X-Cache-Status $upstream_cache_status always;
    if ($status = 404) {
        add_header X-Error-Type "Non Trovato" always;
    }
}

server {
    listen 80;
    server_name example.com;

    add_header X-Frame-Options "SAMEORIGIN" always;
    add_header X-XSS-Protection "1; mode=block" always;
    add_header X-Content-Type-Options "nosniff" always;
    add_header Referrer-Policy "strict-origin-when-cross-origin" always;
    add_header Content-Security-Policy "default-src 'self';" always;

    location / {
        proxy_pass http://backend_server;
    }
}

Ricorda che l'uso del parametro 'always' può mostrare informazioni sensibili nelle risposte di errore. Rivedi le tue intestazioni personalizzate per evitare di esporre dati sensibili.