[THREESCALE-10164] Add support to set large_client_header_buffers directive

tkan145 commented 8 months ago

What

Fixes: https://issues.redhat.com/browse/THREESCALE-10164

Verification Steps

Creat a apicast-config.json file with the following content

cat <<EOF >apicast-config.json
{
    "services": [
        {
            "id": "1",
            "backend_version": "1",
            "proxy": {
                "hosts": [
                    "one"
                ],
                "api_backend": "https://echo-api.3scale.net:443",
                "backend": {
                    "endpoint": "http://127.0.0.1:8081",
                    "host": "backend"
                },
                "policy_chain": [
                    {
                        "name": "apicast.policy.apicast"
                    }
                ],
                "proxy_rules": [
                    {
                        "http_method": "GET",
                        "pattern": "/",
                        "metric_system_name": "hits",
                        "delta": 1,
                        "parameters": [],
                        "querystring_parameters": {}
                    }
                ]
            }
        }
    ]
} 
EOF

Checkout this branch and start dev environment
```
make development
make dependencies
```

Run apicast locally

THREESCALE_DEPLOYMENT_ENV=staging APICAST_LOG_LEVEL=debug APICAST_WORKER=1 APICAST_CONFIGURATION_LOADER=lazy APICAST_CONFIGURATION_CACHE=0 THREESCALE_CONFIG_FILE=apicast-config.json ./bin/apicast

Capture apicast IP

APICAST_IP=$(docker inspect apicast_build_0-development-1 | yq e -P '.[0].NetworkSettings.Networks.apicast_build_0_default.IPAddress' -)

Generate big header

LARGE_HEADER=$(for i in {1..1024}; do echo -n 'ABCDEFGH'; done)

Send request with big header

curl -i -k -H "Host: one" -H "Accept: application/json" -H "Large-Header: ${LARGE_HEADER}" "http://${APICAST_IP}:8080/?user_key="

The response should be HTTP/1.1 400 Bad Request

HTTP/1.1 400 Bad Request                                          
Server: openresty                                                 
Date: Thu, 08 Feb 2024 06:49:26 GMT                               
Content-Type: text/html                                           
Content-Length: 230                                               
Connection: close                                                 

<html>                                                            
<head><title>400 Request Header Or Cookie Too Large</title></head>
<body>                                                            
<center><h1>400 Bad Request</h1></center>                         
<center>Request Header Or Cookie Too Large</center>               
<hr><center>openresty</center>                                    
</body>                                                           
</html>

Stop the gateway
```
CTRL-C
```

Start gateway again with APICAST_LARGE_CLIENT_HEADER_BUFFERS=4 12k

THREESCALE_DEPLOYMENT_ENV=staging APICAST_LOG_LEVEL=debug APICAST_WORKER=1 APICAST_CONFIGURATION_LOADER=lazy APICAST_CONFIGURATION_CACHE=0 THREESCALE_CONFIG_FILE=apicast-config.json APICAST_LARGE_CLIENT_HEADER_BUFFERS="4 12k" ./bin/apicast

Send another request

curl -i -k -H "Host: one" -H "Accept: application/json" -H "Large-Header: ${LARGE_HEADER}" "http://${APICAST_IP}:8080/?user_key="

The response should be HTTP/1.1 200 OK

tkan145 commented 8 months ago

I kindly requested review from @3scale/documentation team.

For some reason the test keeps failing in this PR :disappointed: , hopefully after I address the feedback from the docs team and make a new commit the test will work

tkan145 commented 7 months ago

Conflict resolved

eguzki commented 7 months ago

@dfennessy your approval is needed as you requested changes

3scale / APIcast

[THREESCALE-10164] Add support to set large_client_header_buffers directive #1446

What

Verification Steps