OAuth का इस्तेमाल करके एपीआई को सुरक्षित बनाएं

इस ट्यूटोरियल में, OAuth 2.0 की मदद से एपीआई को सुरक्षित करने का तरीका बताया गया है.

OAuth, अनुमति देने वाला एक प्रोटोकॉल है. इसकी मदद से, ऐप्लिकेशन लोगों की ओर से जानकारी ऐक्सेस कर सकते हैं. इसके लिए, उपयोगकर्ताओं को उपयोगकर्ता नाम और पासवर्ड बताने की ज़रूरत नहीं होती.

OAuth के साथ, सुरक्षा से जुड़े क्रेडेंशियल (जैसे कि उपयोगकर्ता नाम/पासवर्ड या कुंजी/सीक्रेट) को ऐक्सेस टोकन के साथ बदला जाता है. उदाहरण के लिए:

joe:joes_password (username:password) या
Nf2moHOASMJeUmXVdDhlMbPaXm2U7eMc:unUOXYpPe74ZfLEb (key:secret)

कुछ ऐसा बन जाता है:

b0uiYwjRZLEo4lEu7ky2GGxHkanN

ऐक्सेस टोकन, वर्णों का एक रैंडम स्ट्रिंग होता है और कुछ समय के लिए होता है (यह कुछ समय के बाद खत्म हो जाना चाहिए). इसलिए, ऐप्लिकेशन के वर्कफ़्लो में उपयोगकर्ता की पुष्टि करने के लिए इसे पास करना, असल क्रेडेंशियल को पास करने के मुकाबले ज़्यादा सुरक्षित होता है.

OAuth 2.0 स्पेसिफ़िकेशन में ऐप्लिकेशन के लिए ऐक्सेस टोकन डिस्ट्रिब्यूट करने के अलग-अलग तरीके तय किए गए हैं. इन तरीकों को "अनुमति के टाइप" कहा जाता है. OAuth 2.0 में बताए गए सबसे बुनियादी अनुदान प्रकार को "क्लाइंट क्रेडेंशियल" कहा जाता है. इस तरह के अनुदान में, क्लाइंट क्रेडेंशियल के बदले OAuth ऐक्सेस टोकन जनरेट किए जाते हैं. ये क्लाइंट कुंजी/उपभोक्ता के सीक्रेट जोड़े होते हैं, जैसा कि ऊपर दिए गए उदाहरण में बताया गया है.

Edge में क्लाइंट क्रेडेंशियल अनुदान टाइप को एपीआई प्रॉक्सी में नीतियों का इस्तेमाल करके लागू किया गया है. एक सामान्य OAuth फ़्लो में दो चरण शामिल होते हैं:

• क्लाइंट क्रेडेंशियल से OAuth ऐक्सेस टोकन जनरेट करने के लिए, एपीआई प्रॉक्सी 1 को कॉल करें. एपीआई प्रॉक्सी पर मौजूद OAuth v2.0 नीति इसे मैनेज करती है.
• किसी एपीआई कॉल में OAuth ऐक्सेस टोकन भेजने के लिए, एपीआई प्रॉक्सी 2 को कॉल करें. एपीआई प्रॉक्सी, OAuth v2.0 नीति का इस्तेमाल करके, ऐक्सेस टोकन की पुष्टि करता है.

आपको इनकी ज़रूरत होगी

• Apigee Edge का खाता. अगर आपके पास अब तक कोई Apigee Edge खाता नहीं है, तो आप Apigee Edge खाता बनाने के निर्देशों की मदद से साइन अप कर सकते हैं.
• कमांड लाइन से एपीआई कॉल करने के लिए, आपकी मशीन पर cURL इंस्टॉल किया गया.

टोकन जनरेट करने वाले एपीआई प्रॉक्सी को डाउनलोड और डिप्लॉय करना

इस चरण में, आपको एक एपीआई प्रॉक्सी बनानी होगी. यह उपभोक्ता कुंजी और एपीआई कॉल में भेजे गए उपभोक्ता सीक्रेट से OAuth ऐक्सेस टोकन जनरेट करती है. ऐसा करने के लिए, Apigee एक सैंपल एपीआई प्रॉक्सी उपलब्ध कराता है. आपको प्रॉक्सी को अभी डाउनलोड करके डिप्लॉय करना है. इसके बाद, बाद में इसे ट्यूटोरियल में इस्तेमाल करना होगा. (आपके पास खुद यह एपीआई प्रॉक्सी आसानी से बनाने का विकल्प है. यह डाउनलोड और डिप्लॉय करने का तरीका, आपकी सुविधा के लिए है. साथ ही, इससे आपको यह भी पता चलता है कि पहले से बनाई गई प्रॉक्सी को शेयर करना कितना आसान है.)

1. 'oauth' सैंपल एपीआई प्रॉक्सी को अपने फ़ाइल सिस्टम की किसी भी डायरेक्ट्री में डाउनलोड करें.
2. https://apigee.com/edge पर जाएं और साइन इन करें.
3. बाएं नेविगेशन बार में, डेवलप करें > एपीआई प्रॉक्सी चुनें.
4. + प्रॉक्सी पर क्लिक करें.
   
5. प्रॉक्सी बनाएं विज़र्ड में, प्रॉक्सी बंडल अपलोड करें पर क्लिक करें.
6. डाउनलोड की गई oauth.zip फ़ाइल चुनें और आगे बढ़ें पर क्लिक करें.
7. बनाएं पर क्लिक करें.
8. बिल्ड पूरा होने के बाद, एपीआई प्रॉक्सी एडिटर में नया प्रॉक्सी देखने के लिए, प्रॉक्सी में बदलाव करें पर क्लिक करें.
9. एपीआई प्रॉक्सी एडिटर की खास जानकारी देने वाले पेज पर, डिप्लॉयमेंट ड्रॉप-डाउन पर क्लिक करें और जांच करें चुनें. यह आपके संगठन में टेस्ट एनवायरमेंट है.
   
   पुष्टि करने वाले प्रॉम्प्ट पर, डिप्लॉय करें पर क्लिक करें.
   डिप्लॉयमेंट ड्रॉप-डाउन पर फिर से क्लिक करने पर, एक हरा आइकॉन बताता है कि प्रॉक्सी को टेस्ट एनवायरमेंट में डिप्लॉय किया गया है.
   

बहुत बढ़िया! आपने अपने Edge संगठन में, ऐक्सेस टोकन जनरेट करने वाले एपीआई प्रॉक्सी को डाउनलोड और डिप्लॉय कर लिया है.

OAuth फ़्लो और नीति देखना

आइए, अच्छे से जानते हैं कि एपीआई प्रॉक्सी में क्या शामिल है.

1. एपीआई प्रॉक्सी एडिटर में, डेवलप करें टैब पर क्लिक करें. बाएं Navigator पैनल में, आपको दो नीतियां दिखेंगी. आपको Proxy Endpoints सेक्शन में दो POST फ़्लो भी दिखेंगे.

2. Proxy Endpoints में जाकर, AccessTokenClientCredential पर क्लिक करें.
   

   एक्सएमएल कोड व्यू में, आपको AccessTokenClientCredential नाम का एक Flow दिखेगा:

   <Flow name="AccessTokenClientCredential">
       <Description/>
       <Request>
           <Step>
               <Name>GenerateAccessTokenClient</Name>
           </Step>
       </Request>
       <Response/>
       <Condition>(proxy.pathsuffix MatchesPath "/accesstoken") and (request.verb = "POST")</Condition>
   </Flow>
   

   फ़्लो, एपीआई प्रॉक्सी में प्रोसेस होने का एक चरण है. इस मामले में, किसी तय शर्त के पूरा होने पर फ़्लो ट्रिगर होता है. इसे कंडिशनल फ़्लो कहा जाता है. <Condition> एलिमेंट में दी गई शर्त से पता चलता है कि अगर /accesstoken रिसॉर्स में एपीआई प्रॉक्सी कॉल की जाती है और अनुरोध की कार्रवाई POST है, तो GenerateAccessTokenClient नीति लागू करें, जो ऐक्सेस टोकन जनरेट करती है.

3. अब उस नीति को देखते हैं जो कंडिशनल फ़्लो ट्रिगर होगी. फ़्लो डायग्राम में, GenerateAccessTokenClient नीति के आइकॉन पर क्लिक करें.
   
   नीचे दिए गए एक्सएमएल कॉन्फ़िगरेशन को, कोड व्यू में लोड किया जाता है:

   <OAuthV2 name="GenerateAccessTokenClient">
       <!-- This policy generates an OAuth 2.0 access token using the client_credentials grant type -->
       <Operation>GenerateAccessToken</Operation>
       <!-- This is in millseconds, so expire in an hour -->
       <ExpiresIn>3600000</ExpiresIn>
       <SupportedGrantTypes>
           <!-- This part is very important: most real OAuth 2.0 apps will want to use other
            grant types. In this case it is important to NOT include the "client_credentials"
            type because it allows a client to get access to a token with no user authentication -->
           <GrantType>client_credentials</GrantType>
       </SupportedGrantTypes>
       <GrantType>request.queryparam.grant_type</GrantType>
       <GenerateResponse/>
   </OAuthV2>
   

   कॉन्फ़िगरेशन में ये शामिल हैं:

   • <Operation>, पहले से तय की गई कई वैल्यू में से एक हो सकती है. इससे पता चलता है कि नीति क्या होगी. इस मामले में, यह ऐक्सेस टोकन जनरेट करेगा.
   • जनरेट होने के एक घंटे (36,00,000 मिलीसेकंड) में टोकन की समयसीमा खत्म हो जाएगी.
   • <SupportedGrantTypes> में, OAuth <GrantType> का इस्तेमाल client_credentials होने की उम्मीद है. OAuth टोकन के लिए उपभोक्ता कुंजी और सीक्रेट की अदला-बदली करना.
   • दूसरा <GrantType> एलिमेंट, नीति को यह बताता है कि OAuth 2.0 स्पेसिफ़िकेशन के मुताबिक, अनुमति के टाइप वाले पैरामीटर के लिए एपीआई कॉल में कहां देखना है. (आपको यह बाद में एपीआई कॉल में दिखेगा). अनुमति का टाइप, एचटीटीपी हेडर (request.header.grant_type) या फ़ॉर्म पैरामीटर (request.formparam.grant_type) में भी भेजा जा सकता है.

आपको फ़िलहाल एपीआई प्रॉक्सी के साथ और कुछ करने की ज़रूरत नहीं है. बाद के चरणों में, OAuth ऐक्सेस टोकन जनरेट करने के लिए, आपको इस एपीआई प्रॉक्सी का इस्तेमाल करना होगा. हालांकि, आपको कुछ और काम करने होंगे:

• वह एपीआई प्रॉक्सी बनाएं जिसे OAuth की मदद से सुरक्षित करना है.
• कुछ और ऐसे आर्टफ़ैक्ट बनाएं जिनसे आपको उपभोक्ता कुंजी और उपभोक्ता सीक्रेट को ऐक्सेस टोकन के बदले बदलना पड़े.

OAuth-सुरक्षित एपीआई प्रॉक्सी बनाना

अब आप वह एपीआई प्रॉक्सी बनाने वाले हैं जिसे आप सुरक्षित करना चाहते हैं. यह एक एपीआई कॉल है, जो आपकी पसंद की चीज़ दिखाता है. इस मामले में, एपीआई प्रॉक्सी आपके आईपी पते को लौटाने के लिए, Apigee की मॉकटारगेट सेवा को कॉल करेगा. हालांकि, यह आपको यह सिर्फ़ तब दिखेगा, जब आपने एपीआई कॉल के साथ मान्य OAuth ऐक्सेस टोकन पास किया हो.

यहां बनाई जाने वाली एपीआई प्रॉक्सी में एक नीति शामिल होगी, जो अनुरोध में OAuth टोकन की जांच करती है.

1. बाएं नेविगेशन बार में, डेवलप करें > एपीआई प्रॉक्सी चुनें.
2. + प्रॉक्सी पर क्लिक करें.
   
3. प्रॉक्सी बनाएं विज़र्ड में, रिवर्स प्रॉक्सी (सबसे सामान्य) चुनें और आगे बढ़ें पर क्लिक करें.
4. इसके साथ प्रॉक्सी कॉन्फ़िगर करें:
   

   इस फ़ील्ड में	यह करो
   प्रॉक्सी नाम	डालें: helloworld_oauth2
   प्रोजेक्ट के आधार का पाथ	इसमें बदलें: /hellooauth2 प्रोजेक्ट बेस पाथ, यूआरएल का हिस्सा है. इसका इस्तेमाल एपीआई प्रॉक्सी को अनुरोध भेजने के लिए किया जाता है.
   मौजूदा एपीआई	डालें: https://mocktarget.apigee.net/ip यह उस टारगेट यूआरएल के बारे में बताता है जिसे Apigee Edge, एपीआई प्रॉक्सी के अनुरोध पर शुरू करता है.
   Description	डालें: hello world protected by OAuth

5. आगे बढ़ें पर क्लिक करें.
6. सामान्य नीतियां पेज पर:

   इस फ़ील्ड में	यह करो
   सुरक्षा: अनुमति देना	चुनें: OAuth 2.0

7. आगे बढ़ें पर क्लिक करें.
8. वर्चुअल होस्ट पेज पर, आगे बढ़ें पर क्लिक करें.
9. पक्का करें कि बिल्ड पेज पर, टेस्ट एनवायरमेंट को चुना गया हो. इसके बाद, बनाएं और डिप्लॉय करें पर क्लिक करें.
10. खास जानकारी पेज पर, आपको यह पुष्टि दिखेगी कि आपका नया एपीआई प्रॉक्सी बन गया है और एपीआई प्रॉक्सी को आपके टेस्ट एनवायरमेंट में डिप्लॉय किया गया है.
11. एपीआई प्रॉक्सी का खास जानकारी पेज दिखाने के लिए, प्रॉक्सी में बदलाव करें पर क्लिक करें.
    ध्यान दें कि इस बार एपीआई प्रॉक्सी अपने-आप डिप्लॉय होता है. डिप्लॉयमेंट ड्रॉप-डाउन पर क्लिक करके पक्का करें कि "टेस्ट" एनवायरमेंट के बगल में हरा डिप्लॉयमेंट बिंदु मौजूद है.