5分鐘掌握JSON Web權限與認證令牌（JWT）

真正的大師，永遠懷着一顆學徒的心

JWT

1. 什麼是JWT

JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information between parties as a JSON object. This information can be verified and trusted because it is digitally signed. JWTs can be signed using a secret (with the HMAC algorithm) or a public/private key pair using RSA or ECDSA.

---[摘自官網]

# 1.翻譯
-  官網位址: https://jwt.io/introduction/
-  翻譯: jsonwebtoken（JWT）是一個開放标準（rfc7519），它定義了一種緊湊的、自包含的方式，
用于在各方之間以JSON對象安全地傳輸資訊。此資訊可以驗證和信任，因為它是數字簽名的。
jwt可以使用秘密（使用HMAC算法）或使用RSA或ECDSA的公鑰/私鑰對進行簽名

# 2.通俗解釋
- JWT簡稱JSON Web Token,也就是通過JSON形式作為Web應用中的令牌,用于在各方之間安全地将資訊作為
- JSON對象傳輸。在資料傳輸過程中還可以完成資料加密、簽名等相關處理。           

2. JWT能做什麼

# 1.授權
- 這是使用JWT的最常見方案。一旦使用者登入，每個後續請求将包括JWT，進而允許使用者通路該令牌允許的路由，
服務和資源。單點登入是當今廣泛使用JWT的一項功能，因為它的開銷很小并且可以在不同的域中輕松使用。

# 2.資訊交換
- JSON Web Token是在各方之間安全地傳輸資訊的好方法。因為可以對JWT進行簽名（例如，使用公鑰/私鑰對），
是以您可以確定發件人是他們所說的人。此外，由于簽名是使用标頭和有效負載計算的，是以您還可以驗證内容是否遭到篡改。           

3. 為什麼是JWT

3.1 基于傳統的Session認證

# 1.認證方式
- 我們知道，http協定本身是一種無狀态的協定，而這就意味着如果使用者向我們的應用提供了使用者名和密碼來
進行使用者認證，那麼下一次請求時，使用者還要再一次進行使用者認證才行，因為根據http協定，我們并不能知道
是哪個使用者發出的請求，是以為了讓我們的應用能識别是哪個使用者發出的請求，我們隻能在伺服器存儲一份用
戶登入的資訊，這份登入資訊會在響應時傳遞給浏覽器，告訴其儲存為cookie,以便下次請求時發送給我們的
應用，這樣我們的應用就能識别請求來自哪個使用者了,這就是傳統的基于session認證。

# 2.認證流程           

# 3.暴露問題
- 1.每個使用者經過我們的應用認證之後，我們的應用都要在服務端做一次記錄，以友善使用者下次請求的鑒别，
- 通常而言session都是儲存在記憶體中，而随着認證使用者的增多，服務端的開銷會明顯增大

- 2.使用者認證之後，服務端做認證記錄，如果認證的記錄被儲存在記憶體中的話，這意味着使用者下次請求還必須
- 要請求在這台伺服器上,這樣才能拿到授權的資源，這樣在分布式的應用上，相應的限制了負載均衡器的能力。
- 這也意味着限制了應用的擴充能力。

- 3.因為是基于cookie來進行使用者識别的, cookie如果被截獲，使用者就會很容易受到跨站請求僞造的攻擊。

- 4.在前後端分離系統中就更加痛苦:如下圖所示
	也就是說前後端分離在應用解耦後增加了部署的複雜性。通常使用者一次請求就要轉發多次。如果用session
	每次攜帶sessionid 到服務	器，伺服器還要查詢使用者資訊。同時如果使用者很多。這些資訊存儲在伺服器内
	存中，給伺服器增加負擔。還有就是CSRF（跨站僞造請求攻	擊）攻擊，session是基于cookie進行使用者識
	别的, cookie如果被截獲，使用者就會很容易受到跨站請求僞造的攻擊。還有就是sessionid就是一個特征值，
	表達的資訊不夠豐富。不容易擴充。而且如果你後端應用是多節點部署。那麼就需要實作session共享機制。
	不友善叢集應用。           

3.2 基于JWT認證

# 1.認證流程
- 首先，前端通過Web表單将自己的使用者名和密碼發送到後端的接口。這一過程一般是一個HTTP POST請求。
- 建議的方式是通過SSL加密的傳輸（https協定），進而避免敏感資訊被嗅探。
- 後端核對使用者名和密碼成功後，将使用者的id等其他資訊作為JWT Payload（負載），将其與頭部分别進行
- Base64編碼拼接後簽名，形成一個JWT(Token)。形成的JWT就是一個形同lll.zzz.xxx的字元串。
- token head.payload.singurater

- 後端将JWT字元串作為登入成功的傳回結果傳回給前端。前端可以将傳回的結果儲存在localStorage或
- sessionStorage上，登出時前端删除儲存的JWT即可。

- 前端在每次請求時将JWT放入HTTP Header中的Authorization位。(解決XSS和XSRF問題) HEADER

- 後端檢查是否存在，如存在驗證JWT的有效性。例如，檢查簽名是否正确；檢查Token是否過期；檢查
- Token的接收方是否是自己（可選）。
- 驗證通過後後端使用JWT中包含的使用者資訊進行其他邏輯操作，傳回相應結果。

# 2.jwt優勢

- 簡潔(Compact): 可以通過URL，POST參數或者在HTTP header發送，因為資料量小，傳輸速度也很快

- 自包含(Self-contained)：負載中包含了所有使用者所需要的資訊，避免了多次查詢資料庫

- 因為Token是以JSON加密的形式儲存在用戶端的，是以JWT是跨語言的，原則上任何web形式都支援。

- 不需要在服務端儲存會話資訊，特别适用于分布式微服務           

4. JWT的結構

token   string  ====>  header.payload.singnature   token   

# 1.令牌組成
- 1.标頭(Header)
- 2.有效載荷(Payload)
- 3.簽名(Signature)
- 是以，JWT通常如下所示:xxxxx.yyyyy.zzzzz   Header.Payload.Signature           

# 2.Header
- 标頭通常由兩部分組成：令牌的類型（即JWT）和所使用的簽名算法，例如HMAC SHA256或RSA。它會使用
- Base64 編碼組成 JWT 結構的第一部分。

- 注意:Base64是一種編碼，也就是說，它是可以被翻譯回原來的樣子來的。它并不是一種加密過程。           

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

# 3.Payload
- 令牌的第二部分是有效負載，其中包含聲明。聲明是有關實體（通常是使用者）和其他資料的聲明。同樣的，
- 它會使用 Base64 編碼組成 JWT 結構的第二部分           

{
  "sub": "1234567890",
  "name": "John Doe",
  "admin": true
}           

# 4.Signature
- 前面兩部分都是使用 Base64 進行編碼的，即前端可以解開知道裡面的資訊。Signature 需要使用編碼後的
 	header 和 payload 以及我們提供的一個密鑰，然後使用 header 中指定的簽名算法（HS256）進行簽名。
	簽名的作用是保證 JWT 沒有被篡改過
- 如:
	HMACSHA256(base64UrlEncode(header) + "." + base64UrlEncode(payload),secret);

# 簽名目的
- 最後一步簽名的過程，實際上是對頭部以及負載内容進行簽名，防止内容被竄改。如果有人對頭部以及負載的
  内容解碼之後進行修改，再進行編碼，最後加上之前的簽名組合形成新的JWT的話，那麼伺服器端會判斷出新
  的頭部和負載形成的簽名和JWT附帶上的簽名是不一樣的。如果要對新的頭部和負載進行簽名，在不知道服務
  器加密時用的密鑰的話，得出來的簽名也是不一樣的。

# 資訊安全問題
- 在這裡大家一定會問一個問題：Base64是一種編碼，是可逆的，那麼我的資訊不就被暴露了嗎？

- 是的。是以，在JWT中，不應該在負載裡面加入任何敏感的資料。在上面的例子中，我們傳輸的是使用者的
  User ID。這個值實際上不是什麼敏	感内容，一般情況下被知道也是安全的。但是像密碼這樣的内容就不能
  被放在JWT中了。如果将使用者的密碼放在了JWT中，那麼懷有惡意的第	三方通過Base64解碼就能很快地知道
  你的密碼了。是以JWT适合用于向Web應用傳遞一些非敏感資訊。JWT還經常用于設計使用者認證和授權系統，
  甚至實作Web應用的單點登入。           

# 5.放在一起
- 輸出是三個由點分隔的Base64-URL字元串，可以在HTML和HTTP環境中輕松傳遞這些字元串，與基于XML的标準
  （例如SAML）相比，它更緊湊。
- 簡潔(Compact)
	可以通過URL, POST 參數或者在 HTTP header 發送，因為資料量小，傳輸速度快
- 自包含(Self-contained)
	負載中包含了所有使用者所需要的資訊，避免了多次查詢資料庫           

5. 使用JWT

1.引入依賴

<!--引入jwt-->
<dependency>
  <groupId>com.auth0</groupId>
  <artifactId>java-jwt</artifactId>
  <version>3.4.0</version>
</dependency>           

2.生成token

Calendar instance = Calendar.getInstance();
instance.add(Calendar.SECOND, 90);
//生成令牌
String token = JWT.create()
  	.withClaim("username", "張三")//設定自定義使用者名
  	.withExpiresAt(instance.getTime())//設定過期時間
  	.sign(Algorithm.HMAC256("token!Q2W#E$RW"));//設定簽名 保密 複雜
//輸出令牌
System.out.println(token);           

3.根據令牌和簽名解析資料

JWTVerifier jwtVerifier = JWT.require(Algorithm.HMAC256("token!Q2W#E$RW")).build();
DecodedJWT decodedJWT = jwtVerifier.verify(token);
System.out.println("使用者名: " + decodedJWT.getClaim("username").asString());
System.out.println("過期時間: "+decodedJWT.getExpiresAt());           

4.常見異常資訊

- SignatureVerificationException:				簽名不一緻異常
- TokenExpiredException:    					令牌過期異常
- AlgorithmMismatchException:					算法不比對異常
- InvalidClaimException:						失效的payload異常           

6. 封裝工具類

public class JWTUtils {
    private static String TOKEN = "token!Q@W3e4r";
    /**
     * 生成token
     * @param map  //傳入payload
     * @return 傳回token
     */
    public static String getToken(Map<String,String> map){
        JWTCreator.Builder builder = JWT.create();
        map.forEach((k,v)->{
            builder.withClaim(k,v);
        });
        Calendar instance = Calendar.getInstance();
        instance.add(Calendar.SECOND,7);
        builder.withExpiresAt(instance.getTime());
        return builder.sign(Algorithm.HMAC256(TOKEN)).toString();
    }
    /**
     * 驗證token
     * @param token
     * @return
     */
    public static void verify(String token){
        JWT.require(Algorithm.HMAC256(TOKEN)).build().verify(token);
    }
    /**
     * 擷取token中payload
     * @param token
     * @return
     */
    public static DecodedJWT getToken(String token){
        return JWT.require(Algorithm.HMAC256(TOKEN)).build().verify(token);
    }
}           

7. 整合springboot

0.搭建springboot+mybatis+jwt環境

• 引入依賴
• 編寫配置

<!--引入jwt-->
<dependency>
  <groupId>com.auth0</groupId>
  <artifactId>java-jwt</artifactId>
  <version>3.4.0</version>
</dependency>

<!--引入mybatis-->
<dependency>
  <groupId>org.mybatis.spring.boot</groupId>
  <artifactId>mybatis-spring-boot-starter</artifactId>
  <version>2.1.3</version>
</dependency>

<!--引入lombok-->
<dependency>
  <groupId>org.projectlombok</groupId>
  <artifactId>lombok</artifactId>
  <version>1.18.12</version>
</dependency>

<!--引入druid-->
<dependency>
  <groupId>com.alibaba</groupId>
  <artifactId>druid</artifactId>
  <version>1.1.19</version>
</dependency>

<!--引入mysql-->
<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
  <version>5.1.38</version>
</dependency>           

server.port=8989
spring.application.name=jwt

spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/jwt?characterEncoding=UTF-8
spring.datasource.username=root
spring.datasource.password=root

mybatis.type-aliases-package=com.baizhi.entity
mybatis.mapper-locations=classpath:com/baizhi/mapper/*.xml

logging.level.com.baizhi.dao=debug           

1.開發資料庫

DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
  `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '主鍵',
  `name` varchar(80) DEFAULT NULL COMMENT '使用者名',
  `password` varchar(40) DEFAULT NULL COMMENT '使用者密碼',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8;           

2.開發entity

@Data
@Accessors(chain=true)
public class User {
    private String id;
    private String name;
    private String password;
}           

3.開發DAO接口和mapper.xml

@Mapper
public interface UserDAO {
    User login(User user);
}           

<mapper namespace="com.baizhi.dao.UserDAO">
    <!--這裡就寫的簡單點了畢竟不是重點-->
    <select id="login" parameterType="User" resultType="User">
        select * from user where name=#{name} and password = #{password}
    </select>
</mapper>           

4.開發Service 接口以及實作類

public interface UserService {
    User login(User user);//登入接口
}           

@Service
@Transactional
public class UserServiceImpl implements UserService {
    @Autowired
    private UserDAO userDAO;
    @Override
    @Transactional(propagation = Propagation.SUPPORTS)
    public User login(User user) {
        User userDB = userDAO.login(user);
        if(userDB!=null){
            return userDB;
        }
        throw  new RuntimeException("登入失敗~~");
    }
}           

5.開發controller

@RestController
@Slf4j
public class UserController {
    @Autowired
    private UserService userService;
    @GetMapping("/user/login")
    public Map<String,Object> login(User user) {
        Map<String,Object> result = new HashMap<>();
        log.info("使用者名: [{}]", user.getName());
        log.info("密碼: [{}]", user.getPassword());
        try {
            User userDB = userService.login(user);
            Map<String, String> map = new HashMap<>();//用來存放payload
            map.put("id",userDB.getId());
            map.put("username", userDB.getName());
            String token = JWTUtils.getToken(map);
            result.put("state",true);
            result.put("msg","登入成功!!!");
            result.put("token",token); //成功傳回token資訊
        } catch (Exception e) {
            e.printStackTrace();
            result.put("state","false");
            result.put("msg",e.getMessage());
        }
        return result;
    }
}           

6.資料庫添加測試資料啟動項目

7.通過postman模拟登入失敗

8.通過postman模拟登入成功

9.編寫測試接口

@PostMapping("/test/test")
public Map<String, Object> test(String token) {
  Map<String, Object> map = new HashMap<>();
  try {
    JWTUtils.verify(token);
    map.put("msg", "驗證通過~~~");
    map.put("state", true);
  } catch (TokenExpiredException e) {
    map.put("state", false);
    map.put("msg", "Token已經過期!!!");
  } catch (SignatureVerificationException e){
    map.put("state", false);
    map.put("msg", "簽名錯誤!!!");
  } catch (AlgorithmMismatchException e){
    map.put("state", false);
    map.put("msg", "加密算法不比對!!!");
  } catch (Exception e) {
    e.printStackTrace();
    map.put("state", false);
    map.put("msg", "無效token~~");
  }
  return map;
}           

10.通過postman請求接口

11.問題?

• 使用上述方式每次都要傳遞token資料,每個方法都需要驗證token代碼備援,不夠靈活? 如何優化
• 使用攔截器進行優化

public class JWTInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        Map<String, Object> map = new HashMap<>();
        //擷取請求頭中令牌
        String token = request.getHeader("token");
        try {
            JWTUtils.verify(token);//驗證令牌
            return true;//放行請求
        } catch (SignatureVerificationException e) {
            e.printStackTrace();
            map.put("msg","無效簽名!");
        }catch (TokenExpiredException e){
            e.printStackTrace();
            map.put("msg","token過期!");
        }catch (AlgorithmMismatchException e){
            e.printStackTrace();
            map.put("msg","token算法不一緻!");
        }catch (Exception e){
            e.printStackTrace();
            map.put("msg","token無效!!");
        }
        map.put("state",false);//設定狀态
        //将map 專為json  jackson
        String json = new ObjectMapper().writeValueAsString(map);
        response.setContentType("application/json;charset=UTF-8");
        response.getWriter().println(json);
        return false;
    }
}           

@Component
public class InterceptorConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new JwtTokenInterceptor()).
          excludePathPatterns("/user/**")
          .addPathPatterns("/**");
    }
}