http-cookies-filter — NGINX module

http-cookies-filter #

A NGINX module for fine-grained request cookies control.

Directives

add_request_cookie #

syntax: add_request_cookie cookie_name value [if=condition]; · default: — · context: http, server, location

Adds a new cookie. If the cookie already exists, the operation is ignored.

clear_request_cookie #

syntax: clear_request_cookie cookie_name [if=condition]; · default: — · context: http, server, location

Removes a cookie from the request headers.

rewrite_request_cookie #

syntax: rewrite_request_cookie 2 args; · context: http, server, location

Rewrites an existing request cookie's value to a compiled complex-value expression, optionally conditioned on an if=/if!= variable.

set_request_cookie #

syntax: set_request_cookie cookie_name value [if=condition]; · default: — · context: http, server, location

Sets the value of a cookie. If the cookie already exists, it will be modified. Cookie names are case-sensitive, the same below.

Example

http {
    server {
        listen 80;
        server_name example.com;

        location / {
            # If a cookie named "a" exists, set it to 1. Otherwise, add a cookie named "a" with value 1.
            set_request_cookie a 1;

            # If a cookie named "b" exists, do nothing. Otherwise, add a cookie named "a" with value 1.
            add_request_cookie b 2;

            # If a cookie named "c" exists, set it to 3. Otherwise, do nothing.
            modify_request_cookie c 3;
    
            # If a cookie named "d" exists, delete it. Otherwise, do nothing.
            clear_request_cookie d;

            # Conditional filtering. Only effected if varialbe $http_a is not empty or '0'.
            set_request_cookie e 4 if=$http_a;

            # Send the filtered cookies to upstream.
            proxy_set_header Cookie $filtered_request_cookies;

            proxy_pass http://127.0.0.1:8080;
        }
    }
}

↑ back to index