Json WebTokens的實現原理及Django的序列化組件Serializer

前言

最近在做一個python項目的改造，將python項目重構爲java項目，過程中遇到了這個知識點，覺得這個蠻實用的，所以下班後回來趁熱打鐵寫下這篇總結，希望後面的人能夠有所借鑑，少走彎路。

一、優勢簡介

JSON Web Tokens簡稱jwt，是rest接口的一種安全策略。本身有很多的優勢：

解決跨域問題：這種基於Token的訪問策略可以克服cookies的跨域問題。
服務端無狀態可以橫向擴展，Token可完成認證，無需存儲Session。
系統解耦，Token攜帶所有的用戶信息，無需綁定一個特定的認證方案，只需要知道加密的方法和密鑰就可以進行加密解密，有利於解耦。
防止跨站腳本攻擊，沒有cookie技術，無需考慮跨站請求的安全問題。

二、原理簡介

JSON Web Tokens的格式組成，jwt是一段被base64編碼過的字符序列，用點號分隔，一共由三部分組成，頭部header，消息體playload和簽名sign。

1.jwt的頭部Header是json格式：

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

其中typ是type的簡寫，代表該類型是JWT類型，加密方式聲明是HS256，exp代表當前時間戳。

2.jwt的消息體Playload

{
    "userid":"123456",
    "iss":"companyName"
}

消息體的具體字段可根據業務需要自行定義和添加，只需在解密的時候注意拿字段的key值獲取value。

3.簽名sign的生成
最後是簽名，簽名的生成是把header和playload分別使用base64url編碼,接着用’.‘把兩個編碼後的字符串連接起來，再把這拼接起來的字符串配合密鑰進行HMAC SHA-256算法加密，最後再次base64編碼下，這就拿到了簽名sign. 最後把header和playload和sign用’.‘ 連接起來就生成了整個JWT。

三、校驗簡介

整個jwt的結構是由header.playload.sign連接組成，只有sign是用密鑰加密的，而所有的信息都在header和playload中可以直接獲取，sign的作用只是校驗header和playload的信息是否被篡改過，所以jwt不能保護數據，但以上的特性可以很好的應用在權限認證上。

1.加密
比如要加密驗證的是userid字段，首先按前面的格式組裝json消息頭header和消息體playload，按header.playload組成字符串，再根據密鑰和HS256加密header.playload得到sign簽名，最後得到jwtToken爲header.playload.sign，在http請求中的url帶上參數想後端服務請求認證。

2. 解密
後端服務校驗jwtToken是否有權訪問接口服務，進行解密認證，如校驗訪問者的userid，首先 
用將字符串按.號切分三段字符串，分別得到header和playload和sign。然後將header.playload拼裝用密鑰和HAMC SHA-256算法進行加密然後得到新的字符串和sign進行比對，如果一樣就代表數據沒有被篡改，然後從頭部取出exp對存活期進行判斷，如果超過了存活期就返回空字符串，如果在存活期內返回userid的值。四、代碼示例
1.python代碼的加密解密

#!/usr/bin/env python
# coding: utf-8

from itsdangerous import BadTimeSignature, SignatureExpired
from itsdangerous import TimedJSONWebSignatureSerializer as Serializer

APP_SECRET_KEY="secret"
MAX_TOKEN_AGE=1800
token_generator = Serializer(APP_SECRET_KEY, expires_in=MAX_TOKEN_AGE)

def generate_auth_token(userid):
    access_token = token_generator.dumps({"userid":userid})
    return access_token

def verify_token(token):
    try:
        user_auth = token_generator.loads(token)
        print type(token_generator)
    except SignatureExpired as e:
        raise e
    except BadTimeSignature as e:
        raise e
    return user_auth

2. java代碼的加密解密
 

package api.test.util;

import java.io.UnsupportedEncodingException;
import java.security.InvalidKeyException;
import java.security.NoSuchAlgorithmException;

import javax.crypto.Mac;
import javax.crypto.SecretKey;
import javax.crypto.spec.SecretKeySpec;

import org.apache.commons.codec.binary.Base64;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

import lombok.extern.slf4j.Slf4j;
import net.sf.json.JSONObject;

/**
 * jwt加解密實現
 * 
 * @author zhengsc
 */
@Slf4j
public class TokenUtil {

    private String ISSUER = "companyName"; // 機構

    private String APP_SECRET_KEY = "secret"; // 密鑰

    private long MAX_TOKEN_AGE = 1800; // 存活期

    /**
     * 生成userId的accessToken
     * 
     * @param userid
     * @return
     */
    public String generateAccessToken(String userid) {
        JSONObject claims = new JSONObject();
        claims.put("iss", ISSUER);
        claims.put("userid", userid);
        String accessToken = sign(claims, APP_SECRET_KEY);
        return accessToken;
    }

    /**
     * 解密程序返回userid
     * 
     * @param token
     * @return
     */
    public String verifyToken(String token) {
        String userid = "";
        try {
            String[] splitStr = token.split("\\.");
            String headerAndClaimsStr = splitStr[0] + "." +splitStr[1];
            String veryStr = signHmac256(headerAndClaimsStr, APP_SECRET_KEY);
            // 校驗數據是否被篡改
            if (veryStr.equals(splitStr[2])) {
                String header = new String(Base64.decodeBase64(splitStr[0]),"UTF-8");
                JSONObject head = JSONObject.fromObject(header);
                long expire = head.getLong("exp") * 1000L;
                long currentTime = System.currentTimeMillis();
                if (currentTime <= expire){ // 驗證accessToken的有效期
                    String claims = new String(Base64.decodeBase64(splitStr[1]),"UTF-8");
                    JSONObject claim = JSONObject.fromObject(claims);
                    userid = (String) claim.get("userid");
                }
            }
        } catch (UnsupportedEncodingException e) {
            log.error(e.getMessage(), e);
        }

        return userid;
    }

    /**
     * 組裝加密結果jwt返回
     * 
     * @param claims
     * @param appSecretKey
     * @return
     */
    private String sign(JSONObject claims, String appSecretKey) {
        String headerAndClaimsStr = getHeaderAndClaimsStr(claims);
        String signed256 = signHmac256(headerAndClaimsStr, appSecretKey);
        return headerAndClaimsStr + "." + signed256;
    }

    /**
     * 拼接請求頭和聲明
     * 
     * @param claims
     * @return
     */
    private String getHeaderAndClaimsStr(JSONObject claims) {
        JSONObject header = new JSONObject();
        header.put("alg", "HS256");
        header.put("typ", "JWT");
        header.put("exp", System.currentTimeMillis() + MAX_TOKEN_AGE * 1000L);
        String headerStr = header.toString();
        String claimsStr = claims.toString();
        String headerAndClaimsStr = Base64.encodeBase64URLSafeString(headerStr.getBytes()) + "."
                + Base64.encodeBase64URLSafeString(claimsStr.getBytes());
        return headerAndClaimsStr;
    }

    /**
     * 將headerAndClaimsStr用SHA1加密獲取sign
     * 
     * @param headerAndClaimsStr
     * @param appSecretKey
     * @return
     */
    private String signHmac256(String headerAndClaimsStr, String appSecretKey) {
        SecretKey key = new SecretKeySpec(appSecretKey.getBytes(), "HmacSHA256");
        String result = null;
        try {
            Mac mac;
            mac = Mac.getInstance(key.getAlgorithm());
            mac.init(key);
            result = Base64.encodeBase64URLSafeString(mac.doFinal(headerAndClaimsStr.getBytes()));
        } catch (NoSuchAlgorithmException | InvalidKeyException e) {
            log.error(e.getMessage(), e);
        }
        return result;
    }

}