Mechanizm OAuth 2.0

Ten dokument definiuje mechanizm SASL XOAUTH2 do użycia z poleceniami IMAPAUTHENTICATE, POPAUTH i SMTPAUTH. Ten mechanizm umożliwia uwierzytelnianie na koncie Gmail użytkownika za pomocą tokenów dostępu OAuth 2.0.

Korzystanie z OAuth 2.0

Na początek zapoznaj się z artykułem Używanie protokołu OAuth 2.0 na potrzeby dostępu do interfejsów API Google. Wyjaśniono w nim, jak działa OAuth 2.0, oraz opisano czynności wymagane do napisania klienta.

Możesz też przejrzeć przykładowy kod XOAUTH2, aby zobaczyć działające przykłady.

Zakresy OAuth 2.0

Zakres dostępu do protokołów IMAP, POP i SMTP to https://mail.google.com/. Jeśli w przypadku aplikacji IMAP, POP lub SMTP poprosisz o dostęp do pełnego zakresu poczty, musi ona być zgodna z naszymi Zasadami dotyczącymi danych użytkownika usług interfejsów API Google.

  • Aby aplikacja została zatwierdzona, musi w pełni wykorzystywać https://mail.google.com/.
  • Jeśli Twoja aplikacja nie wymaga https://mail.google.com/, przenieś ją do interfejsu Gmail API i używaj bardziej szczegółowych zakresów ograniczonych.

Przekazywanie dostępu w całej domenie Google Workspace

Jeśli zamierzasz używać przekazywania dostępu w całej domenie Google Workspace za pomocą kont usług, aby uzyskiwać dostęp do skrzynek pocztowych użytkowników Google Workspace za pomocą protokołu IMAP, możesz autoryzować klienta za pomocą zakresu https://www.googleapis.com/auth/gmail.imap_admin.

Gdy połączenia IMAP są autoryzowane w tym zakresie, działają 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 za pomocą protokołu IMAP, niezależnie od tego, co użytkownik ustawił w sekcji „Limity rozmiarów folderów” w ustawieniach Gmaila.
.

Mechanizm SASL XOAUTH2

Mechanizm XOAUTH2 umożliwia klientom wysyłanie na serwer tokenów dostępu OAuth 2.0. Protokół używa zakodowanych wartości przedstawionych w kolejnych sekcjach.

Pierwsza odpowiedź klienta

Początkowa odpowiedź klienta SASL XOAUTH2 ma ten format:

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

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

Na przykład przed zakodowaniem w formacie base64 początkowa odpowiedź klienta może wyglądać tak:

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

Po zakodowaniu w formacie base64 ciąg ten wygląda tak (dla przejrzystości wstawiono znaki końca wiersza):

dXNlcj1zb21ldXNlckBleGFtcGxlLmNvbQFhdXRoPUJlYXJlciB5YTI5LnZGOWRmdDRxbVRjMk52
YjNSbGNrQmhkSFJoZG1semRHRXVZMjl0Q2cBAQ==

Odpowiedź o błędzie

Początkowa odpowiedź klienta powodująca błąd sprawia, ż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. Na przykład:

eyJzdGF0dXMiOiI0MDEiLCJzY2hlbWVzIjoiYmVhcmVyIG1hYyIsInNjb3BlIjoiaHR0cHM6Ly9t
YWlsLmdvb2dsZS5jb20vIn0K

Po zdekodowaniu za pomocą base64 wygląda to tak (sformatowane dla przejrzystości):

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

Protokół SASL wymaga, aby klienci wysyłali pustą odpowiedź na to wyzwanie.

Wymiana protokołu IMAP

Z tej sekcji dowiesz się, jak używać 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 i początkową odpowiedzią klienta skonstruowaną 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...]

Wymiana protokołu IMAP:

  • Polecenie IMAP AUTHENTICATE jest opisane w dokumencie RFC 3501.
  • Funkcja SASL-IR umożliwia wysłanie początkowej odpowiedzi klienta w pierwszym wierszu polecenia AUTHENTICATE, dzięki czemu do uwierzytelnienia wymagana jest tylko jedna podróż w obie strony. SASL-IR jest opisany w dokumencie RFC 4959.
  • Możliwość AUTH=XOAUTH2 deklaruje, że serwer obsługuje mechanizm SASL zdefiniowany w tym dokumencie, a mechanizm ten jest aktywowany przez podanie XOAUTH2 jako pierwszego argumentu polecenia AUTHENTICATE.
  • Podziały wierszy w poleceniach AUTHENTICATE i CAPABILITY służą przejrzystości i nie występują w rzeczywistych danych poleceń. Cały argument base64 powinien być jednym ciągłym ciągiem znaków bez wbudowanych spacji, tak aby całe polecenie AUTHENTICATE składało się z jednego wiersza tekstu.

Odpowiedź o błędzie

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

Wymiana protokołu IMAP:

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

Wymiana protokołu POP

Z tej sekcji dowiesz się, jak używać 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 i początkową odpowiedzią klienta skonstruowaną powyżej. Na przykład:

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

Co warto wiedzieć o wymianie protokołu POP:

  • Polecenie POP AUTH jest opisane w dokumencie RFC 1734.
  • Podziały wierszy w poleceniu AUTH zostały dodane dla przejrzystości i nie występują w rzeczywistych danych polecenia. Cały argument base64 powinien być jednym ciągłym ciągiem znaków bez wbudowanych spacji, tak aby całe polecenie AUTH składało się z jednego wiersza tekstu.

Odpowiedź o błędzie

Błędy uwierzytelniania są też zwracane za pomocą polecenia POP AUTH:

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

Wymiana protokołu SMTP

Z tej sekcji dowiesz się, 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ą odpowiedzią klienta skonstruowaną 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...]

Wymiana protokołu SMTP:

  • Polecenie SMTP AUTH jest opisane w dokumencie RFC 4954.
  • Podziały wierszy w poleceniu AUTH zostały dodane dla przejrzystości i nie występują w rzeczywistych danych polecenia. Cały argument base64 powinien być jednym ciągłym ciągiem znaków bez wbudowanych spacji, tak aby całe polecenie AUTH składało się z jednego wiersza tekstu.

Odpowiedź o błędzie

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...]

Wymiana protokołu SMTP:

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

Odniesienia