DrupalのSimple OAuth (OAuth2) & OpenID ConnectモジュールはOAuth 2.0認証フレームワークRFCの実装と説明されています。
https://www.drupal.org/project/simple_oauth
関連する記事として、cookie認証の例や、jwt認証の例も参考にしてください。
インストール#
simple_oauthモジュールには、5系と6系があるようですが、今回は5系を使用します。以下でインストールします。
ただし、さくらレンタルサーバを使用している場合、以下のエラーが発生しました。PHP's sodium extensionが必要でした。
そこで、以下のサイトを参考に、PHP-sodium 拡張を追加しました。
https://qiita.com/tomcat0090/items/2564baa9179747b4d855
ただし、上記のサイトではPHPのバージョンが8.0系を対象にしているのに対して、今回使用しているPHPのバージョンが8.1.24だったため、「3. Download and Compile PHP Extension」の部分を一部変更しています。
上記を行った後に、再度以下を実行した結果、モジュールのインストールに成功しました。
その後、以下でモジュールを有効化しました。
OAuthクライアントの作成#
simple_oauthモジュールの設定に関するドキュメントをうまく見つけることができなかったのですが、今回は以下の「Next.js for Drupal」のドキュメントを参考にします。
https://next-drupal.org/learn/preview-mode/create-oauth-client
操作方法は上記のドキュメントに記載されていますので、画面キャプチャやメモを以下に記載します。
1. Create Role#
/admin/people/roles
2. Assign Permissions#
特に、Bypass content access controlは後述の過程で必要な項目のようでした。
3. Create User#
/admin/people/create
今回は、nextという名前のユーザを作成しました。
4. Generate keys#
/admin/config/people/simple_oauth
Generate keys を行うにあたり、../が例示されていますが、さくらレンタルサーバを使用している場合には、/home/{ユーザ名}/.ssh/drupalなどのほうが適切かと考えられます。
そのため、まず以下のようなコマンドでフォルダを作成し、
Generate keys のボタンをクリックした際に表示されるフォームに、上記のパスを入力します。
その後、「構成を保持」のボタンをクリックして、設定を保存します。
5. Create Consumer#
/admin/config/services/consumer/add
以上で、OAuthクライアントの作成は完了です。
Postmanで試す#
POSTで{DRUPALのパス}/oauth/tokenを指定します。
Bodyでは、x-www-form-urlencodedを指定して、Keyにgrant_type、Valueにclient_credentialsを指定します。
また、Pre-request Scriptで、以下を指定します。
結果、以下のようなJSONデータを取得できます。
上記のaccess_tokenをjwt.ioで検証してみると、以下のように、User IDが4、scopeとして「認証済みユーザー」および先ほど指定した「Next.js Site」が設定されていることが確認できます。
DrupalのREST UIでoauth2認証を試す#
Drupalでの設定#
Postmanを使い方については、以下の記事も参考にしてください。
/admin/config/services/rest/resource/entity%3Anode/editにアクセスして、認証プロバイダで、「oauth2」を選択します。
Postmanでの操作（JSON:APIの場合）#
以下のようにPOSTリクエストを投げてみます。
{DRUPALをインストールしたパス}/jsonapi/node/article
この時、AuthorizationでBear Tokenを選択して、先ほど取得したトークンを入力しておきます。
結果、正しくコンテンツを追加できました。
トークンの有効期限が切れている場合などは、以下のように、「未承認」という結果が返却されました。
Postmanでの操作（非JSON:APIの場合）#
一方、{DRUPALをインストールしたパス}/node?_format=jsonにリクエストした場合、以下の結果が返却されました。
JSON Web Token Authenticationモジュールを使用した際にはうまくいったので、設定等のどこかに間違いがあるのかもしれません。引き続き調査してみたいと思います。
まとめ#
simple_oauthモジュールの使用例を紹介しました。誤っている点などがあるかもしれませんが、参考になりましたら幸いです。