OAuth 2.0 メカニズム

このドキュメントでは、IMAP AUTHENTICATE、POP AUTH、SMTP AUTH コマンドで使用する SASL XOAUTH2 メカニズムを定義します。このメカニズムにより、OAuth 2.0 アクセス トークンを使用してユーザーの Gmail アカウントの認証を行うことができます。

OAuth 2.0 の使用

まず、OAuth 2.0 を使用した Google API へのアクセスについて理解しましょう。このドキュメントでは、OAuth 2.0 の仕組みと、クライアントの作成手順について説明しています。

実用的な例については、サンプル XOAUTH2 コードを参照することもできます。

OAuth 2.0 スコープ

IMAP、POP、SMTP アクセスのスコープは https://mail.google.com/ です。IMAP、POP、SMTP アプリの完全なメールスコープへのアクセスをリクエストする場合は、Google API サービス: ユーザーデータ ポリシーに準拠している必要があります。

  • 承認を受けるには、アプリで https://mail.google.com/ の使用状況をすべて示していただく必要があります。
  • アプリで https://mail.google.com/ が不要な場合は、Gmail API に移行し、よりきめ細かい制限付きスコープを使用します。

Google Workspaceのドメイン全体の委任

サービス アカウントを使用したGoogle Workspace ドメイン全体の委任を使用して、 Google Workspace ユーザーのメールボックスに IMAP 経由でアクセスする場合は、代わりにスコープ https://www.googleapis.com/auth/gmail.imap_admin を使用してクライアントを承認できます。

このスコープで承認されると、IMAP 接続は異なる動作をします。

  • ユーザーが Gmail の設定でラベルの [IMAP で表示] を無効にしていても、すべてのラベルは IMAP で表示されます。
  • ユーザーが Gmail 設定の [フォルダサイズの制限] で設定した内容に関係なく、すべてのメールが IMAP で表示されます。

SASL XOAUTH2 メカニズム

XOAUTH2 メカニズムを使用すると、クライアントは OAuth 2.0 アクセス トークンをサーバーに送信できます。このプロトコルでは、次のセクションで説明するエンコードされた値を使用します。

最初のクライアント対応

SASL XOAUTH2 の初期クライアント レスポンスの形式は次のとおりです。

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

RFC 4648 で定義されている base64 エンコード メカニズムを使用します。^A は Ctrl+A(\001)を表します。

たとえば、base64 でエンコードする前の最初のクライアント レスポンスは次のようになります。

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

base64 エンコードを行うと、次のようになります(わかりやすくするために改行を挿入)。

dXNlcj1zb21ldXNlckBleGFtcGxlLmNvbQFhdXRoPUJlYXJlciB5YTI5LnZGOWRmdDRxbVRjMk52
YjNSbGNrQmhkSFJoZG1semRHRXVZMjl0Q2cBAQ==

エラー レスポンス

最初のクライアント レスポンスでエラーが発生すると、サーバーは次の形式のエラー メッセージを含むチャレンジを送信します。

base64({JSON-Body})

JSON-Body には、statusschemesscope の 3 つの値が含まれます。例:

eyJzdGF0dXMiOiI0MDEiLCJzY2hlbWVzIjoiYmVhcmVyIG1hYyIsInNjb3BlIjoiaHR0cHM6Ly9t
YWlsLmdvb2dsZS5jb20vIn0K

base64 でデコードすると、次のようになります(わかりやすいようにフォーマットされている)。

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

SASL プロトコルでは、クライアントはこのチャレンジに対して空のレスポンスを送信する必要があります。

IMAP プロトコル交換

このセクションでは、Gmail IMAP サーバーで SASL XOAUTH2 を使用する方法について説明します。

最初のクライアント対応

SASL XOAUTH2 メカニズムでログインするために、クライアントは、メカニズム パラメータ XOAUTH2 と上記の最初のクライアント レスポンスを指定して AUTHENTICATE コマンドを呼び出します。例:

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

IMAP プロトコル交換に関する注意事項:

  • IMAP AUTHENTICATE コマンドは、RFC 3501 で説明されています。
  • SASL-IR 機能を使用すると、AUTHENTICATE コマンドの最初の行で最初のクライアント レスポンスを送信できるため、認証に必要なラウンド トリップは 1 回だけです。SASL-IR は、RFC 4959 に記載されています。
  • AUTH=XOAUTH2 機能は、サーバーがこのドキュメントで定義されている SASL メカニズムをサポートしていることを宣言します。このメカニズムは、XOAUTH2 を AUTHENTICATE コマンドの最初の引数として指定することで有効になります。
  • AUTHENTICATE コマンドと CAPABILITY コマンドの改行は、わかりやすくするためのものであり、実際のコマンドデータには存在しません。AUTHENTICATE コマンド全体が 1 行のテキストで構成されるように、base64 引数全体は、空白を埋め込まずに連続した 1 つの文字列にする必要があります。

エラー レスポンス

認証の失敗は、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

IMAP プロトコル交換に関する注意事項:

  • クライアントは、エラー メッセージを含むチャレンジに対して空のレスポンス(「\r\n」)を送信します。

POP プロトコル交換

このセクションでは、Gmail POP サーバーで SASL XOAUTH2 を使用する方法について説明します。

最初のクライアント対応

SASL XOAUTH2 メカニズムでログインするために、クライアントは、メカニズム パラメータ XOAUTH2 と上記の最初のクライアント レスポンスを指定して AUTH コマンドを呼び出します。例:

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

POP プロトコル交換に関する注意事項:

  • POP の AUTH コマンドは、RFC 1734 で説明されています。
  • わかりやすくするためのもので、AUTH コマンド内の改行は実際のコマンドデータには存在しません。AUTH コマンド全体が 1 行のテキストで構成されるように、base64 引数全体は、空白を埋め込まずに連続した 1 つの文字列にする必要があります。

エラー レスポンス

認証の失敗は、POP の AUTH コマンドでも返されます。

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

SMTP プロトコル交換

このセクションでは、Gmail SMTP サーバーで SASL XOAUTH2 を使用する方法について説明します。

最初のクライアント対応

XOAUTH2 メカニズムでログインするために、クライアントは、メカニズム パラメータ XOAUTH2 を指定して 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 dXNlcj1zb21ldXNlckBleGFtcGxlLmNvbQFhdXRoPUJlY
XJlciB5YTI5LnZGOWRmdDRxbVRjMk52YjNSbGNrQmhkSFJoZG1semRHRXVZMj
l0Q2cBAQ==
S: 235 2.7.0 Accepted
[connection continues...]

SMTP プロトコル交換に関する注意事項:

  • SMTP AUTH コマンドは、RFC 4954 に記載されています。
  • わかりやすくするためのもので、AUTH コマンド内の改行は実際のコマンドデータには存在しません。AUTH コマンド全体が 1 行のテキストで構成されるように、base64 引数全体は、空白を埋め込まずに連続した 1 つの文字列にする必要があります。

エラー レスポンス

認証の失敗は、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...]

SMTP プロトコル交換に関する注意事項:

  • クライアントは、エラー メッセージを含むチャレンジに対して空のレスポンス(「\r\n」)を送信します。

参照