Mechanizm OAuth 2.0

Ten dokument definiuje mechanizm SASL XOAUTH2 do użycia z poleceniami IMAP AUTHENTICATE, POP AUTH i SMTP AUTH. Ten mechanizm umożliwia korzystanie z tokenów dostępu OAuth 2.0 do uwierzytelniania na koncie Gmail użytkownika.

Korzystanie z OAuth 2.0

Zacznij od użycia protokołu OAuth 2.0 do korzystania z interfejsów API Google. Ten dokument wyjaśnia, jak działa OAuth 2.0 i jakie czynności należy wykonać, aby utworzyć klienta.

Możesz też przejrzeć przykładowy kod XOAUTH2.

Zakresy OAuth 2.0

Zakres dostępu IMAP, POP i SMTP to https://mail.google.com/. Jeśli prosisz o dostęp do pełnego zakresu poczty dla aplikacji IMAP, POP lub SMTP, musi on być zgodny z zasadami dotyczącymi danych użytkownika w usługach interfejsu API Google.

  • Aby aplikacja została zatwierdzona, musi wykorzystywać pełne wykorzystanie https://mail.google.com/.
  • Jeśli aplikacja nie wymaga interfejsu https://mail.google.com/, przejdź na interfejs Gmail API i korzystaj z bardziej szczegółowych zakresów z ograniczeniami.

Przekazywanie dostępu w całej domenie w domenie Google Workspace

Jeśli zamierzasz korzystać z Google Workspace przekazywania dostępu w całej domenie przy użyciu kont usługi, aby uzyskiwać dostęp do skrzynek pocztowych użytkowników przez IMAP, możesz zamiast tego upoważnić klienta za pomocą zakresu https://www.googleapis.com/auth/gmail.imap_admin.

Po autoryzacji w tym zakresie 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” w ustawieniach Gmaila.
  • Wszystkie wiadomości są wyświetlane przez IMAP, niezależnie od ustawień użytkownika w sekcji „Limity rozmiarów folderów” w ustawieniach Gmaila.

Mechanizm SASL XOAUTH2

Mechanizm XOAUTH2 umożliwia klientom wysyłanie serwerów tokenów OAuth 2.0 do serwera. Protokół wykorzystuje zakodowane wartości wyświetlane w poniższych sekcjach.

Wstępna odpowiedź klienta

Pierwsza odpowiedź klienta SASL XOAUTH2 ma taki format:

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

Użyj mechanizmu kodowania base64 zdefiniowanego w RFC 4648. ^A oznacza Control+A (\001).

Na przykład przed kodowaniem base64 może pojawić się początkowa odpowiedź klienta:

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

Po zakodowaniu base64 ten fragment kodu wygląda tak (wstawiono podziały wierszy ze względu na przejrzystość):

dXNlcj1zb21ldXNlckBleGFtcGxlLmNvbQFhdXRoPUJlYXJlciB5YTI5LnZGOWRmdDRxbVRjMk52
YjNSbGNrQmhkSFJoZG1semRHRXVZMjl0Q2cBAQ==

Odpowiedź błędu

Początkowa odpowiedź klienta powodująca błąd powoduje, że serwer wysyła wyzwanie zawierające komunikat o błędzie w tym formacie:

base64({JSON-Body})

JSON-Body zawiera 3 wartości: status, schemes i scope. Przykład:

eyJzdGF0dXMiOiI0MDEiLCJzY2hlbWVzIjoiYmVhcmVyIG1hYyIsInNjb3BlIjoiaHR0cHM6Ly9t
YWlsLmdvb2dsZS5jb20vIn0K

Po zdekodowaniu zakodowanym w base64 staje się to (sformatowane pod kątem 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

Ta sekcja wyjaśnia, jak używać SASL XOAUTH2 z serwerem IMAP Gmaila.

Wstępna odpowiedź klienta

Aby zalogować się za pomocą mechanizmu SASL XOAUTH2, klient wywołuje polecenie AUTHENTICATE z parametrem mechanizmu XOAUTH2 oraz początkową odpowiedź klienta, jak pokazano powyżej. 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...]

Uwagi na temat wymiany protokołów IMAP:

  • Polecenie IMAP AUTHENTICATE jest wymienione w RFC 3501.
  • Funkcja SASL-IR umożliwia wysyłanie początkowej odpowiedzi klienta w pierwszym wierszu polecenia AUTHENTICATE, dzięki czemu do uwierzytelniania wymagana jest tylko jedna trasa w obie strony. Dokument SASL-IR jest opisany 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 w poleceniu AUTHENTICATE.
  • Podziały wiersza w poleceniach AUTHENTICATE i CAPABILITY mają charakter zrozumiały i nie występują w rzeczywistych danych poleceń. Cały argument base64 powinien być pojedynczym ciągiem znaków bez odstępów, aby całe polecenie AUTHENTICATE składało się z jednego wiersza tekstu.

Odpowiedź błędu

Błędy uwierzytelniania są również zwracane przez polecenie 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

Uwagi na temat wymiany protokołów IMAP:

  • Klient wysyła pustą odpowiedź („Trigger\n”) na wyzwanie zawierające komunikat o błędzie.

Wymiana protokołów POP

Ta sekcja wyjaśnia, jak używać SASL XOAUTH2 z serwerem POP Gmaila.

Wstępna odpowiedź klienta

Aby zalogować się za pomocą mechanizmu SASL XOAUTH2, klient wywołuje polecenie AUTH z parametrem mechanizmu XOAUTH2 oraz początkową odpowiedź klienta, jak pokazano powyżej. Przykład:

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

Uwagi dotyczące wymiany protokołów POP:

  • Polecenie AUTH dotyczące protokołu POP zostało udokumentowane w dokumencie RFC 1734.
  • Podziały wiersza w poleceniu AUTH są przejrzyste i nie występują w rzeczywistych danych polecenia. Cały argument base64 powinien być pojedynczym ciągiem znaków bez odstępów, aby całe polecenie AUTH składało się z jednego wiersza tekstu.

Odpowiedź błędu

Błędy uwierzytelniania są również zwracane przez polecenie POP AUTH:

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

Wymiana protokołów SMTP

Ta sekcja wyjaśnia, jak używać SASL XOAUTH2 z serwerem SMTP Gmaila.

Wstępna odpowiedź klienta

Aby zalogować się za pomocą mechanizmu XOAUTH2, klient wywołuje polecenie AUTH z parametrem mechanizmu XOAUTH2 oraz początkową odpowiedź klienta, jak pokazano powyżej. 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...]

Uwagi na temat wymiany protokołów SMTP:

  • Polecenie SMTP AUTH zostało opisane w dokumencie RFC 4954.
  • Podziały wiersza w poleceniu AUTH są przejrzyste i nie występują w rzeczywistych danych polecenia. Cały argument base64 powinien być pojedynczym ciągiem znaków bez odstępów, aby całe polecenie AUTH składało się z jednego wiersza tekstu.

Odpowiedź błędu

Błędy uwierzytelniania są również 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...]

Uwagi na temat wymiany protokołów SMTP:

  • Klient wysyła pustą odpowiedź („Trigger\n”) na wyzwanie zawierające komunikat o błędzie.

Odsyłacze