Javaサーブレットアプリケーションにログインを追加する

このクイックスタートでは、Javaサーブレットアプリケーションに Auth0 の認証を追加する方法を説明します。Auth0 Java MVC Commons SDK を使用して、ログイン、ログアウト、ユーザープロファイル機能を備えたセキュアな Web アプリケーションを構築します。

前提条件: 始める前に、以下がインストールされていることを確認してください。

• Java Development Kit (JDK): バージョン 8 以上
• ビルドツール: Maven 3.6+ または Gradle 6.0+
• アプリケーションサーバー: Apache Tomcat 9.0+ または任意のサーブレットコンテナ
• Auth0 アカウント: お持ちでない場合は、無料で登録してください

AI を使って Auth0 を統合する

Claude Code、Cursor、GitHub Copilot などの AI コーディングアシスタントを使っている場合は、agent skills を使って数分で Auth0 認証を自動的に追加できます。

インストール:

npx skills add auth0/agent-skills --skill auth0

次に、AI アシスタントにこう依頼します。

Add Auth0 authentication to my Java servlet app

AI アシスタントが、Auth0 アプリケーションの作成、資格情報の取得、Auth0 Java MVC Commons SDK の依存関係の追加、web.xml の設定、さらにサーブレットフィルターを使ったログイン/ログアウト フローの実装まで自動的に行います。agent skills の完全なドキュメント →

​

はじめに

このクイックスタートでは、JavaサーブレットアプリケーションにAuth0の認証を追加する方法を説明します。Auth0 Java MVC Commons SDKを使用して、ログイン、ログアウト、ユーザープロファイル機能を備えたセキュアなWebアプリケーションを構築します。

1. 新規Java Webプロジェクトの作成

   このQuickstart用に、新しいJavaのWebアプリケーションプロジェクトを作成します。

   Maven

   mvn archetype:generate \
     -DgroupId=com.auth0.example \
     -DartifactId=auth0-servlet-app \
     -DarchetypeArtifactId=maven-archetype-webapp \
     -DinteractiveMode=false
   

   プロジェクトのディレクトリに移動します。

   cd auth0-servlet-app
   

   Gradle

   新しいディレクトリを作成し、Gradleプロジェクトを初期化します。

   mkdir auth0-servlet-app && cd auth0-servlet-app
   gradle init --type java-application
   
2. Auth0 Java MVC Commons SDK のインストール

   Auth0 の依存関係をプロジェクトのビルドファイルに追加してください。

   Maven

   次の依存関係を pom.xml に追加してください。

   <dependencies>
       <dependency>
           <groupId>com.auth0</groupId>
           <artifactId>mvc-auth-commons</artifactId>
           <version>1.11.1</version>
       </dependency>
       <dependency>
           <groupId>javax.servlet</groupId>
           <artifactId>javax.servlet-api</artifactId>
           <version>3.1.0</version>
           <scope>provided</scope>
       </dependency>
       <dependency>
           <groupId>javax.servlet</groupId>
           <artifactId>jstl</artifactId>
           <version>1.2</version>
       </dependency>
   </dependencies>
   

   Gradle

   次の依存関係を build.gradle に追加してください。

   plugins {
       id 'java'
       id 'war'
   }
   
   dependencies {
       implementation 'com.auth0:mvc-auth-commons:1.11.1'
       implementation 'javax.servlet:javax.servlet-api:3.1.0'
       implementation 'javax.servlet:jstl:1.2'
   }
   
3. Auth0アプリケーションを設定する

   次に、Auth0 テナントで新しいアプリケーションを作成し、その設定をプロジェクトに追加します。

   1. Auth0 Dashboard を開きます
   2. Applications > Applications > Create Application をクリックします
   3. ポップアップでアプリケーション名を入力し、アプリケーションの種類として Regular Web Application を選択して、Create をクリックします
   4. Application Details ページで Settings タブに切り替えます
   5. Auth0 Dashboard で Domain、Client ID、Client Secret の値を控えます
   6. 最後に、Application Details ページの Settings タブで、次の URL を設定します。

   Allowed Callback URLs:

   http://localhost:8080/callback
   

   許可済みのログアウト URL:

   http://localhost:8080/login
   

   許可済みのWebオリジン:

   http://localhost:8080
   

   • Allowed Callback URLs は、認証後にユーザーを安全にアプリケーションへ戻すための重要なセキュリティ対策です。一致するURLが設定されていないと、ログインは失敗し、ユーザーはアプリにアクセスできず、代わりにAuth0のエラーページが表示されます。
   • Allowed Logout URLs は、サインアウト時にシームレスなユーザー体験を提供するために不可欠です。一致するURLが設定されていないと、ユーザーはlogout後にアプリケーションへリダイレクトされず、代わりに汎用的なAuth0ページに残ることになります。
   • Allowed Web Origins は、サイレント認証に不可欠です。これがないと、ユーザーはページを更新したときや、後でアプリに戻ったときにログアウトされます。
4. Auth0 SDKを設定する

   上で生成したAuth0の資格情報を使用して web.xml を設定し、servletアプリケーションで Auth0 SDK を利用できるようにします。

   src/main/webapp/WEB-INF/web.xml を作成または更新し、プレースホルダーの値を実際のAuth0アプリケーションの設定に置き換えます。

   <?xml version="1.0" encoding="UTF-8"?>
   <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
            http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
            version="3.1">
   
       <display-name>Auth0 Servlet Example</display-name>
   
       <!-- Auth0 設定 -->
       <context-param>
           <param-name>com.auth0.domain</param-name>
           <param-value>YOUR_AUTH0_DOMAIN</param-value>
       </context-param>
       <context-param>
           <param-name>com.auth0.clientId</param-name>
           <param-value>YOUR_AUTH0_CLIENT_ID</param-value>
       </context-param>
       <context-param>
           <param-name>com.auth0.clientSecret</param-name>
           <param-value>YOUR_AUTH0_CLIENT_SECRET</param-value>
       </context-param>
   </web-app>
   

   重要: YOUR_AUTH0_DOMAIN、YOUR_AUTH0_CLIENT_ID、YOUR_AUTH0_CLIENT_SECRET は、Auth0アプリケーションの設定にある実際の値に置き換えてください。

5. 認証用コンポーネントとフィルターを作成する

   認証フローの処理とセキュリティで保護されたページへのアクセス制御に必要なJavaクラスを作成します。

6. ユーザーインターフェイスページを作成する

   アプリケーション用の JSP ページと HTML ファイルを作成します。

7. アプリケーションをビルドして実行する

   これで、アプリケーションをビルドして実行する準備が整いました。

   Maven

   アプリケーションをビルドします。

   mvn clean compile war:war
   

   Tomcat にデプロイします。

   # WAR ファイルを Tomcat の webapps ディレクトリにコピーします
   cp target/auth0-servlet-app.war $CATALINA_HOME/webapps/ROOT.war
   

   Gradle

   アプリケーションをビルドします。

   gradle clean build
   

   Tomcat にデプロイします。

   # WAR ファイルを Tomcat の webapps ディレクトリにコピーします
   cp build/libs/auth0-servlet-app.war $CATALINA_HOME/webapps/
   

   Tomcat (またはお使いのサーブレットコンテナ) を起動します。

   $CATALINA_HOME/bin/startup.sh  # Unix/Linux/Mac の場合
   # or
   $CATALINA_HOME/bin/startup.bat  # Windows の場合
   

チェックポイント

これで、Auth0 と統合されたサーブレットアプリケーションが http://localhost:8080/ で正常に動作しているはずです。

実装をテストする:

1. アプリケーションの URL にアクセスします
2. 「Auth0 でログイン」をクリックします
3. Auth0 でのログインを完了します
4. トークンが表示されたプロファイルページにリダイレクトされるはずです
5. 「Logout」をクリックしてセッションをクリアします

---

​

高度な使用法

アプリケーションの拡張

基本的な認証が動作するようになったら、次のような拡張も検討してください。

• ユーザープロファイル情報: ID トークンをデコードしてユーザー情報を表示する
• API 呼び出し: access token を使用して Auth0 の Management API や独自の API を呼び出す
• ロールベースのアクセス制御: Auth0 のロールと権限を使用して認可を実装する
• シングルサインオン: 複数のアプリケーション間で SSO を構成する

追加リソース

• Auth0 Java MVC Commons Documentation - Auth0 Dashboard - Auth0 のアプリケーションを管理 - Auth0 Servlet Sample Repository - 完全な 例 - Auth0 Java SDK Documentation - SDK の高度な 活用方法

トラブルシューティング

よくある問題

「Invalid callback URL」で認証に失敗する

• Auth0 アプリケーションの設定にある callback URL が次と完全に一致していることを確認してください: http://localhost:8080/callback

「domain、clientId、または clientSecret がありません」エラー

• web.xml の設定に正しい Auth0 アプリケーションの値が入っていることを確認してください
• パラメーター名が次と完全に一致していることを確認してください: com.auth0.domain, com.auth0.clientId, com.auth0.clientSecret

アプリケーションが起動しない

• 必要な依存関係がすべて classpath に含まれていることを確認してください
• 使用しているサーブレットコンテナが Servlet API 3.0+ をサポートしていることを確認してください
• サーバーのログで具体的なエラーメッセージを確認してください

セッションが維持されない

• 使用しているサーブレットコンテナがセッション管理用に設定されていることを確認してください
• ブラウザーで Cookie が有効になっていることを確認してください
• 本番環境では HTTPS を使用していることを確認してください

追加のサポートについては、Auth0 Communityをご覧ください。