11.15. CLI スクリプトを使用した起動可能な JAR の HTTP 認証の有効化

手順

1. 以下の内容を pom.xml ファイルの <build> 要素に追加します。以下に例を示します。

   <plugins>
   	<plugin>
   		<groupId>org.wildfly.plugins</groupId>
   		<artifactId>wildfly-jar-maven-plugin</artifactId>
   		<version>${bootable.jar.maven.plugin.version}</version>
   		<configuration>
   			<channels>
   				<channel>
   					<manifest>
   						<groupId>org.jboss.eap.channels</groupId>
   						<artifactId>eap-8.0</artifactId>
   					</manifest>
   				</channel>
   				<channel>
   					<manifest>
   						<groupId>org.jboss.eap.channels</groupId>
   						<artifactId>eap-xp-5.0</artifactId>
   					</manifest>
   				</channel>
   			</channels>
   			<feature-pack-location>org.jboss.eap.xp:wildfly-galleon-pack</feature-pack-location>
   			<layers>
   				<layer>datasources-web-server</layer>
   			</layers>
   		</configuration>
   		<executions>
   			<execution>
   				<goals>
   					<goal>package</goal>
   				</goals>
   			</execution>
   		</executions>
   	</plugin>
   </plugins>

   この例には、elytron サブシステムが含まれる datasources-web-server Galleon レイヤーが含まれていました。

2. src/main/webapp/WEB-INF ディレクトリーの web.xml ファイルを更新します。以下に例を示します。

   <?xml version="1.0" encoding="UTF-8"?>
   
   <web-app version="4.0"
            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_4_0.xsd">
   
       <login-config>
           <auth-method>BASIC</auth-method>
           <realm-name>Example Realm</realm-name>
       </login-config>
   
   </web-app>

3. java ファイルを保存するディレクトリーを作成します。

   $ mkdir -p APPLICATION_ROOT/src/main/java/com/example/authentication/

   APPLICATION_ROOT は Maven プロジェクトのルートディレクトリーです。

4. 以下の内容で Java ファイル TestServlet.java を作成し、ファイルを APPLICATION_ROOT/src/main/java/com/example/authentication/ ディレクトリーに保存します。

   package com.example.authentication;
   
   import jakarta.servlet.annotation.HttpMethodConstraint;
   import jakarta.servlet.annotation.ServletSecurity;
   import jakarta.servlet.annotation.WebServlet;
   import jakarta.servlet.http.HttpServlet;
   import jakarta.servlet.http.HttpServletRequest;
   import jakarta.servlet.http.HttpServletResponse;
   
   import java.io.IOException;
   import java.io.PrintWriter;
   
   @WebServlet(urlPatterns = "/hello")
   @ServletSecurity(httpMethodConstraints = { @HttpMethodConstraint(value = "GET", rolesAllowed = { "Users" }) })
   public class TestServlet extends HttpServlet {
   
       @Override
       protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
           PrintWriter writer = resp.getWriter();
           writer.println("Hello " + req.getUserPrincipal().getName());
           writer.close();
       }
   
   }

5. authentication.cli などの CLI スクリプトを作成し、これを APPLICATION_ROOT/scripts ディレクトリーなどの起動可能な JAR のアクセス可能なディレクトリーに保存します。スクリプトには以下のコマンドが含まれている必要があります。

   /subsystem=elytron/properties-realm=bootable-realm:add(users-properties={relative-to=jboss.server.config.dir, path=bootable-users.properties, plain-text=true}, groups-properties={relative-to=jboss.server.config.dir, path=bootable-groups.properties})
   /subsystem=elytron/security-domain=BootableDomain:add(default-realm=bootable-realm, permission-mapper=default-permission-mapper, realms=[{realm=bootable-realm, role-decoder=groups-to-roles}])
   
   /subsystem=undertow/application-security-domain=other:write-attribute(name=security-domain, value=BootableDomain)

6. プラグイン <configuration> 要素に以下の設定抽出を追加します。

   <cli-sessions>
       <cli-session>
           <script-files>
               <script>scripts/authentication.cli</script>
           </script-files>
       </cli-session>
   </cli-sessions>

   この例は、サーバーに定義されたセキュリティードメインにデフォルトの undertow セキュリティードメインを設定する authentication.cli CLI スクリプトを示しています。

   注記

   パッケージ化時にではなく、実行時に CLI スクリプトを実行するオプションがあります。これを行うには、この手順をスキップして手順 10 に進みます。

7. Maven プロジェクトのルートディレクトリーで、JBoss EAP JAR Maven プラグインが起動可能な JAR に追加するプロパティーファイルを保存するディレクトリーを作成します。

   $ mkdir -p APPLICATION_ROOT/extra-content/standalone/configuration/

   APPLICATION_ROOT は、アプリケーションの pom.xml 設定ファイルが含まれるディレクトリーです。

   このディレクトリーには、bootable-users.properties および bootable-groups.properties などのファイルを保存します。

   bootable-users.properties ファイルには以下の内容が含まれます。

   testuser=bootable_password

   bootable-groups.properties ファイルには以下の内容が含まれます。

   testuser=Users

8. 以下の extra-content-content-dirs 要素を既存の <configuration> 要素に追加します。

   <extra-server-content-dirs>
               <extra-content>extra-content</extra-content>
   </extra-server-content-dirs>

   extra-content ディレクトリーには、プロパティーファイルが含まれます。

9. アプリケーションを起動可能な JAR としてパッケージ化します。

   $ mvn package

10. アプリケーションを起動します。

    mvn wildfly-jar:run

    手順 6 をスキップし、ビルド中に CLI スクリプトを実行しないことを選択した場合は、次のコマンドを使用してアプリケーションを起動します。

    mvn wildfly-jar:run -Dwildfly.bootable.arguments=--cli-script=scripts/authentication.cli

11. サーブレットを呼び出しますが、認証情報は指定しないでください。

    curl -v http://localhost:8080/hello

    想定される出力:

    HTTP/1.1 401 Unauthorized
    ...
    WWW-Authenticate: Basic realm="Example Realm"

12. サーバーを呼び出して認証情報を指定します。以下に例を示します。

    $ curl -v -u testuser:bootable_password http://localhost:8080/hello

    起動可能な JAR に対して HTTP 認証が有効になっていることを示す HTTP 200 ステータスが返されます。以下に例を示します。

    HTTP/1.1 200 OK
    ....
    Hello testuser