Allow opting out of the default charset being appended to the request `Content-Type` header

Abierto Apto para principiantes
  • ¿Algo no está bien?
#1,729 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
72/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
java
Área
api, backend

Línea de trabajo

Empieza con AwsProxyHttpServletRequestReader.java y ContainerConfig.java para seguir cómo se añade y configura el juego de caracteres predeterminado. Después, lee o ejecuta AwsProxyHttpServletRequestReaderTest; añade pruebas para desactivar esta opción, el comportamiento predeterminado sin cambios y un parámetro charset= existente. Se considera terminado cuando desactivar la opción deja intacto el Content-Type entrante y el comportamiento predeterminado sigue intacto.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

  • Framework version: 3.0.2 (also confirmed identical in 3.0.3 and on main)
  • Implementations: All (core AwsProxyHttpServletRequestReader)

Scenario

AwsProxyHttpServletRequestReader.readRequest(...) rewrites the incoming Content-Type header on the
proxy event before the servlet request is built (and so before any filter runs):

// AwsProxyHttpServletRequestReader.java#L55
request.getMultiValueHeaders().putSingle(HttpHeaders.CONTENT_TYPE, getContentTypeWithCharset(contentType, config));

If the client sent a Content-Type without a charset parameter, getContentTypeWithCharset appends
"; charset=" + config.getDefaultContentCharset(), which defaults to ISO-8859-1:

This breaks any application that has to see the request headers exactly as the client sent them.
The case I hit is request-signature verification: the client signs a set of request components that
includes Content-Type (e.g. an HTTP message signature, a proof-of-possession token whose claims
hash the request headers, or an HMAC scheme). A servlet filter then recomputes the signature input
from HttpServletRequest. Because the container has already changed application/json to
application/json; charset=ISO-8859-1, the recomputed hash never matches and every request that
omits a charset fails verification.

There is currently no way to turn this off through ContainerConfig:

  • setDefaultContentCharset(null) produces Content-Type: application/json; charset=null
  • setDefaultContentCharset("") produces Content-Type: application/json; charset=

Both still change the header. The only workarounds are to replace or subclass the request reader, or to
reverse-engineer the exact appended suffix inside the verifier and retry with it stripped. Both
depend on container internals.

(Related background: #175 covered how a forced default charset interacts badly with
application/json, which RFC 8259 defines as UTF-8 and which has no charset parameter.)

Expected behavior

There should be a supported way to make the container leave the client's Content-Type unmodified.
The default behavior can stay as it is.

Actual behavior

Whenever no charset is present, the header is always rewritten, and no configuration value avoids it.

Steps to reproduce

  1. Build an AwsProxyRequest with header Content-Type: application/json (no charset).
  2. Run it through AwsProxyHttpServletRequestReader.readRequest(...). Calling
    setDefaultContentCharset(null) on the ContainerConfig first doesn't change the outcome.
  3. Observe servletRequest.getHeader("Content-Type") returns application/json; charset=ISO-8859-1
    (or ; charset=null), and that the original event's multi-value headers were mutated as well.

Proposed fix

Make the append opt-out-able, default unchanged. Two options, happy to go with whichever the
maintainers prefer:

Option A: treat a null/blank charset as "don't append" (smallest diff, no new API)

private String getContentTypeWithCharset(String headerValue, ContainerConfig config) {
    if (headerValue == null || "".equals(headerValue.trim())) {
        return headerValue;
    }
    if (headerValue.contains("charset=")) {
        return headerValue;
    }
    String charset = config.getDefaultContentCharset();
    if (charset == null || charset.trim().isEmpty()) {
        return headerValue;
    }
    ...
}

Users opt out with config.setDefaultContentCharset(null). Downside: it gives null a special meaning
that isn't obvious from the API, so the setDefaultContentCharset Javadoc would need to document it.
Right now null just produces a malformed charset=null value, so nobody can depend on the current
behavior.

Option B: explicit boolean flag (more readable intent)

Add ContainerConfig#setAppendDefaultContentCharset(boolean) (default true) and check it in
getContentTypeWithCharset. It's a slightly bigger change (field, getter/setter, default init, guard),
but the setting explains itself.

Either way the default (ISO-8859-1 appended) stays the same, so existing users aren't affected. I'm
happy to open a PR with the change plus tests in AwsProxyHttpServletRequestReaderTest. The tests would
cover: no suffix when opted out, the default path still appending, and an existing charset= left as is.

Lenguaje dominante
Java
Estrellas
1.6k
Forks
575
Merge medio
1 d 15 h
PR fusionados (30 d)
12

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de aws/serverless-java-container

Todos los issues de aws/serverless-java-container

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.