500 सर्वर में गड़बड़ी - बैडफ़ॉर्म डेटा

आपको Apigee Edge का दस्तावेज़ दिख रहा है.
Apigee X के दस्तावेज़ पर जाएं. जानकारी

समस्या का ब्यौरा

क्लाइंट ऐप्लिकेशन को एपीआई कॉल के जवाब में, 500 Internal Server Error एचटीटीपी स्टेटस कोड और गड़बड़ी का कोड protocol.http.BadFormData मिलता है.

गड़बड़ी का मैसेज

क्लाइंट ऐप्लिकेशन को यह रिस्पॉन्स कोड मिलता है:

HTTP/1.1 500 Internal Server Error

इसके अलावा, आपको गड़बड़ी का यह मैसेज भी दिख सकता है:

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

फ़ॉर्म डेटा

इस समस्या को हल करने के बारे में विस्तार से जानने से पहले, आइए समझते हैं कि फ़ॉर्म डेटा क्या होता है.

फ़ॉर्म डेटा, उपयोगकर्ता की ओर से दी गई जानकारी होती है. आम तौर पर, यह जानकारी एचटीएमएल फ़ॉर्म के ज़रिए दी जाती है. इसमें टेक्स्ट इनपुट बॉक्स, बटन या चेक बॉक्स जैसे एलिमेंट होते हैं. फ़ॉर्म का डेटा आम तौर पर, एचटीटीपी अनुरोधों या जवाबों के हिस्से के तौर पर, की-वैल्यू पेयर की सीरीज़ के तौर पर भेजा जाता है.

फ़ॉर्म डेटा ट्रांसमिशन

1. Content-Type: application/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 कोड को दिखाते हैं.
   • इसलिए, फ़ॉर्म डेटा में प्रतिशत का निशान (%) इस्तेमाल करने की अनुमति है. हालांकि, इसे खास एस्केप सीक्वेंस की शुरुआत के तौर पर माना जाता है. इसलिए, अगर फ़ॉर्म के डेटा में कुंजी या वैल्यू में पर्सेंट का निशान (%) शामिल करना है, तो इसे %25, के तौर पर ट्रांसमिट किया जाना चाहिए. यह पर्सेंट के निशान (%) वर्ण के लिए ASCII कोड को दिखाता है.
2. Content-Type: multipart/form-data

   अगर आपको बड़ी मात्रा में बाइनरी डेटा या गैर-ASCII वर्णों वाला टेक्स्ट भेजना है, तो Content-Type: multipart/form-data का इस्तेमाल करके डेटा भेजा जा सकता है. इसके बारे में फ़ॉर्म - सेक्शन 17.13.4.2 में बताया गया है

संभावित कारण

यह गड़बड़ी तब होती है, जब ये सभी शर्तें पूरी होती हैं:

1. क्लाइंट से Apigee Edge को भेजे गए एचटीटीपी अनुरोध में यह जानकारी शामिल होती है:
   1. Content-Type: application/x-www-form-urlencoded, और
   2. फ़ॉर्म डेटा में प्रतिशत का निशान (%) या प्रतिशत के निशान (%) के बाद अमान्य हेक्साडेसिमल वर्ण मौजूद हैं. ये वर्ण, फ़ॉर्म - सेक्शन 17.13.4.1 के मुताबिक इस्तेमाल नहीं किए जा सकते.

2. Apigee Edge में मौजूद एपीआई प्रॉक्सी, फ़ॉर्म के उन पैरामीटर को पढ़ती है जिनमें ऐसे वर्ण शामिल होते हैं जिन्हें ExtractVariables या AssignMessage नीति का इस्तेमाल करके, अनुरोध फ़्लो में इस्तेमाल करने की अनुमति नहीं है.

   उदाहरण के लिए, अगर फ़ॉर्म के डेटा में प्रतिशत का निशान (%) बिना किसी बदलाव के (बिना एन्कोडिंग के) या प्रतिशत का निशान (%) के बाद, कुंजी और/या वैल्यू में कोई अमान्य हेक्साडेसिमल वर्ण शामिल है, तो आपको यह गड़बड़ी दिखेगी.

   इस गड़बड़ी की ये वजहें हो सकती हैं:

   वजह	ब्यौरा	इनके लिए समस्या हल करने के निर्देश
   अनुरोध में मौजूद फ़ॉर्म पैरामीटर में ऐसे वर्ण हैं जिनका इस्तेमाल करने की अनुमति नहीं है	क्लाइंट ने एचटीटीपी अनुरोध के हिस्से के तौर पर जो फ़ॉर्म पैरामीटर पास किए हैं उनमें ऐसे वर्ण शामिल हैं जिनका इस्तेमाल करने की अनुमति नहीं है.	Edge Public और Private Cloud के उपयोगकर्ताओं के लिए

गड़बड़ी का पता लगाने के सामान्य चरण

इस गड़बड़ी का पता लगाने के लिए, इनमें से किसी टूल/तकनीक का इस्तेमाल करें:

वजह: अनुरोध में मौजूद फ़ॉर्म पैरामीटर में ऐसे वर्ण हैं जिनका इस्तेमाल करने की अनुमति नहीं है

संक्रमण की जांच

1. एपीआई मॉनिटरिंग, Trace टूल या NGINX ऐक्सेस लॉग का इस्तेमाल करके, 500 Internal Server Error के लिए गड़बड़ी का कोड, गड़बड़ी का सोर्स, और गड़बड़ी की नीति का पता लगाएं. इसके बारे में गड़बड़ी का पता लगाने के सामान्य तरीके में बताया गया है.
2. अगर गड़बड़ी का कोड protocol.http.BadFormData है, गड़बड़ी का सोर्स की वैल्यू proxy या policy है, और गड़बड़ी की नीति खाली नहीं है, तो इसका मतलब है कि फ़ॉर्म का डेटा (फ़ॉर्म पैरामीटर) पढ़ते या निकालते समय, गड़बड़ी की नीति में बताई गई नीति लागू नहीं हुई.
3. उल्लंघन से जुड़ी नीति में बताई गई नीति की जांच करें और यहां दी गई जानकारी का पता लगाएं:
   1. सोर्स: यह तय करें कि नीति, अनुरोध या जवाब से डेटा पढ़ रही है या निकाल रही है.
   2. फ़ॉर्म पैरामीटर: यह तय करें कि नीति में कौनसे फ़ॉर्म पैरामीटर पढ़े जा रहे हैं.

      पहला सैंपल

      सैंपल #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

        इसे <FormParam> एलिमेंट में मौजूद <Pattern> एलिमेंट से दिखाया जाता है

      इससे पता चलता है कि क्लाइंट ने Apigee Edge को एचटीटीपी अनुरोध के हिस्से के तौर पर जो फ़ॉर्म पैरामीटर username और/या password पास किए हैं उनमें ऐसे वर्ण शामिल हैं जिनका इस्तेमाल करने की अनुमति नहीं है.

      सैंपल #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

        इसकी जानकारी <Copy> एलिमेंट में मौजूद source एट्रिब्यूट से मिलती है

      • फ़ॉर्म पैरामीटर: username और password

        इसकी जानकारी <FormParam> एलिमेंट में मौजूद name एट्रिब्यूट से मिलती है

      इससे पता चलता है कि क्लाइंट ने Apigee Edge को एचटीटीपी अनुरोध के हिस्से के तौर पर जो फ़ॉर्म पैरामीटर username या password या दोनों पास किए हैं उनमें ऐसे वर्ण शामिल हैं जिनका इस्तेमाल करने की अनुमति नहीं है.

4. देखें कि क्या ऐसे कोई वर्ण हैं जिन्हें इस्तेमाल करने की अनुमति नहीं है. इसके लिए, यहां दिए गए तरीकों में से किसी एक का इस्तेमाल करके, तीसरे चरण में पहचाने गए फ़ॉर्म पैरामीटर में वर्णों का इस्तेमाल करें:

   ट्रेस टूल

   ट्रेस टूल का इस्तेमाल करके पुष्टि करने के लिए:

   1. अगर आपने अनुरोध पूरा न होने की वजह से मिले ट्रेस को कैप्चर कर लिया है, जैसा कि समस्या का पता लगाने के लिए सामान्य तरीके में बताया गया है, तो अनुरोध पूरा न होने की वजह से मिले ट्रेस में से किसी एक को चुनें.
   2. अगर आपको लगता है कि फ़ॉर्म पैरामीटर में ऐसे वर्ण शामिल हैं जिनका इस्तेमाल करने की अनुमति नहीं है और वे ऊपर दिए गए तीसरे चरण में एचटीटीपी अनुरोध का हिस्सा हैं, तो
      1. क्लाइंट से मिला अनुरोध फ़ेज़ पर जाएं.

      2. नीचे की ओर स्क्रोल करके, फ़ेज़ की जानकारी सेक्शन पर जाएं और कॉन्टेंट का अनुरोध करें की समीक्षा करें.

         ( बड़ी इमेज देखें)

         
      3. ऊपर दिए गए उदाहरण में ध्यान दें कि फ़ॉर्म पैरामीटर password में प्रतिशत का निशान (%) शामिल है.
      4. प्रतिशत के निशान (%) का इस्तेमाल, खास वर्णों के लिए परसेंट एन्कोडिंग के लिए भी किया जाता है. इसलिए, इसका इस्तेमाल फ़ॉर्म डेटा में नहीं किया जा सकता.
      5. इसलिए, Apigee Edge, गड़बड़ी कोड protocol.http.BadFormData के साथ 500 Internal Server Error दिखाता है.

   असल अनुरोध

   असली अनुरोध का इस्तेमाल करके पुष्टि करने के लिए:

   1. अगर आपके पास टारगेट सर्वर को भेजे गए अनुरोध का ऐक्सेस नहीं है, तो समस्या हल करना पर जाएं.
   2. अगर आपके पास Apigee Edge को किए गए असली अनुरोध का ऐक्सेस है, तो यह तरीका अपनाएं:
      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

         अनुरोध का दूसरा उदाहरण: फ़ाइल में पास किया गया फ़ॉर्म डेटा:

         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 एलिमेंट में प्रतिशत का निशान (%) शामिल है. इसे फ़ॉर्म डेटा में उसी तरह पास नहीं किया जाना चाहिए.

   3. ऊपर दिए गए दोनों उदाहरणों में, Apigee Edge को एचटीटीपी अनुरोध के तौर पर भेजे गए फ़ॉर्म डेटा में ऐसे वर्ण शामिल हैं जिनका इस्तेमाल अनुमति नहीं है.
   4. इसलिए, Apigee Edge, गड़बड़ी कोड protocol.http.BadFormData के साथ 500 Internal Server Error का जवाब देता है.

रिज़ॉल्यूशन

1. पक्का करें कि क्लाइंट की ओर से एचटीटीपी अनुरोध के तौर पर भेजे गए फ़ॉर्म डेटा या पैरामीटर की कुंजियों और वैल्यू में मौजूद सभी खास वर्णों को हमेशा कोड में बदला गया हो. इसके बारे में फ़ॉर्म डेटा - application/x-www-form-urlencoded में बताया गया है.
2. ऊपर दिए गए उदाहरणों में, इन समस्याओं को इस तरह ठीक किया जा सकता है:

   पहला सैंपल

   पहला सैंपल: अनुरोध के हिस्से के तौर पर फ़ॉर्म का डेटा पास किया गया:

   ऐसे मान्य हेक्साडेसिमल वर्ण इस्तेमाल करें जो किसी वर्ण के 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

   अनुरोध का दूसरा उदाहरण: फ़ाइल में पास किया गया फ़ॉर्म डेटा:

   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 की सहायता टीम से संपर्क करें:

अगर आप पब्लिक क्लाउड के उपयोगकर्ता हैं, तो यह जानकारी दें:

• संगठन का नाम
• परिवेश का नाम
• एपीआई प्रॉक्सी का नाम
• curl कमांड का इस्तेमाल करके, गड़बड़ी के कोड protocol.http.BadFormData के साथ 500 Internal Server Error को फिर से बनाया गया
• एपीआई अनुरोधों के लिए ट्रेस फ़ाइल

अगर आप Private Cloud के उपयोगकर्ता हैं, तो यह जानकारी दें:

• अनुरोध पूरे न होने पर, गड़बड़ी का पूरा मैसेज दिखता है
• परिवेश का नाम
• एपीआई प्रॉक्सी बंडल
• एपीआई अनुरोधों के लिए ट्रेस फ़ाइल

• 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: प्रतिशत एन्कोडिंग
• परसेंट एन्कोडिंग
• हेक्साडेसिमल वर्ण