アイデンティティーストアを使用したアプリケーションと管理インターフェイスの保護

手順

1. Elytron で暗号化された filesystem-realm を作成します。

   構文

   /subsystem=elytron/filesystem-realm=<filesystem_realm_name>:add(path=<file_path>,credential-store=<name_of_credential_store>,secret-key=<key>)

   Copy to Clipboard Toggle word wrap

   例

   /subsystem=elytron/filesystem-realm=exampleSecurityRealm:add(path=fs-realm-users,relative-to=jboss.server.config.dir, credential-store=examplePropertiesCredentialStore, secret-key=key)
   {"outcome" => "success"}

   Copy to Clipboard Toggle word wrap

2. レルムにユーザーを追加し、ユーザーのロールを設定します。

   1. ユーザーを追加します。

      構文

      /subsystem=elytron/filesystem-realm=<filesystem_realm_name>:add-identity(identity=<user_name>)

      Copy to Clipboard Toggle word wrap

      例

      /subsystem=elytron/filesystem-realm=exampleSecurityRealm:add-identity(identity=user1)
      {"outcome" => "success"}

      Copy to Clipboard Toggle word wrap

   2. ユーザーのパスワードを設定します。

      構文

      /subsystem=elytron/filesystem-realm=<filesystem_realm_name>:set-password(identity=<user_name>, clear={password=<password>})

      Copy to Clipboard Toggle word wrap

      例

      /subsystem=elytron/filesystem-realm=exampleSecurityRealm:set-password(identity=user1, clear={password="passwordUser1"})
      {"outcome" => "success"}

      Copy to Clipboard Toggle word wrap

   3. ユーザーのロールを設定します。

      構文

      /subsystem=elytron/filesystem-realm=<filesystem_realm_name>:add-identity-attribute(identity=<user_name>, name=<roles_attribute_name>, value=[<role_1>,<role_N>])

      Copy to Clipboard Toggle word wrap

      例

      /subsystem=elytron/filesystem-realm=exampleSecurityRealm:add-identity-attribute(identity=user1, name=Roles, value=["Admin","Guest"])
      {"outcome" => "success"}

      Copy to Clipboard Toggle word wrap

3. filesystem-realm を参照するセキュリティードメインを作成します。

   構文

   /subsystem=elytron/security-domain=<security_domain_name>:add(default-realm=<filesystem_realm_name>,permission-mapper=default-permission-mapper,realms=[{realm=<filesystem_realm_name>,role-decoder="<role_decoder_name>"}])

   Copy to Clipboard Toggle word wrap

   例

   /subsystem=elytron/security-domain=exampleSecurityDomain:add(default-realm=exampleSecurityRealm,permission-mapper=default-permission-mapper,realms=[{realm=exampleSecurityRealm}])
   {"outcome" => "success"}

   Copy to Clipboard Toggle word wrap

手順

1. キーストアを作成します。

   構文

   /subsystem=elytron/key-store=<key_store_name>:add(path=<path_to_key_store_file>,credential-reference={<password>})

   Copy to Clipboard Toggle word wrap

   例

   /subsystem=elytron/key-store=exampleKeystore:add(path=keystore, relative-to=jboss.server.config.dir, type=JKS, credential-reference={clear-text=secret})
   {"outcome" => "success"}

   Copy to Clipboard Toggle word wrap

2. キーストアにキーペアを作成します。

   構文

   /subsystem=elytron/key-store=<key_store_name>:generate-key-pair(alias=<alias>,algorithm=<key_algorithm>,key-size=<size_of_key>,validity=<validity_in_days>,distinguished-name="<distinguished_name>")

   Copy to Clipboard Toggle word wrap

   例

   /subsystem=elytron/key-store=exampleKeystore:generate-key-pair(alias=localhost,algorithm=RSA,key-size=1024,validity=365,distinguished-name="CN=localhost")
   {"outcome" => "success"}

   Copy to Clipboard Toggle word wrap

3. キーペアをキーストアファイルに永続化します。

   構文

   /subsystem=elytron/key-store=<key_store_name>:store()

   Copy to Clipboard Toggle word wrap

   例

   /subsystem=elytron/key-store=exampleKeystore:store()
   {
       "outcome" => "success",
       "result" => undefined
   }

   Copy to Clipboard Toggle word wrap

手順

1. Elytron で filesystem-realm を作成します。

   構文

   /subsystem=elytron/filesystem-realm=<filesystem_realm_name>:add(path=<file_path>,key-store=<key_store_name>,key-store-alias=<key_store_alias>)

   Copy to Clipboard Toggle word wrap

   例

   /subsystem=elytron/filesystem-realm=exampleSecurityRealm:add(path=fs-realm-users,relative-to=jboss.server.config.dir, key-store=exampleKeystore, key-store-alias=localhost)
   {"outcome" => "success"}

   Copy to Clipboard Toggle word wrap

2. レルムにユーザーを追加し、ユーザーのロールを設定します。

   1. ユーザーを追加します。

      構文

      /subsystem=elytron/filesystem-realm=<filesystem_realm_name>:add-identity(identity=<user_name>)

      Copy to Clipboard Toggle word wrap

      例

      /subsystem=elytron/filesystem-realm=exampleSecurityRealm:add-identity(identity=user1)
      {"outcome" => "success"}

      Copy to Clipboard Toggle word wrap

   2. ユーザーのパスワードを設定します。

      構文

      /subsystem=elytron/filesystem-realm=<filesystem_realm_name>:set-password(identity=<user_name>, clear={password=<password>})

      Copy to Clipboard Toggle word wrap

      例

      /subsystem=elytron/filesystem-realm=exampleSecurityRealm:set-password(identity=user1, clear={password="passwordUser1"})
      {"outcome" => "success"}

      Copy to Clipboard Toggle word wrap

   3. ユーザーのロールを設定します。

      構文

      /subsystem=elytron/filesystem-realm=<filesystem_realm_name>:add-identity-attribute(identity=<user_name>, name=<roles_attribute_name>, value=[<role_1>,<role_N>])

      Copy to Clipboard Toggle word wrap

      例

      /subsystem=elytron/filesystem-realm=exampleSecurityRealm:add-identity-attribute(identity=user1, name=Roles, value=["Admin","Guest"])
      {"outcome" => "success"}

      Copy to Clipboard Toggle word wrap

3. filesystem-realm を参照するセキュリティードメインを作成します。

   構文

   /subsystem=elytron/security-domain=<security_domain_name>:add(default-realm=<filesystem_realm_name>,permission-mapper=default-permission-mapper,realms=[{realm=<filesystem_realm_name>,role-decoder="<role_decoder_name>"}])

   Copy to Clipboard Toggle word wrap

   例

   /subsystem=elytron/security-domain=exampleSecurityDomain:add(default-realm=exampleSecurityRealm,permission-mapper=default-permission-mapper,realms=[{realm=exampleSecurityRealm}])
   {"outcome" => "success"}

   Copy to Clipboard Toggle word wrap

手順

1. 既存のキーストアにキーペアを作成します。

   構文

   /subsystem=elytron/key-store=<key_store_name>:generate-key-pair(alias=<alias>,algorithm=<key_algorithm>,key-size=<size_of_key>,validity=<validity_in_days>,distinguished-name="<distinguished_name>")

   Copy to Clipboard Toggle word wrap

   例

   /subsystem=elytron/key-store=exampleKeystore:generate-key-pair(alias=localhost2,algorithm=RSA,key-size=1024,validity=365,distinguished-name="CN=localhost")
   {"outcome" => "success"}

   Copy to Clipboard Toggle word wrap

2. キーペアをキーストアファイルに永続化します。

   構文

   /subsystem=elytron/key-store=<key_store_name>:store()

   Copy to Clipboard Toggle word wrap

   例

   /subsystem=elytron/key-store=exampleKeystore:store()
   {
       "outcome" => "success",
       "result" => undefined
   }

   Copy to Clipboard Toggle word wrap

3. 新しいキーペアを参照するようにキーストアエイリアスを更新します。

   構文

   /subsystem=elytron/filesystem-realm=<filesystem_realm_name>:write-attribute(name=key-store-alias, value=<key_store_alias>)

   Copy to Clipboard Toggle word wrap

   例

   /subsystem=elytron/filesystem-realm=exampleSecurityRealm:write-attribute(name=key-store-alias, value=localhost2)
   {
       "outcome" => "success",
       "response-headers" => {
           "operation-requires-reload" => true,
           "process-state" => "reload-required"
       }
   }

   Copy to Clipboard Toggle word wrap

4. サーバーをリロードします。

   reload

   Copy to Clipboard Toggle word wrap

5. 新しいキーペアを使用して、filesystem-realm のファイルを新規署名で更新します。

   構文

   /subsystem=elytron/filesystem-realm=<filesystem_realm_name>:update-key-pair()

   Copy to Clipboard Toggle word wrap

   例

   /subsystem=elytron/filesystem-realm=exampleSecurityRealm:update-key-pair()
   {"outcome" => "success"}

   Copy to Clipboard Toggle word wrap

手順

1. 暗号化されていない filesystem-realm を暗号化されたものに変換します。

   構文

   $ JBOSS_HOME/bin/elytron-tool.sh filesystem-realm-encrypt --input-location <existing_filesystem_realm_name> --output-location JBOSS_HOME/standalone/configuration/<target_filesystem_realm_name> --credential-store <path_to_credential_store>/<credential_store>

   Copy to Clipboard Toggle word wrap

   例

   $ JBOSS_HOME/bin/elytron-tool.sh filesystem-realm-encrypt --input-location JBOSS_HOME/standalone/configuration/fs-realm-users --output-location JBOSS_HOME/standalone/configuration/fs-realm-users-enc --credential-store JBOSS_HOME/standalone/configuration/examplePropertiesCredentialStore.cs
   
   Creating encrypted realm for: JBOSS_HOME/standalone/configuration/fs-realm-users
   Found credential store and alias, using pre-existing key

   Copy to Clipboard Toggle word wrap

   WildFly Elytron コマンド filesystem-realm-encrypt によって、--output-location 引数で指定された filesystem-realm が作成されます。また、filesystem-realm のルートに CLI スクリプトが作成されます。このスクリプトを使用すると、elytron サブシステムに filesystem-realm リソースを追加できます。

   ヒント

   --summary オプションを使用して、コマンド実行の概要を表示します。

2. 生成された CLI スクリプトを使用して、elytron サブシステムに filesystem-realm リソースを追加します。

   構文

   $ JBOSS_HOME/bin/jboss-cli.sh --connect --file=<target_filesystem_realm_directory>/<target_filesystem_realm_name>.cli

   Copy to Clipboard Toggle word wrap

   例

   $ JBOSS_HOME/bin/jboss-cli.sh --connect --file=JBOSS_HOME/standalone/configuration/fs-realm-users-enc/encrypted-filesystem-realm.cli

   Copy to Clipboard Toggle word wrap

手順

1. キーストアを作成します。

   構文

   /subsystem=elytron/key-store=<key_store_name>:add(path=<path_to_key_store_file>,credential-reference={<password>})

   Copy to Clipboard Toggle word wrap

   例

   /subsystem=elytron/key-store=exampleKeystore:add(path=keystore, relative-to=jboss.server.config.dir, type=JKS, credential-reference={clear-text=secret})
   {"outcome" => "success"}

   Copy to Clipboard Toggle word wrap

2. キーストアにキーペアを作成します。

   構文

   /subsystem=elytron/key-store=<key_store_name>:generate-key-pair(alias=<alias>,algorithm=<key_algorithm>,key-size=<size_of_key>,validity=<validity_in_days>,distinguished-name="<distinguished_name>")

   Copy to Clipboard Toggle word wrap

   例

   /subsystem=elytron/key-store=exampleKeystore:generate-key-pair(alias=localhost,algorithm=RSA,key-size=1024,validity=365,distinguished-name="CN=localhost")
   {"outcome" => "success"}

   Copy to Clipboard Toggle word wrap

3. キーペアをキーストアファイルに永続化します。

   構文

   /subsystem=elytron/key-store=<key_store_name>:store()

   Copy to Clipboard Toggle word wrap

   例

   /subsystem=elytron/key-store=exampleKeystore:store()
   {
       "outcome" => "success",
       "result" => undefined
   }

   Copy to Clipboard Toggle word wrap

手順

1. 既存の filesystem-realm を使用し、キーペアで署名することにより、整合性をサポートする filesystem-realm を作成します。

   既存の filesystem-realm に整合性サポートを追加する場合は、次のコマンドの --output-location および --realm-name オプションを省略してください。--output-location および --realm-name オプションを指定すると、既存の filesystem-realm が更新されず、整合性チェックを備えた新しい filesystem-realm が作成されます。

   構文

   $ JBOSS_HOME/bin/elytron-tool.sh filesystem-realm-integrity  --input-location <path_to_existing_filesystem_realm> --keystore <path_to_key_store_file> --password <keystore_password> --key-pair <key_pair_alias> --output-location <path_for_new_filesystem_realm> --realm-name <name_of_new_filesystem_realm>

   Copy to Clipboard Toggle word wrap

   例

   $ JBOSS_HOME/bin/elytron-tool.sh filesystem-realm-integrity --input-location JBOSS_HOME/standalone/configuration/fs-realm-users/ --keystore JBOSS_HOME/standalone/configuration/keystore --password secret --key-pair localhost --output-location JBOSS_HOME/standalone/configuration/fs-realm-users --realm-name exampleRealmWithIntegrity

   Copy to Clipboard Toggle word wrap

   出力例

   Creating filesystem realm with integrity verification for: JBOSS_HOME/standalone/configuration/fs-realm-users

   Copy to Clipboard Toggle word wrap

   WildFly Elytron コマンド filesystem-realm-integrity によって、--output-location 引数で指定された filesystem-realm が作成されます。また、filesystem-realm のルートに CLI スクリプトが作成されます。このスクリプトを使用すると、elytron サブシステムに filesystem-realm リソースを追加できます。

   ヒント

   --summary オプションを使用して、コマンド実行の概要を表示します。

2. 生成された CLI スクリプトを使用して、elytron サブシステムに filesystem-realm リソースを追加します。

   構文

   $ JBOSS_HOME/bin/jboss-cli.sh --connect --file=<target_filesystem_realm_directory>/<target_filesystem_realm_name>.cli

   Copy to Clipboard Toggle word wrap

   例

   $ JBOSS_HOME/bin/jboss-cli.sh --connect --file=JBOSS_HOME/standalone/configuration/fs-realm-users/exampleRealmWithIntegrity.cli

   Copy to Clipboard Toggle word wrap

手順

1. mvn コマンドを使用して Maven プロジェクトを設定します。このコマンドは、プロジェクトのディレクトリー構造と pom.xml 設定ファイルを作成します。

   構文

   $ mvn archetype:generate \
   -DgroupId=${group-to-which-your-application-belongs} \
   -DartifactId=${name-of-your-application} \
   -DarchetypeGroupId=org.apache.maven.archetypes \
   -DarchetypeArtifactId=maven-archetype-webapp \
   -DinteractiveMode=false

   Copy to Clipboard Toggle word wrap

   例

   $ mvn archetype:generate \
   -DgroupId=com.example.app \
   -DartifactId=simple-webapp-example \
   -DarchetypeGroupId=org.apache.maven.archetypes \
   -DarchetypeArtifactId=maven-archetype-webapp \
   -DinteractiveMode=false

   Copy to Clipboard Toggle word wrap

2. アプリケーションのルートディレクトリーに移動します。

   構文

   $ cd <name-of-your-application>

   Copy to Clipboard Toggle word wrap

   例

   $ cd simple-webapp-example

   Copy to Clipboard Toggle word wrap

3. 生成された pom.xml ファイルの内容を、以下のテキストに置き換えます。

   <?xml version="1.0" encoding="UTF-8"?>
   
   <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
   
     <groupId>com.example.app</groupId>
     <artifactId>simple-webapp-example</artifactId>
     <version>1.0-SNAPSHOT</version>
     <packaging>war</packaging>
   
     <name>simple-webapp-example Maven Webapp</name>
     <!-- FIXME change it to the project's website -->
     <url>http://www.example.com</url>
   
       <properties>
           <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
           <maven.compiler.source>11</maven.compiler.source>
           <maven.compiler.target>11</maven.compiler.target>
           <version.maven.war.plugin>3.4.0</version.maven.war.plugin>
       </properties>
   
       <dependencies>
           <dependency>
               <groupId>jakarta.servlet</groupId>
               <artifactId>jakarta.servlet-api</artifactId>
               <version>6.0.0</version>
               <scope>provided</scope>
           </dependency>
       </dependencies>
   
       <build>
           <finalName>${project.artifactId}</finalName>
           <plugins>
               <plugin>
                   <groupId>org.apache.maven.plugins</groupId>
                   <artifactId>maven-war-plugin</artifactId>
                   <version>${version.maven.war.plugin}</version>
               </plugin>
               <plugin>
                   <groupId>org.wildfly.plugins</groupId>
                   <artifactId>wildfly-maven-plugin</artifactId>
                   <version>4.2.2.Final</version>
               </plugin>
           </plugins>
       </build>
   </project>

   Copy to Clipboard Toggle word wrap

手順

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

   構文

   $ mkdir -p src/main/java/<path_based_on_artifactID>

   Copy to Clipboard Toggle word wrap

   例

   $ mkdir -p src/main/java/com/example/app

   Copy to Clipboard Toggle word wrap

2. 新しいディレクトリーに移動します。

   構文

   $ cd src/main/java/<path_based_on_artifactID>

   Copy to Clipboard Toggle word wrap

   例

   $ cd src/main/java/com/example/app

   Copy to Clipboard Toggle word wrap

3. 以下の内容で SecuredServlet.java ファイルを作成します。

   package com.example.app;
   
   import java.io.IOException;
   import java.io.PrintWriter;
   import java.security.Principal;
   
   import jakarta.servlet.ServletException;
   import jakarta.servlet.annotation.WebServlet;
   import jakarta.servlet.http.HttpServlet;
   import jakarta.servlet.http.HttpServletRequest;
   import jakarta.servlet.http.HttpServletResponse;
   
   /**
    * A simple secured HTTP servlet. It returns the user name of obtained
    * from the logged-in user's Principal. If there is no logged-in user,
    * it returns the text "NO AUTHENTICATED USER".
    */
   
   @WebServlet("/secured")
   public class SecuredServlet extends HttpServlet {
   
       @Override
       protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
           try (PrintWriter writer = resp.getWriter()) {
               writer.println("<html>");
               writer.println("  <head><title>Secured Servlet</title></head>");
               writer.println("  <body>");
               writer.println("    <h1>Secured Servlet</h1>");
               writer.println("    <p>");
               writer.print(" Current Principal '");
               Principal user = req.getUserPrincipal();
               writer.print(user != null ? user.getName() : "NO AUTHENTICATED USER");
               writer.print("'");
               writer.println("    </p>");
               writer.println("  </body>");
               writer.println("</html>");
           }
       }
   
   }

   Copy to Clipboard Toggle word wrap

4. アプリケーションのルートディレクトリーで、次のコマンドを使用してアプリケーションをコンパイルします。

   $ mvn package
   ...
   [INFO] ------------------------------------------------------------------------
   [INFO] BUILD SUCCESS
   [INFO] ------------------------------------------------------------------------
   [INFO] Total time: 1.015 s
   [INFO] Finished at: 2022-04-28T17:48:53+05:30
   [INFO] ------------------------------------------------------------------------

   Copy to Clipboard Toggle word wrap

5. アプリケーションをデプロイします。

   $ mvn wildfly:deploy

   Copy to Clipboard Toggle word wrap