org.dromara.jpom.util.JwtUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of server Show documentation
There is a newer version: 2.11.9
/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2019 Code Technology Studio
 *
 * 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 org.dromara.jpom.util;

import cn.hutool.core.convert.Convert;
import cn.hutool.core.date.DateField;
import cn.hutool.core.date.DateTime;
import cn.hutool.core.date.DateUtil;
import cn.hutool.core.util.StrUtil;
import cn.hutool.extra.spring.SpringUtil;
import cn.hutool.jwt.JWT;
import cn.hutool.jwt.JWTHeader;
import cn.hutool.jwt.JWTValidator;
import cn.hutool.jwt.signers.JWTSignerUtil;
import lombok.extern.slf4j.Slf4j;
import org.dromara.jpom.model.user.UserModel;
import org.dromara.jpom.system.ServerConfig;

/**
 * jwt 工具类
 *
 * @author bwcx_jzy
 * @since 2020/7/25
 */
@Slf4j
public class JwtUtil {

    /**
     * 加密算法
     */
    private static final String ALGORITHM = "HS256";
    /**
     * token的的加密key
     */
    private static byte[] KEY;
    public static final String KEY_USER_ID = "userId";

    public static JWT parseBody(String token) {
        if (StrUtil.isEmpty(token)) {
            return null;
        }
        ServerConfig serverConfig = SpringUtil.getBean(ServerConfig.class);
        ServerConfig.UserConfig user = serverConfig.getUser();
        JWT jwt = JWT.of(token);
        if (jwt.verify(JWTSignerUtil.hs256(user.getTokenJwtKeyByte()))) {
            return jwt;
        }
        return null;
    }


    /**
     * 读取token 信息 过期也能读取
     *
     * @param token token
     * @return claims
     */
    public static JWT readBody(String token) {
        try {
            return parseBody(token);
        } catch (Exception e) {
            log.warn("token 解析失败：" + token, e);
            return null;
        }
    }

    /**
     * 读取用户id
     *
     * @param jwt jwt
     * @return 用户id
     */
    public static String readUserId(JWT jwt) {
        return Convert.toStr(jwt.getPayload(KEY_USER_ID));
    }

    /**
     * 获取jwt的唯一身份标识
     *
     * @param jwt jwt
     * @return id
     */
    public static String getId(JWT jwt) {
        if (null == jwt) {
            return null;
        }
        return Convert.toStr(jwt.getPayload(JWT.JWT_ID));
    }

    /**
     * 判断是否过期
     *
     * @param jwt    claims
     * @param leeway 容忍空间，单位：秒。当不能晚于当前时间时，向后容忍；不能早于向前容忍。
     * @return 是否过期
     */
    public static boolean expired(JWT jwt, long leeway) {
        if (jwt == null) {
            return true;
        }
        try {
            JWTValidator of = JWTValidator.of(jwt);
            of.validateDate(DateUtil.date(), leeway);
        } catch (Exception e) {
            return true;
        }
        return false;
    }

    /**
     * 生成token
     *
     * @param userModel 用户
     * @return token
     */
    public static String builder(UserModel userModel, String jwtId) {
        ServerConfig serverConfig = SpringUtil.getBean(ServerConfig.class);
        ServerConfig.UserConfig user = serverConfig.getUser();
        //
        DateTime now = DateTime.now();
        JWT jwt = JWT.create();
        jwt.setHeader(JWTHeader.ALGORITHM, ALGORITHM);
        jwt.setPayload(KEY_USER_ID, userModel.getId())
            .setJWTId(jwtId)
            .setIssuer("Jpom")
            .setIssuedAt(now)
            .setExpiresAt(now.offsetNew(DateField.HOUR, user.getTokenExpired()));
        return jwt.sign(JWTSignerUtil.hs256(user.getTokenJwtKeyByte()));
    }


}