9.4. 使用 OpenID Connect 开发 JBoss EAP bootable jar 应用程序

流程

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

   Example

   $ mvn archetype:generate \
   -DgroupId=com.example.oidc \
   -DartifactId=simple-oidc-layer-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

   Example

   $ cd simple-oidc-layer-example

   Copy to Clipboard Toggle word wrap

3. 更新生成的 pom.xml 文件，如下所示：

   1. 设置以下软件仓库：

      <repositories>
          <repository>
              <id>jboss</id>
              <url>https://maven.repository.redhat.com/ga</url>
              <snapshots>
                  <enabled>false</enabled>
              </snapshots>
          </repository>
      </repositories>

      Copy to Clipboard Toggle word wrap

   2. 设置以下插件存储库：

      <pluginRepositories>
          <pluginRepository>
              <id>jboss</id>
              <url>https://maven.repository.redhat.com/ga</url>
              <snapshots>
                  <enabled>false</enabled>
              </snapshots>
          </pluginRepository>
      </pluginRepositories>

      Copy to Clipboard Toggle word wrap

   3. 设置以下属性：

      <properties>
          <maven.compiler.source>1.8</maven.compiler.source>
          <maven.compiler.target>1.8</maven.compiler.target>
          <bootable.jar.maven.plugin.version>6.1.2.Final-redhat-00001</bootable.jar.maven.plugin.version>
          <jboss.xp.galleon.feature.pack.version>4.0.0.GA-redhat-00002</jboss.xp.galleon.feature.pack.version>
      </properties>

      Copy to Clipboard Toggle word wrap

   4. 设置以下依赖项：

      <dependencies>
          <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>3.1.0.redhat-1</version>
            <scope>provided</scope>
          </dependency>
      </dependencies>
      
      <dependencyManagement>
          <dependencies>
              <dependency>
                  <groupId>org.jboss.bom</groupId>
                  <artifactId>jboss-eap-jakartaee8</artifactId>
                  <version>7.3.4.GA</version>
                  <type>pom</type>
                  <scope>import</scope>
              </dependency>
              <dependency>
                  <groupId>org.jboss.spec.javax.servlet</groupId>
                  <artifactId>jboss-servlet-api_4.0_spec</artifactId>
                  <scope>provided</scope>
              </dependency>
          </dependencies>
      </dependencyManagement>

      Copy to Clipboard Toggle word wrap

   5. 在 pom.xml 文件的 & lt;build > 项中设置以下构建配置：

      <finalName>${project.artifactId}</finalName>
      <plugins>
          <plugin>
              <groupId>org.wildfly.plugins</groupId>
              <artifactId>wildfly-jar-maven-plugin</artifactId>   

      1

      
              <version>${bootable.jar.maven.plugin.version}</version>
              <configuration>
                  <feature-pack-location>org.jboss.eap:wildfly-galleon-pack:${jboss.xp.galleon.feature.pack.version}</feature-pack-location>
                  <layers>
                      <layer>jaxrs-server</layer>
                      <layer>elytron-oidc-client</layer>    

      2

      
                  </layers>
                  <context-root>false</context-root>   

      3

      
              </configuration>
              <executions>
                  <execution>
                      <goals>
                          <goal>package</goal>
                      </goals>
                  </execution>
              </executions>
          </plugin>
      </plugins>

      Copy to Clipboard Toggle word wrap

      1

      JBoss EAP Maven 插件，将应用程序构建为可引导 JAR

      2

      elytron-oidc-client 层提供了一个原生 OpenID Connect (OIDC)客户端来与外部 OpenID 供应商连接。

      3

      在 simple-oidc-layer-example 资源路径中注册应用程序。然后，servlet 位于 URL http://server-url/application_name/servlet_path，例如： http://localhost:8080/simple-oidc-layer-example/secured。默认情况下，应用程序 WAR 文件在 root-context 路径下注册，如 http://server-url/servlet_path，例如： http://localhost:8080/secured。

   6. 在 pom.xml 文件的 < build > 元素中设置应用程序名称，如 "simple-oidc-layer-example"。

      <finalName>simple-oidc-layer-example</finalName>

      Copy to Clipboard Toggle word wrap

流程

1. 创建一个用于存储 Java 文件的目录。

   语法

   $ mkdir -p <application_root>/src/main/java/com/example/oidc

   Copy to Clipboard Toggle word wrap

   Example

   $ mkdir -p simple-oidc-layer-example/src/main/java/com/example/oidc

   Copy to Clipboard Toggle word wrap

2. 前往新目录。

   语法

   $ cd <application_root>/src/main/java/com/example/oidc

   Copy to Clipboard Toggle word wrap

   Example

   $ cd simple-oidc-layer-example/src/main/java/com/example/oidc

   Copy to Clipboard Toggle word wrap

3. 使用以下内容创建 servlet "SecuredServlet.java"：

   package com.example.oidc;
   
   import java.io.IOException;
   import java.io.PrintWriter;
   import java.security.Principal;
   
   import javax.servlet.ServletException;
   import javax.servlet.annotation.WebServlet;
   import javax.servlet.http.HttpServlet;
   import javax.servlet.http.HttpServletRequest;
   import javax.servlet.http.HttpServletResponse;
   
   /**
    * A simple secured HTTP servlet.
    *
    */
   @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. 在应用的 WEB-INF 目录中的部署描述符 web.xml 文件中添加访问应用程序的安全规则。

   <?xml version="1.0" encoding="UTF-8"?>
   
   <web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
      metadata-complete="false">
   
       <security-constraint>
           <web-resource-collection>
               <web-resource-name>secured</web-resource-name>
               <url-pattern>/secured</url-pattern>
           </web-resource-collection>
           <auth-constraint>
               <role-name>*</role-name>
           </auth-constraint>
       </security-constraint>
   
       <security-role>
           <role-name>*</role-name>
       </security-role>
   </web-app>

   Copy to Clipboard Toggle word wrap

5. 要使用 OpenID Connect 保护应用，可以更新部署配置或配置 elytron-oidc-client 子系统。

   注意

   如果您在部署配置和 elytron-oidc-client 子系统中配置 OpenID Connect，则 elytron-oidc-client 子系统 secure-deployment 属性中的配置优先于应用部署描述符中的配置。

   • 更新部署配置：

     1. 在 WEB-INF 目录中创建 oidc.json 文件，如下所示：

        {
          "provider-url" : "http://localhost:8180/auth/realms/example_realm",
          "ssl-required": "external",
          "client-id": "my_jbeap",
          "public-client": true,
          "confidential-port": 0
        }

        Copy to Clipboard Toggle word wrap

     2. 使用以下文本更新部署描述符 web.xml 文件，以声明此应用程序使用 OIDC：

        <login-config>
            <auth-method>OIDC</auth-method>
        </login-config>

        Copy to Clipboard Toggle word wrap

   • 配置 elytron-oidc-client 子系统：

     1. 创建一个目录，将 CLI 脚本存储在应用程序根目录中：

        语法

        $ mkdir <application_root>/<cli_script_directory>

        Copy to Clipboard Toggle word wrap

        Example

        $ mkdir simple-oidc-layer-example/scripts/

        Copy to Clipboard Toggle word wrap

        您可以在 Maven 能够访问应用程序根目录的任意位置创建该目录。

     2. 创建包含以下内容的 CLI 脚本，如 configure-oidc.cli ：

        /subsystem=elytron-oidc-client/secure-deployment=simple-oidc-layer-example.war:add(client-id=my_jbeap,provider-url=http://localhost:8180/auth/realms/example_realm,public-client=true,ssl-required=external)

        Copy to Clipboard Toggle word wrap

        subsystem 命令定义 simple-oidc-layer-example.war 资源，作为在 elytron-oidc-client 子系统中保护的部署。

     3. 在项目 pom.xml 文件中，将以下配置提取添加到现有插件 < configuration> 元素中：

        <cli-sessions>
            <cli-session>
                <script-files>
                    <script>scripts/configure-oidc.cli</script>
                </script-files>
            </cli-session>
        </cli-sessions>

        Copy to Clipboard Toggle word wrap

6. 在应用程序根目录中，使用以下命令编译应用程序：

   $ mvn package

   Copy to Clipboard Toggle word wrap

7. 使用以下命令部署可引导 jar 应用程序：

   语法

   $ java -jar <application_root>/target/simple-oidc-layer-example-bootable.jar

   Copy to Clipboard Toggle word wrap

   Example

   $ java -jar simple-oidc-layer-example/target/simple-oidc-layer-example-bootable.jar

   Copy to Clipboard Toggle word wrap

   这将启动 JBoss EAP 并部署应用程序。

验证

1. 在一个浏览器中，导航到 http://localhost:8080/simple-oidc-layer-example/secured。

2. 使用您的凭证登录。例如：

   username: jane_doe
   password: janedoep@$$

   Copy to Clipboard Toggle word wrap

   您将获得以下输出：

   Secured Servlet
   Current Principal '5cb0c4ca-0477-44c3-bdef-04db04d7e39d'

   Copy to Clipboard Toggle word wrap

   现在，您可以使用您在 Red Hat Single Sign-On 中配置的凭证作为 OpenID 供应商登录到应用程序。

流程

1. 使用以下文本更新部署描述符 web.xml 文件：

   语法

   <security-constraint>
       ...
       <auth-constraint>
           <role-name><allowed_role></role-name>
       </auth-constraint>
   </security-constraint>

   Copy to Clipboard Toggle word wrap

   Example

   <security-constraint>
       ...
       <auth-constraint>
           <role-name>example_role</role-name> 

   1

   
       </auth-constraint>
   </security-constraint>

   Copy to Clipboard Toggle word wrap

   1

   仅允许具有 example_role 角色的用户访问您的应用。

2. 在应用程序根目录中，使用以下命令重新编译应用程序：

   $ mvn package

   Copy to Clipboard Toggle word wrap

3. 部署应用。

   $ java -jar simple-oidc-layer-example/target/simple-oidc-layer-example-bootable.jar

   Copy to Clipboard Toggle word wrap

   这将启动 JBoss EAP 并部署应用程序。

验证

1. 在浏览器中，导航到 \localhost:8080/simple-oidc-layer-example/secured。

2. 使用您的凭证登录。例如：

   username: jane_doe
   password: janedoep@$$

   Copy to Clipboard Toggle word wrap

   您将获得以下输出：

   Forbidden

   Copy to Clipboard Toggle word wrap

   由于您尚未将所需的角色分配给用户 "jane_doe，" jane_doe 无法登录到您的应用程序。只有具有所需角色的用户才能登录。

流程

1. 登录到位于 http://localhost:<port>/auth/ 的 admin 控制台。例如： http://localhost:8180/auth/。
2. 单击用于与 JBoss EAP 连接的域。例如： example_realm。
3. 单击 Clients，然后单击您为 JBoss EAP 配置的 client-name。例如，my_jbeap。
4. 单击 Roles，然后单击 Add Role。
5. 输入角色名称，如 example_role，然后单击 Save。这是您在 JBoss EAP 中配置用于授权的角色名称。
6. 单击 Users，然后查看所有用户。
7. 点 ID 来分配您创建的角色。例如，单击 jane_doe 的 ID。
8. 点 Role Mappings。在 Client Roles 字段中，选择您为 JBoss EAP 配置的 client-name。例如，my_jbeap。
9. 在 Available Roles 中，选择要分配的角色。例如，example_role。单击 Add selected。

验证

1. 在浏览器中，导航到应用 URL。

2. 使用您的凭证登录。例如：

   username: jane_doe
   password: janedoep@$$

   Copy to Clipboard Toggle word wrap

   您将获得以下输出：

   Secured Servlet
   Current Principal '5cb0c4ca-0477-44c3-bdef-04db04d7e39d'

   Copy to Clipboard Toggle word wrap

   具有所需角色的用户可以登录到您的应用程序。