8.14. 使用 CLI 脚本为可引导 JAR 启用 HTTP 身份验证
您可以使用 CLI 脚本为可引导 JAR 启用 HTTP 身份验证。此脚本将安全域和安全域添加到您的服务器。
先决条件
-
您已检查了最新的 Maven 插件版本,如
MAVEN_PLUGIN_VERSION.X.GA.Final-redhat-00001
,其中 MAVEN_PLUGIN_VERSION 是主版本,X 是 microversion。请参阅 /ga/org/wildfly/plugins/wildfly-jar-maven-plugin 的索引。 -
您已检查了最新的 Galleon 功能包版本,如
3.0.X.GA-redhat-BUILD_NUMBER
,其中 X 是 JBoss EAP XP 和 BUILD_NUMBER 的微版本,是 Galleon 功能包的构建号。X 和 BUILD_NUMBER 在 JBoss EAP XP 3.0.0 产品生命周期中都可能会演变。请参阅 /ga/org/jboss/eap/wildfly-galleon-pack 的索引。 您已创建了 Maven 项目,设置父依赖项,并添加了用于创建需要 HTTP 身份验证的应用的依赖关系。请参阅 创建可引导 JAR Maven 项目。
重要在设置 Maven 项目时,您必须在 Maven archetype 配置中指定 HTTP 身份验证值。例如:
$ mvn archetype:generate \ -DgroupId=com.example.auth \ -DartifactId=authentication \ -DarchetypeGroupId=org.apache.maven.archetypes \ -DarchetypeArtifactId=maven-archetype-webapp \ -DinteractiveMode=false cd authentication
注意流程中显示的示例指定以下属性:
-
用于 Maven 插件版本的
${bootable.jar.maven.plugin.version}
。 -
Gall
eon 功能包版本的 ${JBoss.xp.galleon.feature.pack.version}
。
您必须在项目中设置这些属性。例如:
<properties> <bootable.jar.maven.plugin.version>4.0.3.Final-redhat-00001</bootable.jar.maven.plugin.version> <jboss.xp.galleon.feature.pack.version>3.0.0.GA-redhat-00001</jboss.xp.galleon.feature.pack.version> </properties>
-
用于 Maven 插件版本的
流程
将以下内容添加到
pom.xml
文件的<build> 元素
中。您必须指定任何 Maven 插件的最新版本,以及org.jboss.eap:wildfly-galleon-pack
Galleon 功能包的最新版本。例如:<plugins> <plugin> <groupId>org.wildfly.plugins</groupId> <artifactId>wildfly-jar-maven-plugin</artifactId> <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>datasources-web-server</layer> </layers> </configuration> <executions> <execution> <goals> <goal>package</goal> </goals> </execution> </executions> </plugin> </plugins>
示例显示了包含
elytron
子系统的datasources-web-server
Galleon 层。更新
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>
创建用于存储 Java 文件的目录:
$ mkdir -p APPLICATION_ROOT/src/main/java/com/example/authentication/
其中
APPLICATION_ROOT
是 Maven 项目的根目录。创建包含以下内容的 Java 文件
TestServlet.java
,并将文件保存到APPLICATION_ROOT/src/main/java/com/example/authentication/
目录中:package com.example.authentication; import javax.servlet.annotation.HttpMethodConstraint; import javax.servlet.annotation.ServletSecurity; import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.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(); } }
创建 CLI 脚本,如
authentication.cli
,并将它保存在可引导 JAR 的可访问目录中,如APPLICATION_ROOT/scripts
目录。该脚本必须包含以下命令:/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)
将以下配置提取添加到插件
<configuration>
元素中:<cli-sessions> <cli-session> <script-files> <script>scripts/authentication.cli</script> </script-files> </cli-session> </cli-sessions>
本例显示了
authentication.cli
CLI 脚本,该脚本会将默认undertow
安全域配置为为服务器定义的安全域。在 Maven 项目的根目录中创建一个目录,以存储 JBoss EAP JAR Maven 插件添加到可引导 JAR 的属性文件:
$ mkdir -p APPLICATION_ROOT/extra-content/standalone/configuration/
其中
APPLICATION_ROOT
是含有应用的pom.xml
配置文件的目录。此目录存储
可引导用户.properties 和可
引导组.properties
文件等文件。bootable-users.properties
文件包含以下内容:testuser=bootable_password
bootable-groups.properties
文件包含以下内容:testuser=Users
将以下
extra-content-content-dirs
元素添加到现有的<configuration>
元素中:<extra-server-content-dirs> <extra-content>extra-content</extra-content> </extra-server-content-dirs>
extra-content
目录包含属性文件。将应用打包为可引导 JAR。
$ mvn package
启动应用程序:
mvn wildfly-jar:run
调用 servlet,但不要指定凭证:
curl -v http://localhost:8080/hello
预期输出:
HTTP/1.1 401 Unauthorized ... WWW-Authenticate: Basic realm="Example Realm"
调用服务器并指定您的凭据。例如:
$ curl -v -u testuser:bootable_password http://localhost:8080/hello
返回 HTTP 200 状态,表示已为您的可引导 JAR 启用了 HTTP 身份验证。例如:
HTTP/1.1 200 OK .... Hello testuser
其他资源
-
有关为
undertow
安全域 启用 HTTP 身份验证的详情,请参考 如何配置服务器安全性的 CLI Security 命令为应用程序 启用 HTTP 身份验证。