OAuth 2.0 तकनीकी

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

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

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

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

OAuth 2.0 का दायरा

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

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

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

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

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

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

एसएएसएल 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

बेस64-एन्कोडिंग के बाद, यह बन जाता है (साफ़ तौर पर जानकारी देने के लिए लाइन ब्रेक डाले गए):

dXNlcj1zb21ldXNlckBleGFtcGxlLmNvbQFhdXRoPUJlYXJlciB5YTI5LnZGOWRmdDRxbVRjMk52
YjNSbGNrQmhkSFJoZG1semRHRXVZMjl0Q2cBAQ==

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

एक शुरुआती क्लाइंट प्रतिक्रिया के कारण किसी गड़बड़ी के कारण सर्वर किसी गड़बड़ी की वजह से नीचे दिए गए फ़ॉर्मैट में गड़बड़ी का मैसेज दिखाने वाली चुनौती:

base64({JSON-Body})

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

eyJzdGF0dXMiOiI0MDEiLCJzY2hlbWVzIjoiYmVhcmVyIG1hYyIsInNjb3BlIjoiaHR0cHM6Ly9t
YWlsLmdvb2dsZS5jb20vIn0K

बेस64-डिकोडिंग के बाद, यह (साफ़ तौर पर फ़ॉर्मैट करने के लिए फ़ॉर्मैट किया जाता है) हो जाता है:

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

SASL प्रोटोकॉल के लिए ज़रूरी है कि क्लाइंट इस चैलेंज के लिए कोई जवाब न दें.

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

यह सेक्शन बताता है कि Gmail आईएमएपी सर्वर के साथ 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...]

आईएमएपी प्रोटोकॉल एक्सचेंज के बारे में ज़रूरी बातें:

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

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

पुष्टि नहीं हो पाने की जानकारी को आईएमएपी 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 निर्देश में टेक्स्ट की एक लाइन हो.

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

पुष्टि नहीं हो पाने की जानकारी भी पीओपी 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...]

एसएमटीपी प्रोटोकॉल एक्सचेंज के बारे में ज़रूरी बातें:

  • SMTP AUTH कमांड को RFC 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") भेजता है.

रेफ़रंस