使用 JAX-RS 和 Jersey 进行基于 REST 令牌的身份验证的最佳实践

Question

我正在寻找一种在泽西岛启用基于令牌的身份验证的方法。 我尽量不使用任何特定的框架。 那可能吗？

我的计划是：一个用户注册我的 Web 服务，我的 Web 服务生成一个令牌，将其发送给客户端，客户端将保留它。 然后，对于每个请求，客户端将发送令牌而不是用户名和密码。

我正在考虑为每个请求和@PreAuthorize("hasRole('ROLE')")使用自定义过滤器，但我只是认为这会导致对数据库的大量请求以检查令牌是否有效。

或者不创建过滤器并在每个请求中放置一个参数令牌？ 这样每个 API 首先检查令牌，然后执行某些操作以检索资源。

Answer 1

基于令牌的身份验证如何工作

在基于令牌的身份验证中，客户端将硬凭证（例如用户名和密码）交换为一段名为token的数据。 对于每个请求，客户端不会发送硬凭证，而是将令牌发送到服务器以执行身份验证然后授权。

简而言之，基于令牌的身份验证方案遵循以下步骤：

1. 客户端将其凭据（用户名和密码）发送到服务器。
2. 服务器验证凭据，如果它们有效，则为用户生成令牌。
3. 服务器将先前生成的令牌与用户标识符和到期日期一起存储在某个存储器中。
4. 服务器将生成的令牌发送给客户端。
5. 客户端在每个请求中将令牌发送到服务器。
6. 服务器在每个请求中从传入请求中提取令牌。 使用令牌，服务器查找用户详细信息以执行身份验证。
   • 如果令牌有效，则服务器接受请求。
   • 如果令牌无效，则服务器拒绝请求。
7. 一旦执行了身份验证，服务器就会执行授权。
8. 服务器可以提供一个端点来刷新令牌。

您可以使用 JAX-RS 2.0（Jersey、RESTEasy 和 Apache CXF）做什么

此解决方案仅使用 JAX-RS 2.0 API，避免使用任何特定于供应商的解决方案。 因此，它应该适用于 JAX-RS 2.0 实现，例如Jersey 、 RESTEasy和Apache CXF 。

值得一提的是，如果您正在使用基于令牌的身份验证，则您不依赖于由 servlet 容器提供并通过应用程序的web.xml描述符可配置的标准 Java EE Web 应用程序安全机制。 这是自定义身份验证。

使用用户名和密码对用户进行身份验证并发出令牌

创建一个 JAX-RS 资源方法，用于接收和验证凭据（用户名和密码）并为用户发出令牌：

@Path("/authentication")
public class AuthenticationEndpoint {

    @POST
    @Produces(MediaType.APPLICATION_JSON)
    @Consumes(MediaType.APPLICATION_FORM_URLENCODED)
    public Response authenticateUser(@FormParam("username") String username, 
                                     @FormParam("password") String password) {

        try {

            // Authenticate the user using the credentials provided
            authenticate(username, password);

            // Issue a token for the user
            String token = issueToken(username);

            // Return the token on the response
            return Response.ok(token).build();

        } catch (Exception e) {
            return Response.status(Response.Status.FORBIDDEN).build();
        }      
    }

    private void authenticate(String username, String password) throws Exception {
        // Authenticate against a database, LDAP, file or whatever
        // Throw an Exception if the credentials are invalid
    }

    private String issueToken(String username) {
        // Issue a token (can be a random String persisted to a database or a JWT token)
        // The issued token must be associated to a user
        // Return the issued token
    }
}

如果在验证凭据时抛出任何异常，将返回状态为403 （禁止）的响应。

如果凭据成功验证，则将返回状态为200 (OK) 的响应，并且发出的令牌将在响应负载中发送到客户端。 客户端必须在每个请求中将令牌发送到服务器。

使用application/x-www-form-urlencoded ，客户端必须在请求负载中以以下格式发送凭据：

username=admin&password=123456

可以将用户名和密码包装到一个类中，而不是表单参数：

public class Credentials implements Serializable {

    private String username;
    private String password;
    
    // Getters and setters omitted
}

然后将其作为 JSON 使用：

@POST
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
public Response authenticateUser(Credentials credentials) {

    String username = credentials.getUsername();
    String password = credentials.getPassword();
    
    // Authenticate the user, issue a token and return a response
}

使用这种方法，客户端必须在请求的有效负载中以以下格式发送凭据：

{
  "username": "admin",
  "password": "123456"
}

从请求中提取令牌并验证它

客户端应在请求的标准 HTTP Authorization标头中发送令牌。 例如：

Authorization: Bearer <token-goes-here>

标准 HTTP 标头的名称很不幸，因为它携带身份验证信息，而不是授权。 但是，它是用于向服务器发送凭据的标准 HTTP 标头。

JAX-RS 提供了@NameBinding ，这是一个元注释，用于创建其他注释以将过滤器和拦截器绑定到资源类和方法。 定义一个@Secured注解如下：

@NameBinding
@Retention(RUNTIME)
@Target({TYPE, METHOD})
public @interface Secured { }

上面定义的名称绑定注解将用于装饰过滤器类，它实现了ContainerRequestFilter ，允许您在请求被资源方法处理之前拦截请求。 ContainerRequestContext可用于访问 HTTP 请求标头，然后提取令牌：

@Secured
@Provider
@Priority(Priorities.AUTHENTICATION)
public class AuthenticationFilter implements ContainerRequestFilter {

    private static final String REALM = "example";
    private static final String AUTHENTICATION_SCHEME = "Bearer";

    @Override
    public void filter(ContainerRequestContext requestContext) throws IOException {

        // Get the Authorization header from the request
        String authorizationHeader =
                requestContext.getHeaderString(HttpHeaders.AUTHORIZATION);

        // Validate the Authorization header
        if (!isTokenBasedAuthentication(authorizationHeader)) {
            abortWithUnauthorized(requestContext);
            return;
        }

        // Extract the token from the Authorization header
        String token = authorizationHeader
                            .substring(AUTHENTICATION_SCHEME.length()).trim();

        try {

            // Validate the token
            validateToken(token);

        } catch (Exception e) {
            abortWithUnauthorized(requestContext);
        }
    }

    private boolean isTokenBasedAuthentication(String authorizationHeader) {

        // Check if the Authorization header is valid
        // It must not be null and must be prefixed with "Bearer" plus a whitespace
        // The authentication scheme comparison must be case-insensitive
        return authorizationHeader != null && authorizationHeader.toLowerCase()
                    .startsWith(AUTHENTICATION_SCHEME.toLowerCase() + " ");
    }

    private void abortWithUnauthorized(ContainerRequestContext requestContext) {

        // Abort the filter chain with a 401 status code response
        // The WWW-Authenticate header is sent along with the response
        requestContext.abortWith(
                Response.status(Response.Status.UNAUTHORIZED)
                        .header(HttpHeaders.WWW_AUTHENTICATE, 
                                AUTHENTICATION_SCHEME + " realm=\"" + REALM + "\"")
                        .build());
    }

    private void validateToken(String token) throws Exception {
        // Check if the token was issued by the server and if it's not expired
        // Throw an Exception if the token is invalid
    }
}

如果令牌验证期间出现任何问题，将返回状态为401 （未授权）的响应。 否则，请求将继续执行资源方法。

保护您的 REST 端点

要将身份验证过滤器绑定到资源方法或资源类，请使用上面创建的@Secured批注对其进行批注。 对于被注解的方法和/或类，过滤器将被执行。 这意味着只有在使用有效令牌执行请求时才能到达此类端点。

如果某些方法或类不需要身份验证，请不要对其进行注释：

@Path("/example")
public class ExampleResource {

    @GET
    @Path("{id}")
    @Produces(MediaType.APPLICATION_JSON)
    public Response myUnsecuredMethod(@PathParam("id") Long id) {
        // This method is not annotated with @Secured
        // The authentication filter won't be executed before invoking this method
        ...
    }

    @DELETE
    @Secured
    @Path("{id}")
    @Produces(MediaType.APPLICATION_JSON)
    public Response mySecuredMethod(@PathParam("id") Long id) {
        // This method is annotated with @Secured
        // The authentication filter will be executed before invoking this method
        // The HTTP request must be performed with a valid token
        ...
    }
}

在上面显示的示例中，过滤器将仅针对mySecuredMethod(Long)方法执行，因为它使用@Secured注释。

识别当前用户

您很可能需要知道再次向您的 REST API 执行请求的用户。 可以使用以下方法来实现它：

覆盖当前请求的安全上下文

在您的ContainerRequestFilter.filter(ContainerRequestContext)方法中，可以为当前请求设置一个新的SecurityContext实例。 然后覆盖SecurityContext.getUserPrincipal() ，返回一个Principal实例：

final SecurityContext currentSecurityContext = requestContext.getSecurityContext();
requestContext.setSecurityContext(new SecurityContext() {

        @Override
        public Principal getUserPrincipal() {
            return () -> username;
        }

    @Override
    public boolean isUserInRole(String role) {
        return true;
    }

    @Override
    public boolean isSecure() {
        return currentSecurityContext.isSecure();
    }

    @Override
    public String getAuthenticationScheme() {
        return AUTHENTICATION_SCHEME;
    }
});

使用令牌查找用户标识符（用户名），这将是Principal的名称。

在任何 JAX-RS 资源类中注入SecurityContext ：

@Context
SecurityContext securityContext;

同样可以在 JAX-RS 资源方法中完成：

@GET
@Secured
@Path("{id}")
@Produces(MediaType.APPLICATION_JSON)
public Response myMethod(@PathParam("id") Long id, 
                         @Context SecurityContext securityContext) {
    ...
}

然后得到Principal ：

Principal principal = securityContext.getUserPrincipal();
String username = principal.getName();

使用 CDI（上下文和依赖注入）

如果出于某种原因，您不想覆盖SecurityContext ，您可以使用 CDI（上下文和依赖注入），它提供了有用的功能，例如事件和生产者。

创建 CDI 限定符：

@Qualifier
@Retention(RUNTIME)
@Target({ METHOD, FIELD, PARAMETER })
public @interface AuthenticatedUser { }

在上面创建的AuthenticationFilter ，注入一个用@AuthenticatedUser注释的Event ：

@Inject
@AuthenticatedUser
Event<String> userAuthenticatedEvent;

如果身份验证成功，则触发传递用户名作为参数的事件（请记住，令牌是为用户发出的，令牌将用于查找用户标识符）：

userAuthenticatedEvent.fire(username);

很可能在您的应用程序中有一个代表用户的类。 让我们称这个类为User 。

创建一个 CDI bean 来处理身份验证事件，找到具有对应用户名的User实例并将其分配给authenticatedUser生产者字段：

@RequestScoped
public class AuthenticatedUserProducer {

    @Produces
    @RequestScoped
    @AuthenticatedUser
    private User authenticatedUser;
    
    public void handleAuthenticationEvent(@Observes @AuthenticatedUser String username) {
        this.authenticatedUser = findUser(username);
    }

    private User findUser(String username) {
        // Hit the the database or a service to find a user by its username and return it
        // Return the User instance
    }
}

authenticatedUser字段生成一个User实例，该实例可以注入到容器管理的 bean 中，例如 JAX-RS 服务、CDI bean、servlet 和 EJB。 使用下面这段代码注入一个User实例（其实就是一个 CDI 代理）：

@Inject
@AuthenticatedUser
User authenticatedUser;

请注意，CDI @Produces注释是从JAX-RS不同的@Produces注解：

• CDI： javax.enterprise.inject.Produces
• JAX-RS： javax.ws.rs.Produces

确保在AuthenticatedUserProducer bean 中使用 CDI @Produces注释。

这里的关键是用@RequestScoped注释的 bean，允许您在过滤器和 bean 之间共享数据。 如果您不想使用事件，您可以修改过滤器以将经过身份验证的用户存储在请求范围的 bean 中，然后从您的 JAX-RS 资源类中读取它。

与覆盖SecurityContext的方法相比，CDI 方法允许您从 JAX-RS 资源和提供程序以外的 bean 获取经过身份验证的用户。

支持基于角色的授权

有关如何支持基于角色的授权的详细信息，请参阅我的其他答案。

发行代币

令牌可以是：

• 不透明：除了值本身之外不显示任何细节（如随机字符串）
• 自包含：包含有关令牌本身的详细信息（如 JWT）。

请参阅下面的详细信息：

随机字符串作为标记

可以通过生成随机字符串并将其与用户标识符和到期日期一起保存到数据库来发布令牌。 可以在此处查看如何在 Java 中生成随机字符串的一个很好的示例。 您还可以使用：

Random random = new SecureRandom();
String token = new BigInteger(130, random).toString(32);

JWT（JSON 网络令牌）

JWT（JSON Web Token）是一种用于在两方之间安全地表示声明的标准方法，由RFC 7519定义。

它是一个自包含的令牌，它使您能够在claim 中存储详细信息。 这些声明存储在令牌有效负载中，该有效负载是编码为Base64的 JSON。 以下是在RFC 7519 中注册的一些声明及其含义（阅读完整的 RFC 以获取更多详细信息）：

• iss ：发行令牌的委托人。
• sub ：作为 JWT 主题的主体。
• exp ：令牌的到期日期。
• nbf ：开始接受令牌进行处理的时间。
• iat ：发行令牌的时间。
• jti ：令牌的唯一标识符。

请注意，您不得在令牌中存储敏感数据，例如密码。

客户端可以读取有效负载，并且可以通过在服务器上验证其签名来轻松检查令牌的完整性。 签名是防止令牌被篡改的原因。

如果您不需要跟踪 JWT 令牌，则不需要保留 JWT 令牌。 尽管如此，通过持久化令牌，您将有可能使它们的访问无效和撤销。 为了跟踪 JWT 令牌，您可以将令牌标识符（ jti声明）与一些其他详细信息（例如您为其颁发令牌的用户、到期日期等）一起jti在服务器上，而不是将整个令牌保存在服务器上。

持久化令牌时，请始终考虑删除旧令牌，以防止数据库无限增长。

使用 JWT

有一些 Java 库可以发布和验证 JWT 令牌，例如：

• jjwt
• java-jwt
• 何塞4j

要找到与 JWT 一起使用的其他一些很好的资源，请查看http://jwt.io 。

使用 JWT 处理令牌撤销

如果您想撤销令牌，则必须对其进行跟踪。 您不需要在服务器端存储整个令牌，只需存储令牌标识符（必须是唯一的）和一些元数据（如果需要）。 对于令牌标识符，您可以使用UUID 。

jti声明应该用于在令牌上存储令牌标识符。 验证令牌时，请根据服务器端的令牌标识符检查jti声明的值，确保它没有被撤销。

出于安全考虑，当用户更改密码时，撤销用户的所有令牌。

附加信息

• 您决定使用哪种类型的身份验证并不重要。 始终在 HTTPS 连接的顶部执行此操作以防止中间人攻击。
• 有关令牌的更多信息，请查看 Information Security 的这个问题。
• 在本文中，您将找到一些有关基于令牌的身份验证的有用信息。

Answer 2

^{这个答案是关于授权的，它是我之前关于身份验证的答案的补充}

^{为什么是另一个答案？ 我试图通过添加有关如何支持 JSR-250 注释的详细信息来扩展我之前的答案。 然而原来的答案变得太长，超过了30,000个字符的最大长度。 所以我将整个授权细节移到了这个答案，让另一个答案专注于执行身份验证和颁发令牌。}

---

使用@Secured注解支持基于角色的授权

除了其他答案中显示的身份验证流程外，REST 端点还支持基于角色的授权。

创建枚举并根据需要定义角色：

public enum Role {
    ROLE_1,
    ROLE_2,
    ROLE_3
}

更改之前创建的@Secured名称绑定注释以支持角色：

@NameBinding
@Retention(RUNTIME)
@Target({TYPE, METHOD})
public @interface Secured {
    Role[] value() default {};
}

然后用@Secured注解资源类和方法来执行授权。 方法注释将覆盖类注释：

@Path("/example")
@Secured({Role.ROLE_1})
public class ExampleResource {

    @GET
    @Path("{id}")
    @Produces(MediaType.APPLICATION_JSON)
    public Response myMethod(@PathParam("id") Long id) {
        // This method is not annotated with @Secured
        // But it's declared within a class annotated with @Secured({Role.ROLE_1})
        // So it only can be executed by the users who have the ROLE_1 role
        ...
    }

    @DELETE
    @Path("{id}")    
    @Produces(MediaType.APPLICATION_JSON)
    @Secured({Role.ROLE_1, Role.ROLE_2})
    public Response myOtherMethod(@PathParam("id") Long id) {
        // This method is annotated with @Secured({Role.ROLE_1, Role.ROLE_2})
        // The method annotation overrides the class annotation
        // So it only can be executed by the users who have the ROLE_1 or ROLE_2 roles
        ...
    }
}

创建具有AUTHORIZATION优先级的过滤器，该过滤器在先前定义的AUTHENTICATION优先级过滤器之后执行。

ResourceInfo可用于获取将处理请求的资源Method和资源Class ，然后从中提取@Secured注解：

@Secured
@Provider
@Priority(Priorities.AUTHORIZATION)
public class AuthorizationFilter implements ContainerRequestFilter {

    @Context
    private ResourceInfo resourceInfo;

    @Override
    public void filter(ContainerRequestContext requestContext) throws IOException {

        // Get the resource class which matches with the requested URL
        // Extract the roles declared by it
        Class<?> resourceClass = resourceInfo.getResourceClass();
        List<Role> classRoles = extractRoles(resourceClass);

        // Get the resource method which matches with the requested URL
        // Extract the roles declared by it
        Method resourceMethod = resourceInfo.getResourceMethod();
        List<Role> methodRoles = extractRoles(resourceMethod);

        try {

            // Check if the user is allowed to execute the method
            // The method annotations override the class annotations
            if (methodRoles.isEmpty()) {
                checkPermissions(classRoles);
            } else {
                checkPermissions(methodRoles);
            }

        } catch (Exception e) {
            requestContext.abortWith(
                Response.status(Response.Status.FORBIDDEN).build());
        }
    }

    // Extract the roles from the annotated element
    private List<Role> extractRoles(AnnotatedElement annotatedElement) {
        if (annotatedElement == null) {
            return new ArrayList<Role>();
        } else {
            Secured secured = annotatedElement.getAnnotation(Secured.class);
            if (secured == null) {
                return new ArrayList<Role>();
            } else {
                Role[] allowedRoles = secured.value();
                return Arrays.asList(allowedRoles);
            }
        }
    }

    private void checkPermissions(List<Role> allowedRoles) throws Exception {
        // Check if the user contains one of the allowed roles
        // Throw an Exception if the user has not permission to execute the method
    }
}

如果用户没有执行操作的权限，则请求会以403 (Forbidden) 中止。

要了解执行请求的用户，请参阅我之前的回答。 您可以从SecurityContext （应该已经在ContainerRequestContext设置）获取它或使用 CDI 注入它，具体取决于您采用的方法。

如果@Secured注释没有声明角色，则可以假设所有经过身份验证的用户都可以访问该端点，而不管用户拥有的角色。

使用 JSR-250 注释支持基于角色的授权

作为在上面显示的@Secured注释中定义角色的@Secured ，您可以考虑 JSR-250 注释，例如@RolesAllowed 、 @PermitAll和@DenyAll 。

JAX-RS 不支持这种开箱即用的注释，但可以通过过滤器来实现。 如果您想支持所有这些，请记住以下几点注意事项：

• @DenyAll上所述方法优先于@RolesAllowed和@PermitAll上的类。
• @RolesAllowed上所述方法优先于@PermitAll上的类。
• @PermitAll上所述方法优先于@RolesAllowed上的类。
• @DenyAll不能附加到类。
• @RolesAllowed上的@RolesAllowed优先于类上的@PermitAll 。

因此，检查 JSR-250 注释的授权过滤器可能如下所示：

@Provider
@Priority(Priorities.AUTHORIZATION)
public class AuthorizationFilter implements ContainerRequestFilter {

    @Context
    private ResourceInfo resourceInfo;

    @Override
    public void filter(ContainerRequestContext requestContext) throws IOException {

        Method method = resourceInfo.getResourceMethod();

        // @DenyAll on the method takes precedence over @RolesAllowed and @PermitAll
        if (method.isAnnotationPresent(DenyAll.class)) {
            refuseRequest();
        }

        // @RolesAllowed on the method takes precedence over @PermitAll
        RolesAllowed rolesAllowed = method.getAnnotation(RolesAllowed.class);
        if (rolesAllowed != null) {
            performAuthorization(rolesAllowed.value(), requestContext);
            return;
        }

        // @PermitAll on the method takes precedence over @RolesAllowed on the class
        if (method.isAnnotationPresent(PermitAll.class)) {
            // Do nothing
            return;
        }

        // @DenyAll can't be attached to classes

        // @RolesAllowed on the class takes precedence over @PermitAll on the class
        rolesAllowed = 
            resourceInfo.getResourceClass().getAnnotation(RolesAllowed.class);
        if (rolesAllowed != null) {
            performAuthorization(rolesAllowed.value(), requestContext);
        }

        // @PermitAll on the class
        if (resourceInfo.getResourceClass().isAnnotationPresent(PermitAll.class)) {
            // Do nothing
            return;
        }

        // Authentication is required for non-annotated methods
        if (!isAuthenticated(requestContext)) {
            refuseRequest();
        }
    }

    /**
     * Perform authorization based on roles.
     *
     * @param rolesAllowed
     * @param requestContext
     */
    private void performAuthorization(String[] rolesAllowed, 
                                      ContainerRequestContext requestContext) {

        if (rolesAllowed.length > 0 && !isAuthenticated(requestContext)) {
            refuseRequest();
        }

        for (final String role : rolesAllowed) {
            if (requestContext.getSecurityContext().isUserInRole(role)) {
                return;
            }
        }

        refuseRequest();
    }

    /**
     * Check if the user is authenticated.
     *
     * @param requestContext
     * @return
     */
    private boolean isAuthenticated(final ContainerRequestContext requestContext) {
        // Return true if the user is authenticated or false otherwise
        // An implementation could be like:
        // return requestContext.getSecurityContext().getUserPrincipal() != null;
    }

    /**
     * Refuse the request.
     */
    private void refuseRequest() {
        throw new AccessDeniedException(
            "You don't have permissions to perform this action.");
    }
}

^{注意：上述实现基于 Jersey RolesAllowedDynamicFeature 。 如果使用 Jersey，则无需编写自己的过滤器，只需使用现有实现即可。}