SpringBoot 快速實現 api 加密!

在項目中,爲了保證數據的安全,我們常常會對傳遞的數據進行加密。常用的加密算法包括對稱加密(AES)和非對稱加密(RSA),博主選取碼雲上最簡單的 API 加密項目進行下面的講解。

https://gitee.com/isuperag/rsa-encrypt-body-spring-boot

項目介紹

該項目使用 RSA 加密方式對 API 接口返回的數據加密,讓 API 數據更加安全。別人無法對提供的數據進行破解。Spring Boot 接口加密,可以對返回值、參數值通過註解的方式自動加解密 。

什麼是 RSA 加密

首先我們當然是瞭解 RSA 加密

RSA 加密是一種非對稱加密。可以在不直接傳遞密鑰的情況下,完成解密。這能夠確保信息的安全性,避免了直接傳遞密鑰所造成的被破解的風險。是由一對密鑰來進行加解密的過程,分別稱爲公鑰和私鑰。兩者之間有數學相關,該加密算法的原理就是對一極大整數做因數分解的困難性來保證安全性。通常個人保存私鑰,公鑰是公開的(可能同時多人持有)。

舉例子大法

加密和簽名都是爲了安全性考慮,但略有不同。常有人問加密和簽名是用私鑰還是公鑰?其實都是對加密和簽名的作用有所混淆。簡單的說,加密是爲了防止信息被泄露,而簽名是爲了防止信息被篡改。這裏舉 2 個例子說明。

**「第一個場景:」**戰場上,B 要給 A 傳遞一條消息,內容爲某一指令。

RSA 的加密過程如下:

在這個過程中,只有 2 次傳遞過程,第一次是 A 傳遞公鑰給 B,第二次是 B 傳遞加密消息給 A,即使都被敵方截獲,也沒有危險性,因爲只有 A 的私鑰才能對消息進行解密,防止了消息內容的泄露。

**「第二個場景:」**A 收到 B 發的消息後,需要進行回覆 “收到”。

RSA 簽名的過程如下:

在這個過程中,只有 2 次傳遞過程,第一次是 A 傳遞加簽的消息和消息本身給 B,第二次是 B 獲取 A 的公鑰,即使都被敵方截獲,也沒有危險性,因爲只有 A 的私鑰才能對消息進行簽名,即使知道了消息內容,也無法僞造帶簽名的回覆給 B,防止了消息內容的篡改。

但是,綜合兩個場景你會發現,第一個場景雖然被截獲的消息沒有泄露,但是可以利用截獲的公鑰,將假指令進行加密,然後傳遞給 A。第二個場景雖然截獲的消息不能被篡改,但是消息的內容可以利用公鑰驗籤來獲得,並不能防止泄露。所以在實際應用中,要根據情況使用,也可以同時使用加密和簽名,比如 A 和 B 都有一套自己的公鑰和私鑰,當 A 要給 B 發送消息時,先用 B 的公鑰對消息加密,再對加密的消息使用 A 的私鑰加簽名,達到既不泄露也不被篡改,更能保證消息的安全性。

加密實戰

博主你嗶哩嗶哩這麼多,我已經知道了 RSA 是幹什麼了。不就是 公鑰加密、私鑰解密、私鑰簽名、公鑰驗籤

實戰準備

1、新建一個 springboot 項目

springboot_api_encryption

2、引入 maven 依來
<dependency>
    <groupId>cn.shuibo</groupId>
    <artifactId>rsa-encrypt-body-spring-boot</artifactId>
    <version>1.0.1.RELEASE</version>
</dependency>
3、啓動類 Application 中添加 @EnableSecurity 註解
@SpringBootApplication
@EnableSecurity
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}
4、在 application.yml 或者 application.properties 中添加 RSA 公鑰及私鑰

公鑰私鑰的生成文章後面會放出生成工具

rsa:
  encrypt:
    open: false # 是否開啓加密 true  or  false
    showLog: true # 是否打印加解密log true  or  false
    publicKey: # RSA公鑰 軟件生成
    privateKey: # RSA私鑰 軟件生成
5、對 Controller 裏面的 API 方法進行加密
@Encrypt
@GetMapping("/encryption")
public TestBean encryption(){
    TestBean testBean = new TestBean();
    testBean.setName("shuibo.cn");
    testBean.setAge(18);
    return testBean;
}
6、對傳過來的加密參數解密

其他 java 端程序可以用註解,如果是 vue,請用 RSA 密鑰解密

@Decrypt
@PostMapping("/decryption")
public String Decryption(@RequestBody TestBean testBean){
    return testBean.toString();
}

真刀真槍

1、引入 maven

2、啓動類添加註解

3、YML 添加配置密鑰

4、創建一個實體類

5、寫一個對外 API 接口

6、啓動項目

請求地址: http://localhost:8080/encryption

我們看到返回的數據未加密

7、修改

修改 open 爲 true 打開加密

rsa:
  encrypt:
    open: true # 是否開啓加密 true  or  false
    showLog: true # 是否打印加解密log true  or  false
    publicKey: # RSA公鑰 軟件生成
    privateKey: # RSA私鑰 軟件生成
8、再次重啓項目

請求地址: http://localhost:8080/encryption

我們看到返回的數據已加密

9、加密日誌

解密實戰

如果是其他 springboot 項目,跟前面一樣。我們這兒就當客戶端是 springboot 項目,其他的請使用 RSA 解密協議解密!

服務端有私密鑰、公密鑰

前端只需要公密鑰就可以

實戰準備

在原來的 springboot 基礎上寫一份解密方法

1、前端 js 解密方法
<script src="https://cdn.bootcdn.net/ajax/libs/jquery/3.5.1/jquery.js"></script>
<script src="https://cdn.bootcdn.net/ajax/libs/jsencrypt/3.0.0-rc.1/jsencrypt.js"></script>
2、後臺增加解密方法
/**
 * 解密
 * @param user
 * @return
 */
@PostMapping("/decryption")
@Decrypt
@ResponseBody
public String Decryption(@RequestBody User user){
    System.out.println(user.toString());
    return user.toString();
}
3、js 方法
#公鑰
 var PUBLIC_KEY = 'MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAobhGH4WMwMvJRUlTxWrCVIOQtsHijAxPJNvAWAgq80ADpFEWrpbcGB9cKqp6XHRH4k/CVtCUZ7jm9UKwhaeAm18sKtcwe+M8JFNX6FSHpgde0o8C9S/QpcmLxf4iN7nGZ7P3ZTvMdmKUcdRMsVQnsydG2Bj6gRxP2+kexEebTeODbdM7dHlkxAL0RxGWmX/ZOBzsoWZw2gKcC0vxwyIZBGHUdImG2T3nEA+VMfK2Yqv3uSYukmlKP+0mjfhrTtLFDuTV1VER9BfryBMvpQCxLO4pqgZnXPd+SOQcZHZ2OL0wqo5OX1+GPYx7TNxz5Qi76pK//T2mH7s6X/BuyT21HQIDAQAB';

/**
 * 加密方法
 * @returns {PromiseLike<ArrayBuffer>}
 * @constructor
 */
function RSA_encryption(jsonData) {
 var encrypt = new JSEncrypt();
 encrypt.setPublicKey('-----BEGIN PUBLIC KEY-----' + PUBLIC_KEY + '-----END PUBLIC KEY-----');
 var encrypted = encrypt.encrypt(JSON.stringify(jsonData));
 console.log('加密前數據:%o', str);
 console.log('加密後數據:%o', encrypted);
 return encrypted;
}


/**
 * 提交方法
 */
function tijiao() {
 var str = {
  "name":"1223334",
  "password":"asd",
  age:1
 };
  $.ajax({
   url: "/decryption",
   type : "POST",
   contentType: "application/json;charset=utf-8",
   data : RSA_encryption(str) ,
   success : function(data) {
    alert(data);
   }
  })
}

真刀真槍

1、 Controller 添加解密方法接口

2、前端頁面引入 js 以及方法
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
加密傳後端,後端解密
<button id="jiami" onclick="tijiao()">加密傳後端</button>
<script src="https://cdn.bootcdn.net/ajax/libs/jquery/3.5.1/jquery.js"></script>
<script src="https://cdn.bootcdn.net/ajax/libs/jsencrypt/3.0.0-rc.1/jsencrypt.js"></script>
<script>
    var PUBLIC_KEY = 'MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAobhGH4WMwMvJRUlTxWrCVIOQtsHijAxPJNvAWAgq80ADpFEWrpbcGB9cKqp6XHRH4k/CVtCUZ7jm9UKwhaeAm18sKtcwe+M8JFNX6FSHpgde0o8C9S/QpcmLxf4iN7nGZ7P3ZTvMdmKUcdRMsVQnsydG2Bj6gRxP2+kexEebTeODbdM7dHlkxAL0RxGWmX/ZOBzsoWZw2gKcC0vxwyIZBGHUdImG2T3nEA+VMfK2Yqv3uSYukmlKP+0mjfhrTtLFDuTV1VER9BfryBMvpQCxLO4pqgZnXPd+SOQcZHZ2OL0wqo5OX1+GPYx7TNxz5Qi76pK//T2mH7s6X/BuyT21HQIDAQAB';

    /**
     * 加密方法
     * @returns {PromiseLike<ArrayBuffer>}
     * @constructor
     */
    function RSA_encryption(jsonData) {
        var encrypt = new JSEncrypt();
        encrypt.setPublicKey('-----BEGIN PUBLIC KEY-----' + PUBLIC_KEY + '-----END PUBLIC KEY-----');
        var encrypted = encrypt.encrypt(JSON.stringify(jsonData));
        console.log('加密前數據:%o', jsonData);
        console.log('加密後數據:%o', encrypted);
        return encrypted;
    }

    /**
     * 提交方法
     */
    function tijiao() {
        var str = {
            "name":"1223334",
            "password":"asd",
            age:1
        };
            $.ajax({
                url: "/decryption",
                type : "POST",
                contentType: "application/json;charset=utf-8",
                data : RSA_encryption(str) ,
                success : function(data) {
                    alert(data);
                }
            })
    }

</script>
</body>
</html>
3、啓動訪問

http://localhost:8080

4、後臺解密日誌

總結

經過上面的接口加密解密操作。可以看出我們的接口如果沒有公鑰、或者私鑰別人根本無法解密!這樣就對 API 接口起到了很好的保護作用,防止別人抓包!

祝大家:每天學習一點,技術成長飛快

項目坑點

此項目的 demo 無法訪問,難點就在前端如何加密回傳到後臺解密,此坑我帶大家爬出來了!

以下是主意事項:

1、主意 ajax 的 contentType: “application/json;charset=utf-8”

$.ajax({
    url: "/decryption",
    type : "POST",
    contentType: "application/json;charset=utf-8",
    data : RSA_encryption(str) ,
    success : function(data) {
        alert(data);
    }
})

2、解密方法必須 @RequestBody

@PostMapping("/decryption")
@Decrypt
@ResponseBody
public String Decryption(@RequestBody User user){
    System.out.println(user.toString());
    return user.toString();
}
本文由 Readfog 進行 AMP 轉碼,版權歸原作者所有。
來源https://mp.weixin.qq.com/s/i4wnVNSZxp4gdhRQrlXgWA