500 Внутренняя ошибка сервера — BadFormData

Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация

Симптом

Клиентское приложение получает код состояния HTTP 500 Internal Server Error с кодом ошибки protocol.http.BadFormData в качестве ответа на вызовы API.

Сообщение об ошибке

Клиентское приложение получает следующий код ответа:

HTTP/1.1 500 Internal Server Error

Кроме того, вы можете увидеть следующее сообщение об ошибке:

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

Данные формы

Прежде чем мы углубимся в подробности устранения этой проблемы, давайте разберемся, что такое данные формы.

Данные формы — это информация, предоставляемая пользователем, обычно через форму HTML, имеющую такие элементы, как поле ввода текста, кнопка или флажок. Данные формы обычно отправляются в виде серии пар ключ-значение как часть HTTP-запросов или ответов.

Передача данных формы

1. Тип контента: приложение/x-www-form-urlencoded
   • Если размер данных формы небольшой, данные отправляются как пары ключ-значение с помощью:
     • Символы в обеих клавишах закодированы в соответствии с правилами, описанными в разделе «Формы» — раздел 17.13.4.1.
     • Content-Type: application/x-www-form-urlencoded

     Пример запроса с данными формы:

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

   • Любые небуквенно-цифровые символы как в ключах, так и в значениях закодированы в процентах , то есть они представлены в виде тройки символов %HH , состоящей из знака процента, за которым следуют две шестнадцатеричные цифры, представляющие код ASCII конкретного символа.
   • Таким образом, хотя знак процента ( % ) разрешен в данных формы, он интерпретируется как начало специальной escape-последовательности. Таким образом, если данные формы должны содержать знак процента ( % ) в ключе или значении, их следует передавать как %25, что представляет собой код ASCII для символа знака процента ( % ).
2. Тип контента: multipart/form-data

   Если вы хотите передать большие объемы двоичных данных или текста, содержащего символы, отличные от ASCII, вы можете отправить данные с Content-Type: multipart/form-data, как описано в разделе «Формы» — раздел 17.13.4.2.

Возможные причины

Эта ошибка возникает тогда и только тогда, когда выполняются все следующие условия:

1. HTTP-запрос , отправленный клиентом в Apigee Edge, содержит:
   1. Content-Type: application/x-www-form-urlencoded и
   2. Данные формы со знаком процента ( % ) или знаком процента ( % ), за которым следуют недопустимые шестнадцатеричные символы, которые не разрешены в соответствии с разделом 17.13.4.1 «Формы» .

2. Прокси-сервер API в Apigee Edge считывает определенные параметры формы, содержащие любые символы, которые не разрешено использовать в потоке запросов, с помощью политики ExtractVariables или AssignMessage.

   Например, если данные формы содержат знак процента ( % ) как есть (без кодирования) или знак процента ( % ) за которыми следуют недопустимые шестнадцатеричные символы в ключе и/или значении, вы получаете эту ошибку.

   Вот возможные причины этой ошибки:

   Причина	Описание	Инструкции по устранению неполадок применимы для
   Параметры формы в запросе содержат недопустимые символы.	Параметры формы, передаваемые клиентом как часть HTTP-запроса, содержат любые символы, использование которых запрещено .	Пользователи Edge Public и Private Cloud

Общие этапы диагностики

Для диагностики этой ошибки используйте один из следующих инструментов/методов:

Причина: параметры формы в запросе содержат недопустимые символы.

Диагностика

1. Определите код ошибки , источник ошибки и политику ошибок для 500 Internal Server Error с помощью мониторинга API, инструмента трассировки или журналов доступа NGINX, как описано в разделе «Общие шаги диагностики» .
2. Если код ошибки — protocol.http.BadFormData , источник сбоя имеет значение proxy или policy , а политика сбоя не пуста , это указывает на то, что политика, указанная в политике сбоя, не удалась при чтении или извлечении данных формы (параметров формы).
3. Изучите политику, указанную в Политике ошибок , и определите следующую информацию:
   1. Источник: Определите, читает ли политика или извлекает данные из запроса или ответа.
   2. Параметры формы. Определите конкретные параметры формы, которые считываются в политике.

      Образец №1

      Пример № 1. Политика ExtractVariables, извлекающая параметры формы:

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

      В приведенной выше политике ExtractVariables:

      • Источник: request

        На это указывает элемент <Source> .

      • Параметры формы: username и password

        На это указывает элемент <Pattern> внутри элемента <FormParam>

      Это означает, что username и/или password формы, переданные клиентом в HTTP-запросе к Apigee Edge, содержат символы, использование которых запрещено .

      Образец №2

      Пример №2: Параметры формы копирования политики AssignMessage:

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

      В приведенной выше политике ExtractVariables:

      • Источник: request

        На это указывает атрибут source в элементе <Copy>

      • Параметры формы: username и password

        На это указывает атрибут name в элементе <FormParam>

      Это означает, что username или password (или оба параметра формы), передаваемые клиентом в Apigee Edge как часть HTTP-запроса, содержат любые символы, использование которых запрещено .

4. Проверьте, есть ли в параметрах формы, определенных на шаге 3, символы, использование которых запрещено, одним из следующих способов:

   Инструмент трассировки

   Чтобы проверить с помощью инструмента «Трассировка»:

   1. Если вы записали трассировку неудачного запроса, как описано в разделе «Общие шаги диагностики» , выберите один из неудачных запросов.
   2. Если вы определили, что параметры формы, содержащие любые символы, которые нельзя использовать, являются частью HTTP-запроса на шаге 3 выше, то
      1. Перейдите к этапу «Запрос получен от клиента» .

      2. Прокрутите вниз до раздела «Сведения о этапе» и просмотрите содержимое запроса .

         ( просмотреть увеличенное изображение )

         
      3. Обратите внимание, что в приведенном выше примере password параметра формы содержит знак процента ( % ).
      4. Поскольку знак процента ( % ) также используется для кодирования специальных символов в процентах , его нельзя использовать в данных формы как есть.
      5. Поэтому Apigee Edge отвечает 500 Internal Server Error с кодом ошибки protocol.http.BadFormData .

   Фактический запрос

   Чтобы подтвердить использование фактического запроса:

   1. Если у вас нет доступа к фактическому запросу, отправленному на целевой сервер, перейдите к разделу «Разрешение» .
   2. Если у вас есть доступ к фактическому запросу, сделанному к Apigee Edge, выполните следующие действия:
      1. Просмотрите содержимое данных формы и проверьте, содержит ли оно какие-либо символы, использование которых запрещено , например знак процента ( % ) или знак процента ( % ). за которыми следуют недопустимые шестнадцатеричные символы.

         Образец №1

         Пример запроса № 1: данные формы как часть запроса

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

         Обратите внимание, что в этом примере элемент client_secret содержит знак процента ( % ), за которым следуют недопустимые шестнадцатеричные символы ZY .

         Образец №2

         Пример запроса № 2. Данные формы передаются в файле:

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

         Содержимое form_data.xml:

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

         В этом примере обратите внимание, что password элемента password содержит знак процента ( % ), который не следует передавать в данных формы как есть.

   3. В двух приведенных выше примерах данные формы, отправленные как часть HTTP-запроса к Apigee Edge, содержат символы, использование которых запрещено .
   4. Поэтому Apigee Edge отвечает 500 Internal Server Error с кодом ошибки protocol.http.BadFormData .

Разрешение

1. Убедитесь, что любые специальные символы как в ключах, так и в значениях данных или параметров формы, отправляемых клиентом как часть HTTP-запроса, всегда закодированы, как описано в разделе «Данные формы — application/x-www-form-urlencoded» .
2. В примерах, рассмотренных выше, вы можете исправить проблемы следующим образом:

   Образец №1

   Пример № 1. Данные формы, передаваемые как часть запроса:

   Используйте допустимые шестнадцатеричные символы , соответствующие коду ASCII для определенного символа. Например, если вы хотите отправить знак доллара ( $ ), используйте %24 , как показано ниже:

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

   Образец №2

   Пример запроса № 2. Данные формы передаются в файле:

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

   Содержимое form_data.xml:

   Используйте процентную кодировку для знака процента ( % ), то есть измените файл так, чтобы он имел %25 как показано ниже:

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

Спецификация

Apigee Edge ожидает, что данные формы будут отправлены в соответствии со следующими спецификациями:

Если вам по-прежнему нужна помощь со стороны службы поддержки Apigee, перейдите к разделу «Необходимо собрать диагностическую информацию» .

Необходимо собрать диагностическую информацию

Если проблема не устранена даже после выполнения приведенных выше инструкций, соберите следующую диагностическую информацию, а затем обратитесь в службу поддержки Apigee Edge :

Если вы являетесь пользователем Public Cloud , предоставьте следующую информацию:

• Название организации
• Имя среды
• Имя прокси API
• Полная команда curl , используемая для воспроизведения 500 Internal Server Error с кодом ошибки protocol.http.BadFormData
• Файл трассировки запросов API

Если вы являетесь пользователем частного облака , предоставьте следующую информацию:

• Полное сообщение об ошибке, наблюдаемое для неудачных запросов
• Имя среды
• Пакет прокси API
• Файл трассировки запросов API

• Журналы доступа NGINX

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

  Где: ORG , ENV и PORT# заменяются фактическими значениями.

• Системные журналы процессора сообщений

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

Ссылки

• Типы контента формы
• RFC3986, раздел 2.1: Процентное кодирование
• Процентное кодирование
• Шестнадцатеричные символы