【コラボフロー】Google OAuth認証を利用するための設定

コラボフローでGoogle OAuth認証を利用するための設定手順について説明します。
ここでは、コラボフローで必要な設定について記載します。

適用可能な環境

• パッケージ版コラボフロー2.20.0を利用している
• ColdFusion 2021 Update 5 または ColdFusion 2018 を利用している

ColdFusion 2021を利用している場合

ColdFusion 2021 Update 4 以前の場合は、Update 5にアップデートしてください。

※本記事に記載のColdFusionパッチは、Update 5 向けのため Update 6 以降には適用できません。
　ColdFusion 2021 Update 6 以降に関しては、対応方法が確認でき次第、本記事にて手順を公開します。

1. Google Workspaceの設定

コラボフローでGmailをメールサーバーとして利用するためには、Google Workspaceで設定をおこなう必要があります。

以下記事を参考に、Google Workspaceの設定をおこなってください。

• 【Google Workspace】Google OAuth認証を利用するための設定

2. ColdFusionの設定

ColdFusionにOAuthに対応するためのパッチを適用します。

事前準備

設定を誤りますとColdFusionが起動できなくなる場合がありますので、必ず事前に以下のファイルをコピーしてバックアップしてください。

• {ColdFusionインストールルート}\cfusion\bin\jvm.config

例：ColdFusion 2021の場合
既定では C:\ColdFusion2021\cfusion\bin\jvm.config となります。

ColdFusion 2021の設定

1. Webサーバーへログインします。
2. スタート＞アプリ＞Adobe＞Administrator からColdFusionの管理画面を開き、ログインします。
   ※メニューが見当たらない場合は、ブラウザーから以下URLにアクセスしてください。
   http://127.0.0.1:8500/CFIDE/administrator/
3. 左側のメニューから「サーバの設定 > JavaとJVM」画面を表示します。
4. 「JVM 引数」項目の一番最後に以下の設定値を半角空白で区切って追加します。
   • 設定値：-Dcoldfusion.mail.oauth2=true
5. 「変更の送信」ボタンをクリックします。
6. スタート＞管理ツール＞サービス をクリックし、Windowsサービス一覧画面を表示します。
7. 「ColdFusion 2021 Application Server」を選択し、[サービスの停止] をクリックします。
8. 以下リンクから「patch.zip」をダウンロードします。
   • patch.zip
9. ダウンロードしたファイルを展開します。
10. 手順9で展開したフォルダ内のファイル「mail-2021.0.05.330109.jar」を、以下フォルダに適用（上書き）します。
    • {ColdFusionインストールルート}\bundles
11. 手順9で展開したフォルダ内のファイル「mail.jar」を、以下フォルダに適用（上書き）します。
    • {ColdFusionインストールルート}\cfusion\lib
12. 以下フォルダ内のファイルを全て削除します。
    • {ColdFusionインストールルート}\cfusion\bin\felix-cache
13. スタート＞管理ツール＞サービス をクリックし、Windowsサービス一覧画面を表示します。
14. 「ColdFusion 2021 Application Server」を選択し、[サービスの開始] をクリックします。

ColdFusion 2018の設定

1. 以下記事を参考にColdFusionの最新のアップデートを適用します。
   • ColdFusionのアップデートについて
2. Webサーバーへログインします。
3. スタート＞アプリ＞Adobe＞Administrator からColdFusionの管理画面を開き、ログインします。
   ※メニューが見当たらない場合は、ブラウザーから以下URLにアクセスしてください。 http://127.0.0.1:8500/CFIDE/administrator/
4. 左側のメニューから「サーバの設定 > JavaとJVM」画面を表示します。
5. 「JVM 引数」項目の一番最後に以下の設定値を半角空白で区切って追加します。
   • 設定値：-Dcoldfusion.mail.oauth2=true
6. 「変更の送信」ボタンをクリックします。
7. スタート＞管理ツール＞サービス をクリックし、Windowsサービス一覧画面を表示します。
8. 「ColdFusion 2018 Application Server」を選択し、[サービスの停止] をクリックします。
9. 以下リンクから「hf201800-4212004.jar」をダウンロードします。
   • hf201800-4212004.jar
10. 手順9でダウンロードしたファイル「hf201800-4212004.jar」を、以下フォルダに適用します。
    • {ColdFusionインストールルート}\cfusion\lib\updates
11. 以下リンクから「mail.jar」をダウンロードします。
    • mail.jar
12. 手順11でダウンロードしたファイル「mail.jar」を、以下フォルダに適用します。
    • {ColdFusionインストールルート}\cfusion\lib
13. スタート＞管理ツール＞サービス をクリックし、Windowsサービス一覧画面を表示します。
14. 「ColdFusion 2018 Application Server」を選択し、[サービスの開始] をクリックします。

外部参考サイト

• OAuth を使用した IMAP、POP、SMTP または Exchange 接続の認証

3. コラボフローの設定

1. 「1. Google Workspaceの設定」でダウンロードした秘密鍵のJSONファイルを以下ファイル名に変更します。
   • GoogleOAuthSecretKey.json
2. ファイル名を変更した手順1のJSONファイルを、以下フォルダに適用します。
   • {コラボフローインストールフォルダ}\config
     ※configフォルダがない場合は、フォルダを作成します。
3. 本記事に添付されているZIPファイル「patch-2.20.0-10222.zip」をダウンロードし、展開します。
4. 以下手順を参考にパッチを適用してください。
   • 修正パッチの適用手順（パッケージ版）
5. コラボフローにシステム管理者でログインします。
6. システム管理エリア＞環境設定を表示します。
7. メール設定の「SMTP認証設定」にて、「SMTP認証の有効化」をON、「GoogleOAuth認証の有効化」をONにし、ユーザー名には「管理メール送信元アドレス」と同じメールアドレスを入力します。
   
8. [登録] をクリックします。

※適用時に、コラボフローを停止する必要はありません。