OAuth 2.0 तकनीकी

इस दस्तावेज़ में, IMAP AUTHENTICATE, POP AUTH, और SMTP AUTH कमांड के साथ इस्तेमाल करने के लिए, SASL XOAUTH2 मेकेनिज़्म के बारे में बताया गया है. इस तरीके से, OAuth 2.0 ऐक्सेस टोकन का इस्तेमाल करके, किसी उपयोगकर्ता के Gmail खाते की पुष्टि की जा सकती है.

OAuth 2.0 का इस्तेमाल करना

सबसे पहले, OAuth 2.0 का इस्तेमाल करके, Google API को ऐक्सेस करना के बारे में जानें. उस दस्तावेज़ में बताया गया है कि OAuth 2.0 कैसे काम करता है. साथ ही, क्लाइंट लिखने के लिए ज़रूरी चरणों के बारे में भी बताया गया है.

काम करने वाले उदाहरणों के लिए, XOAUTH2 का सैंपल कोड भी ब्राउज़ किया जा सकता है.

OAuth 2.0 के स्कोप

IMAP, POP, और SMTP ऐक्सेस का दायरा https://mail.google.com/ है. अगर आपको अपने IMAP, POP या SMTP ऐप्लिकेशन के लिए, ईमेल के पूरे स्कोप का ऐक्सेस चाहिए, तो उसे हमारी Google API सेवाओं की उपयोगकर्ता के डेटा से जुड़ी नीति का पालन करना होगा.

  • मंज़ूरी पाने के लिए, आपके ऐप्लिकेशन में https://mail.google.com/ का पूरी तरह से इस्तेमाल किया जाना चाहिए.
  • अगर आपके ऐप्लिकेशन को https://mail.google.com/ की ज़रूरत नहीं है, तो Gmail API पर माइग्रेट करें. साथ ही, ज़्यादा बारीकी से पाबंदी वाले स्कोप का इस्तेमाल करें.

Google Workspace के लिए, पूरे डोमेन को डेटा का ऐक्सेस देना

अगर आपको IMAP के ज़रिए Google Workspace उपयोगकर्ताओं के मेलबॉक्स ऐक्सेस करने के लिए, Google Workspace के डोमेन-वाइड डेलिगेशन का इस्तेमाल करना है, तो सेवा खातों का इस्तेमाल करें. इसके बजाय, https://www.googleapis.com/auth/gmail.imap_admin स्कोप का इस्तेमाल करके अपने क्लाइंट को अनुमति दी जा सकती है.

इस स्कोप के साथ अनुमति मिलने पर, आईएमएपी कनेक्शन अलग तरीके से काम करते हैं:

  • सभी लेबल, IMAP के ज़रिए दिखाए जाते हैं. भले ही, उपयोगकर्ताओं ने Gmail की सेटिंग में जाकर, लेबल के लिए "IMAP में दिखाएं" विकल्प को बंद कर दिया हो.
  • सभी मैसेज IMAP के ज़रिए दिखाए जाते हैं. इससे कोई फ़र्क़ नहीं पड़ता कि उपयोगकर्ता ने Gmail की सेटिंग में "फ़ोल्डर के साइज़ की सीमाएं" क्या सेट की हैं.

SASL XOAUTH2 मैकेनिज़्म

XOAUTH2 मेकेनिज़्म की मदद से क्लाइंट, सर्वर को OAuth 2.0 ऐक्सेस टोकन भेज सकते हैं. यह प्रोटोकॉल, नीचे दिए गए सेक्शन में दिखाई गई कोड में बदली गई वैल्यू का इस्तेमाल करता है.

क्लाइंट का शुरुआती जवाब

SASL XOAUTH2 के लिए, क्लाइंट से मिलने वाले शुरुआती रिस्पॉन्स का फ़ॉर्मैट यह होता है:

base64("user=" {User} "^Aauth=Bearer " {Access Token} "^A^A")

RFC 4648 में बताए गए base64 कोड में बदलने के तरीके का इस्तेमाल करें. ^A का मतलब Control+A (\001) है.

उदाहरण के लिए, base64-encoding से पहले, क्लाइंट का शुरुआती जवाब ऐसा दिख सकता है:

user=someuser@example.com^Aauth=Bearer ya29.vF9dft4qmTc2Nvb3RlckBhdHRhdmlzdGEuY29tCg^A^A

base64 में कोड में बदलने के बाद, यह (लाइन ब्रेक को समझने के लिए डाला गया है):

dXNlcj1zb21ldXNlckBleGFtcGxlLmNvbQFhdXRoPUJlYXJlciB5YTI5LnZGOWRmdDRxbVRjMk52
YjNSbGNrQmhkSFJoZG1semRHRXVZMjl0Q2cBAQ==

गड़बड़ी वाला जवाब

क्लाइंट के शुरुआती जवाब में गड़बड़ी होने पर, सर्वर एक चुनौती भेजता है. इसमें गड़बड़ी का मैसेज इस फ़ॉर्मैट में होता है:

base64({JSON-Body})

JSON-Body में तीन वैल्यू शामिल हैं: status, schemes, और scope. उदाहरण के लिए:

eyJzdGF0dXMiOiI0MDEiLCJzY2hlbWVzIjoiYmVhcmVyIG1hYyIsInNjb3BlIjoiaHR0cHM6Ly9t
YWlsLmdvb2dsZS5jb20vIn0K

base64 से डिकोड करने के बाद, यह (साफ़ तौर पर समझने के लिए फ़ॉर्मैट किया गया) ऐसा दिखता है:

{
  "status":"401",
  "schemes":"bearer",
  "scope":"https://mail.google.com/"
}

एसएएसएल प्रोटोकॉल के लिए, क्लाइंट को इस चुनौती का जवाब खाली भेजना होता है.

IMAP प्रोटोकॉल एक्सचेंज

इस सेक्शन में, Gmail IMAP सर्वर के साथ SASL XOAUTH2 का इस्तेमाल करने का तरीका बताया गया है.

क्लाइंट का शुरुआती जवाब

SASL XOAUTH2 मेकेनिज़्म से लॉग इन करने के लिए, क्लाइंट AUTHENTICATE कमांड को XOAUTH2 के मेकेनिज़्म पैरामीटर के साथ शुरू करता है. साथ ही, ऊपर दिए गए तरीके से क्लाइंट का शुरुआती जवाब देता है. उदाहरण के लिए:

[connection begins]
C: C01 CAPABILITY
S: * CAPABILITY IMAP4rev1 UNSELECT IDLE NAMESPACE QUOTA XLIST
CHILDREN XYZZY SASL-IR AUTH=XOAUTH2 AUTH=XOAUTH
S: C01 OK Completed
C: A01 AUTHENTICATE XOAUTH2 dXNlcj1zb21ldXNlckBleGFtcGxlLmNvb
QFhdXRoPUJlYXJlciB5YTI5LnZGOWRmdDRxbVRjMk52YjNSbGNrQmhkSFJoZG
1semRHRXVZMjl0Q2cBAQ==
S: A01 OK Success
[connection continues...]

आईएमएपी प्रोटोकॉल एक्सचेंज के बारे में ध्यान रखने वाली बातें:

  • IMAP AUTHENTICATE कमांड के बारे में RFC 3501 में बताया गया है.
  • SASL-IR की सुविधा की मदद से, क्लाइंट के शुरुआती जवाब को AUTHENTICATE कमांड की पहली लाइन में भेजा जा सकता है. इससे पुष्टि करने के लिए, सिर्फ़ एक राउंड ट्रिप की ज़रूरत होती है. SASL-IR के बारे में RFC 4959 में बताया गया है.
  • AUTH=XOAUTH2 सुविधा से यह पता चलता है कि सर्वर, इस दस्तावेज़ में बताए गए SASL मैकेनिज़्म के साथ काम करता है. इस मैकेनिज़्म को चालू करने के लिए, AUTHENTICATE कमांड के पहले आर्ग्युमेंट के तौर पर XOAUTH2 को सेट करें.
  • AUTHENTICATE और CAPABILITY कमांड में लाइन ब्रेक, जानकारी को साफ़ तौर पर दिखाने के लिए हैं. ये असल कमांड डेटा में मौजूद नहीं होंगे. पूरा base64 तर्क, एक लगातार स्ट्रिंग होना चाहिए. इसमें कोई भी खाली सफ़ेद जगह नहीं होनी चाहिए, ताकि पूरी AUTHENTICATE कमांड में टेक्स्ट की एक लाइन हो.

गड़बड़ी वाला जवाब

IMAP AUTHENTICATE कमांड के ज़रिए, पुष्टि से जुड़ी गड़बड़ियों की जानकारी भी मिलती है:

[connection begins]
S: * CAPABILITY IMAP4rev1 UNSELECT IDLE NAMESPACE QUOTA XLIST
CHILDREN XYZZY SASL-IR AUTH=XOAUTH2
S: C01 OK Completed
C: A01 AUTHENTICATE XOAUTH2 dXNlcj1zb21ldXNlckBleGFtcGxlLmNvbQ
FhdXRoPUJlYXJlciB5YTI5LnZGOWRmdDRxbVRjMk52YjNSbGNrQmhkSFJoZG1s
emRHRXVZMjl0Q2cBAQ==
S: + eyJzdGF0dXMiOiI0MDEiLCJzY2hlbWVzIjoiYmVhcmVyIG1hYyIsInNjb
3BlIjoiaHR0cHM6Ly9tYWlsLmdvb2dsZS5jb20vIn0K
C:
S: A01 NO SASL authentication failed

आईएमएपी प्रोटोकॉल एक्सचेंज के बारे में ध्यान रखने वाली बातें:

  • क्लाइंट, चुनौती के लिए खाली जवाब ("\r\n") भेजता है. इसमें गड़बड़ी का मैसेज शामिल होता है.

पीओपी प्रोटोकॉल एक्सचेंज

इस सेक्शन में, Gmail POP सर्वर के साथ SASL XOAUTH2 का इस्तेमाल करने का तरीका बताया गया है.

क्लाइंट का शुरुआती जवाब

SASL XOAUTH2 मेकेनिज़्म से लॉग इन करने के लिए, क्लाइंट AUTH कमांड को XOAUTH2 के मेकेनिज़्म पैरामीटर के साथ शुरू करता है. साथ ही, ऊपर दिए गए तरीके से क्लाइंट का शुरुआती जवाब देता है. उदाहरण के लिए:

[connection begins]
C: AUTH XOAUTH2 dXNlcj1zb21ldXNlckBleGFtcGxlLmNvbQFhdXRoPUJlYX
JlciB5YTI5LnZGOWRmdDRxbVRjMk52YjNSbGNrQmhkSFJoZG1semRHRXVZMjl0
Q2cBAQ==
S: +OK Welcome.
[connection continues...]

पीओपी प्रोटोकॉल एक्सचेंज के बारे में ध्यान रखने वाली बातें:

  • पीओपी AUTH कमांड के बारे में आरएफ़सी 1734 में बताया गया है.
  • AUTH कमांड में लाइन ब्रेक, जानकारी को साफ़ तौर पर दिखाने के लिए हैं. ये असल कमांड डेटा में मौजूद नहीं होंगे. पूरा base64 तर्क, एक लगातार स्ट्रिंग होना चाहिए. इसमें कोई भी खाली सफ़ेद जगह नहीं होनी चाहिए, ताकि पूरी AUTH कमांड में टेक्स्ट की एक लाइन हो.

गड़बड़ी वाला जवाब

पुष्टि न हो पाने की जानकारी, POP AUTH कमांड के ज़रिए भी मिलती है:

[connection begins]
C: AUTH XOAUTH2 dXNlcj1zb21ldXNlckBleGFtcGxlLmNvbQFhdXRoPUJlY
XJlciB5YTI5LnZGOWRmdDRxbVRjMk52YjNSbGNrQmhkSFJoZG1semRHRXVZMj
l0Q2cBAQ==
S: + eyJzdGF0dXMiOiI0MDAiLCJzY2hlbWVzIjoiQmVhcmVyIiwic2NvcGUi
OiJodHRwczovL21haWwuZ29vZ2xlLmNvbS8ifQ==

एसएमटीपी प्रोटोकॉल एक्सचेंज

इस सेक्शन में, Gmail SMTP सर्वर के साथ SASL XOAUTH2 का इस्तेमाल करने का तरीका बताया गया है.

क्लाइंट का शुरुआती जवाब

XOAUTH2 मेकेनिज़्म से लॉग इन करने के लिए, क्लाइंट AUTH कमांड को XOAUTH2 के मेकेनिज़्म पैरामीटर के साथ शुरू करता है. साथ ही, ऊपर दिए गए तरीके से क्लाइंट का शुरुआती जवाब देता है. उदाहरण के लिए:

[connection begins]
S: 220 mx.google.com ESMTP 12sm2095603fks.9
C: EHLO sender.example.com
S: 250-mx.google.com at your service, [172.31.135.47]
S: 250-SIZE 35651584
S: 250-8BITMIME
S: 250-AUTH LOGIN PLAIN XOAUTH XOAUTH2
S: 250-ENHANCEDSTATUSCODES
S: 250 PIPELINING
C: AUTH XOAUTH2 dXNlcj1zb21ldXNlckBleGFtcGxlLmNvbQFhdXRoPUJlY
XJlciB5YTI5LnZGOWRmdDRxbVRjMk52YjNSbGNrQmhkSFJoZG1semRHRXVZMj
l0Q2cBAQ==
S: 235 2.7.0 Accepted
[connection continues...]

एसएमटीपी प्रोटोकॉल एक्सचेंज के बारे में ध्यान रखने वाली बातें:

  • एसएमटीपी AUTH कमांड के बारे में आरएफ़सी 4954 में बताया गया है.
  • AUTH कमांड में लाइन ब्रेक, जानकारी को साफ़ तौर पर दिखाने के लिए हैं. ये असल कमांड डेटा में मौजूद नहीं होंगे. पूरा base64 तर्क, एक लगातार स्ट्रिंग होना चाहिए. इसमें कोई भी खाली सफ़ेद जगह नहीं होनी चाहिए, ताकि पूरी AUTH कमांड में टेक्स्ट की एक लाइन हो.

गड़बड़ी वाला जवाब

एसएमटीपी AUTH कमांड के ज़रिए, पुष्टि न हो पाने की गड़बड़ियों के बारे में भी जानकारी मिलती है:

[connection begins]
S: 220 mx.google.com ESMTP 12sm2095603fks.9
C: EHLO sender.example.com
S: 250-mx.google.com at your service, [172.31.135.47]
S: 250-SIZE 35651584
S: 250-8BITMIME
S: 250-AUTH LOGIN PLAIN XOAUTH XOAUTH2
S: 250-ENHANCEDSTATUSCODES
S: 250 PIPELINING
C: AUTH XOAUTH2 dXNlcj1zb21ldXNlckBleGFtcGxlLmNvbQFhdXRoPUJlYXJl
ciB5YTI5LnZGOWRmdDRxbVRjMk52YjNSbGNrQmhkSFJoZG1semRHRXVZMjl0Q2cB
AQ==
S: 334 eyJzdGF0dXMiOiI0MDEiLCJzY2hlbWVzIjoiYmVhcmVyIG1hYyIsInNjb
3BlIjoiaHR0cHM6Ly9tYWlsLmdvb2dsZS5jb20vIn0K
C:
S: 535-5.7.1 Username and Password not accepted. Learn more at
S: 535 5.7.1 https://support.google.com/mail/?p=BadCredentials hx9sm5317360pbc.68
[connection continues...]

एसएमटीपी प्रोटोकॉल एक्सचेंज के बारे में ध्यान रखने वाली बातें:

  • क्लाइंट, चुनौती के लिए खाली जवाब ("\r\n") भेजता है. इसमें गड़बड़ी का मैसेज शामिल होता है.

रेफ़रंस