Wie fügt man einen benutzerdefinierten Response Header in Nginx mit proxy_pass hinzu?

Nginx für benutzerdefinierte Header konfigurieren

Die add_header-Anweisung in Nginx funktioniert mit proxy_pass und ermöglicht das Hinzufügen benutzerdefinierter Header zu Antworten von Upstream-Servern. Diese Funktion ist nützlich, um zusätzliche Informationen hinzuzufügen oder die Antwort zu ändern, bevor sie den Client erreicht.

Um add_header mit proxy_pass zu verwenden, fügen Sie es in denselben location-Block wie Ihre proxy_pass-Anweisung ein. Hier ist eine Beispiel-Nginx-Konfiguration:

server {
    server_name example.com;

    location / {
        proxy_pass http://backend_server;
        add_header X-Custom-Header "Benutzerdefinierter Wert";
    }
}

In dieser Konfiguration fügt Nginx den X-Custom-Header mit dem Wert "Benutzerdefinierter Wert" zu allen Antworten vom backend_server hinzu. Dieser Header wird in der an den Client gesendeten Antwort enthalten sein, unabhängig davon, ob Nginx oder der Upstream-Server die Antwort generiert hat.

Die add_header-Anweisung gilt für die aktuelle Ebene und alle darunter liegenden Ebenen, es sei denn, sie wird überschrieben. Wenn Sie Header nur für bestimmte Locations hinzufügen möchten, platzieren Sie die add_header-Anweisung im entsprechenden location-Block.

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

Schritt-für-Schritt-Anleitung

Um benutzerdefinierte Header bei Verwendung von proxy_pass in Nginx hinzuzufügen, folgen Sie diesen Schritten:

1. Bearbeiten Sie die Nginx-Konfigurationsdatei: Öffnen Sie Ihre Nginx-Konfigurationsdatei mit einem Texteditor. Die Datei befindet sich normalerweise unter /etc/nginx/nginx.conf oder /usr/local/nginx/conf/nginx.conf.

2. Fügen Sie die add_header-Anweisung hinzu: Fügen Sie im server- oder location-Block die add_header-Anweisung hinzu. Platzieren Sie sie nach der proxy_pass-Anweisung, um sie auf die weitergeleiteten Antworten anzuwenden.

3. Legen Sie den benutzerdefinierten Header und seinen Wert fest: Definieren Sie Ihren benutzerdefinierten Header-Namen und -Wert mit der add_header-Anweisung. Die Syntax lautet:

   add_header <header_name> <header_value>;

Hier ist ein Beispiel, wie Ihre Konfiguration aussehen könnte:

server {
    listen 80;
    server_name example.com;

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

In diesem Beispiel werden zwei benutzerdefinierte Header hinzugefügt:

• X-Custom-Header mit einem statischen Wert "Benutzerdefinierter Wert"
• X-Served-By mit dem Wert der $hostname-Variable, die den Namen des Nginx-Servers enthält

Nachdem Sie diese Änderungen vorgenommen haben, speichern Sie die Konfigurationsdatei und laden Sie Nginx neu, um die neuen Einstellungen anzuwenden:

sudo nginx -t
sudo nginx -s reload

Der erste Befehl überprüft die Konfiguration auf Syntaxfehler, während der zweite Nginx mit der neuen Konfiguration neu lädt.

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

Verwendung des 'always'-Parameters

Der 'always'-Parameter in Nginx's add_header-Anweisung ermöglicht es Ihnen, benutzerdefinierte Header zu allen Antworten hinzuzufügen, einschließlich Fehlerantworten. Diese Funktion ist nützlich, wenn Sie Ihre benutzerdefinierten Header in jeder Antwort haben möchten, unabhängig vom Statuscode.

Standardmäßig fügt Nginx benutzerdefinierte Header nur zu erfolgreichen Antworten (2xx und 3xx Statuscodes) hinzu. Um benutzerdefinierte Header auch in Fehlerantworten (4xx und 5xx Statuscodes) einzuschließen, verwenden Sie den 'always'-Parameter.

Hier ist die Verwendung des 'always'-Parameters:

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

In dieser Konfiguration wird der X-Custom-Header zu allen Antworten hinzugefügt, einschließlich Fehlerantworten.

Sie können den 'always'-Parameter mit mehreren Headern verwenden:

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

Diese Konfiguration fügt drei benutzerdefinierte Header zu allen Antworten hinzu, einschließlich derer mit Fehlerstatuscodes.

location / {
    proxy_pass http://backend_server;
    add_header X-Cache-Status $upstream_cache_status always;
    if ($status = 404) {
        add_header X-Error-Type "Nicht gefunden" 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;
    }
}

Beachten Sie, dass die Verwendung des 'always'-Parameters sensible Informationen in Fehlerantworten anzeigen kann. Überprüfen Sie Ihre benutzerdefinierten Header, um die Offenlegung sensibler Daten zu vermeiden.