DAITEI's blog

OAuth2.0は認証用のプロトコルではなく、認可用のプロトコルとのこと...。 「ユーザーがアプリを使う時、アプリが認可サーバから権限を取得(その際にユーザーが同意する)し、 その認可された権限をもってリソースサーバーにアクセスする」らしい。なんのこっちゃ？
※書籍 :「雰囲気で使わずきちんと理解する！整理してOAuth2.0を使うためのチュートリアルガイド」を読んでとりあえず納得はしました...。

では、以下にOAuth2.0を用いてGMailの送受信をする為の
「STEP 0 : Google Cloud設定」、「STEP 1 : 認可コード取得」、「STEP 2 : アクセストークン取得」の例を示す。

「STEP 3: アクセストークンを用いてリソースサーバにアクセス」は、上記STEP 2で得たアクセストークンを用いて実施するらしい...。

STEP 0 : Google Cloud設定

• 設定手順
  • https://console.cloud.google.com/ から 新しいプロジェクトを作成(プロジェクト名は任意の文字列)し、作成したプロジェクトを選択する。
  • 三 から APIとサービス ( https://console.cloud.google.com/projectselector2/apis/dashboard ) を選択し、上の検索バーに "Gmail API"と入力し選択する。
  • Gmail API で [有効にする」 をクリック → [認証情報の作成] を クリック
    • 認証情報 : 「ユーザーデータ」を選択し[次へ]
    • OAuth同意 : 設定情報(例)の認識情報作成時を参照
    • スコープ : 設定情報(例)の認識情報作成時を参照
      ※ [スコープを追加または削除] から追加し、[保存して次へ]をクリック
    • OAuthクライアントID : 設定情報(例)の認識情報作成時を参照
      ※ 入力して[追加]をクリック
    • 認証情報
      ※ ダウンロード をクリックして認証情報をGETし、[完了]をクリック
      ダウンロードデータ(例)

      {"installed": {
          "client_id":"************-********************************.apps.googleusercontent.com",
          "project_id":"example0430",
          "auth_uri":"https://accounts.google.com/o/oauth2/auth",
          "token_uri":"https://oauth2.googleapis.com/token",
          "auth_provider_x509_cert_url":"https://www.googleapis.com/oauth2/v1/certs",
          "client_secret":"******-****************************",
          "redirect_uris":["http://localhost"]
      }}
      

  • クライアント ( https://console.cloud.google.com/auth/clients ) から上記で作成した OAuthクライアントID を編集
    ※ 対象 ( https://console.cloud.google.com/auth/audience ) にて [+ Add users]をクリックしてテストユーザーを追加する
    (設定情報(例) の 確認場所=対象 を参照)。
• 設定情報(例)

  項目	設定例	認識情報作成時	確認場所	備考
  アプリ名	gmail0430oauth2	OAuth同意	ブランディング	他のgoogleアプリとかぶらない名にする事
  ユーザーサポートメール	example0430@gmail.com	OAuth同意	ブランディング	ユーザーのgmailから選択
  デベロッパーの連絡先情報	example0430@gmail.com	OAuth同意	ブランディング	ユーザーサポートメールと同じで良い
  スコープ(範囲)	https://mail.google.com/	スコープ	データアクセス	Gmail のすべてのメールの閲覧、作成、送信、完全な削除
  アプリケーションの種類	デスクトップアプリ	OAuthクライアントID	クライアント
  名前	desktop0430client01	OAuthクライアントID	クライアント	コンソールでのクライアント識別
  クライアントID	************-********************************.apps.googleusercontent.com	-	クライアント	Google Cloud 自動生成ID
  クライアントシークレット	******-****************************	-	クライアント	Google Cloud 自動生成シークレット
  公開ステータス	テスト中	-	対象	変更しない。つまり、[アプリを公開]しない事
  ユーザーの種類	外部	-	対象
  テストユーザー	example0430@gmail.com	-	対象	自分のgmail等

• 確認場所

  名称	URL
  ブランディング	https://console.cloud.google.com/auth/branding
  対象	https://console.cloud.google.com/auth/audience
  クライアント	https://console.cloud.google.com/auth/clients
  デーアアクセス	https://console.cloud.google.com/auth/scopes

• プロジェクト削除方法
  https://console.cloud.google.com/iam-admin/settings にアクセスし、選択したプロジェクトを「シャットダウン」する。

STEP 1 : 認可コード取得

認可サーバから認可コードを取得する。

• ロールとデータ

  ロール	データ	備考
  リソースオーナー	クライアントID, スコープ	Google Cloudののデータを使用
  認可サーバ(https://accounts.google.com/o/oauth2/auth)	認可コード	アクセストークン取得用

• 認可サーバへのHTTPアクセス例

  https://accounts.google.com/o/oauth2/auth?response_type=code
  &client_id=*************-********************************.apps.googleusercontent.com
  &state=xyz
  &scope=https://mail.google.com/
  &redirect_uri=http://127.0.0.1/callback
  

  Google Cloudのconsoleの[対象]で追加したテストユーザーの認証を求められる。
  
• 認可サーバからの返信の例
  そして下記の内容が返ってくる(code=... が認可コード)。

  http://127.0.0.1/callback?state=xyz
  &code=*****_*******************************-_**********************************
  &scope=https://mail.google.com/
  

  ※stateはリソースオーナー側でランダム生成した値。認可サーバからの返信に同じ値のstateがる事を確認する。

STEP 2 : アクセストークン取得

トークンサーバからアクセストークンを取得する。

• ロールとデータ

  ロール	データ	備考
  クライアント	クライアントID, クライアントシークレット, 認可コード	Google CloudののデータとSTEP 1で取得したコードを使用
  トークンサーバ(https://oauth2.googleapis.com/token)	アクセストークン、リフレッシュトークン	リソースサーバアクセス用

• トークンサーバーへのcurlでのアクセス例

  curl -d "client_id=*************-********************************.apps.googleusercontent.com" \
       -d "client_secret=******-****************-***********" \
       -d "redirect_uri=http://127.0.0.1/callback" \
       -d "grant_type=authorization_code" \
       -d "code=*****_*******************************-_**********************************" \
       https://oauth2.googleapis.com/token
  

• トークンサーバからの返信の例
  下記のようにアクセストークンとリフレッシュトークンが返ってくる。

  {
    "access_token": "****.**********************************************************************-********************************-********************************************************-********************************************************",
    "expires_in": 3599,
    "refresh_token": "*******************************-***************************************************************_*******",
    "scope": "https://mail.google.com/",
    "token_type": "Bearer",
    "refresh_token_expires_in": 604799
  }%     
  

---

参考資料

• 書籍 :「雰囲気で使わずきちんと理解する！整理してOAuth2.0を使うためのチュートリアルガイド」

sasl-xoauth2 に付属の README.md に詳しく設定が書いてある。 また、Gmail側のGoogle Cloudの設定は GMail OAuth2.0 の手順メモ(Google Cloud設定とアクセストークン取得まで)を参照する。
※OAuth2.0についてちゃんと勉強してから使いましょう...。

• Install

   $ sudo apt install postfix procmail
   $ sudo dpkg -i sasl-xoauth2_0.20-1_amd64.deb sasl-xoauth2-tool_0.20-1_amd64.deb
  

  ※ sasl-xoauth2 は debian experimental にある sasl-xoauth2 (0.20-1)を使用しました(R7年5月1日(木)現在 debian packageとしては、そこにしかない...)。
  ※ (尚、dscファイル、origソース、debianソースをとってきてBuildしなおして使用した)
• postfixの設定

   $ sudo dpkg-reconfigure postfix 
  

  項目	設定	備考
  General mail configuration type	スマートホスト付きインターネット Internet with smarthost	メールはSMTPを使用して直接受信するか、fetchmailなどのユーティリティを実行して受信します。送信メールはスマートホストを使用して送信されます。 Mail is received directly using SMTP or by running a utility such as fetchmail. Outgoing mail is sent using a smarthost.
  System mail name	(PCローカルHOST名に合わせる)
  SMTP relay host	[smtp.gmail.com]:587	Please specify a domain, host, host:port, [address] or [address]:port.
  Recipient for root and postmaster mail	(PCローカルのユーザー名)	Mail for the 'postmaster', 'root', and other system accounts needs to be redirected to the user account of the actual system administrator.
  メールを受け取るほかの宛先 (なければ空)	(空)	このマシンが最終的な宛先と見なされるドメインのリストを、コンマで区切って指定してください。
  Local networks:	127.0.0.0/8 [::ffff:127.0.0.0]/104 [::1]/128	Please specify the network blocks for which this host should relay mail. The default is just the local host, which is needed by some mail user agents.
  Mailbox size limit (bytes)	0	A value of zero (0) means no limit. The upstream default is 51200000.
  Local address extension character	(空)	To not use address extensions, leave the string blank.
  利用するインターネットプロトコル	IPv4	すべて : IPv4 と IPv6 アドレス両方を使う, IPv6: IPv6 アドレスのみをリスンする, ipv4: IPv4 アドレスのみをリスンする,

• ローカルメールの配送方法をホームディレクトリ内のMaildir形式にする(これはお好みで...)。

  mailbox_command = /usr/bin/procmail -a "$EXTENSION"
  

• スマートホスト認証用設定

  # SMTP Client TLS security level: none|may|encrypt|...
  smtp_tls_security_level = encrypt
  
  # SASL XOAUTH2
  smtp_sasl_auth_enable = yes
  smtp_sasl_password_maps = hash:/etc/postfix/sasl_passwd
  smtp_sasl_security_options =
  smtp_sasl_mechanism_filter = xoauth2
  

• /etc/postfix/sasl_passwd

  [smtp.gmail.com]:587 YourMail@gmail.com:/etc/tokens/YourMail@gmail.com
  

  ※ SecretなFILEなのでchown 600 しましょう。
• /etc/sasl-xoauth2.conf

  {
    "client_id": "*************-********************************.apps.googleusercontent.com",
    "client_secret": "******-****************************"
  }
  

  認可サーバへの通信にproxyを使用する場合は、以下のようにproxy設定を記述する。

  {
    "client_id": "*************-********************************.apps.googleusercontent.com",
    "client_secret": "******-****************************",
    "proxy" : "http://proxy:8080"
  }
  

  ※ SecretなFILEなのでchown 600 しましょう。
• 初期アクセストークンを準備する

   $ sasl-xoauth2-tool get-token gmail \
       --client-id=*************-********************************.apps.googleusercontent.com \
       --client-secret=******-**************************** \
       --scope="https://mail.google.com/" \
       /tmp/YourMail@gmail.com
   $ sudo mkdir -p /var/spool/postfix/etc/tokens
   $ sudo mv /tmp/YourMail@gmail.com /var/spool/postfix/etc/tokens
   $ sudo chown -R postfix:postfix /var/spool/postfix/etc/tokens
  

  ※ chrootで実行している設定なので、/var/spool/postfix/ 以下をアクセスする為
• SSL/TLS Certificates

  $ sudo mkdir -p /var/spool/postfix/etc/ssl/certs
  $ sudo cp /etc/ssl/certs/ca-certificates.crt /var/spool/postfix/etc/ssl/certs/ca-certificates.crt
  

  ※ chrootで実行している設定なので、/var/spool/postfix/ 以下をアクセスする為
  ※ 本来debianなら/var/spool/postfix に自動で設定されるのだが、R7年5月1日(木)現在 trixie/sid だと手動で設定だった...
• SASL password databaseの再生成

   $ sudo postmap /etc/postfix/sasl_passwd
  

• 設定を反映

   $ sudo systemctl reload postfix
  

ユーザー名とパスワードで接続認証するものを「安全性の低いアプリ」として、Gmailへのアクセスから排除している...。
令和7年3月14日に「すべての Google アカウントで、安全性の低いアプリへのアクセスが無効」となると宣言していた...(令和7年4月28日までは使えていたが)。
なんだかGmailって使いづらいよね...。が、Gmailを使う為にOAuth2.0に対応せねばなるまい(T_T);;;

まずは、「OAuth2.0って何よ？」から始めよう...→GMail OAuth2.0 の手順メモ(Google Cloud設定とアクセストークン取得まで) にまとめました。

※生成AI全盛なので、chatGPTやGemini使って調べてみましたが...役に立たなかった。かえって混乱して時間かかってしまった...(最近の情報にはうまく対応できないみたいです...)。

Mew(Emacs)で送受信をOAuth2.0対応する

MUAからGmailに直接送受信してみよう。
→Mew(Emacs)でGmailにアクセスする為に(OAuth2.0編) にまとめた。
Gmailへの直接接続は、やはり遅くて辛いっす...(T_T);

参照URL

• Experimental support for IMAP XOAUTH2 (2020-11-22)
• IMAP XOAUTH2 (2020-11-25〜2024-03-11)
• Mew/elisp/Makefile の SRCS / OBJS に mew-oauth2.el(c) が含まれていない (2024-06-08)

Gmailからのfetchmail受信をOAuth2.0対応する

どうやら、fetchmail version 7.x で OAuth2.0に対応しているらしい...。が、もっと楽な方法があった!!
「メール転送」だ!! もともと GmailへのIMAP接続が遅くて我慢できずに、自分のIMAPサーバを作成してそこでfetchmailしていた。
そうさ!自分のIMAPサーバへ転送すれば解決!。

設定は以下 :
Gmail → [設定の歯車マーク] → [すべての設定を表示] → [メール転送とPOP/IMAP]

これで受信メール閲覧がサクサク動く!(^-^)!

参照URL

• Ubuntu 22.04 上に OAuth2 に対応した fetchmail 7 を構築して運用する (2023-10-25)
• アプリパスワード設定
• fetchmail7 で Oauth2 認証を利用したい (2024-10-14)
• Setting Up OAUTH2 Support for Fetchmail and Postfix (2023-01-01)

GmailのSMTP送信をOAuth2.0対応する(postfix)

postfix + sasl-xoauth2 で GmailのOAuth2.0対応が簡単にできるようだ。
※ exim4から乗り換えだ
→Gmail(Googleアカウント)に対するOAuth2.0対応MTA設定 にまとめました。

これでメールの送信もサクサク動く!(^-^)!

参照URL

• Postfixをxoauth2に対応させ、smtp.gmail.comへリレーする (2022-03-14)

GmailのSMTP送信をOAuth2.0対応する(exim4)

なんか...むずそうだ...。
※ postfixに乗り換えで...

参照URL

• https://github.com/pcw11211/exim4-oauth2

最新のMewをGETしてdebパッケージにしてInstall

• https://packages.debian.org/experimental/mew から mew 6.9のdebian用ソースとdscをGET
• https://www.mew.org/ja/git/ を見て最新のソースをGET
  R7年4月30日(水) 現在、 mew-oauth2.el が含まれていた!!! 尚、mew-version は 6.9
• gitからGETしたものを mew_6.9.orig.tar.gz としてアーカイブ。
• mew_6.9-1.debian.tar.xz の変更
  • patches/020_locale-utf8.patch を削除
  • patches/series から 020_locale-utf8.patch の記述を削除
  変更後のソースをmew_6.9-1.debian.tar.xzとしてアーカイブ。
• mew_6.9-1.dscの記述を上記のアーカイブに合せる(sum関係やファイルsizeの変更)。
• debパッケージbuildして、Install

    $ dpkg-source -x mew_6.9-1.dsc
    $ cd mew-6.9
    $ vi debian/changelog  # 変更内容記載し、versionを上げておく
    $ dpkg-buildpackage -us -uc
    $ cd ..
    $ sudo dpkg -i mew_6.9-5_all.deb mew-bin_6.9-5_amd64.deb
  

.mew.el の設定例

;;; for OAuth2.0
(setq mew-oauth2-client-id "*************-********************************.apps.googleusercontent.com")
(setq mew-oauth2-client-secret "******-****************************")

(setq mew-config-alist
      '(("MyGmail"
         ("user"             . "MyName")
         ("mail-domain"      . "gmail.com")
         ("prog-ssl"         . "/usr/bin/stunnel")
         ("use-smtp-auth"    . t)
	 ("smtp-ssl"         . t)
         ("smtp-server"      . "smtp.gmail.com")
	 ("smtp-ssl-port"    . "465")
         ("smtp-auth-list"   . ("XOAUTH2"))
	 ("smtp-user"        . "MyName@gmail.com")
         ("imap-ssl"         . t)
         ("imap-server"      . "imap.gmail.com")
         ("imap-ssl-port"    . "993")
         ("imap-auth-list"   . ("XOAUTH2"))
         ("imap-user"        . "MyName@gmail")
         )))

---

参照URL

• Experimental support for IMAP XOAUTH2 (2020-11-22)
• IMAP XOAUTH2 (2020-11-25〜2024-03-11)
• Mew/elisp/Makefile の SRCS / OBJS に mew-oauth2.el(c) が含まれていない (2024-06-08)