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

Aberta Para iniciantes
  • Algo errado?
#1,729 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
72/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
java
Domínio
api, backend

Direção de pesquisa

Comece por AwsProxyHttpServletRequestReader.java e ContainerConfig.java para rastrear como o conjunto de caracteres padrão é adicionado e configurado. Em seguida, leia ou execute AwsProxyHttpServletRequestReaderTest; adicione testes para desativar a opção, para o comportamento padrão inalterado e para um parâmetro charset= existente. O trabalho estará concluído quando a desativação deixar o Content-Type recebido inalterado e o comportamento padrão continuar intacto.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

  • 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.

Linguagem predominante
Java
Estrelas
1.6k
Forks
575
Merge médio
1d 15h
PRs com merge (30d)
12

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de aws/serverless-java-container

Todas as issues de aws/serverless-java-container

Issues semelhantes

Mais issues de Java

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.