在Spring中我們通過繼承RequestBodyAdviceAdapter實現對于請求的內容進行解密操作,實現ResponseBodyAdvice來對相應內容進行加密處理。接下來將詳細講解數據加解密的實現過程。
環境:Springboot2.5.12 + Vue2 + AxIOS
概述
API接口的安全傳輸是確保數據在API請求和響應之間的傳輸過程中不被截獲、篡改或泄露的重要步驟。以下是一些用于增強API接口安全傳輸的常見技術和最佳實踐:
- 使用HTTPS:使用HTTPS協議而不是HTTP,以確保數據在傳輸過程中的安全性。HTTPS使用SSL/TLS協議對通信進行加密,防止中間人攻擊和數據竊聽。
- 驗證HTTPS請求:驗證HTTPS請求的來源,確保請求來自授權的客戶端。這可以通過檢查SSL證書的頒發機構和有效期來實現。
- 驗證API密鑰:驗證API請求中包含的API密鑰的合法性。這可以通過檢查密鑰的唯一標識符、有效性和權限來實現。
- 使用JSON Web Tokens (JWT):JWT是一種開放標準,用于在雙方之間安全地傳輸信息。JWT包含一組聲明,由JSON對象表示,并使用數字簽名進行驗證。它可以用于API身份驗證和授權。
- 限制API訪問頻率:限制API請求的頻率和并發數,以防止濫用和拒絕服務攻擊。這可以通過設置速率限制和并發限制來實現。
- 使用消息身份驗證碼(mac):消息身份驗證碼是一種用于驗證消息完整性和認證性的機制。它可以用于防止篡改和重放攻擊。
- 加密敏感數據:對傳輸的敏感數據進行加密,例如用戶密碼和個人信息。這可以通過使用對稱加密或公鑰加密來實現。
- 使用合適的HTTP標頭:使用適當的HTTP標頭來防止跨站腳本攻擊(XSS)和其他安全漏洞。例如,設置"X-XSS-Protection: 1; mode=block"標頭來啟用瀏覽器的內置XSS保護機制。
- 實施訪問控制:根據用戶的身份和權限,對API請求進行訪問控制。這可以通過使用基于角色的訪問控制(RBAC)或基于聲明的訪問控制(ABAC)來實現。
- 定期更新和修補:確保API和相關系統得到及時更新和修補,以修復任何已知的安全漏洞。
在Spring中我們通過繼承RequestBodyAdviceAdapter實現對于請求的內容進行解密操作,實現ResponseBodyAdvice來對相應內容進行加密處理。接下來將詳細講解數據加解密的實現過程。
定義加密解密的接口:
SecretProcess
public interface SecretProcess {
/**
* <p>數據加密</p>
* <p>時間:2020年12月24日-下午12:22:13</p>
* @author xg
* @param data 待加密數據
* @return String 加密結果
*/
String encrypt(String data) ;
/**
* <p>數據解密</p>
* <p>時間:2020年12月24日-下午12:23:20</p>
* @author xg
* @param data 待解密數據
* @return String 解密后的數據
*/
String decrypt(String data) ;
/**
* <p>加密算法格式:算法[/模式/填充]</p>
* <p>時間:2020年12月24日-下午12:32:49</p>
* @author xg
* @return String
*/
String getAlgorithm() ;
public static class Hex {
private static final char[] HEX = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
'a', 'b', 'c', 'd', 'e', 'f' };
public static byte[] decode(CharSequence s) {
int nChars = s.length();
if (nChars % 2 != 0) {
throw new IllegalArgumentException("16進制數據錯誤");
}
byte[] result = new byte[nChars / 2];
for (int i = 0; i < nChars; i += 2) {
int msb = Character.digit(s.charAt(i), 16);
int lsb = Character.digit(s.charAt(i + 1), 16);
if (msb < 0 || lsb < 0) {
throw new IllegalArgumentException(
"Detected a Non-hex character at " + (i + 1) + " or " + (i + 2) + " position");
}
result[i / 2] = (byte) ((msb << 4) | lsb);
}
return result;
}
public static String encode(byte[] buf) {
StringBuilder sb = new StringBuilder() ;
for (int i = 0, leng = buf.length; i < leng; i++) {
sb.Append(HEX[(buf[i] & 0xF0) >>> 4]).append(HEX[buf[i] & 0x0F]) ;
}
return sb.toString() ;
}
}
}
該接口中定義了兩個方法分別是加密與解密的方法,還有Hex類 該類用來對數據處理16進制的轉換。
定義一個抽象類實現上面的接口,具體的加解密實現細節在該抽象類中
AbstractSecretProcess
public abstract class AbstractSecretProcess implements SecretProcess {
@Resource
private SecretProperties props ;
@Override
public String decrypt(String data) {
try {
Cipher cipher = Cipher.getInstance(getAlgorithm()) ;
cipher.init(Cipher.DECRYPT_MODE, keySpec()) ;
byte[] decryptBytes = cipher.doFinal(Hex.decode(data)) ;
return new String(decryptBytes) ;
} catch (Exception e) {
throw new RuntimeException(e) ;
}
}
@Override
public String encrypt(String data) {
try {
Cipher cipher = Cipher.getInstance(getAlgorithm()) ;
cipher.init(Cipher.ENCRYPT_MODE, keySpec()) ;
return Hex.encode(cipher.doFinal(data.getBytes(Charset.forName("UTF-8")))) ;
} catch (Exception e) {
throw new RuntimeException(e) ;
}
}
/**
* <p>根據密鑰生成不同的密鑰材料</p>
* <p>目前支持:AES, DES</p>
* <p>時間:2020年12月25日-下午1:02:54</p>
* @author xg
* @param secretKey 密鑰
* @param algorithm 算法
* @return Key
*/
public Key getKeySpec(String algorithm) {
if (algorithm == null || algorithm.trim().length() == 0) {
return null ;
}
String secretKey = props.getKey() ;
switch (algorithm.toUpperCase()) {
case "AES":
return new SecretKeySpec(secretKey.getBytes(), "AES") ;
case "DES":
Key key = null ;
try {
DESKeySpec desKeySpec = new DESKeySpec(secretKey.getBytes()) ;
SecretKeyFactory secretKeyFactory = SecretKeyFactory.getInstance("DES") ;
key = secretKeyFactory.generateSecret(desKeySpec);
} catch (Exception e) {
throw new RuntimeException(e) ;
}
return key ;
default:
return null ;
}
}
/**
* <p>生成密鑰材料</p>
* <p>時間:2020年12月25日-上午11:35:03</p>
* @author xg
* @return Key 密鑰材料
*/
public abstract Key keySpec() ;
}
該抽象類中提供了2中對稱加密的密鑰還原,分表是AES和DES算法。一個抽象方法,該抽象方法
keySpec該方法需要子類實現(具體使用的是哪種對稱加密算法)。
具體加密算法的實現類
AESAlgorithm
public class AESAlgorithm extends AbstractSecretProcess {
@Override
public String getAlgorithm() {
return "AES/ECB/PKCS5Padding";
}
@Override
public Key keySpec() {
return this.getKeySpec("AES") ;
}
}
SecretProperties
@Configuration
public class SecretConfig {
@Bean
@ConditionalOnMissingBean(SecretProcess.class)
public SecretProcess secretProcess() {
return new AESAlgorithm() ;
}
@Component
@ConfigurationProperties(prefix = "secret")
public static class SecretProperties {
private Boolean enabled ;
private String key ;
public Boolean getEnabled() {
return enabled;
}
public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
public String getKey() {
return key;
}
public void setKey(String key) {
this.key = key;
}
}
}
配置文件中如下配置:
secret:
key: aaaabbbbccccdddd #密鑰
enabled: true #是否開啟加解密功能
在項目中可能不是所有的方法都要進行數據的加密解密出來,所以接下來定義一個注解,只有添加有該注解的Controller類或是具體接口方法才進行數據的加密解密,如下:
SIProtection
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Mapping
@Documented
public @interface SIProtection {
}
對請求內容進行解密出來,通過RequestBodyAdvice
DecryptRequestBodyAdivce
@ControllerAdvice
@ConditionalOnProperty(name = "secret.enabled", havingValue = "true")
public class DecryptRequestBodyAdivce extends RequestBodyAdviceAdapter {
@Resource
private SecretProcess secretProcess ;
@Override
public boolean supports(MethodParameter methodParameter, Type targetType,
Class<? extends HttpMessageConverter<?>> converterType) {
return methodParameter.getMethod().isAnnotationPresent(SIProtection.class)
|| methodParameter.getMethod().getDeclaringClass().isAnnotationPresent(SIProtection.class) ;
}
@Override
public HttpInputMessage beforeBodyRead(HttpInputMessage inputMessage, MethodParameter parameter, Type targetType,
Class<? extends HttpMessageConverter<?>> converterType) throws IOException {
String body = secretProcess.decrypt(inToString(inputMessage.getBody())) ;
return new HttpInputMessage() {
@Override
public HttpHeaders getHeaders() {
return inputMessage.getHeaders();
}
@Override
public InputStream getBody() throws IOException {
return new ByteArrayInputStream(body.getBytes()) ;
}
} ;
}
private String inToString(InputStream is) {
byte[] buf = new byte[10 * 1024] ;
int leng = -1 ;
StringBuilder sb = new StringBuilder() ;
try {
while ((leng = is.read(buf)) != -1) {
sb.append(new String(buf, 0, leng)) ;
}
return sb.toString() ;
} catch (IOException e) {
throw new RuntimeException(e) ;
}
}
}
注意這里的:@ConditionalOnProperty(name = "secret.enabled", havingValue = "true")注解,只有開啟了加解密功能才會生效。注意這里的supports方法
對響應內容加密出來
EncryptResponseBodyAdivce
@ControllerAdvice
@ConditionalOnProperty(name = "secret.enabled", havingValue = "true")
public class EncryptResponseBodyAdivce implements ResponseBodyAdvice<Object> {
@Resource
private SecretProcess secretProcess ;
@Override
public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
return returnType.getMethod().isAnnotationPresent(SIProtection.class)
|| returnType.getMethod().getDeclaringClass().isAnnotationPresent(SIProtection.class) ;
}
@Override
public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,
Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request,
ServerHttpResponse response) {
if (body == null) {
return body ;
}
try {
String jsonStr = new ObjectMapper().writeValueAsString(body) ;
return secretProcess.encrypt(jsonStr) ;
} catch (Exception e) {
throw new RuntimeException(e) ;
}
}
}
Controller接口
@PostMapping("/save")
@SIProtection
public R save(@RequestBody Users users) {
return R.success(usersService.save(users)) ;
} // 這對具體方法進行加解密
@RestController
@RequestMapping("/users")
@SIProtection
public class UsersController { // 對該Controller中的所有方法進行加解密處理
}
前端
引入第三方插件:crypto-js
工具方法加解密:
/**
* 加密方法
* @param data 待加密數據
* @returns {string|*}
*/
encrypt (data) {
let key = CryptoJS.enc.Utf8.parse(Consts.Secret.key)
if (typeof data === 'object') {
data = JSON.stringify(data)
}
let plAInText = CryptoJS.enc.Utf8.parse(data)
let secretText = CryptoJS.AES.encrypt(plainText, key, {mode: CryptoJS.mode.ECB, padding: CryptoJS.pad.Pkcs7}).ciphertext.toString()
return secretText
},
/**
* 解密數據
* @param data 待解密數據
*/
decrypt (data) {
let key = CryptoJS.enc.Utf8.parse(Consts.Secret.key)
let secretText = CryptoJS.enc.Hex.parse(data)
let encryptedBase64Str = CryptoJS.enc.Base64.stringify(secretText)
let result = CryptoJS.AES.decrypt(encryptedBase64Str, key, {mode: CryptoJS.mode.ECB, padding: CryptoJS.pad.Pkcs7}).toString(CryptoJS.enc.Utf8)
return JSON.parse(result)
}
配置:
let Consts = {
Secret: {
key: 'aaaabbbbccccdddd', // 必須16位(前后端要一致,密鑰)
urls: ['/users/save']
}
}
export default Consts
這里的urls表示對那些請求進行攔截出來(加解密),這里也可以配置 "*" 表示對所有的請求出來。
axios請求前和響應后對數據進行加解密出來:
發送請求前:
axios.interceptors.request.use((config) => {
let uri = config.url
if (uri.includes('?')) {
uri = uri.substring(0, uri.indexOf('?'))
}
if (window.cfg.enableSecret === '1' && config.data && (Consts.Secret.urls.indexOf('*') > -1 || Consts.Secret.urls.indexOf(uri) > -1)) {
let data = config.data
let secretText = Utils.Secret.encrypt(data)
config.data = secretText
}
return config
}, (error) => {
let errorMessage = '請求失敗'
store.dispatch(types.G_SHOW_ALERT, {title: '請求失敗', content: errorMessage, showDetail: false, detailContent: String(error)})
return Promise.reject(error)
})
axios.interceptors.response.use((response) => {
let uri = response.config.url
if (uri.includes('?')) {
uri = uri.substring(0, uri.indexOf('?'))
}
if (window.cfg.enableSecret === '1' && response.data && (Consts.Secret.urls.indexOf('*') > -1 || Consts.Secret.urls.indexOf(uri) > -1)) {
let data = Utils.Secret.decrypt(response.data)
if (data) {
response.data = data
}
}
return response
}, (error) => {
console.error(`test interceptors.response is in, ${error}`)
return Promise.reject(error)
})
這里的 window.cfg.enableSecret 配置是我自己項目中有個配置文件配置是否開啟,這個大家可以根據自己的環境來實現。
測試:
圖片
這里可以看到前端發起的請求內容已經被加密了
響應內容:
圖片
完畢!!!