top.dcenter.ums.security.jwt.bearer.UmsBearerTokenAuthenticationEntryPoint Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ums-jwt Show documentation

ums-jwt feature: JWT 创建(通过接口自定义 Claims, 通过配置设置算法等), 校验(通过接口自定义校验规则), 刷新(自动刷新, 直接拒绝, 通过 refreshToken 刷新), 刷新的 JWT 使旧 JWT 失效引发的并发访问问题及黑名单.

There is a newer version: 2.2.42

Show newest version

/*
 * MIT License
 * Copyright (c) 2020-2029 YongWu zheng (dcenter.top and gitee.com/pcore and github.com/ZeroOrInfinity)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package top.dcenter.ums.security.jwt.bearer;

import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.security.core.AuthenticationException;
import org.springframework.security.web.AuthenticationEntryPoint;
import org.springframework.util.StringUtils;
import top.dcenter.ums.security.common.consts.SecurityConstants;
import top.dcenter.ums.security.common.enums.ErrorCodeEnum;
import top.dcenter.ums.security.common.utils.IpUtil;
import top.dcenter.ums.security.core.mdc.utils.MdcUtil;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

import static org.springframework.util.StringUtils.hasText;
import static top.dcenter.ums.security.common.utils.JsonUtil.responseWithJson;
import static top.dcenter.ums.security.common.utils.JsonUtil.toJsonString;
import static top.dcenter.ums.security.common.vo.ResponseResult.fail;

/**
 * 只返回 json 错误信息的 {@link AuthenticationEntryPoint} 实现.
 * @author YongWu zheng
 * @weixin z56133
 * @since 2021.3.14 22:38
 */
@Slf4j
public class UmsBearerTokenAuthenticationEntryPoint implements AuthenticationEntryPoint {

    private final String bearerTokenHeaderName;
    private final String requestParameterName;

    public UmsBearerTokenAuthenticationEntryPoint(String bearerTokenHeaderName, String requestParameterName) {
        this.bearerTokenHeaderName = bearerTokenHeaderName;
        this.requestParameterName = requestParameterName;
    }

    @Override
    public void commence(HttpServletRequest request, HttpServletResponse response,
                         AuthenticationException authException) throws IOException {

        String token = resolveFromAuthorizationHeader(request);
        if (!hasText(token)) {
            token = resolveFromRequestParameters(request);
        }

        String msg = String.format("JWT 认证失败: token=%s, ip=%s, ua=%s, errorMsg=%s",
                                   token,
                                   IpUtil.getRealIp(request),
                                   request.getHeader(SecurityConstants.HEADER_USER_AGENT),
                                   authException.getMessage());
        log.warn(msg, authException);

        // 返回 json
        int status = HttpStatus.UNAUTHORIZED.value();
        responseWithJson(response, status,
                         toJsonString(fail(authException.getMessage(),
                                           ErrorCodeEnum.UNAUTHORIZED,
                                           MdcUtil.getMdcTraceId())));
    }

    private String resolveFromAuthorizationHeader(HttpServletRequest request) {
        String authorization = request.getHeader(this.bearerTokenHeaderName);
        String bearer = "bearer";
        if (!StringUtils.startsWithIgnoreCase(authorization, bearer)) {
            return null;
        }
        return authorization;
    }

    private String resolveFromRequestParameters(HttpServletRequest request) {
        String[] values = request.getParameterValues(this.requestParameterName);
        if (values == null || values.length == 0) {
            return null;
        }
        if (values.length == 1) {
            return values[0];
        }
        return null;
    }
}