Como configurar processadores de mensagens para permitir cabeçalhos duplicados

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
informações

De acordo com a especificação HTTP RFC 7230, seção 3.2.2: ordem dos campos (em inglês), o Apigee Edge espera que a solicitação HTTP do cliente ou a resposta HTTP do servidor de back-end não contenha o mesmo cabeçalho transmitido mais de uma vez com valores iguais ou diferentes, a menos que o cabeçalho específico tenha uma exceção e possa ter duplicatas.

Por padrão, o Apigee Edge permite que cópias e vários valores sejam transmitidos para a maioria dos cabeçalhos HTTP. No entanto, ela não permite determinados cabeçalhos listados em Cabeçalhos que não podem ter cópias e vários valores. Assim:

  • Você vai receber 400 Bad Request com o código de erro protocol.http.DuplicateHeader se o cliente enviar uma solicitação HTTP com um cabeçalho específico mais de uma vez ou com vários valores para os cabeçalhos HTTP que não podem ter cópias/vários valores no Apigee Edge.
  • Da mesma forma, você vai receber 502 Bad Gateway com o código de erro protocol.http.DuplicateHeader se o servidor de back-end enviar uma resposta HTTP com um cabeçalho específico mais de uma vez ou com vários valores para os cabeçalhos HTTP que não podem ter cópias ou diversos valores no Apigee Edge

A solução recomendada para resolver esses erros é corrigir o aplicativo cliente e o servidor de back-end para não enviar cabeçalhos duplicados e aderir à especificação RFC 7230, seção 3.2.2: ordem de campos, conforme explicado nos seguintes manuais de solução de problemas:

No entanto, em alguns casos, convém adicionar uma exceção para incluir duplicatas e múltiplos valores para alguns cabeçalhos HTTP. Nessas situações, você pode permitir cabeçalhos duplicados e vários valores para um cabeçalho HTTP específico, definindo uma propriedade HTTPHeader.HEADER_NAME no nível do processador de mensagens.

Este documento contém informações sobre essa propriedade, explica como ativá-la para evitar os erros mencionados acima e compartilha práticas recomendadas.

Propriedades do cabeçalho HTTP para permitir duplicatas e vários valores

O Apigee Edge fornece as duas propriedades a seguir para controlar o comportamento de permitir duplicatas e vários valores para cabeçalhos HTTP. Observe que eles só podem ser configurados nos processadores de mensagens usando a sintaxe de token explicada em Como configurar o Edge.

Nome da propriedade Descrição Valores permitidos
HTTPHeader.ANY

Essa propriedade indica se cópias ou vários valores são permitidos para todos os cabeçalhos HTTP, incluindo os personalizados enviados como parte da solicitação HTTP feita pelo cliente ou da resposta HTTP enviada pelo servidor de back-end para o Apigee Edge.

Valor padrão:

multivalued, allowDuplicate,

  1. blank: cópias e vários valores para cabeçalhos HTTP não são permitidos.
  2. multiValued: divide o cabeçalho com vários valores em vários. Vários valores são permitidos para cabeçalhos HTTP, mas cópias não são permitidas. O valor multiValued está ativado, o que implica que test-header=a,b seria convertido em test-header=a e test-header=b.
  3. allowDuplicate: permite vários cabeçalhos HTTP (duplicados) com o mesmo nome.
  4. multivalued, allowDuplicate: valores múltiplos e duplicatas são permitidos para cabeçalhos HTTP.

HTTPHeader.HEADER_NAME

Essa propriedade é usada para substituir o comportamento de um cabeçalho específico do que é especificado por HTTPHeader.ANY

As mesmas informações mencionadas acima.

Cabeçalhos que não podem ter cópias e valores múltiplos

Conforme explicado anteriormente, o Apigee Edge permite cópias e diversos valores na maioria dos cabeçalhos HTTP por padrão. Isso ocorre porque a propriedade HTTPHeader.ANY está configurada com o valor multivalued, allowDuplicate.

Configuração substituída

Para alguns cabeçalhos específicos, a configuração padrão é substituída usando um dos seguintes métodos:

  • HTTPHeader.HEADER_NAME=multivalued, allowDuplicate

    Essa configuração não muda o comportamento padrão. Ou seja, o cabeçalho específico pode ter duplicatas e valores múltiplos.

    .
  • HTTPHeader.HEADER_NAME=

    Esta configuração muda o comportamento padrão. Ou seja, o cabeçalho específico não pode ter cópias e vários valores.

Determinar cabeçalhos que não podem ter cópias e vários valores

Esta seção descreve como identificar o seguinte:

  • Os cabeçalhos específicos que não têm permissão para ter cópias e vários valores na configuração da nuvem privada do Apigee Edge e
  • Os cabeçalhos específicos com configuração preexistente
  1. Na máquina do processador de mensagens, pesquise a propriedade HTTPHeader. no diretório /opt/apigee/edge-message-processor/conf, conforme mostrado abaixo:

    grep -ri "HTTPHeader." /opt/apigee/edge-message-processor/conf
    

    Exemplo de resposta:

    # grep -ri "HTTPHeader" /opt/apigee/edge-message-processor/conf
    /opt/apigee/edge-message-processor/conf/http.properties:HTTPHeader.ANY=allowDuplicates, multiValued
    /opt/apigee/edge-message-processor/conf/http.properties:HTTPHeader.Connection=allowDuplicates, multiValued
    … <snipped>
    /opt/apigee/edge-message-processor/conf/http.properties:HTTPHeader.Host=
    /opt/apigee/edge-message-processor/conf/http.properties:HTTPHeader.Expires=
    /opt/apigee/edge-message-processor/conf/http.properties:HTTPHeader.Date=allowDuplicates
    …
    <snipped>
    
  2. Conforme explicado na seção Configuração substituída, observe as seguintes informações na amostra de saída acima:
    1. O cabeçalho HTTP Connection é substituído, mas pode ter cópias e vários valores
    2. Os cabeçalhos HTTP Host e Expires foram substituídos e não podem ter cópias e vários valores
    3. O cabeçalho HTTP Date é substituído e pode ter cópias, mas não vários valores.
    4. Todos os cabeçalhos que aparecem aqui (Connection, Host, Expires e Date no exemplo acima) são chamados de cabeçalhos com configuração preexistente neste documento.

Comportamento do Apigee Edge

A tabela a seguir descreve o comportamento do Apigee Edge quando os cabeçalhos são enviados como duplicados e com vários valores, dependendo de como as propriedades HTTPHeader estão configuradas nos processadores de mensagens com um exemplo de HTTPHeader de test-header.

Solicitação CABEÇALHOS enviados com base no valor de conf/http.properties+HTTPHeader.test-header=
<Em branco> allowDuplicate multiValued allowDuplicate, multiValued (DEFAULT)
test‑header=a,b test‑header=a,b test‑header=a,b

protocol.http.
DuplicateHeader

Internamente, dividimos test-header=a,b em:

  • test-header=a e
  • test-header=b,

em seguida, o erro DuplicateHeader será gerado.

test‑header=a,b

Internamente, dividimos test-header=a,b em:

  • test-header=a e
  • test-header=b,

mas o formulário original é enviado para a segmentação.

test‑header=a
test‑header=b
protocol.http.
DuplicateHeader
test‑header=a
test‑header=b
protocol.http.
DuplicateHeader
test‑header=a
test‑header=b

Antes de começar

Antes de usar as etapas deste documento, entenda a configuração de propriedades para o Edge na nuvem privada, descritas em Como configurar o Edge.

Como configurar allowDuplicates e vários valores para cabeçalhos

Conforme explicado em Propriedades do cabeçalho HTTP para permitir duplicatas e vários valores, o valor da propriedade HTTPHeader.ANY = allowDuplicates, multivalued implica que todos os cabeçalhos podem ter cópias e vários valores no Apigee Edge. No entanto, há alguns cabeçalhos com valores que são substituídos explicitamente para não permitir cabeçalhos duplicados ou vários valores para esses cabeçalhos usando a propriedade HTTPHeader.HEADER_NAME.

Esta seção explica como configurar a propriedade HTTPHeader.HEADER_NAME para permitir cópias e diversos valores de cabeçalhos HTTP nos processadores de mensagens usando o token correspondente de acordo com a sintaxe descrita em Como configurar o Edge.

Nesta seção, usaremos Expires (e myheader) como um exemplo de cabeçalho para o qual queremos permitir cópias e vários valores, conforme explicado abaixo:

  1. Determine o valor atual da propriedade HTTPHeaderHEADER_NAME para verificar se ela já não está ativada para permitir duplicatas e vários valores usando o seguinte comando:
    grep -ri "HTTPHeader.HEADER_NAME" /opt/apigee/edge-message-processor/conf
    

    Por exemplo, se você estiver tentando definir a propriedade para o cabeçalho Expires, verifique o valor atual do token da propriedade HTTPHeader.Expires no processador de mensagens:

    grep -ri "HTTPHeader.Expires" /opt/apigee/edge-message-processor/conf
    

    A saída do comando acima resulta em uma das seguintes opções:

    1. Quando a propriedade é definida como em branco, isso significa que o valor é substituído (e esse é um cabeçalho com configuração preexistente) para NÃO permitir cabeçalhos duplicados e vários valores. Ou seja, você não tem permissão para enviar o cabeçalho Expires mais de uma vez como parte da solicitação HTTP ou resposta HTTP para a Apigee.
    2. Não houver hits para a propriedade específica, isso significa que o valor não é substituído (e NÃO é um cabeçalho com configuração preexistente). Isso significa que o cabeçalho específico pode ser enviado mais de uma vez (cópias são permitidas) como parte da solicitação HTTP ou resposta HTTP para o Apigee Edge.
    3. A propriedade é definida com o valor allowDuplicates, multivalued, o que significa que o valor foi substituído explicitamente (e esse é um cabeçalho com configuração preexistente). Isso significa que o cabeçalho específico pode ser enviado mais de uma vez (cópias são permitidas) como parte da solicitação HTTP ou resposta HTTP à Apigee.

    Exemplo de saída do comando de pesquisa:

    /opt/apigee/edge-message-processor/conf/http.properties:HTTPHeader.Expires=
    

    O exemplo de saída acima mostra que a propriedade HTTPHeader.Expires está definida como em branco. Isso significa que a propriedade é substituída para não permitir valores duplicados ou múltiplos para o cabeçalho Expires.

  2. Se você perceber que a propriedade correspondente ao cabeçalho específico foi substituída explicitamente para não permitir valores duplicados ou múltiplos, como no exemplo de saída acima, somente depois realize as etapas a seguir. Se ela não for substituída explicitamente, pule o restante das etapas nesta seção.
  3. Editar playlist. Se não existir, você poderá criá-lo:
    /opt/apigee/customer/application/message-processor.properties
    

    Por exemplo, para abrir o arquivo usando o vi, digite o seguinte:

    vi /opt/apigee/customer/application/message-processor.properties
    
  4. Adicione uma linha no seguinte formato:
    conf_http_HTTPHeader.Expires=allowDuplicates, multiValued
    
  5. Salve as mudanças.
  6. Verifique se o arquivo de propriedades pertence ao usuário apigee. Se não estiver, execute o seguinte comando:

    chown apigee:apigee /opt/apigee/customer/application/message-processor.properties
    
  7. Reinicie o processador de mensagens:

    /opt/apigee/apigee-service/bin/apigee-service edge-message-processor restart
    

    Para reiniciar sem impacto no tráfego, consulte Reinicialização contínua dos processadores de mensagens sem impacto no tráfego.

  8. Se você tiver mais de um processador de mensagens, repita as etapas acima em todos eles.

Verificar se o cabeçalho está configurado para ter duplicatas e vários valores

Esta seção explica como verificar se a propriedade HTTPHeader.HEADER_NAME de um cabeçalho específico foi atualizada para permitir duplicatas nos processadores de mensagens.

Vamos usar Expires como um cabeçalho de exemplo e verificar se a propriedade correspondente HTTPHeader.Expires foi atualizada.

Mesmo que você use o token conf_http_HTTPHeader.Expires para atualizar o valor no processador de mensagens, será necessário verificar se a propriedade HTTPHeader.Expires real foi definida com o novo valor.

  1. Na máquina do processador de mensagens, pesquise a propriedade HTTPHeader.HEADER_NAME no diretório /opt/apigee/edge-message-processor/conf e verifique se ela foi definida com o novo valor, conforme mostrado abaixo:
    grep -ri "HTTPHeader.HEADER_NAME" /opt/apigee/edge-message-processor/conf
    

    Por exemplo, se você quiser verificar se a propriedade HTTPHeader.Expires está definida com o novo valor, execute o seguinte comando:

    grep -ri "HTTPHeader.Expires" /opt/apigee/edge-message-processor/conf
    
  2. Se o novo valor for definido com êxito para HTTPHeader.HEADER_NAME no processador de mensagens, o comando acima mostrará o novo valor no arquivo http.properties.
  3. O resultado de amostra do comando acima depois de configurar allowDuplicates e multiValued é o seguinte:

    /opt/apigee/edge-message-processor/conf/http.properties:HTTPHeader.Expires=allowDuplicates, multiValued
    
  4. No exemplo de saída acima, observe que a propriedade HTTPHeader.Expires foi definida com o novo valor allowDuplicates, multiValued em http.properties. Isso indica que o comportamento para permitir duplicatas e valores múltiplos em HTTPHeader foi configurado com sucesso no processador de mensagens.
  5. Se o valor antigo da propriedade HTTPHeader.HEADER_NAME ainda aparecer, verifique se você seguiu todas as etapas descritas em Como configurar allowDuplicates e vários valores para cabeçalhos corretamente. Se você esqueceu alguma etapa, repita todas as etapas corretamente.

    Verifique se os proxies estão funcionando conforme o esperado, especialmente se houver uma lógica funcional para receber e definir os cabeçalhos no proxy.

  6. Se ainda não for possível modificar a propriedade, entre em contato com o suporte do Apigee Edge

Desativação de allowDuplicates para cabeçalhos

Esta seção explica como configurar a propriedade HTTPHeader.{Headername} para não permitir duplicatas e valores múltiplos para um cabeçalho HTTP específico nos processadores de mensagens, usando o token correspondente de acordo com a sintaxe descrita em Como configurar o Edge.

Nesta seção, usaremos Expires (e myheader) como um exemplo de cabeçalho para o qual não queremos permitir cópias, conforme explicado abaixo:

  1. Determine o valor atual da propriedade HTTPHeaderHEADER_NAME para garantir que ela ainda não esteja desativada para permitir duplicatas e vários valores usando o seguinte comando:
    grep -ri "HTTPHeader.HEADER_NAME" /opt/apigee/edge-message-processor/conf
    

    Por exemplo, se você estiver tentando definir a propriedade para o cabeçalho Expires, verifique o valor atual do token da propriedade HTTPHeader.Expires no processador de mensagens:

    grep -ri "HTTPHeader.Expires" /opt/apigee/edge-message-processor/conf
    

    A saída do comando acima resulta em uma das seguintes opções:

    1. Se a propriedade for definida como em branco, isso implica que o valor será substituído por NOT para permitir cabeçalhos duplicados e vários valores. Ou seja, você não tem permissão para enviar o cabeçalho Expires mais de uma vez como parte da solicitação HTTP ou resposta HTTP para a Apigee.
    2. Não houver hits para a propriedade específica. Isso significa que o valor não será substituído e esse é um cabeçalho NOT com configuração preexistente. Isso significa que o cabeçalho específico pode ser enviado mais de uma vez (cópias são permitidas) como parte da solicitação HTTP ou resposta HTTP para o Apigee Edge.
    3. A propriedade é definida com o valor allowDuplicates, multivalued, então isso significa que o valor foi substituído explicitamente, e essa é uma configuração existente. No entanto, isso significa que o cabeçalho específico pode ser enviado mais de uma vez (cópias são permitidas) como parte da solicitação HTTP ou resposta HTTP à Apigee.

    Exemplo de saída 1

    Exemplo de saída 1 do comando de pesquisa:

    /opt/apigee/edge-message-processor/conf/http.properties:HTTPHeader.Expires=allowDuplicates, multiValued
    

    O exemplo de saída mostra que a propriedade HTTPHeader.Expires está definida como allowDuplicates, multiValued. Isso significa que a propriedade é substituída para permitir valores duplicados ou múltiplos para o cabeçalho Expires.

    Exemplo de saída 2

    Comando de exemplo e saída no 2 do comando de pesquisa

    grep -ri "HTTPHeader.myheader" /opt/apigee/edge-message-processor/conf
    

    A saída da amostra não mostra nenhuma saída, o que significa que a propriedade HTTPHeader.myheader está definida como allowDuplicates, multiValued por padrão. Isso também significa que a propriedade não será substituída para o cabeçalho myheader,

  2. Se uma das seguintes situações for exibida, siga as outras etapas desta seção:
    1. A propriedade correspondente ao cabeçalho específico é substituída para permitir duplicatas e vários valores, como no Exemplo de saída no 1 acima (cabeçalho com configuração preexistente)
    2. Não há hits para a propriedade correspondente ao cabeçalho específico, como no Exemplo de saída 2 acima (não um cabeçalho com configuração preexistente).

    Caso contrário, pule as outras etapas desta seção.

  3. Edite o arquivo a seguir. Se ainda não existir, você poderá criá-lo.
    /opt/apigee/customer/application/message-processor.properties
    

    Por exemplo, para abrir o arquivo usando o vi, digite o seguinte:

    vi /opt/apigee/customer/application/message-processor.properties
    
  4. Adicione uma linha no seguinte formato ao arquivo de propriedades:

    Configuração preexistente

    Cenário 1: cabeçalho com configuração preexistente:

    conf_http_HTTPHeader.Expires=
    

    Nenhuma configuração preexistente

    Cenário n.o 2: não é um cabeçalho com configuração preexistente:

    conf/http.properties+HTTPHeader.myheader=
    
  5. Salve as mudanças.
  6. Verifique se o arquivo de propriedades pertence ao usuário apigee. Caso contrário, execute o seguinte:
    chown apigee:apigee /opt/apigee/customer/application/message-processor.properties
    
  7. Reinicie o processador de mensagens:
    /opt/apigee/apigee-service/bin/apigee-service edge-message-processor restart
    

    Para reiniciar sem impacto no tráfego, consulte Reinicialização contínua dos processadores de mensagens sem impacto no tráfego.

  8. Se você tiver mais de um processador de mensagens, repita as etapas acima para todos eles.

Verificar se o cabeçalho está configurado para não permitir duplicatas e valores múltiplos

Esta seção explica como verificar se a propriedade HTTPHeader.HEADER_NAME de um cabeçalho específico foi atualizada para não permitir duplicatas nos processadores de mensagens.

Vamos usar Expires (e myheader) como um cabeçalho de exemplo e verificar se a propriedade correspondente HTTPHeader.Expires (e HTTPHeader.myheader) foi atualizada.

  1. Na máquina do processador de mensagens, pesquise a propriedade HTTPHeader.HEADER_NAME no diretório /opt/apigee/edge-message- processor/conf e verifique se ela foi definida com o novo valor, conforme mostrado abaixo:

    grep -ri "HTTPHeader.HEADER_NAME" /opt/apigee/edge-message-processor/conf
    

    Por exemplo, se você quiser verificar se a propriedade HTTPHeader.Expires está definida com o novo valor, execute o seguinte comando:

    Configuração preexistente

    grep -ri "HTTPHeader.Expires" /opt/apigee/edge-message-processor/conf
    

    Nenhuma configuração preexistente

    grep -ri "HTTPHeader.myheader" /opt/apigee/edge-message-processor/conf
    
  2. Se o novo valor do cabeçalho HTTP for definido para HTTPHeader.HEADER_NAME I no processador de mensagens, o comando acima vai mostrar o novo valor no arquivo http.properties.
  3. O resultado do comando acima, após a desativação de allowDuplicates, é o seguinte:

    Configuração preexistente

    Cenário n.o 1: cabeçalho de expiração (cabeçalho com configuração preexistente)

    /opt/apigee/edge-message-processor/conf/http.properties:HTTPHeader.Expires=
    

    Nenhuma configuração preexistente

    Cenário 2: cabeçalho myheader (não um cabeçalho com configuração preexistente)

    /opt/apigee/edge-message-processor/conf/http.properties:HTTPHeader.myheader=
    
  4. No exemplo de saída acima, observe que a propriedade HTTPHeader.Expires ( e HTTPHeader.myheader) foi definida com o novo valor {blank} em http.properties. Isso indica que o comportamento para permitir duplicatas e diversos valores para o cabeçalho HTTP específico Expires (e myheader) foi desativado com sucesso no processador de mensagens.
  5. Se o valor antigo da propriedade HTTPHeader.Expires (or HTTPHeader.myheader) ainda aparecer, verifique se você seguiu todas as etapas descritas em Como configurar allowDuplicates e vários valores para cabeçalhos corretamente. Se você esqueceu alguma etapa, repita todas as etapas corretamente.

    Verifique se os proxies estão funcionando conforme o esperado, especialmente se houver uma lógica funcional para acessar e definir os cabeçalhos no proxy.

  6. Se ainda não for possível modificar a propriedade, entre em contato com o suporte do Apigee Edge.