500 Erro interno do servidor - BadFormData

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Sintoma

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

Mensagem de erro

O aplicativo cliente recebe o seguinte código de resposta:

HTTP/1.1 500 Internal Server Error

Além disso, você pode receber a seguinte mensagem de erro:

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

Dados do formulário

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

Os dados de formulário são as informações fornecidas pelo usuário, geralmente por 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 codificados de acordo com as regras explicadas em Forms: seção 17.13.4.1
     • O cabeçalho Content-Type: application/x-www-form-urlencoded

     Exemplo de solicitação com dados de 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 nas chaves e nos valores são codificados por porcentagem, ou seja, são representados como um tripleto de caracteres %HH, consistindo em um sinal de porcentagem seguido por dois dígitos hexadecimais que representam 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 do 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 do caractere de sinal de porcentagem (%).
2. Content-Type: multipart/form-data

   Se você quiser transmitir grandes quantidades de dados binários ou texto com caracteres não ASCII, envie os dados com o Content-Type: multipart/form-data, conforme explicado em Forms: 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 ao 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 de caracteres hexadecimais inválidos que não são permitidos de acordo com Forms: seção 17.13.4.1.

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

   Por exemplo, se os dados do formulário contiverem o sinal de porcentagem (%) sem codificação ou o sinal de porcentagem (%) seguido de caracteres hexadecimais inválidos na chave e/ou no valor, esse erro vai aparecer.

   Confira as possíveis causas para esse 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 de formulário transmitidos como parte da solicitação HTTP pelo cliente contêm caracteres que não podem ser usados.	Usuários da nuvem pública e privada do Edge

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 para 500 Internal Server Error usando o Monitoramento de APIs, a ferramenta Trace 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. Examine a política indicada em Política de falha e determine as seguintes informações:
   1. Origem:determine se a política está lendo ou extraindo os dados da solicitação ou resposta.
   2. Parâmetros de formulário:determine os parâmetros específicos que estão sendo lidos na política.

      Exemplo 1

      Exemplo 1: política ExtractVariables extraindo parâmetros de formulário:

            <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> no elemento <FormParam>.

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

      Exemplo 2

      Exemplo 2: política AssignMessage copiando parâmetros de 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 de formulário username ou password, ou ambos, transmitidos como parte da solicitação HTTP pelo cliente para o Apigee Edge contêm caracteres que não podem ser usados.

4. Verifique se há caracteres não permitidos nos parâmetros de formulário identificados na etapa 3 usando um dos seguintes métodos:

   Ferramenta Trace

   Para validar usando a ferramenta Trace:

   1. Se você capturou o trace 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 do formulário que contêm caracteres não permitidos fazem parte da solicitação HTTP na etapa 3 acima, então
      1. Acesse a fase Solicitação recebida do cliente.

      2. Role a tela para baixo até a seção Detalhes da fase e analise o Conteúdo da solicitação.

         ( ampliar imagem)

         
      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 como está nos dados do formulário.
      5. Portanto, o Apigee Edge responde com 500 Internal Server Error e o código de erro protocol.http.BadFormData.

   Solicitação real

   Para validar usando a solicitação real:

   1. Se você não tiver acesso à solicitação real feita ao servidor de destino, vá para 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 verifique se ele contém caracteres que não são permitidos, como o sinal de porcentagem (%) ou o sinal de porcentagem (%) seguido de caracteres hexadecimais inválidos.

         Exemplo 1

         Exemplo de solicitação nº 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.

         Exemplo 2

         Exemplo de solicitação nº 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 deve 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 e o código de erro protocol.http.BadFormData.

Resolução

1. Verifique se todos os caracteres especiais nas chaves e nos valores de dados ou parâmetros de formulário enviados como parte da solicitação HTTP pelo cliente estão sempre codificados conforme explicado em Dados de formulário - application/x-www-form-urlencoded.
2. Para os exemplos discutidos acima, você pode corrigir os problemas da seguinte maneira:

   Exemplo 1

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

   Use caracteres hexadecimais válidos que correspondam ao código ASCII de 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"
   

   Exemplo 2

   Exemplo de solicitação nº 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 por porcentagem para o sinal de porcentagem (%), ou seja, modifique o arquivo para ter %25 , conforme 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:

Se você ainda precisar de ajuda do suporte da Apigee, acesse Precisa de 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, reúna as seguintes informações de diagnóstico 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 de API
• Comando curl completo usado para reproduzir o 500 Internal Server Error com o código de erro protocol.http.BadFormData
• Arquivo de rastreamento para as solicitações de API

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

• Mensagem de erro completa observada para as solicitações com falha
• Nome do ambiente
• Pacote de proxy de API
• Arquivo de rastreamento para as solicitações de API

• Registros de acesso do NGINX

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

  Em que: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 por porcentagem
• Caracteres hexadecimais