OAuth 2.0 तकनीकी

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

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

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

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

OAuth 2.0 के दायरे

IMAP, POP, और एसएमटीपी ऐक्सेस का दायरा 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 का इस्तेमाल करके अपने क्लाइंट को अनुमति दी जा सकती है.

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

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

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

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

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

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

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

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

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

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/"
}

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

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

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

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

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

[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 कमांड के बारे में आरएफ़सी 3501 में बताया गया है.
  • SASL-IR की सुविधा की मदद से, AUTHENTICATE कमांड की पहली लाइन में क्लाइंट का शुरुआती जवाब भेजा जा सकता है. इससे पुष्टि करने के लिए, सिर्फ़ एक राउंड ट्रिप की ज़रूरत होती है. SASL-IR के बारे में आरएफ़सी 4959 में बताया गया है.
  • AUTH=XOAUTH2 सुविधा से पता चलता है कि सर्वर, इस दस्तावेज़ में बताए गए एसएएसएल मेकेनिज्म के साथ काम करता है. साथ ही, 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...]

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

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

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

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

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

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

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

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

XOAUTH2 प्रोसेस का इस्तेमाल करके लॉग इन करने के लिए, क्लाइंट XOAUTH2 के प्रोसेस पैरामीटर और ऊपर दिए गए क्लाइंट के शुरुआती जवाब के साथ 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 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") भेजता है.

रेफ़रंस