Ten dokument definiuje mechanizm SASL XOAUTH2 do użycia z protokołem IMAP
Polecenia AUTHENTICATE
, POP AUTH
i SMTP AUTH
. Ten mechanizm umożliwia
wykorzystanie tokenów dostępu OAuth 2.0 do uwierzytelniania na koncie Gmail użytkownika.
Korzystanie z OAuth 2.0
Zacznij od zapoznania się z artykułem Korzystanie z protokołu OAuth 2.0 na potrzeby dostępu do interfejsów API Google. W tym dokumencie wyjaśniono, jak działa OAuth 2.0 i jakie czynności są wymagane do napisania klienta.
Możesz też przejrzeć przykładowy kod XOAUTH2, aby zapoznać się z działającymi przykładami.
Zakresy protokołu OAuth 2.0
Zakres dostępu IMAP, POP i SMTP to https://mail.google.com/
. Jeśli
poprosić o dostęp do pełnego zakresu poczty dla aplikacji IMAP, POP lub SMTP,
musi być zgodny z Zasadami dotyczącymi danych użytkownika w usługach interfejsu API Google.
- Aby została zatwierdzona, aplikacja musi pokazywać pełne wykorzystanie przez
https://mail.google.com/
. - Jeśli Twoja aplikacja nie wymaga
https://mail.google.com/
, przejdź na Gmaila API i używać bardziej szczegółowych zakresów z ograniczeniami.
Przekazywanie dostępu w całej domenie dla usługi Google Workspace
Jeśli zamierzasz używać
Google Workspace Przekazywanie dostępu w całej domenie
za pomocą
Konta usługi
dostęp do Google Workspace użytkowników skrzynki pocztowe za pomocą protokołu IMAP,
możesz autoryzować swojego klienta za pomocą zakresu
https://www.googleapis.com/auth/gmail.imap_admin
.
Po autoryzacji dla tego zakresu połączenia IMAP zachowują się inaczej:
- Wszystkie etykiety są wyświetlane przez IMAP, nawet jeśli użytkownicy wyłączyli opcję „Pokaż w kliencie IMAP” obok etykiety w ustawieniach Gmaila.
- Wszystkie wiadomości są wyświetlane przy użyciu protokołu IMAP, niezależnie od wartości ustawionej przez użytkownika w polu „Limity rozmiarów folderów”. w ustawieniach Gmaila.
Mechanizm SASL XOAUTH2
Mechanizm XOAUTH2 pozwala klientom wysyłać tokeny dostępu OAuth 2.0 do serwera. Protokół wykorzystuje zakodowane wartości widoczne w kolejnych sekcjach.
Pierwsza odpowiedź klienta
Pierwsza odpowiedź klienta SASL XOAUTH2 ma następujący format:
base64("user=" {User} "^Aauth=Bearer " {Access Token} "^A^A")
Użyj mechanizmu kodowania base64 zdefiniowanego w RFC 4648. ^A
oznacza kombinację klawiszy Control+A (\001).
Na przykład przed kodowaniem base64 wstępna odpowiedź klienta może wyglądać tak:
user=someuser@example.com^Aauth=Bearer ya29.vF9dft4qmTc2Nvb3RlckBhdHRhdmlzdGEuY29tCg^A^A
Po zakodowaniu base64 wygląda to tak (w celu uniknięcia wątpliwości: podziały wiersza):
dXNlcj1zb21ldXNlckBleGFtcGxlLmNvbQFhdXRoPUJlYXJlciB5YTI5LnZGOWRmdDRxbVRjMk52
YjNSbGNrQmhkSFJoZG1semRHRXVZMjl0Q2cBAQ==
Odpowiedź na błąd
Początkowa odpowiedź klienta powodująca błąd powoduje, że serwer wysyła komunikat zadanie zawierające komunikat o błędzie w następującym formacie:
base64({JSON-Body})
Pole JSON-Body zawiera 3 wartości: status
, schemes
i scope
. Na przykład:
eyJzdGF0dXMiOiI0MDEiLCJzY2hlbWVzIjoiYmVhcmVyIG1hYyIsInNjb3BlIjoiaHR0cHM6Ly9t
YWlsLmdvb2dsZS5jb20vIn0K
Po zdekodowaniu base64 wygląda to (dla przejrzystości):
{
"status":"401",
"schemes":"bearer",
"scope":"https://mail.google.com/"
}
Protokół SASL wymaga od klientów wysłania pustej odpowiedzi na to wyzwanie.
Wymiana protokołów IMAP
W tej sekcji wyjaśniono, jak używać protokołu SASL XOAUTH2 z serwerem IMAP Gmaila.
Pierwsza odpowiedź klienta
Aby zalogować się za pomocą mechanizmu SASL XOAUTH2, klient wywołuje polecenie AUTHENTICATE
z parametrem mechanizmu XOAUTH2
oraz początkową odpowiedź klienta (tak jak powyżej). Na przykład:
[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...]
Istotne informacje dotyczące wymiany protokołów IMAP:
- Polecenie IMAP
AUTHENTICATE
zostało opisane w RFC 3501. - Funkcja SASL-IR umożliwia wysyłanie początkowej odpowiedzi klienta w pierwszym wierszu polecenia
AUTHENTICATE
, więc do uwierzytelnienia wymagana jest tylko jedna trasa w obie strony. Dokument SASL-IR znajduje się w RFC 4959. - Funkcja AUTH=XOAUTH2 deklaruje, że serwer obsługuje mechanizm SASL zdefiniowany w tym dokumencie, a ten mechanizm jest aktywowany przez określenie XOAUTH2 jako pierwszego argumentu polecenia
AUTHENTICATE
. - Podziały wierszy w poleceniach
AUTHENTICATE
iCAPABILITY
mają na celu zwiększenie przejrzystości i nie występują w rzeczywistych danych poleceń. Cały argument base64 powinien być jednym ciągiem tekstowym bez osadzonych odstępów, aby całe polecenieAUTHENTICATE
składało się z jednego wiersza tekstu.
Odpowiedź na błąd
Błędy uwierzytelniania są też zwracane za pomocą polecenia 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
Istotne informacje dotyczące wymiany protokołów IMAP:
- Klient wysyła pustą odpowiedź („\r\n”) na zadanie zawierające komunikat o błędzie.
Protokół POP
W tej sekcji wyjaśniono, jak używać protokołu SASL XOAUTH2 z serwerem POP Gmaila.
Pierwsza odpowiedź klienta
Aby zalogować się za pomocą mechanizmu SASL XOAUTH2, klient wywołuje polecenie AUTH
z parametrem mechanizmu XOAUTH2
oraz początkową odpowiedź klienta (tak jak powyżej). Na przykład:
[connection begins]
C: AUTH XOAUTH2 dXNlcj1zb21ldXNlckBleGFtcGxlLmNvbQFhdXRoPUJlYX
JlciB5YTI5LnZGOWRmdDRxbVRjMk52YjNSbGNrQmhkSFJoZG1semRHRXVZMjl0
Q2cBAQ==
S: +OK Welcome.
[connection continues...]
Co warto wiedzieć na temat wymiany protokołów POP:
- Polecenie POP
AUTH
jest opisane w RFC 1734. - Podziały wierszy w poleceniu
AUTH
mają na celu zapewnienie przejrzystości i nie występują w rzeczywistych danych polecenia. Cały argument base64 powinien być jednym ciągiem tekstowym bez osadzonych odstępów, aby całe polecenieAUTH
składało się z jednego wiersza tekstu.
Odpowiedź na błąd
Błędy uwierzytelniania są również zwracane za pomocą polecenia POP AUTH
:
[connection begins]
C: AUTH XOAUTH2 dXNlcj1zb21ldXNlckBleGFtcGxlLmNvbQFhdXRoPUJlY
XJlciB5YTI5LnZGOWRmdDRxbVRjMk52YjNSbGNrQmhkSFJoZG1semRHRXVZMj
l0Q2cBAQ==
S: + eyJzdGF0dXMiOiI0MDAiLCJzY2hlbWVzIjoiQmVhcmVyIiwic2NvcGUi
OiJodHRwczovL21haWwuZ29vZ2xlLmNvbS8ifQ==
Wymiana protokołów SMTP
W tej sekcji wyjaśniamy, jak używać SASL XOAUTH2 z serwerem SMTP Gmaila.
Pierwsza odpowiedź klienta
Aby zalogować się za pomocą mechanizmu XOAUTH2, klient wywołuje polecenie AUTH
z parametrem mechanizmu XOAUTH2
i początkową odpowiedź klienta (tak jak powyżej). Na przykład:
[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...]
Co warto wiedzieć o transmisji protokołów SMTP:
- Polecenie SMTP
AUTH
jest opisane w RFC 4954. - Podziały wierszy w poleceniu
AUTH
mają charakter zrozumiały i nie występują w rzeczywistych danych polecenia. Cały argument base64 powinien być jednym ciągiem tekstowym bez osadzonych odstępów, aby całe polecenieAUTH
składało się z jednego wiersza tekstu.
Odpowiedź na błąd
Błędy uwierzytelniania są też zwracane za pomocą polecenia SMTP 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...]
Co warto wiedzieć o transmisji protokołów SMTP:
- Klient wysyła pustą odpowiedź („\r\n”) na zadanie zawierające komunikat o błędzie.
Pliki referencyjne
- OAUTH2: używanie protokołu OAuth 2.0 na potrzeby dostępu do interfejsów API Google,
- SMTP: RFC 2821: Simple Mail Transfer Protocol
- IMAP: RFC 3501: PROTOCOL DOSTĘP DO WIADOMOŚCI INTERNETOWEJ – VERSION 4rev1
- POP: RFC 1081: Post Office Protocol – wersja 3
- SASL: RFC 4422: Simple Authentication and Security Layer (SASL)
- JSON: RFC 4627: the application/json Media Type for JavaScript Object Notation
- BASE64: RFC 4648: kodowanie danych Base16, Base32 i Base64
- SASL-IR: RFC 4959: protokół IMAP Extension for Simple Authentication and Security Layer (SASL) Initial Client Response
- SMTP-AUTH: RFC 4954: rozszerzenie usługi SMTP na potrzeby uwierzytelniania