Google के OAuth 2.0 एपीआई का इस्तेमाल, पुष्टि करने और अनुमति देने, दोनों के लिए किया जा सकता है. इस दस्तावेज़ में, पुष्टि करने के लिए OAuth 2.0 को लागू करने के बारे में बताया गया है. यह OpenID Connect की शर्तों के मुताबिक है और इसे OpenID सर्टिफ़िकेट मिला है. Google API को ऐक्सेस करने के लिए OAuth 2.0 का इस्तेमाल करना में मौजूद दस्तावेज़, इस सेवा पर भी लागू होता है. अगर आपको इस प्रोटोकॉल को इंटरैक्टिव तरीके से एक्सप्लोर करना है, तो हमारा सुझाव है कि आप Google OAuth 2.0 Playground का इस्तेमाल करें. Stack Overflow पर मदद पाने के लिए, अपने सवालों को 'google-oauth' के साथ टैग करें.
OAuth 2.0 सेट अप करना
आपका ऐप्लिकेशन, उपयोगकर्ता के लॉगिन के लिए Google के OAuth 2.0 ऑथेंटिकेशन सिस्टम का इस्तेमाल कर सकता है. इसके लिए, आपको Google Cloud Console में एक प्रोजेक्ट सेट अप करना होगा, ताकि आपको OAuth 2.0 क्रेडेंशियल मिल सकें. साथ ही, आपको रीडायरेक्ट यूआरआई सेट करना होगा और ब्रैंडिंग की जानकारी को अपनी पसंद के मुताबिक बनाना होगा. यह जानकारी, उपयोगकर्ताओं को ऐसी स्क्रीन जहां OAuth के लिए सहमति दी जाती है पर दिखती है. हालांकि, ब्रैंडिंग की जानकारी को अपनी पसंद के मुताबिक बनाना ज़रूरी नहीं है. सेवा खाता बनाने, बिलिंग की सुविधा चालू करने, फ़िल्टर सेट अप करने, और अन्य काम करने के लिए, Cloud Console का भी इस्तेमाल किया जा सकता है. ज़्यादा जानकारी के लिए, Google Cloud Console के सहायता केंद्र पर जाएं.
OAuth 2.0 क्रेडेंशियल पाना
उपयोगकर्ताओं की पुष्टि करने और Google के एपीआई का ऐक्सेस पाने के लिए, आपको OAuth 2.0 क्रेडेंशियल की ज़रूरत होगी. इनमें क्लाइंट आईडी और क्लाइंट सीक्रेट शामिल हैं.
किसी OAuth 2.0 क्रेडेंशियल का क्लाइंट आईडी और क्लाइंट सीक्रेट देखने के लिए, इस टेक्स्ट पर क्लिक करें: क्रेडेंशियल चुनें. इसके बाद, जो विंडो खुलेगी उसमें अपना प्रोजेक्ट और क्रेडेंशियल चुनें. इसके बाद, देखें पर क्लिक करें.
इसके अलावा, Cloud Console में Clients पेज पर जाकर, अपना क्लाइंट आईडी और क्लाइंट सीक्रेट देखें:
- क्लाइंट पेज पर जाएं.
- अपने क्लाइंट के नाम या बदलाव करें (create) आइकॉन पर क्लिक करें. आपका क्लाइंट आईडी और सीक्रेट, पेज पर सबसे ऊपर मौजूद होता है.
रीडायरेक्ट यूआरआई सेट करना
Cloud Console में सेट किया गया रीडायरेक्ट यूआरआई यह तय करता है कि Google आपके पुष्टि करने के अनुरोधों के जवाब कहां भेजेगा.
किसी OAuth 2.0 क्रेडेंशियल के लिए रीडायरेक्ट यूआरआई बनाने, देखने या उनमें बदलाव करने के लिए, यह तरीका अपनाएं:
- क्लाइंट पेज पर जाएं.
- क्लाइंट पर क्लिक करें.
- रीडायरेक्ट यूआरआई देखें या उनमें बदलाव करें.
अगर Clients पेज पर कोई क्लाइंट मौजूद नहीं है, तो इसका मतलब है कि आपके प्रोजेक्ट के लिए कोई OAuth क्रेडेंशियल नहीं है. क्लाइंट बनाने के लिए, क्लाइंट बनाएं पर क्लिक करें.
उपयोगकर्ता की सहमति वाली स्क्रीन को पसंद के मुताबिक बनाना
आपके उपयोगकर्ताओं के लिए, OAuth 2.0 की मदद से पुष्टि करने की प्रोसेस में, सहमति देने वाली स्क्रीन शामिल होती है. इस स्क्रीन पर, उपयोगकर्ता की ओर से शेयर की जा रही जानकारी और लागू होने वाली शर्तों के बारे में बताया जाता है. उदाहरण के लिए, जब उपयोगकर्ता लॉग इन करता है, तो उससे आपके ऐप्लिकेशन को अपने ईमेल पते और खाते की बुनियादी जानकारी का ऐक्सेस देने के लिए कहा जा सकता है. इस जानकारी का ऐक्सेस पाने के लिए, scope पैरामीटर का इस्तेमाल करके अनुरोध किया जाता है. आपका ऐप्लिकेशन, इस पैरामीटर को पुष्टि करने के अनुरोध में शामिल करता है. Google के अन्य एपीआई का ऐक्सेस पाने के लिए, स्कोप का भी इस्तेमाल किया जा सकता है.
उपयोगकर्ता की सहमति वाली स्क्रीन पर, ब्रैंडिंग की जानकारी भी दिखती है. जैसे, आपके प्रॉडक्ट का नाम, लोगो, और होम पेज का यूआरएल. Cloud Console में, ब्रैंडिंग की जानकारी को कंट्रोल किया जा सकता है.
अपने प्रोजेक्ट की ऐसी स्क्रीन जहां OAuth के लिए सहमति दी जाती है, उसे चालू करने के लिए:
- Google Cloud Console में ब्रैंडिंग पेज खोलें.
- अगर कहा जाए, तो कोई प्रोजेक्ट चुनें या नया प्रोजेक्ट बनाएं.
- फ़ॉर्म भरें और सेव करें पर क्लिक करें.
सहमति वाला यह डायलॉग बॉक्स दिखाता है कि जब अनुरोध में OAuth 2.0 और Google Drive के दायरों का कॉम्बिनेशन मौजूद होता है, तो उपयोगकर्ता को क्या दिखेगा. (यह सामान्य डायलॉग, Google OAuth 2.0 Playground का इस्तेमाल करके जनरेट किया गया था. इसलिए, इसमें ब्रैंडिंग की वह जानकारी शामिल नहीं है जो Cloud Console में सेट की जाएगी.)
सेवा को ऐक्सेस करना
Google और तीसरे पक्ष ऐसी लाइब्रेरी उपलब्ध कराते हैं जिनका इस्तेमाल करके, उपयोगकर्ताओं की पुष्टि करने और Google API का ऐक्सेस पाने से जुड़ी कई ज़रूरी जानकारी को मैनेज किया जा सकता है. उदाहरण के लिए, Google Identity Services और Google क्लाइंट लाइब्रेरी. ये कई प्लैटफ़ॉर्म के लिए उपलब्ध हैं.
अगर आपको किसी लाइब्रेरी का इस्तेमाल नहीं करना है, तो इस दस्तावेज़ में दिए गए बाकी निर्देशों का पालन करें. इनमें एचटीटीपी अनुरोध के उन फ़्लो के बारे में बताया गया है जो उपलब्ध लाइब्रेरी के आधार पर काम करते हैं.
उपयोगकर्ता की पुष्टि करना
उपयोगकर्ता की पुष्टि करने के लिए, आईडी टोकन पाना और उसकी पुष्टि करना ज़रूरी है. आईडी टोकन, OpenID Connect की एक स्टैंडर्ड सुविधा है. इसे इंटरनेट पर पहचान की पुष्टि करने के लिए डिज़ाइन किया गया है.
उपयोगकर्ता की पुष्टि करने और आईडी टोकन पाने के लिए, आम तौर पर इस्तेमाल किए जाने वाले तरीकों को "server" फ़्लो और "implicit" फ़्लो कहा जाता है. सर्वर फ़्लो की मदद से, किसी ऐप्लिकेशन का बैकएंड सर्वर, ब्राउज़र या फ़ोन या टैबलेट का इस्तेमाल करने वाले व्यक्ति की पहचान की पुष्टि कर सकता है. इंप्लिसिट फ़्लो का इस्तेमाल तब किया जाता है, जब क्लाइंट-साइड ऐप्लिकेशन (आम तौर पर, ब्राउज़र में चलने वाला JavaScript ऐप्लिकेशन) को अपने बैकएंड सर्वर का इस्तेमाल करने के बजाय, सीधे एपीआई को ऐक्सेस करना होता है.
इस दस्तावेज़ में, उपयोगकर्ता की पुष्टि करने के लिए सर्वर फ़्लो को लागू करने का तरीका बताया गया है. इंप्लिसिट फ़्लो काफ़ी मुश्किल है, क्योंकि क्लाइंट साइड पर टोकन को मैनेज करने और इस्तेमाल करने में सुरक्षा से जुड़े जोखिम होते हैं. अगर आपको इंप्लिसिट फ़्लो लागू करना है, तो हमारा सुझाव है कि आप Google Identity Services का इस्तेमाल करें.
सर्वर फ़्लो
पक्का करें कि आपने Cloud Console में अपना ऐप्लिकेशन सेट अप किया हो, ताकि वह इन प्रोटोकॉल का इस्तेमाल कर सके और आपके उपयोगकर्ताओं की पुष्टि कर सके. जब कोई उपयोगकर्ता Google से साइन इन करने की कोशिश करता है, तो आपको ये काम करने होंगे:
- धोखाधड़ी से बचाने वाला स्टेट टोकन बनाना
- Google को पुष्टि करने का अनुरोध भेजना
- धोखाधड़ी से बचाने वाले स्टेट टोकन की पुष्टि करना
- ऐक्सेस टोकन और आईडी टोकन के लिए,
codeको एक्सचेंज करना - आईडी टोकन से उपयोगकर्ता की जानकारी पाना
- उपयोगकर्ता की पुष्टि करना
1. धोखाधड़ी रोकने के लिए स्टेट टोकन बनाना
आपको अपने उपयोगकर्ताओं की सुरक्षा करनी होगी. इसके लिए, आपको अनुरोध में जालसाज़ी करके किए जाने वाले हमलों को रोकना होगा. सबसे पहले, एक यूनीक सेशन टोकन बनाएं. यह टोकन, आपके ऐप्लिकेशन और उपयोगकर्ता के क्लाइंट के बीच की स्थिति को सेव रखता है. इसके बाद, इस यूनीक सेशन टोकन को Google OAuth लॉगिन सेवा से मिले पुष्टि के जवाब से मैच किया जाता है. इससे यह पुष्टि की जाती है कि अनुरोध उपयोगकर्ता ने किया है, न कि किसी नुकसान पहुंचाने वाले हमलावर ने. इन टोकन को अक्सर क्रॉस-साइट रिक्वेस्ट फ़ॉर्जरी (CSRF) टोकन कहा जाता है.
स्टेट टोकन के लिए, 30 या इससे ज़्यादा वर्णों की स्ट्रिंग एक अच्छा विकल्प है. इसे अच्छी क्वालिटी वाले रैंडम-नंबर जनरेटर का इस्तेमाल करके बनाया जाता है. दूसरा तरीका है, आपके सेशन के कुछ स्टेट वैरिएबल को एक ऐसी कुंजी से साइन करके हैश जनरेट करना जिसे आपके बैकएंड पर गुप्त रखा जाता है.
यहां दिए गए कोड से, यूनीक सेशन टोकन जनरेट करने का तरीका पता चलता है.
PHP
इस सैंपल का इस्तेमाल करने के लिए, आपको PHP के लिए Google APIs क्लाइंट लाइब्रेरी डाउनलोड करनी होगी.
// Create a state token to prevent request forgery.
// Store it in the session for later validation.
$state = bin2hex(random_bytes(128/8));
$app['session']->set('state', $state);
// Set the client ID, token state, and application name in the HTML while
// serving it.
return $app['twig']->render('index.html', array(
'CLIENT_ID' => CLIENT_ID,
'STATE' => $state,
'APPLICATION_NAME' => APPLICATION_NAME
));
Java
इस सैंपल का इस्तेमाल करने के लिए, आपको Java के लिए Google APIs क्लाइंट लाइब्रेरी डाउनलोड करनी होगी.
// Create a state token to prevent request forgery.
// Store it in the session for later validation.
String state = new BigInteger(130, new SecureRandom()).toString(32);
request.session().attribute("state", state);
// Read index.html into memory, and set the client ID,
// token state, and application name in the HTML before serving it.
return new Scanner(new File("index.html"), "UTF-8")
.useDelimiter("\\A").next()
.replaceAll("[{]{2}\\s*CLIENT_ID\\s*[}]{2}", CLIENT_ID)
.replaceAll("[{]{2}\\s*STATE\\s*[}]{2}", state)
.replaceAll("[{]{2}\\s*APPLICATION_NAME\\s*[}]{2}",
APPLICATION_NAME);
Python
इस सैंपल का इस्तेमाल करने के लिए, आपको Python के लिए Google APIs क्लाइंट लाइब्रेरी डाउनलोड करनी होगी.
# Create a state token to prevent request forgery.
# Store it in the session for later validation.
state = hashlib.sha256(os.urandom(1024)).hexdigest()
session['state'] = state
# Set the client ID, token state, and application name in the HTML while
# serving it.
response = make_response(
render_template('index.html',
CLIENT_ID=CLIENT_ID,
STATE=state,
APPLICATION_NAME=APPLICATION_NAME))
2. Google को पुष्टि करने का अनुरोध भेजना
अगला चरण, सही यूआरआई पैरामीटर के साथ एचटीटीपीएस GET अनुरोध बनाना है. इस प्रोसेस के सभी चरणों में, एचटीटीपी के बजाय एचटीटीपीएस का इस्तेमाल करें. एचटीटीपी कनेक्शन स्वीकार नहीं किए जाते. आपको authorization_endpoint मेटाडेटा वैल्यू का इस्तेमाल करके, खोज से जुड़े दस्तावेज़ से बेस यूआरआई को वापस पाना चाहिए. यहां दी गई जानकारी के मुताबिक, बेस यूआरआई https://accounts.google.com/o/oauth2/v2/auth है.
सामान्य अनुरोध के लिए, ये पैरामीटर डालें:
client_id, जो आपको Cloud Console के क्लाइंट पेज से मिलता है.response_type, जो ऑथराइज़ेशन कोड फ़्लो के बुनियादी अनुरोध मेंcodeहोना चाहिए. (इस बारे में ज़्यादा जानने के लिए,response_typeपर जाएं.)scope, जो सामान्य अनुरोध मेंopenid emailहोना चाहिए. (इस बारे में ज़्यादा जानने के लिए,scopeपर जाएं.)redirect_uriआपके सर्वर पर मौजूद एचटीटीपी एंडपॉइंट होना चाहिए, जिसे Google से जवाब मिलेगा. यह वैल्यू, OAuth 2.0 क्लाइंट के लिए अनुमति वाले रीडायरेक्ट यूआरआई में से किसी एक से पूरी तरह मेल खानी चाहिए. इसे आपने Cloud Console के क्रेडेंशियल पेज पर कॉन्फ़िगर किया है. अगर यह वैल्यू, अनुमति वाले यूआरआई से मैच नहीं होती है, तो अनुरोध पूरा नहीं होगा औरredirect_uri_mismatchगड़बड़ी का मैसेज दिखेगा.stateमें, जालसाज़ी से बचाने वाले यूनीक सेशन टोकन की वैल्यू शामिल होनी चाहिए.साथ ही, इसमें ऐसी कोई भी अन्य जानकारी शामिल होनी चाहिए जो उपयोगकर्ता के आपके ऐप्लिकेशन पर वापस आने पर, कॉन्टेक्स्ट को वापस पाने के लिए ज़रूरी हो. उदाहरण के लिए, शुरुआती यूआरएल. (इस बारे में ज़्यादा जानने के लिए,stateपर जाएं.)nonce, आपके ऐप्लिकेशन से जनरेट की गई एक रैंडम वैल्यू है. इसके मौजूद होने पर, रीप्ले प्रोटेक्शन की सुविधा चालू हो जाती है.login_hint, उपयोगकर्ता का ईमेल पता याsubस्ट्रिंग हो सकती है. यह उपयोगकर्ता के Google आईडी के बराबर होती है. अगर आपनेlogin_hintनहीं दिया है और उपयोगकर्ता ने लॉग इन किया है, तो ऐसी स्क्रीन जहां OAuth के लिए सहमति दी जाती है, उस पर उपयोगकर्ता के ईमेल पते को आपके ऐप्लिकेशन के साथ शेयर करने की अनुमति मांगी जाती है. इस बारे में ज़्यादा जानने के लिए,login_hintपर जाएं.hdपैरामीटर का इस्तेमाल करके, Google Workspace या Cloud संगठन से जुड़े किसी खास डोमेन के उपयोगकर्ताओं के लिए, OpenID Connect फ़्लो को ऑप्टिमाइज़ करें. इस बारे में ज़्यादा जानने के लिए,hdपर जाएं.
यहां OpenID Connect की पुष्टि करने वाले यूआरआई का एक उदाहरण दिया गया है. इसमें लाइन ब्रेक और स्पेस का इस्तेमाल किया गया है, ताकि इसे आसानी से पढ़ा जा सके:
https://accounts.google.com/o/oauth2/v2/auth? response_type=code& client_id=424911365001.apps.googleusercontent.com& scope=openid%20email& redirect_uri=https%3A//developers.google.com/oauthplayground& state=security_token%3D138r5719ru3e1%26url%3Dhttps%3A%2F%2Foauth2-login-demo.example.com%2FmyHome& login_hint=jsmith@example.com& nonce=0394852-3190485-2490358& hd=example.com
अगर आपका ऐप्लिकेशन उपयोगकर्ताओं के बारे में कोई नई जानकारी मांगता है या खाते के ऐसे ऐक्सेस का अनुरोध करता है जिसे उन्होंने पहले मंज़ूरी नहीं दी है, तो उपयोगकर्ताओं को सहमति देनी होगी.
3. एंटी-फ़ॉर्जरी स्टेट टोकन की पुष्टि करना
जवाब, उस redirect_uri पर भेजा जाता है जो आपने अनुरोध में बताया है. सभी जवाब, क्वेरी स्ट्रिंग में दिखाए जाते हैं:
https://developers.google.com/oauthplayground?state=security_token%3D138r5719ru3e1%26url%3Dhttps%3A%2F%2Foa2cb.example.com%2FmyHome&code=4/P7q7W91a-oMsCeLvIaQm6bTrgtp7&scope=openid%20email%20https://www.googleapis.com/auth/userinfo.email
आरएफ़सी 6749 के मुताबिक, क्लाइंट को ऐसे रिस्पॉन्स पैरामीटर को अनदेखा करना चाहिए जिनकी पहचान नहीं की जा सकी. सर्वर पर, आपको यह पुष्टि करनी होगी कि Google से मिला state, पहले चरण में बनाए गए सेशन टोकन से मैच करता हो. पुष्टि करने की इस दोतरफ़ा प्रक्रिया से यह पुष्टि करने में मदद मिलती है कि अनुरोध किसी उपयोगकर्ता ने किया है, न कि नुकसान पहुंचाने वाली किसी स्क्रिप्ट ने.
यहां दिए गए कोड से, पहले चरण में बनाए गए सेशन टोकन की पुष्टि करने का तरीका पता चलता है:
PHP
इस सैंपल का इस्तेमाल करने के लिए, आपको PHP के लिए Google APIs क्लाइंट लाइब्रेरी डाउनलोड करनी होगी.
// Ensure that there is no request forgery going on, and that the user
// sending us this connect request is the user that was supposed to.
if ($request->get('state') != ($app['session']->get('state'))) {
return new Response('Invalid state parameter', 401);
}
Java
इस सैंपल का इस्तेमाल करने के लिए, आपको Java के लिए Google APIs क्लाइंट लाइब्रेरी डाउनलोड करनी होगी.
// Ensure that there is no request forgery going on, and that the user
// sending us this connect request is the user that was supposed to.
if (!request.queryParams("state").equals(
request.session().attribute("state"))) {
response.status(401);
return GSON.toJson("Invalid state parameter.");
}
Python
इस सैंपल का इस्तेमाल करने के लिए, आपको Python के लिए Google APIs क्लाइंट लाइब्रेरी डाउनलोड करनी होगी.
# Ensure that the request is not a forgery and that the user sending
# this connect request is the expected user.
if request.args.get('state', '') != session['state']:
response = make_response(json.dumps('Invalid state parameter.'), 401)
response.headers['Content-Type'] = 'application/json'
return response
4. ऐक्सेस टोकन और आईडी टोकन के लिए, code को एक्सचेंज करें
जवाब में code पैरामीटर शामिल होता है. यह एक बार इस्तेमाल होने वाला ऑथराइज़ेशन कोड होता है.
आपका सर्वर इसे ऐक्सेस टोकन और आईडी टोकन से बदल सकता है. आपका सर्वर, एचटीटीपीएस POST अनुरोध भेजकर यह एक्सचेंज करता है. POST अनुरोध को टोकन एंडपॉइंट पर भेजा जाता है. आपको इसे token_endpoint मेटाडेटा वैल्यू का इस्तेमाल करके, खोज से जुड़े दस्तावेज़ से वापस पाना चाहिए. नीचे दी गई चर्चा में, एंडपॉइंट को https://oauth2.googleapis.com/token माना गया है. अनुरोध के POST मुख्य हिस्से में, ये पैरामीटर शामिल होने चाहिए:
| फ़ील्ड | |
|---|---|
code |
शुरुआती अनुरोध से मिला ऑथराइज़ेशन कोड. |
client_id |
वह क्लाइंट आईडी जो आपको Cloud Console के क्लाइंट पेज से मिलता है. इसके बारे में OAuth 2.0 क्रेडेंशियल पाना में बताया गया है. |
client_secret |
क्लाइंट सीक्रेट, जो आपको Cloud Console के क्लाइंट पेज से मिलता है. इसके बारे में OAuth 2.0 क्रेडेंशियल पाना में बताया गया है. |
redirect_uri |
दिए गए client_id के लिए, अनुमति वाला रीडायरेक्ट यूआरआई. इसे Cloud Console के क्लाइंट पेज पर बताया गया है. इसके बारे में रीडायरेक्ट यूआरआई सेट करें में बताया गया है. |
grant_type |
इस फ़ील्ड में authorization_code की वैल्यू होनी चाहिए,
जैसा कि OAuth 2.0 की खास जानकारी में बताया गया है. |
असल अनुरोध कुछ इस तरह दिख सकता है:
POST /token HTTP/1.1 Host: oauth2.googleapis.com Content-Type: application/x-www-form-urlencoded code=4/P7q7W91a-oMsCeLvIaQm6bTrgtp7& client_id=your-client-id& client_secret=your-client-secret& redirect_uri=https%3A//developers.google.com/oauthplayground& grant_type=authorization_code
इस अनुरोध के सफल जवाब में, JSON कलेक्शन में ये फ़ील्ड शामिल होते हैं:
| फ़ील्ड | |
|---|---|
access_token |
यह एक टोकन है, जिसे Google API को भेजा जा सकता है. |
expires_in |
ऐक्सेस टोकन की बची हुई लाइफ़टाइम, सेकंड में. |
id_token |
एक JWT, जिसमें उपयोगकर्ता की पहचान की जानकारी होती है. इस पर Google के डिजिटल हस्ताक्षर होते हैं. |
scope |
access_token से मिले ऐक्सेस के स्कोप को, स्पेस से अलग की गई और केस-सेंसिटिव स्ट्रिंग की सूची के तौर पर दिखाया जाता है. |
token_type |
इससे, मिले टोकन के टाइप की पहचान होती है. फ़िलहाल, इस फ़ील्ड की वैल्यू हमेशा Bearer होती है.
|
refresh_token |
(ज़रूरी नहीं)
यह फ़ील्ड सिर्फ़ तब मौजूद होता है, जब पुष्टि के अनुरोध में |
5. आईडी टोकन से उपयोगकर्ता की जानकारी पाना
आईडी टोकन एक JWT (JSON वेब टोकन) होता है. यह क्रिप्टोग्राफ़िक तरीके से साइन किया गया Base64-कोड में बदला गया JSON ऑब्जेक्ट होता है. आम तौर पर, आईडी टोकन का इस्तेमाल करने से पहले, उसकी पुष्टि करना ज़रूरी होता है. हालांकि, Google के साथ सीधे तौर पर कम्यूनिकेट करने के लिए, एचटीटीपीएस चैनल का इस्तेमाल किया जाता है. इसमें किसी तीसरे पक्ष की ज़रूरत नहीं होती. साथ ही, Google के साथ अपनी पहचान की पुष्टि करने के लिए, क्लाइंट सीक्रेट का इस्तेमाल किया जाता है. इसलिए, आपको यह भरोसा हो सकता है कि आपको मिला टोकन वाकई Google से मिला है और मान्य है. अगर आपका सर्वर, आईडी टोकन को आपके ऐप्लिकेशन के अन्य कॉम्पोनेंट को पास करता है, तो यह बेहद ज़रूरी है कि अन्य कॉम्पोनेंट, टोकन का इस्तेमाल करने से पहले उसकी पुष्टि करें.
ज़्यादातर एपीआई लाइब्रेरी, पुष्टि करने की प्रोसेस को base64url-कोड में बदली गई वैल्यू को डिकोड करने और JSON को पार्स करने के साथ जोड़ती हैं. इसलिए, आईडी टोकन में मौजूद दावों को ऐक्सेस करने पर, टोकन की पुष्टि अपने-आप हो जाएगी.
आईडी टोकन का पेलोड
आईडी टोकन एक JSON ऑब्जेक्ट होता है. इसमें नाम/वैल्यू के पेयर का एक सेट होता है. यहां एक उदाहरण दिया गया है, जिसे पढ़ने में आसानी हो, इस तरह से फ़ॉर्मैट किया गया है:
{
"iss": "https://accounts.google.com",
"azp": "1234987819200.apps.googleusercontent.com",
"aud": "1234987819200.apps.googleusercontent.com",
"sub": "10769150350006150715113082367",
"at_hash": "HK6E_P6Dh8Y93mRNtsDB1Q",
"hd": "example.com",
"email": "jsmith@example.com",
"email_verified": "true",
"iat": 1353601026,
"exp": 1353604926,
"nonce": "0394852-3190485-2490358"
}
Google आईडी टोकन में ये फ़ील्ड (इन्हें दावे कहा जाता है) शामिल हो सकते हैं:
| दावा करें | दिया गया | ब्यौरा |
|---|---|---|
aud |
हमेशा | वह ऑडियंस जिसके लिए यह आईडी टोकन बनाया गया है. यह आपके ऐप्लिकेशन के OAuth 2.0 क्लाइंट आईडी में से एक होना चाहिए. |
exp |
हमेशा | समयसीमा खत्म होने का समय, जिसके बाद आईडी टोकन स्वीकार नहीं किया जाना चाहिए. इसे Unix epoch टाइम (सेकंड में पूर्णांक) में दिखाया जाता है. |
iat |
हमेशा | आईडी टोकन जारी किए जाने का समय. इसे Unix epoch टाइम (सेकंड में पूर्णांक) में दिखाया जाता है. |
iss |
हमेशा | जवाब जारी करने वाले के लिए आइडेंटिफ़ायर. Google आईडी टोकन के लिए, हमेशा https://accounts.google.com या accounts.google.com का इस्तेमाल करें. |
sub |
हमेशा | उपयोगकर्ता के लिए एक आइडेंटिफ़ायर, जो सभी Google खातों के लिए यूनीक होता है और जिसका दोबारा इस्तेमाल नहीं किया जाता. एक Google खाते में अलग-अलग समय पर कई ईमेल पते हो सकते हैं. हालांकि, sub वैल्यू कभी नहीं बदलती. अपने ऐप्लिकेशन में sub का इस्तेमाल, उपयोगकर्ता के लिए यूनीक आइडेंटिफ़ायर कुंजी के तौर पर करें. केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) ASCII वर्णों की ज़्यादा से ज़्यादा संख्या 255 होनी चाहिए. |
amr |
स्ट्रिंग का एक JSON कलेक्शन, जो Google खाते में साइन इन करने के लिए इस्तेमाल किए गए, पुष्टि करने के तरीकों की पहचान करता है. अगर यह मौजूद है, तो इसमें इनमें से एक या उससे ज़्यादा संभावित
[IANA.AMR]
वैल्यू शामिल होती हैं:
amr क्लेम शामिल किया गया हो और सेटिंग में जाकर इसे चालू किया गया हो.
|
|
auth_time |
उपयोगकर्ता की पुष्टि होने का समय. यह एक JSON नंबर होता है, जो Unix epoch (1 जनवरी, 1970, 00:00:00 यूटीसी) के बाद से बीते हुए सेकंड की संख्या दिखाता है. यह तब दिया जाता है, जब पुष्टि करने के अनुरोध में auth_time दावे को शामिल किया जाता है और सेटिंग में चालू किया जाता है.
|
|
at_hash |
ऐक्सेस टोकन हैश. यह पुष्टि करता है कि ऐक्सेस टोकन, आईडी टोकन से जुड़ा है. अगर आईडी टोकन को सर्वर फ़्लो में access_token वैल्यू के साथ जारी किया जाता है, तो यह दावा हमेशा शामिल किया जाता है. इस दावे का इस्तेमाल, दूसरी साइट से किए गए फ़र्ज़ी अनुरोध (सीएसआरएफ़) वाले हमलों से बचने के लिए, एक वैकल्पिक तरीके के तौर पर किया जा सकता है. हालांकि, अगर आपने पहला चरण और तीसरा चरण पूरा किया है, तो ऐक्सेस टोकन की पुष्टि करना ज़रूरी नहीं है. |
|
azp |
आधिकारिक तौर पर प्रज़ेंट करने वाले व्यक्ति का client_id. इस दावे की ज़रूरत सिर्फ़ तब होती है, जब आईडी टोकन का अनुरोध करने वाली पार्टी, आईडी टोकन की ऑडियंस से अलग हो. Google पर हाइब्रिड ऐप्लिकेशन के लिए ऐसा हो सकता है. इनमें वेब ऐप्लिकेशन और Android ऐप्लिकेशन का OAuth 2.0 client_id अलग-अलग होता है, लेकिन वे एक ही Google API प्रोजेक्ट शेयर करते हैं. |
|
email |
उपयोगकर्ता का ईमेल पता. यह सिर्फ़ तब दिया जाता है, जब आपने अपने अनुरोध में email स्कोप शामिल किया हो. इस दावे की वैल्यू, इस खाते के लिए यूनीक नहीं हो सकती और समय के साथ बदल सकती है. इसलिए, आपको इस वैल्यू का इस्तेमाल, अपने उपयोगकर्ता रिकॉर्ड से लिंक करने के लिए प्राइमरी आइडेंटिफ़ायर के तौर पर नहीं करना चाहिए. Google Workspace या Google Cloud संगठनों के उपयोगकर्ताओं की पहचान करने के लिए, email दावे के डोमेन पर भी भरोसा नहीं किया जा सकता. इसके बजाय, hd दावे का इस्तेमाल करें.
|
|
email_verified |
अगर उपयोगकर्ता के ईमेल पते की पुष्टि हो गई है, तो True; अगर नहीं हुई है, तो False. | |
family_name |
उपयोगकर्ता का सरनेम या उपनाम. name का दावा मौजूद होने पर, यह जानकारी दी जा सकती है. |
|
given_name |
उपयोगकर्ता का नाम या पहला नाम. name का दावा मौजूद होने पर, यह जानकारी दी जा सकती है. |
|
hd |
उपयोगकर्ता के Google Workspace या Cloud संगठन से जुड़ा डोमेन. यह जानकारी सिर्फ़ तब दी जाती है, जब उपयोगकर्ता Google Cloud संगठन से जुड़ा हो. किसी संसाधन का ऐक्सेस सिर्फ़ कुछ डोमेन के सदस्यों तक सीमित करते समय, आपको इस दावे की जांच करनी होगी. इस दावे के न होने का मतलब है कि खाता, Google के होस्ट किए गए डोमेन से जुड़ा नहीं है. | |
locale |
उपयोगकर्ता की भाषा, जिसे BCP 47 भाषा टैग से दिखाया जाता है.
name का दावा मौजूद होने पर, यह जानकारी दी जा सकती है. |
|
name |
उपयोगकर्ता का पूरा नाम, जिसे दिखाया जा सके. यह जानकारी तब दी जा सकती है, जब:
|
|
nonce |
पुष्टि करने के अनुरोध में, आपके ऐप्लिकेशन से दी गई nonce की वैल्यू.
इस वैल्यू को सिर्फ़ एक बार दिखाकर, रीप्ले अटैक से बचा जा सकता है. |
|
picture |
उपयोगकर्ता की प्रोफ़ाइल फ़ोटो का यूआरएल. यह जानकारी तब दी जा सकती है, जब:
|
|
profile |
उपयोगकर्ता के प्रोफ़ाइल पेज का यूआरएल. यह जानकारी तब दी जा सकती है, जब:
|
6. उपयोगकर्ता की पुष्टि करना
आईडी टोकन से उपयोगकर्ता की जानकारी मिलने के बाद, आपको अपने ऐप्लिकेशन के उपयोगकर्ता डेटाबेस से क्वेरी करनी चाहिए. अगर उपयोगकर्ता पहले से ही आपके डेटाबेस में मौजूद है, तो आपको उस उपयोगकर्ता के लिए ऐप्लिकेशन सेशन शुरू करना चाहिए. ऐसा तब करना चाहिए, जब Google API से मिली जानकारी में लॉगिन की सभी ज़रूरी शर्तें पूरी की गई हों.
अगर उपयोगकर्ता आपके डेटाबेस में मौजूद नहीं है, तो उसे नए उपयोगकर्ता के साइन-अप फ़्लो पर रीडायरेक्ट करें. Google से मिलने वाली जानकारी के आधार पर, उपयोगकर्ता का रजिस्ट्रेशन अपने-आप हो सकता है. इसके अलावा, रजिस्ट्रेशन फ़ॉर्म में मौजूद कई फ़ील्ड में जानकारी अपने-आप भरी जा सकती है. आईडी टोकन में मौजूद जानकारी के अलावा, आपको हमारे उपयोगकर्ता प्रोफ़ाइल एंडपॉइंट पर, उपयोगकर्ता की प्रोफ़ाइल की अतिरिक्त जानकारी मिल सकती है.
उन्नत विषय
यहां दिए गए सेक्शन में, Google OAuth 2.0 API के बारे में ज़्यादा जानकारी दी गई है. यह जानकारी उन डेवलपर के लिए है जिन्हें पुष्टि करने और अनुमति देने के लिए, ऐडवांस सुविधाओं की ज़रूरत होती है.
अन्य Google APIs का ऐक्सेस
पुष्टि करने के लिए OAuth 2.0 का इस्तेमाल करने का एक फ़ायदा यह है कि आपके ऐप्लिकेशन को उपयोगकर्ता की ओर से, Google के अन्य एपीआई इस्तेमाल करने की अनुमति मिल सकती है. जैसे, YouTube, Google Drive, Calendar या Contacts. यह अनुमति, उपयोगकर्ता की पुष्टि करने के दौरान ही मिल सकती है. इसके लिए, Google को भेजे जाने वाले पुष्टि के अनुरोध में, वे अन्य स्कोप शामिल करें जिनकी आपको ज़रूरत है. उदाहरण के लिए,
पहचान की पुष्टि करने के अनुरोध में उपयोगकर्ता की उम्र समूह की जानकारी जोड़ने के लिए, openid email https://www.googleapis.com/auth/profile.agerange.read का स्कोप पैरामीटर पास करें. उपयोगकर्ता को ऐसी स्क्रीन जहां OAuth के लिए सहमति दी जाती है पर सही तरीके से प्रॉम्प्ट किया जाता है.
Google से मिलने वाले ऐक्सेस टोकन की मदद से, आपका ऐप्लिकेशन उन सभी एपीआई को ऐक्सेस कर पाएगा जिनके लिए आपने ऐक्सेस का अनुरोध किया था और आपको ऐक्सेस दिया गया था.
रीफ़्रेश टोकन
एपीआई ऐक्सेस के लिए किए गए अनुरोध में, code एक्सचेंज के दौरान रीफ़्रेश टोकन वापस करने का अनुरोध किया जा सकता है. रिफ़्रेश टोकन की मदद से, आपके ऐप्लिकेशन को Google API का लगातार ऐक्सेस मिलता रहता है. भले ही, उपयोगकर्ता आपके ऐप्लिकेशन में मौजूद न हो. रिफ़्रेश टोकन का अनुरोध करने के लिए, अपने पुष्टि के अनुरोध में access_type पैरामीटर को offline पर सेट करें.
इन बातों पर ध्यान दें:
- पक्का करें कि आपने रीफ़्रेश टोकन को सुरक्षित और स्थायी तौर पर सेव किया हो. ऐसा इसलिए, क्योंकि पहली बार कोड एक्सचेंज फ़्लो को पूरा करने पर ही रीफ़्रेश टोकन मिल सकता है.
- जारी किए जाने वाले रीफ़्रेश टोकन की संख्या पर सीमाएं लागू होती हैं: हर क्लाइंट/उपयोगकर्ता के कॉम्बिनेशन के लिए एक सीमा और सभी क्लाइंट के लिए हर उपयोगकर्ता के लिए एक सीमा. अगर आपका ऐप्लिकेशन बहुत ज़्यादा रीफ़्रेश टोकन का अनुरोध करता है, तो हो सकता है कि वह इन सीमाओं को पार कर जाए. ऐसे में, पुराने रीफ़्रेश टोकन काम करना बंद कर देते हैं.
ज़्यादा जानकारी के लिए, ऐक्सेस टोकन को रीफ़्रेश करना (बिना इंटरनेट के इस्तेमाल) देखें.
दोबारा सहमति देने के लिए अनुरोध करना
उपयोगकर्ता को अपने ऐप्लिकेशन को फिर से अनुमति देने के लिए कहा जा सकता है. इसके लिए, आपको पुष्टि करने के अनुरोध में prompt पैरामीटर को consent पर सेट करना होगा. prompt=consent शामिल होने पर, जब भी आपका ऐप्लिकेशन ऐक्सेस के स्कोप की अनुमति का अनुरोध करेगा, तब सहमति वाली स्क्रीन दिखेगी. भले ही, आपके Google API प्रोजेक्ट को पहले ही सभी स्कोप की अनुमति मिल चुकी हो. इसलिए, prompt=consent को सिर्फ़ तब शामिल करें, जब ज़रूरी हो.
prompt पैरामीटर के बारे में ज़्यादा जानने के लिए, पुष्टि करने के लिए यूआरआई पैरामीटर टेबल में prompt देखें.
पुष्टि करने के लिए यूआरआई पैरामीटर
यहां दी गई टेबल में, Google के OAuth 2.0 ऑथेंटिकेशन एपीआई के स्वीकार किए गए पैरामीटर के बारे में ज़्यादा जानकारी दी गई है.
| पैरामीटर | ज़रूरी है | ब्यौरा | ||||||
|---|---|---|---|---|---|---|---|---|
client_id |
(ज़रूरी है) | क्लाइंट आईडी स्ट्रिंग, जो आपको Cloud Console के क्लाइंट पेज से मिलती है. इसके बारे में OAuth 2.0 क्रेडेंशियल पाना में बताया गया है. | ||||||
nonce |
(ज़रूरी है) | आपके ऐप्लिकेशन से जनरेट की गई कोई रैंडम वैल्यू, जिससे रीप्ले प्रोटेक्शन की सुविधा चालू होती है. | ||||||
response_type |
(ज़रूरी है) | अगर वैल्यू code है, तो बेसिक ऑथराइज़ेशन कोड फ़्लो लॉन्च होता है. टोकन पाने के लिए, टोकन एंडपॉइंट पर POST की ज़रूरत होती है. अगर वैल्यू token id_token या id_token token है, तो इंप्लिसिट फ़्लो लॉन्च होता है. इसके लिए, रीडायरेक्ट यूआरआई पर JavaScript का इस्तेमाल करना ज़रूरी है, ताकि यूआरआई #fragment आइडेंटिफ़ायर से टोकन वापस पाए जा सकें. |
||||||
redirect_uri |
(ज़रूरी है) | इससे यह तय होता है कि जवाब कहां भेजा जाए. इस पैरामीटर की वैल्यू, Cloud Console के क्लाइंट पेज पर सेट की गई, अनुमति वाली रीडायरेक्ट वैल्यू में से किसी एक से पूरी तरह मेल खानी चाहिए. इसमें एचटीटीपी या एचटीटीपीएस स्कीम, केस, और आखिर में मौजूद '/' (अगर कोई है) शामिल है. | ||||||
scope |
(ज़रूरी है) | स्कोप पैरामीटर, अगर अगर OpenID के लिए खास तौर पर तय किए गए इन स्कोप के अलावा, आपके स्कोप आर्ग्युमेंट में अन्य स्कोप वैल्यू भी शामिल हो सकती हैं. स्कोप की सभी वैल्यू को स्पेस से अलग किया जाना चाहिए. उदाहरण के लिए, अगर आपको किसी उपयोगकर्ता की Google Drive में मौजूद हर फ़ाइल का ऐक्सेस चाहिए, तो आपका स्कोप पैरामीटर उपलब्ध दायरों के बारे में जानकारी पाने के लिए, Google API के लिए OAuth 2.0 के दायरे या उस Google API का दस्तावेज़ देखें जिसका आपको इस्तेमाल करना है. |
||||||
state |
(ज़रूरी नहीं, लेकिन इसका सुझाव दिया जाता है) | एक ओपेक स्ट्रिंग, जो प्रोटोकॉल में राउंड-ट्रिप होती है. इसका मतलब है कि इसे बेसिक फ़्लो में यूआरआई पैरामीटर के तौर पर और इंप्लिसिट फ़्लो में यूआरआई
|
||||||
access_type |
(ज़रूरी नहीं) | offline और online को वैल्यू के तौर पर इस्तेमाल किया जा सकता है. इसके असर के बारे में
बिना इंटरनेट के इस्तेमाल में बताया गया है; अगर ऐक्सेस टोकन का अनुरोध किया जा रहा है, तो क्लाइंट को तब तक रीफ़्रेश टोकन नहीं मिलता, जब तक कि offline की वैल्यू तय न की गई हो. |
||||||
claims |
(ज़रूरी नहीं) | दावों के पैरामीटर का इस्तेमाल, एक या उससे ज़्यादा वैकल्पिक फ़ील्ड तय करने के लिए किया जाता है. इन फ़ील्ड को userinfo एंडपॉइंट या पुष्टि करने के अनुरोध के आईडी टोकन के रिस्पॉन्स टाइप में शामिल किया जाता है. यह वैल्यू एक JSON ऑब्जेक्ट है. इसमें रिस्पॉन्स टाइप और अनुरोध किए गए दावे शामिल होते हैं. Google के सर्वर, दावे के इन अनुरोधों को स्वीकार करते हैं:
|
||||||
display |
(ज़रूरी नहीं) | ASCII स्ट्रिंग वैल्यू, जिससे यह तय किया जाता है कि अनुमति देने वाला सर्वर, पुष्टि करने और सहमति देने वाले यूज़र इंटरफ़ेस पेजों को कैसे दिखाता है. यहां दी गई वैल्यू तय की गई हैं और Google के सर्वर इन्हें स्वीकार करते हैं. हालांकि, इनका प्रोटोकॉल फ़्लो के व्यवहार पर कोई असर नहीं पड़ता: page, popup, touch, और wap. |
||||||
hd |
(ज़रूरी नहीं) | Google Cloud संगठन के मालिकाना हक वाले खातों के लिए, लॉगिन की प्रोसेस को आसान बनाएं. Google Cloud संगठन का डोमेन (उदाहरण के लिए, mycollege.edu) शामिल करके, यह बताया जा सकता है कि खाता चुनने वाले यूज़र इंटरफ़ेस (यूआई) को उस डोमेन के खातों के लिए ऑप्टिमाइज़ किया जाना चाहिए. सिर्फ़ एक Google Cloud संगठन डोमेन के बजाय, Google Cloud संगठन के खातों को ऑप्टिमाइज़ करने के लिए, ऐस्टरिस्क ( अपने ऐप्लिकेशन का ऐक्सेस कंट्रोल करने के लिए, यूज़र इंटरफ़ेस (यूआई) के इस ऑप्टिमाइज़ेशन पर भरोसा न करें. ऐसा इसलिए, क्योंकि क्लाइंट-साइड के अनुरोधों में बदलाव किया जा सकता है. पक्का करें कि वापस मिले आईडी टोकन में |
||||||
include_granted_scopes |
(ज़रूरी नहीं) | अगर इस पैरामीटर की वैल्यू true है और अनुमति देने का अनुरोध स्वीकार कर लिया जाता है, तो अनुमति में इस उपयोगकर्ता/ऐप्लिकेशन के कॉम्बिनेशन को अन्य स्कोप के लिए दी गई पिछली अनुमतियां भी शामिल होंगी. इसके बारे में ज़्यादा जानने के लिए, इंक्रीमेंटल ऑथराइज़ेशन देखें.
ध्यान दें कि इंस्टॉल किए गए ऐप्लिकेशन के फ़्लो की मदद से, इंक्रीमेंटल ऑथराइज़ेशन नहीं किया जा सकता. |
||||||
login_hint |
(ज़रूरी नहीं) | जब आपके ऐप्लिकेशन को पता होता है कि उसे किस उपयोगकर्ता की पुष्टि करनी है, तो वह इस पैरामीटर को ऑथेंटिकेशन सर्वर को हिंट के तौर पर दे सकता है. इस हिंट को पास करने से, खाता चुनने की सुविधा बंद हो जाती है. साथ ही, साइन-इन फ़ॉर्म पर ईमेल बॉक्स ऑटोमैटिक तरीके से भर जाता है या सही सेशन चुन लिया जाता है. ऐसा तब होता है, जब उपयोगकर्ता एक से दूसरे खाते पर जाने की सुविधा का इस्तेमाल कर रहा हो. इससे आपको उन समस्याओं से बचने में मदद मिल सकती है जो आपके ऐप्लिकेशन में गलत उपयोगकर्ता खाते से लॉग इन करने पर होती हैं.
वैल्यू, ईमेल पता या sub स्ट्रिंग हो सकती है. यह उपयोगकर्ता के Google आईडी के बराबर होती है. |
||||||
prompt |
(ज़रूरी नहीं) | स्ट्रिंग वैल्यू की स्पेस-डिलिमिटेड सूची, जिससे यह पता चलता है कि अनुमति देने वाला सर्वर, उपयोगकर्ता को फिर से पुष्टि करने और सहमति देने के लिए कहता है या नहीं. ये वैल्यू इस्तेमाल की जा सकती हैं:
अगर कोई वैल्यू तय नहीं की गई है और उपयोगकर्ता ने पहले ऐक्सेस की अनुमति नहीं दी है, तो उपयोगकर्ता को सहमति वाली स्क्रीन दिखाई जाती है. |
||||||
hl |
(ज़रूरी नहीं) | BCP 47 भाषा टैग का इस्तेमाल, साइन-इन करने, खाता चुनने की सुविधा, और ऐसी स्क्रीन जहां OAuth के लिए सहमति दी जाती है स्क्रीन के लिए डिसप्ले भाषा तय करने के लिए किया जाता है. अगर यह पैरामीटर नहीं दिया जाता है, तो भाषा डिफ़ॉल्ट रूप से उपयोगकर्ता के Google खाते या ब्राउज़र की सेटिंग के हिसाब से सेट हो जाती है. उदाहरण के लिए, ब्रिटिश इंग्लिश में यूज़र इंटरफ़ेस का अनुरोध करने के लिए, पैरामीटर को en-GB पर सेट करें.
|
||||||
आईडी टोकन की पुष्टि करना
आपको अपने सर्वर पर मौजूद सभी आईडी टोकन की पुष्टि करनी होगी. हालांकि, अगर आपको पता है कि वे सीधे Google से मिले हैं, तो आपको ऐसा करने की ज़रूरत नहीं है. उदाहरण के लिए, आपके सर्वर को क्लाइंट ऐप्लिकेशन से मिलने वाले किसी भी आईडी टोकन की पुष्टि करनी होगी.
यहां कुछ ऐसी सामान्य स्थितियां दी गई हैं जिनमें आपको अपने सर्वर पर आईडी टोकन भेजने पड़ सकते हैं:
- उन अनुरोधों के साथ आईडी टोकन भेजना जिनकी पुष्टि करना ज़रूरी है. आईडी टोकन से आपको पता चलता है कि अनुरोध करने वाला उपयोगकर्ता कौन है और वह आईडी टोकन किस क्लाइंट के लिए दिया गया था.
आईडी टोकन संवेदनशील होते हैं. अगर इन्हें इंटरसेप्ट किया जाता है, तो इनका गलत इस्तेमाल किया जा सकता है. आपको यह पक्का करना होगा कि इन टोकन को सुरक्षित तरीके से मैनेज किया जाए. इसके लिए, इन्हें सिर्फ़ एचटीटीपीएस के ज़रिए ट्रांसमिट करें. साथ ही, सिर्फ़ पोस्ट डेटा का इस्तेमाल करें या अनुरोध के हेडर में शामिल करें. अगर आईडी टोकन आपके सर्वर पर सेव किए जाते हैं, तो उन्हें सुरक्षित तरीके से सेव करना ज़रूरी है.
आईडी टोकन की एक खास बात यह है कि इन्हें अपने ऐप्लिकेशन के अलग-अलग कॉम्पोनेंट में पास किया जा सकता है. ये कॉम्पोनेंट, आईडी टोकन का इस्तेमाल करके, ऐप्लिकेशन और उपयोगकर्ता की पुष्टि करने के लिए, पुष्टि करने के आसान तरीके के तौर पर कर सकते हैं. हालांकि, आईडी टोकन में मौजूद जानकारी का इस्तेमाल करने या इस बात पर भरोसा करने से पहले कि उपयोगकर्ता की पुष्टि हो गई है, आपको इसकी पुष्टि ज़रूर करनी होगी.
आईडी टोकन की पुष्टि करने के लिए, कई चरणों को पूरा करना ज़रूरी है:
- पुष्टि करें कि आईडी टोकन पर, उसे जारी करने वाले के सही हस्ताक्षर हों. Google की ओर से जारी किए गए टोकन पर, खोज से जुड़े दस्तावेज़ की
jwks_uriमेटाडेटा वैल्यू में बताए गए यूआरआई पर मौजूद किसी एक सर्टिफ़िकेट का इस्तेमाल करके हस्ताक्षर किए जाते हैं. - पुष्टि करें कि आईडी टोकन में
issदावे की वैल्यू,https://accounts.google.comयाaccounts.google.comके बराबर हो. - पुष्टि करें कि आईडी टोकन में
audदावे की वैल्यू, आपके ऐप्लिकेशन के क्लाइंट आईडी के बराबर हो. - पुष्टि करें कि आईडी टोकन की समयसीमा खत्म होने का समय (
expदावा) न बीता हो. - अगर आपने अनुरोध में hd पैरामीटर की वैल्यू दी है, तो पुष्टि करें कि आईडी टोकन में
hdदावा मौजूद हो. यह दावा, Google Cloud संगठन से जुड़े किसी स्वीकार किए गए डोमेन से मैच होना चाहिए.
दूसरे से पांचवें चरण में, सिर्फ़ स्ट्रिंग और तारीख की तुलना की जाती है. यह काफ़ी आसान है. इसलिए, हम यहां इनके बारे में ज़्यादा जानकारी नहीं देंगे.
पहला चरण ज़्यादा जटिल है. इसमें क्रिप्टोग्राफ़िक सिग्नेचर की जांच करना शामिल है.
डीबग करने के लिए, Google के tokeninfo एंडपॉइंट का इस्तेमाल किया जा सकता है. इससे, आपके सर्वर या डिवाइस पर लागू की गई लोकल प्रोसेसिंग की तुलना की जा सकती है. मान लें कि आपके आईडी टोकन की वैल्यू XYZ123 है. इसके बाद, आपको यूआरआई https://oauth2.googleapis.com/tokeninfo?id_token=XYZ123 को डीरेफ़रंस करना होगा.
अगर टोकन का हस्ताक्षर मान्य है, तो रिस्पॉन्स में JWT पेलोड, डिकोड किए गए JSON ऑब्जेक्ट के तौर पर दिखेगा.
tokeninfo एंडपॉइंट, डीबग करने के लिए मददगार है. हालांकि, प्रोडक्शन के लिए, पासकोड एंडपॉइंट से Google के सार्वजनिक पासकोड वापस पाएं और पुष्टि करने की प्रोसेस को स्थानीय तौर पर पूरा करें. आपको jwks_uri मेटाडेटा वैल्यू का इस्तेमाल करके, खोज से जुड़े दस्तावेज़ से कुंजियों का यूआरआई वापस पाना चाहिए. डीबगिंग एंडपॉइंट के अनुरोधों को थ्रॉटल किया जा सकता है या उनमें कभी-कभी गड़बड़ियां आ सकती हैं.
Google अपने सार्वजनिक पासकोड को बहुत कम बदलता है. इसलिए, एचटीटीपी रिस्पॉन्स के कैश डायरेक्टिव का इस्तेमाल करके, उन्हें कैश मेमोरी में सेव किया जा सकता है. साथ ही, ज़्यादातर मामलों में, tokeninfo एंडपॉइंट का इस्तेमाल करने के बजाय, स्थानीय तौर पर पुष्टि करने की प्रोसेस को ज़्यादा बेहतर तरीके से पूरा किया जा सकता है. इस पुष्टि के लिए, सर्टिफ़िकेट को वापस पाना और पार्स करना ज़रूरी है. साथ ही, हस्ताक्षर की जांच करने के लिए सही क्रिप्टोग्राफ़िक कॉल करना ज़रूरी है. खुशकिस्मती से, इस काम को पूरा करने के लिए कई भाषाओं में अच्छी तरह से डीबग की गई लाइब्रेरी उपलब्ध हैं. इनके बारे में जानने के लिए, jwt.io देखें.
उपयोगकर्ता की प्रोफ़ाइल से जुड़ी जानकारी हासिल करना
उपयोगकर्ता की प्रोफ़ाइल के बारे में ज़्यादा जानकारी पाने के लिए, ऐक्सेस टोकन और OpenID Connect स्टैंडर्ड का इस्तेमाल किया जा सकता है. ऐक्सेस टोकन, आपके ऐप्लिकेशन को पुष्टि करने की प्रोसेस के दौरान मिलता है:
OpenID के मुताबिक होने के लिए, आपको अपने पुष्टि के अनुरोध में
openid profileस्कोप की वैल्यू शामिल करनी होंगी.अगर आपको उपयोगकर्ता का ईमेल पता शामिल करना है, तो
emailकी अतिरिक्त स्कोप वैल्यू तय की जा सकती है.profileऔरemail, दोनों की जानकारी देने के लिए, पुष्टि करने के अनुरोध URI में यह पैरामीटर शामिल किया जा सकता है:scope=openid%20profile%20emailअनुमति देने वाले हेडर में अपना ऐक्सेस टोकन जोड़ें. इसके बाद, userinfo एंडपॉइंट को एचटीटीपीएस
GETअनुरोध भेजें. आपको यह एंडपॉइंट,userinfo_endpointमेटाडेटा वैल्यू का इस्तेमाल करके, खोज से जुड़े दस्तावेज़ से वापस पाना चाहिए. userinfo रिस्पॉन्स में उपयोगकर्ता के बारे में जानकारी शामिल होती है. इसके बारे मेंOpenID Connect Standard Claimsऔर खोज से जुड़े दस्तावेज़ कीclaims_supportedमेटाडेटा वैल्यू में बताया गया है. उपयोगकर्ता या उनके संगठन, कुछ फ़ील्ड की जानकारी दे सकते हैं या उन्हें छिपा सकते हैं. इसलिए, हो सकता है कि आपको ऐक्सेस के लिए अनुमति वाले स्कोप के हर फ़ील्ड की जानकारी न मिले.
खोज से जुड़ा दस्तावेज़
OpenID Connect प्रोटोकॉल के लिए, उपयोगकर्ताओं की पुष्टि करने के लिए कई एंडपॉइंट इस्तेमाल करने की ज़रूरत होती है. साथ ही, टोकन, उपयोगकर्ता की जानकारी, और सार्वजनिक पासकोड जैसे संसाधनों का अनुरोध करने के लिए भी कई एंडपॉइंट इस्तेमाल करने की ज़रूरत होती है.
OpenID Connect, "खोज से जुड़े दस्तावेज़" का इस्तेमाल करने की अनुमति देता है. इससे, इसे लागू करना आसान हो जाता है और इसे ज़्यादा आसानी से इस्तेमाल किया जा सकता है. यह एक JSON दस्तावेज़ होता है, जो किसी जाने-पहचाने यूआरएल पर मिलता है. इसमें की-वैल्यू पेयर होते हैं. इनसे OpenID Connect की सेवा देने वाली कंपनी के कॉन्फ़िगरेशन के बारे में जानकारी मिलती है. इसमें अनुमति, टोकन, रद्द करने, उपयोगकर्ता की जानकारी, और सार्वजनिक पासकोड के एंडपॉइंट के यूआरआई शामिल होते हैं. Google की OpenID Connect सेवा के लिए, खोज से जुड़ा दस्तावेज़ यहां से वापस पाया जा सकता है:
https://accounts.google.com/.well-known/openid-configuration
Google की OpenID Connect सेवाओं का इस्तेमाल करने के लिए, आपको अपने ऐप्लिकेशन में खोज से जुड़े दस्तावेज़ के यूआरआई (https://accounts.google.com/.well-known/openid-configuration) को हार्ड-कोड करना चाहिए.
आपका ऐप्लिकेशन, दस्तावेज़ को फ़ेच करता है और रिस्पॉन्स में कैश मेमोरी के नियम लागू करता है. इसके बाद, ज़रूरत के हिसाब से उससे एंडपॉइंट यूआरआई को वापस लाता है. उदाहरण के लिए, किसी उपयोगकर्ता की पुष्टि करने के लिए, आपका कोड authorization_endpoint मेटाडेटा वैल्यू (यहां दिए गए उदाहरण में https://accounts.google.com/o/oauth2/v2/auth) को Google को भेजे गए पुष्टि के अनुरोधों के लिए बेस यूआरआई के तौर पर वापस लाएगा.
यहां ऐसे दस्तावेज़ का एक उदाहरण दिया गया है. फ़ील्ड के नाम, OpenID Connect Discovery 1.0 में बताए गए नाम हैं. इनके मतलब जानने के लिए, उस दस्तावेज़ को देखें. ये वैल्यू सिर्फ़ उदाहरण के तौर पर दी गई हैं और इनमें बदलाव हो सकता है. हालांकि, इन्हें Google डिस्कवरी दस्तावेज़ के हाल ही के वर्शन से कॉपी किया गया है:
{ "issuer": "https://accounts.google.com", "authorization_endpoint": "https://accounts.google.com/o/oauth2/v2/auth", "device_authorization_endpoint": "https://oauth2.googleapis.com/device/code", "token_endpoint": "https://oauth2.googleapis.com/token", "userinfo_endpoint": "https://openidconnect.googleapis.com/v1/userinfo", "revocation_endpoint": "https://oauth2.googleapis.com/revoke", "jwks_uri": "https://www.googleapis.com/oauth2/v3/certs", "response_types_supported": [ "code", "token", "id_token", "code token", "code id_token", "token id_token", "code token id_token", "none" ], "subject_types_supported": [ "public" ], "id_token_signing_alg_values_supported": [ "RS256" ], "scopes_supported": [ "openid", "email", "profile" ], "token_endpoint_auth_methods_supported": [ "client_secret_post", "client_secret_basic" ], "claims_supported": [ "aud", "email", "email_verified", "exp", "family_name", "given_name", "iat", "iss", "locale", "name", "picture", "sub" ], "code_challenge_methods_supported": [ "plain", "S256" ] }
खोज से जुड़े दस्तावेज़ की वैल्यू को कैश मेमोरी में सेव करके, एचटीटीपी की दोतरफ़ा यात्रा से बचा जा सकता है. स्टैंडर्ड एचटीटीपी कैशिंग हेडर का इस्तेमाल किया जाता है और इनका पालन किया जाना चाहिए.
क्लाइंट लाइब्रेरी
यहां दी गई क्लाइंट लाइब्रेरी, लोकप्रिय फ़्रेमवर्क के साथ इंटिग्रेट करके, OAuth 2.0 को लागू करना आसान बनाती हैं:
- Java के लिए Google APIs क्लाइंट लाइब्रेरी
- Python के लिए Google API की क्लाइंट लाइब्रेरी
- .NET के लिए Google APIs क्लाइंट लाइब्रेरी
- Ruby के लिए Google API की क्लाइंट लाइब्रेरी
- PHP के लिए Google APIs की क्लाइंट लाइब्रेरी
- Google Web Toolkit के लिए OAuth 2.0 लाइब्रेरी
- Mac OAuth 2.0 कंट्रोलर के लिए Google टूलबॉक्स
OpenID Connect के नियमों का पालन करना
Google का OAuth 2.0 ऑथेंटिकेशन सिस्टम, OpenID Connect Core की खास जानकारी में बताई गई ज़रूरी सुविधाओं के साथ काम करता है. OpenID Connect के साथ काम करने के लिए डिज़ाइन किए गए किसी भी क्लाइंट को इस सेवा के साथ इंटरऑपरेट करना चाहिए. हालांकि, OpenID अनुरोध ऑब्जेक्ट के साथ ऐसा नहीं किया जा सकता.
