OAuth 2.0-Mechanismus

In diesem Dokument wird der SASL XOAUTH2-Mechanismus für die Verwendung mit den IMAP-AUTHENTICATE-, POP-AUTH- und SMTP-AUTH-Befehlen definiert. Dieser Mechanismus ermöglicht die Authentifizierung für das Gmail-Konto eines Nutzers mithilfe von OAuth 2.0-Zugriffstokens.

Verwenden von OAuth 2.0

Machen Sie sich zuerst mit dem Zugriff auf Google APIs über OAuth 2.0 vertraut. In diesem Dokument wird beschrieben, wie OAuth 2.0 funktioniert und welche Schritte zum Schreiben eines Clients erforderlich sind.

Möglicherweise möchten Sie sich auch den XOAUTH2-Beispielcode ansehen.

OAuth 2.0-Bereiche

Der Bereich für den IMAP-, POP- und SMTP-Zugriff ist https://mail.google.com/. Wenn Sie für Ihre IMAP-, POP- oder SMTP-App Zugriff auf den vollständigen E-Mail-Bereich anfordern, muss sie unserer Nutzerdatenrichtlinie für Google API-Dienste entsprechen.

  • Damit Ihre App genehmigt werden kann, muss https://mail.google.com/ vollständig genutzt werden.
  • Wenn für Ihre App https://mail.google.com/ nicht erforderlich ist, migrieren Sie zur Gmail API und verwenden Sie detailliertere eingeschränkte Bereiche.

Domainweite Delegation für Google Workspace

Wenn Sie die domainweite Delegierung für Google Workspace mit Dienstkonten verwenden möchten, um über IMAP auf die Postfächer von Google Workspace-Nutzern zuzugreifen, können Sie Ihren Client stattdessen mit dem Bereich https://www.googleapis.com/auth/gmail.imap_admin autorisieren.

Wenn die Autorisierung mit diesem Bereich erfolgt, verhalten sich IMAP-Verbindungen anders:

  • Alle Labels werden über IMAP angezeigt, auch wenn Nutzer in den Gmail-Einstellungen die Option „In IMAP anzeigen“ für das Label deaktiviert haben.
  • Alle Nachrichten werden über IMAP angezeigt, unabhängig davon, was der Nutzer in den Gmail-Einstellungen unter „Grenzen für die Ordnergröße“ festgelegt hat.

Der SASL XOAUTH2-Mechanismus

Mit dem XOAUTH2-Mechanismus können Clients OAuth 2.0-Zugriffstokens an den Server senden. Das Protokoll verwendet codierte Werte, die in den folgenden Abschnitten aufgeführt sind.

Erste Clientantwort

Die erste Clientantwort für SASL XOAUTH2 hat das folgende Format:

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

Verwenden Sie den in RFC 4648 definierten Base64-Codierungsmechanismus. ^A steht für Strg+A (\001).

Vor der Base64-Codierung könnte die erste Clientantwort beispielsweise so aussehen:

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

Nach der Base64-Codierung sieht das so aus (Zeilenumbrüche zur besseren Lesbarkeit eingefügt):

dXNlcj1zb21ldXNlckBleGFtcGxlLmNvbQFhdXRoPUJlYXJlciB5YTI5LnZGOWRmdDRxbVRjMk52
YjNSbGNrQmhkSFJoZG1semRHRXVZMjl0Q2cBAQ==

Fehlerantwort

Wenn eine erste Clientantwort einen Fehler verursacht, sendet der Server eine Challenge mit einer Fehlermeldung im folgenden Format:

base64({JSON-Body})

JSON-Body enthält drei Werte: status, schemes und scope. Beispiel:

eyJzdGF0dXMiOiI0MDEiLCJzY2hlbWVzIjoiYmVhcmVyIG1hYyIsInNjb3BlIjoiaHR0cHM6Ly9t
YWlsLmdvb2dsZS5jb20vIn0K

Nach der Base64-Decodierung sieht das so aus (zur besseren Lesbarkeit formatiert):

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

Das SASL-Protokoll erfordert, dass Clients eine leere Antwort auf diese Challenge senden.

IMAP-Protokollaustausch

In diesem Abschnitt wird erläutert, wie Sie SASL XOAUTH2 mit dem Gmail-IMAP-Server verwenden.

Erste Clientantwort

Um sich mit dem SASL XOAUTH2-Mechanismus anzumelden, ruft der Client den Befehl AUTHENTICATE mit dem Mechanismusparameter XOAUTH2 und der oben erstellten ersten Clientantwort auf. Beispiel:

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

Hinweise zum IMAP-Protokollaustausch:

  • Der IMAP-Befehl AUTHENTICATE ist in RFC 3501 dokumentiert.
  • Die SASL-IR-Funktion ermöglicht das Senden der ersten Clientantwort in der ersten Zeile des AUTHENTICATE-Befehls, sodass für die Authentifizierung nur ein Roundtrip erforderlich ist. SASL-IR ist in RFC 4959 dokumentiert.
  • Die Funktion AUTH=XOAUTH2 deklariert, dass der Server den in diesem Dokument definierten SASL-Mechanismus unterstützt. Dieser Mechanismus wird aktiviert, indem XOAUTH2 als erstes Argument für den Befehl AUTHENTICATE angegeben wird.
  • Die Zeilenumbrüche in den Befehlen AUTHENTICATE und CAPABILITY dienen der Übersichtlichkeit und sind in den tatsächlichen Befehlsdaten nicht vorhanden. Das gesamte base64-Argument sollte ein durchgehender String ohne eingebettete Leerzeichen sein, sodass der gesamte AUTHENTICATE-Befehl aus einer einzelnen Textzeile besteht.

Fehlerantwort

Authentifizierungsfehler werden auch über den IMAP-Befehl AUTHENTICATE zurückgegeben:

[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

Hinweise zum IMAP-Protokollaustausch:

  • Der Client sendet eine leere Antwort („\r\n“) auf die Challenge mit der Fehlermeldung.

POP-Protokollaustausch

In diesem Abschnitt wird erläutert, wie Sie SASL XOAUTH2 mit dem Gmail-POP-Server verwenden.

Erste Clientantwort

Um sich mit dem SASL XOAUTH2-Mechanismus anzumelden, ruft der Client den Befehl AUTH mit dem Mechanismusparameter XOAUTH2 und der oben erstellten ersten Clientantwort auf. Beispiel:

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

Hinweise zum POP-Protokollaustausch:

  • Der POP-Befehl AUTH ist in RFC 1734 dokumentiert.
  • Die Zeilenumbrüche im AUTH-Befehl dienen der Übersichtlichkeit und sind in den tatsächlichen Befehlsdaten nicht vorhanden. Das gesamte base64-Argument sollte ein durchgehender String ohne eingebettete Leerzeichen sein, sodass der gesamte AUTH-Befehl aus einer einzelnen Textzeile besteht.

Fehlerantwort

Authentifizierungsfehler werden auch über den POP3-Befehl AUTH zurückgegeben:

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

SMTP-Protokollaustausch

In diesem Abschnitt wird erläutert, wie Sie SASL XOAUTH2 mit dem Gmail-SMTP-Server verwenden.

Erste Clientantwort

Um sich mit dem XOAUTH2-Mechanismus anzumelden, ruft der Client den Befehl AUTH mit dem Mechanismusparameter XOAUTH2 und der oben erstellten ersten Clientantwort auf. Beispiel:

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

Hinweise zum SMTP-Protokollaustausch:

  • Der SMTP-Befehl AUTH ist in RFC 4954 dokumentiert.
  • Die Zeilenumbrüche im AUTH-Befehl dienen der Übersichtlichkeit und sind in den tatsächlichen Befehlsdaten nicht vorhanden. Das gesamte base64-Argument sollte ein durchgehender String ohne eingebettete Leerzeichen sein, sodass der gesamte AUTH-Befehl aus einer einzelnen Textzeile besteht.

Fehlerantwort

Authentifizierungsfehler werden auch über den SMTP-Befehl AUTH zurückgegeben:

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

Hinweise zum SMTP-Protokollaustausch:

  • Der Client sendet eine leere Antwort („\r\n“) auf die Challenge mit der Fehlermeldung.

Verweise