¿Por qué Nginx elimina los HTTP headers con guiones bajos?

La eliminación silenciosa: Comportamiento predeterminado de Nginx

Nginx elimina los encabezados con guiones bajos por defecto. Esto ocurre sin ninguna advertencia o mensaje de error. Cuando Nginx recibe una solicitud con encabezados que contienen guiones bajos, los elimina antes de enviar la solicitud al servidor o aplicación backend. Esta eliminación puede causar problemas en las aplicaciones web que usan estos encabezados personalizados para funcionalidades o transferencia de datos.

La naturaleza oculta de este proceso dificulta que los desarrolladores y administradores de sistemas encuentren la causa de los problemas relacionados con la falta de datos en los encabezados. Los usuarios pueden pasar tiempo depurando sus aplicaciones sin saber que Nginx está eliminando sus encabezados personalizados. Este comportamiento predeterminado puede ser un problema al trabajar con servicios o APIs de terceros que utilizan encabezados con guiones bajos, ya que puede interrumpir el flujo de información entre sistemas.

Contexto histórico: Variables CGI y conversión de encabezados

El comportamiento de Nginx de eliminar los encabezados con guiones bajos proviene del legado de la Interfaz de Entrada Común (CGI). CGI es un estándar antiguo para que los servidores web ejecuten programas externos y devuelvan su salida a los clientes web. Esto influyó en cómo los servidores web manejan los encabezados HTTP.

En CGI, los encabezados HTTP se convierten en variables de entorno para que los scripts las usen. Durante esta conversión, los guiones y guiones bajos en los nombres de los encabezados se cambian a guiones bajos. Por ejemplo, un encabezado como "Custom-Header" se convierte en "HTTP_CUSTOM_HEADER" como variable de entorno CGI. Este proceso puede crear confusión cuando los encabezados ya tienen guiones bajos.

Para evitar estas ambigüedades, Nginx elimina los encabezados con guiones bajos por defecto. Esta decisión previene problemas donde diferentes encabezados podrían mapearse al mismo nombre de variable CGI. Por ejemplo, "Custom_Header" y "Custom-Header" se convertirían ambos en "HTTP_CUSTOM_HEADER" en CGI, lo que haría poco claro a qué encabezado original representa la variable.

Aunque este enfoque resuelve el problema de ambigüedad, puede causar comportamientos inesperados en aplicaciones web modernas que no usan CGI y dependen de encabezados personalizados con guiones bajos. Entender este contexto histórico ayuda a explicar por qué Nginx maneja los encabezados que contienen guiones bajos de esta manera, aunque no siempre sea el comportamiento deseado en las prácticas actuales de desarrollo web.

Aclarando el RFC de HTTP

El RFC (Request for Comments) de HTTP permite el uso de guiones bajos en los nombres de los encabezados. Esto a menudo es malinterpretado por desarrolladores y administradores de sistemas. La especificación HTTP permite muchos caracteres en los nombres de los encabezados, incluidos los guiones bajos.

La confusión a menudo proviene de una mala interpretación de las reglas de caracteres ASCII en el RFC. La especificación HTTP/1.1 (RFC 2616) se refiere al RFC 822 para los formatos de campos de encabezado. El RFC 822 establece que los nombres de los campos deben usar caracteres ASCII imprimibles, que incluyen caracteres con valores decimales entre 33 y 126, excepto por los dos puntos. El carácter de guion bajo (valor decimal 95) está dentro de este rango permitido.

Algunos desarrolladores piensan que los guiones bajos no están permitidos porque ciertos servidores web, como Apache o Nginx, los tratan como inválidos por defecto. Sin embargo, esta es una elección específica del servidor, no un requisito del estándar HTTP.

Aunque los guiones bajos están permitidos en los nombres de los encabezados HTTP según el RFC, usarlos puede causar problemas con algunos servidores o proxies que no están configurados para manejarlos. Por esta razón, a menudo es mejor usar guiones en lugar de guiones bajos en los nombres de encabezados personalizados para evitar posibles problemas.

Habilitando encabezados con guiones bajos: La solución de configuración

Para resolver el problema de Nginx eliminando los encabezados con guiones bajos, puedes usar la directiva 'underscores_in_headers on;' en tu configuración de Nginx. Esta directiva le dice a Nginx que acepte y pase los encabezados que contienen guiones bajos.

Para implementar esta solución, agrega la siguiente línea a tu configuración de Nginx:

underscores_in_headers on;

Puedes colocar esta directiva en diferentes ubicaciones dentro de tu archivo de configuración de Nginx, dependiendo de cuán ampliamente quieras aplicarla:

1. Bloque server: Si quieres habilitar los encabezados con guiones bajos para un servidor específico, agrega la directiva dentro del bloque server. Por ejemplo:

server {
    listen 80;
    server_name ejemplo.com;
    underscores_in_headers on;
    # Otras configuraciones del servidor...
}

2. Bloque http: Para habilitar los encabezados con guiones bajos para todos los servidores, coloca la directiva en el bloque http de tu configuración de Nginx:

http {
    underscores_in_headers on;
    # Otras configuraciones http...
}

3. Bloque location: Si solo necesitas permitir encabezados con guiones bajos para ubicaciones específicas, agrega la directiva al bloque location relevante:

location /api {
    underscores_in_headers on;
    # Otras configuraciones de location...
}

Después de agregar la directiva, reinicia Nginx para aplicar los cambios. Esto permitirá que Nginx procese y pase los encabezados que contienen guiones bajos, resolviendo el problema de los encabezados personalizados faltantes en tus aplicaciones.

Recuerda probar tu configuración después de hacer estos cambios para asegurarte de que todo funcione como se espera.

curl -I -H "X_Custom_Header: ValorDePrueba" http://tu-dominio.com