简单实现一个JWT认证

JWT,即JSON Web Token,是目前最流行的跨域认证解决方案之一。

原理

1、用户发送账号密码到服务器,服务器进行认证并生成一个JSON对象返回给用户。

{
  "姓名": "张三",
  "角色": "管理员",
  "到期时间": "2020年8月10日8点30分"
}

2、以后用户和服务器进行通信都要携带这个JSON对象,服务器通过这个对象来认定用户身份。为防止用户篡改数据,服务器生成对象时应加上签名
3、服务器是无状态的,不保存任何session数据,以方便扩展。

数据结构

JWT是一串长字符串,结构分为以下三部分:

  • 头部(Header)
  • 负载(Payload)
  • 签名(Signature)

每个部分之间都用.隔开。

Header

Header是一个JSON对象,用于描述JWT的元数据。

{
   "alg": "HS256",
  "typ": "JWT"
}

Payload

Payload也是一个JSON对象,用于存放实际需要传递的数据,规定了7个官方字段:

  • iss (issuer):签发人
  • exp (expiration time):过期时间
  • sub (subject):主题
  • aud (audience):受众
  • nbf (Not Before):生效时间
  • iat (Issued At):签发时间
  • jti (JWT ID):编号

除此之外,也可以在这个部分定义私有字段,尽量不要将私密信息存放在这个部分。

{
  "sub": "1234567890",
  "name": "wunian",
  "admin": true
}

上述官方字段,我们可以从Claims的实现类DefaultClaims的源码中找到对应的getter/setter方法。

public class DefaultClaims extends JwtMap implements Claims {
    public DefaultClaims() {
    }

    public DefaultClaims(Map<String, Object> map) {
        super(map);
    }

    public String getIssuer() {
        return this.getString("iss");//iss (issuer):签发人
    }

    public Claims setIssuer(String iss) {
        this.setValue("iss", iss);
        return this;
    }

    public String getSubject() {
        return this.getString("sub");//sub (subject):主题
    }

    public Claims setSubject(String sub) {
        this.setValue("sub", sub);
        return this;
    }

    public String getAudience() {
        return this.getString("aud");//aud (audience):受众
    }

    public Claims setAudience(String aud) {
        this.setValue("aud", aud);
        return this;
    }

    public Date getExpiration() {
        return (Date)this.get("exp", Date.class);//exp (expiration time):过期时间
    }

    public Claims setExpiration(Date exp) {
        this.setDate("exp", exp);
        return this;
    }

    public Date getNotBefore() {
        return (Date)this.get("nbf", Date.class);//nbf (Not Before):生效时间
    }

    public Claims setNotBefore(Date nbf) {
        this.setDate("nbf", nbf);
        return this;
    }

    public Date getIssuedAt() {
        return (Date)this.get("iat", Date.class);//iat (Issued At):签发时间
    }

    public Claims setIssuedAt(Date iat) {
        this.setDate("iat", iat);
        return this;
    }

    public String getId() {
        return this.getString("jti");//jti (JWT ID):编号
    }

    public Claims setId(String jti) {
        this.setValue("jti", jti);
        return this;
    }
    //获取用户自己定义的claim主体信息字段
    public <T> T get(String claimName, Class<T> requiredType) {
        Object value = this.get(claimName);
        if (value == null) {
            return null;
        } else {
            if ("exp".equals(claimName) || "iat".equals(claimName) || "nbf".equals(claimName)) {
                value = this.getDate(claimName);
            }

            return this.castClaimValue(value, requiredType);
        }
    }

    //将claim参数的值转换为想转换的类型
    private <T> T castClaimValue(Object value, Class<T> requiredType) {
        if (requiredType == Date.class && value instanceof Long) {
            value = new Date((Long)value);//Long类型转换为日期类型
        }

        //Integer类型转其他类型
        if (value instanceof Integer) {
            int intValue = (Integer)value;
            if (requiredType == Long.class) {
                value = (long)intValue;//转换为long类型
            } else if (requiredType == Short.class && -32768 <= intValue && intValue <= 32767) {
                value = (short)intValue;//转换为short类型
            } else if (requiredType == Byte.class && -128 <= intValue && intValue <= 127) {
                value = (byte)intValue;//转换为byte类型
            }
        }

        if (!requiredType.isInstance(value)) {//未知的类型,直接报错
            throw new RequiredTypeException("Expected value to be of type: " + requiredType + ", but was " + value.getClass());
        } else {//其他类型转换
            return requiredType.cast(value);
        }
    }
}

Signature

Signature是对前两个部分的签名,防止数据被篡改。这里需要指定一个密钥(secret),这个密钥只有服务器知道,不能透露给用户。然后,使用Header中指定的签名算法(默认是HMAC SHA256),按照下面的公式产生签名。

HMACSHA256(
  base64UrlEncode(header) + "." +
  base64UrlEncode(payload),
  secret)

计算得到签名后,将Header、Payload、Signature三部分拼成一个字符串,每个部分之间用.分隔,然后将其返回给用户。

JWT认证简单实现

生成token

1、引入JWT依赖。

<dependency>
    <groupId>io.jsonwebtoken</groupId>
    <artifactId>jjwt</artifactId>
    <version>0.9.1</version>
</dependency>

2、编写token生成方法,传入主体信息和密钥,密钥用于校验时解密。

public static Map<String,Object> generateToken(String userId,String secret){
    //过期时间
    long EXPIRE=1000*60*60*24;
    Map<String,Object> data = new HashMap<>(16);
    Date expiration=new Date(System.currentTimeMillis() + EXPIRE);

    String token = Jwts.builder()
        .setHeaderParam("typ","JWT")//token的类型
        .setHeaderParam("alg","HS256")//加密算法
        .setExpiration(expiration)//过期时间
        .setIssuedAt(new Date())//签名时间,时间戳
        .claim("userId",userId)//主体信息
        .signWith(SignatureAlgorithm.HS256,secret)//使用密钥进行签名加密
        .compact();
    //将token和过期时间返回给用户
    data.put("token",token);
    data.put("expire_time",new SimpleDateFormat("yyyy-MM-dd HH:ss:mm").format(expiration));
    return data;
}

校验token

编写token校验方法,传入token和密钥进行解密,token解密后返回一个Claims对象,其本质上是一个Map对象,我们可以从Claims对象中获取主体信息(具体底层实现见前面DefaultClaims源码)。

public static Claims validateTokenAndGetClaims(String token, String secret){
    Claims claims = Jwts.parser()
        .setSigningKey(secret)//使用密钥对签名进行解密
        .parseClaimsJws(token)//对token进行解析
        .getBody();//获得主体信息
    return claims;
}

这样,我们就实现了一个简单的JWT认证,是不是很简单呢!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,384评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,845评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,148评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,640评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,731评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,712评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,703评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,473评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,915评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,227评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,384评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,063评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,706评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,302评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,531评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,321评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,248评论 2 352