500 Erro interno do servidor - BadFormData

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

Sintoma

O aplicativo cliente recebe um código de status HTTP de 500 Internal Server Error com o código de erro protocol.http.BadFormData como uma resposta para chamadas de API.

Mensagem de erro

O aplicativo cliente recebe este código de resposta:

HTTP/1.1 500 Internal Server Error

Além disso, talvez você veja a seguinte mensagem de erro:

{
   "fault":{
      "faultstring":"Bad Form Data",
      "detail":{
         "errorcode":"protocol.http.BadFormData"
      }
   }
}

Dados do formulário

Antes de entrar em detalhes sobre como solucionar esse problema, vamos entender o que são dados de formulário.

Os dados do formulário são as informações fornecidas pelo usuário normalmente por meio de um formulário HTML com elementos como uma caixa de entrada de texto, um botão ou uma caixa de seleção. Os dados do formulário geralmente são enviados como uma série de pares de chave-valor como parte de solicitações ou respostas HTTP.

Transmissão de dados de formulário

1. Content-Type: application/x-www-form-urlencoded
   • Se o tamanho dos dados do formulário for pequeno, eles serão enviados como pares de chave-valor com:
     • Os caracteres nas duas chaves são codificados de acordo com as regras explicadas em Formulários: seção 17.13.4.1.
     • Cabeçalho Content-Type: application/x-www-form-urlencoded

     Exemplo de solicitação com dados do formulário:

     curl https://HOSTALIAS/somepath -H "Content-Type: application/x-www-form-urlencoded" -d "username=abc@google.com&pasword=secret123"
     

   • Todos os caracteres não alfanuméricos em chaves e valores são codificados por porcentagem, ou seja, eles são representados como um trio de caracteres %HH, que consiste em um sinal de porcentagem seguido por dois dígitos hexadecimais representando o código ASCII do caractere específico.
   • Assim, mesmo que o sinal de porcentagem (%) seja permitido nos dados do formulário, ele é interpretado como o início de uma sequência de escape especial. Portanto, se os dados de formulário precisarem conter o sinal de porcentagem (%) na chave ou no valor, eles deverão ser transmitidos como %25, , que representa o código ASCII para o caractere de sinal de porcentagem (%).
2. Content-Type: multipart/form-data

   Para transmitir grandes quantidades de dados binários ou textos com caracteres não ASCII, envie os dados com Content-Type: multipart/form-data, conforme explicado em Formulários: seção 17.13.4.2

Causas possíveis

Esse erro ocorrerá se e somente se todas as condições a seguir forem satisfeitas:

1. A solicitação HTTP enviada pelo cliente para o Apigee Edge contém:
   1. Content-Type: application/x-www-form-urlencoded e
   2. Dados de formulário com o sinal de porcentagem (%) ou o sinal de porcentagem (%) seguido por caracteres hexadecimais inválidos que não são permitidos de acordo com a Seção 17.13.4.1 dos Formulários.

2. O proxy de API no Apigee Edge lê os parâmetros de formulário específicos que contêm caracteres que não são permitidos para uso no fluxo de solicitação usando a política ExtractVariables ou AttributionMessage.

   Por exemplo, se os dados do formulário contiverem o sinal de porcentagem (%) no estado em que se encontra (sem codificação) ou o sinal de porcentagem (%) seguido por qualquer caractere hexadecimal inválido na chave e/ou valor, você receberá esse erro.

   Estas são as possíveis causas desse erro:

   Causa	Descrição	Instruções de solução de problemas aplicáveis para
   Os parâmetros de formulário na solicitação têm caracteres não permitidos	Os parâmetros do formulário transmitidos como parte da solicitação HTTP pelo cliente contêm caracteres que não têm permissão para uso.	Usuários de nuvens públicas e privadas de borda

Etapas comuns do diagnóstico

Use uma das seguintes ferramentas/técnicas para diagnosticar esse erro:

Causa: os parâmetros do formulário na solicitação têm caracteres não permitidos

Diagnóstico

1. Determine o código de falha, a origem da falha e a política de falha de 500 Internal Server Error usando o monitoramento de APIs, a ferramenta de rastreamento ou os registros de acesso do NGINX, conforme explicado em Etapas comuns de diagnóstico.
2. Se o Código de falha for protocol.http.BadFormData, a Origem da falha tiver o valor proxy ou policy e a Política de falha não estiver vazia, isso indica que a política especificada em Política de falha falhou ao ler ou extrair os dados do formulário (parâmetros do formulário).
3. Analise a política indicada na Política de falhas e determine as seguintes informações:
   1. Fonte: determina se a política está lendo ou extraindo os dados de solicitação ou resposta.
   2. Parâmetros de formulário:determina os parâmetros específicos do formulário que estão sendo lidos na política.

      Amostra 1

      Exemplo 1: política ExtractVariables para extração de parâmetros de formulários:

            <ExtractVariables name="EV-ExtractFormParms">
               <DisplayName>EV-ExtractFormParams</DisplayName>
               <Source>request</Source>
               <FormParam name="username">
                  <Pattern ignoreCase="false">{username}</Pattern>
               </FormParam>
               <FormParam name="password">
                 <Pattern ignoreCase="false">{password}</Pattern>
               </FormParam>
               <VariablePrefix>forminfo</VariablePrefix>
             <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
            </ExtractVariables>
            

      Na política ExtractVariables acima:

      • Fonte: request

        Isso é indicado pelo elemento <Source>

      • Parâmetros de formulário:username e password

        Isso é indicado pelo elemento <Pattern> dentro do elemento <FormParam>.

      Isso indica que os parâmetros do formulário username e/ou password transmitidos como parte da solicitação HTTP pelo cliente para o Apigee Edge contêm caracteres não permitidos.

      Amostra 2

      Exemplo 2: política AttributionMessage copiando parâmetros do formulário:

            <AssignMessage continueOnError="false" enabled="true" name="AM-CopyFormParams">
              <Copy source="request">
                <FormParams>
                  <FormParam name="username"/>
                  <FormParam name="password"/>
                </FormParams>
              </Copy>
              <AssignTo createNew="true" transport="http" type="request"/>
            </AssignMessage>
            

      Na política ExtractVariables acima:

      • Origem: request

        Isso é indicado pelo atributo source no elemento <Copy>.

      • Parâmetros de formulário:username e password

        Isso é indicado pelo atributo name no elemento <FormParam>.

      Isso indica que os parâmetros do formulário username, password ou ambos transmitidos como parte da solicitação HTTP pelo cliente para o Apigee Edge contêm caracteres não permitidos.

4. Confira se há caracteres que não têm permissão para o uso nos parâmetros de formulário identificados na etapa 3 com um dos métodos a seguir:

   Ferramenta de rastreamento

   Para validar usando a ferramenta Trace:

   1. Se você capturou o rastro da solicitação com falha, conforme explicado em Etapas comuns de diagnóstico, selecione uma das solicitações com falha.
   2. Se você determinou que os parâmetros de formulário que contêm caracteres não permitidos para uso fazem parte da solicitação HTTP na etapa 3 acima, então
      1. Navegue para a fase Solicitação recebida do cliente.

      2. Role para baixo até a seção Stage Details e analise a seção Request Content.

         ( ver imagem ampliada)

         
      3. No exemplo acima, observe que o parâmetro de formulário password contém o sinal de porcentagem (%).
      4. Como o sinal de porcentagem (%) também é usado para codificação de porcentagem dos caracteres especiais, ele não pode ser usado no estado em que se encontra nos dados do formulário.
      5. Portanto, o Apigee Edge responde com 500 Internal Server Error com o código de erro protocol.http.BadFormData.

   Solicitação real

   Para validar usando a solicitação real, faça o seguinte:

   1. Se você não tiver acesso à solicitação real feita ao servidor de destino, acesse Resolução.
   2. Se você tiver acesso à solicitação real feita ao Apigee Edge, siga estas etapas:
      1. Revise o conteúdo dos dados do formulário e confira se ele contém caracteres não permitidos, como o sinal de porcentagem (%) ou o sinal de porcentagem (%), seguido de caracteres hexadecimais inválidos.

         Amostra 1

         Exemplo de solicitação no 1: dados do formulário como parte da solicitação

         curl -X GET "https://HOSTALIAS/myproxy -H "Content-Type: application/x-www-form-urlencoded" -d "client_id=123456abc123&client_secret=c23578%ZY"
         

         Neste exemplo, observe que o elemento client_secret contém o sinal de porcentagem (%) seguido de caracteres hexadecimais inválidos ZY.

         Amostra 2

         Exemplo de solicitação no 2: dados de formulário transmitidos em um arquivo:

         curl -X GET "https://HOSTALIAS/myproxy -H "Content-Type: application/x-www-form-urlencoded" -d @form_data.xml
         

         Conteúdo de form_data.xml:

         xml=<user><username>abc1234@google.com</username><password>qwerty12345!@#$%</password></user>
         

         Neste exemplo, observe que o elemento password contém o sinal de porcentagem (%), que não pode ser transmitido como está nos dados do formulário.

   3. Nos dois exemplos acima, os dados do formulário enviados como parte da solicitação HTTP para o Apigee Edge contêm caracteres que não podem ser usados.
   4. Portanto, o Apigee Edge responde com 500 Internal Server Error com o código de erro protocol.http.BadFormData.

Resolução

1. Os caracteres especiais nas chaves e nos valores dos dados de formulário ou parâmetros enviados como parte da solicitação HTTP pelo cliente são sempre codificados conforme explicado em Dados do formulário - application/x-www-form-urlencoded.
2. Nos exemplos discutidos, corrija os problemas da seguinte maneira:

   Amostra 1

   Exemplo 1: dados do formulário transmitidos como parte da solicitação:

   Use caracteres hexadecimais válidos que correspondam ao código ASCII para um caractere específico. Por exemplo, se você quiser enviar o cifrão ($), use %24, conforme mostrado abaixo:

   curl -X GET "https://HOSTALIAS/myproxy -H "Content-Type: application/x-www-form-urlencoded" -d "client_id=123456abc123&client_secret=c23578%24"
   

   Amostra 2

   Exemplo de solicitação no 2: dados de formulário transmitidos em um arquivo:

   curl -X GET "https://HOSTALIAS/myproxy -H "Content-Type: application/x-www-form-urlencoded" -d @form_data.xml
   

   Conteúdo de form_data.xml:

   Use a codificação de porcentagem para o sinal de porcentagem (%), que é modificar o arquivo para ter %25 , como mostrado abaixo:

   xml=<user><username>abc1234@google.com</username><password>qwerty12345!!@#$%25</password></user>
   

Especificação

O Apigee Edge espera que os dados do formulário sejam enviados de acordo com as seguintes especificações:

Especificação
Dados do formulário: application/x-www-form-urlencoded

Se você ainda precisar de ajuda do suporte da Apigee, acesse Precisa coletar informações de diagnóstico.

É necessário coletar informações de diagnóstico

Se o problema persistir mesmo depois de seguir as instruções acima, colete as informações de diagnóstico a seguir e entre em contato com o suporte do Apigee Edge:

Se você for um usuário da nuvem pública, forneça as seguintes informações:

• Nome da organização
• Nome do ambiente
• Nome do proxy da API
• Comando curl completo usado para reproduzir o 500 Internal Server Error com o código do erro protocol.http.BadFormData
• Arquivo de rastreamento das solicitações de API

Se você for um usuário da nuvem privada, forneça as seguintes informações:

• Concluir a mensagem de erro observada para as solicitações com falha
• Nome do ambiente
• Pacote de proxy de API
• Arquivo de rastreamento das solicitações de API

• Registros de acesso do NGINX

  /opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log

  Onde:ORG, ENV e PORT# são substituídos por valores reais.

• Registros do sistema do processador de mensagens

  /opt/apigee/var/log/edge-message-processor/logs/system.log

Referências

• Tipos de conteúdo de formulário
• RFC3986, seção 2.1: codificação de porcentagem
• Codificação de porcentagem
• Caracteres hexadecimais