From 3716b874e369464d4c200bbe08291dc87ec4ca76 Mon Sep 17 00:00:00 2001 From: shengzhang <2393584716@qq.com> Date: Mon, 8 Mar 2021 02:13:18 +0800 Subject: [PATCH] =?UTF-8?q?=E6=96=B0=E5=A2=9E=E5=AF=86=E7=A0=81=E5=8A=A0?= =?UTF-8?q?=E5=AF=86=E7=AE=97=E6=B3=95=E5=B7=A5=E5=85=B7=E7=B1=BB?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../cn/dev33/satoken/secure/SaBase64Util.java | 61 +++ .../cn/dev33/satoken/secure/SaSecureUtil.java | 443 ++++++++++++++++++ sa-token-doc/doc/use/dao-extend.md | 1 - 3 files changed, 504 insertions(+), 1 deletion(-) create mode 100644 sa-token-core/src/main/java/cn/dev33/satoken/secure/SaBase64Util.java create mode 100644 sa-token-core/src/main/java/cn/dev33/satoken/secure/SaSecureUtil.java diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/secure/SaBase64Util.java b/sa-token-core/src/main/java/cn/dev33/satoken/secure/SaBase64Util.java new file mode 100644 index 00000000..02315822 --- /dev/null +++ b/sa-token-core/src/main/java/cn/dev33/satoken/secure/SaBase64Util.java @@ -0,0 +1,61 @@ +package cn.dev33.satoken.secure; + +import java.io.UnsupportedEncodingException; +import java.util.Base64; + +/** + * Base64工具类 + * @author kong + * + */ +public class SaBase64Util { + + private static Base64.Encoder encoder = Base64.getEncoder(); + private static Base64.Decoder decoder = Base64.getDecoder(); + + /** + * Base64编码，byte[] 转 String + * @param bytes byte[] + * @return 字符串 + */ + public static String encodeBytesToString(byte[] bytes){ + return encoder.encodeToString(bytes); + } + + /** + * Base64解码，String 转 byte[] + * @param text 字符串 + * @return byte[] + */ + public static byte[] decodeStringToBytes(String text){ + return decoder.decode(text); + } + + /** + * Base64编码，String 转 String + * @param text 字符串 + * @return Base64格式字符串 + */ + public static String encode(String text){ + try { + return encoder.encodeToString(text.getBytes("UTF-8")); + } catch (UnsupportedEncodingException e) { + throw new RuntimeException(e); + } + } + + /** + * Base64解码，String 转 String + * @param text Base64格式字符串 + * @return 字符串 + */ + public static String decode(String base64Text){ + try { + return new String(decoder.decode(base64Text), "UTF-8"); + } catch (UnsupportedEncodingException e) { + throw new RuntimeException(e); + } + } + + +} diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/secure/SaSecureUtil.java b/sa-token-core/src/main/java/cn/dev33/satoken/secure/SaSecureUtil.java new file mode 100644 index 00000000..3b95f5ba --- /dev/null +++ b/sa-token-core/src/main/java/cn/dev33/satoken/secure/SaSecureUtil.java @@ -0,0 +1,443 @@ +package cn.dev33.satoken.secure; + +import java.security.InvalidParameterException; +import java.security.KeyFactory; +import java.security.KeyPair; +import java.security.KeyPairGenerator; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.security.PrivateKey; +import java.security.PublicKey; +import java.security.SecureRandom; +import java.security.interfaces.RSAPrivateKey; +import java.security.interfaces.RSAPublicKey; +import java.security.spec.InvalidKeySpecException; +import java.security.spec.PKCS8EncodedKeySpec; +import java.security.spec.X509EncodedKeySpec; +import java.util.Base64; +import java.util.HashMap; +import java.util.UUID; + +import javax.crypto.Cipher; +import javax.crypto.KeyGenerator; +import javax.crypto.SecretKey; +import javax.crypto.spec.SecretKeySpec; + +import cn.dev33.satoken.exception.SaTokenException; + +/** + * sa-token 常见加密算法工具类 + * + * @author kong + * + */ +public class SaSecureUtil { + + /** + * Base64编码 + */ + private static Base64.Encoder encoder = Base64.getEncoder(); + + /** + * Base64解码 + */ + private static Base64.Decoder decoder = Base64.getDecoder(); + + // ----------------------- 摘要加密 ----------------------- + + /** + * md5加密 + * @param str 指定字符串 + * @return 加密后的字符串 + */ + public static String md5(String str) { + str = (str == null ? "" : str); + char[] hexDigits = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' }; + try { + byte[] btInput = str.getBytes(); + MessageDigest mdInst = MessageDigest.getInstance("MD5"); + mdInst.update(btInput); + byte[] md = mdInst.digest(); + int j = md.length; + char[] strA = new char[j * 2]; + int k = 0; + for (byte byte0 : md) { + strA[k++] = hexDigits[byte0 >>> 4 & 0xf]; + strA[k++] = hexDigits[byte0 & 0xf]; + } + return new String(strA); + } catch (Exception e) { + throw new SaTokenException(e); + } + } + + /** + * sha1加密 + * + * @param str 指定字符串 + * @return 加密后的字符串 + */ + public static String sha1(String str) { + try { + str = (str == null ? "" : str); + MessageDigest md = MessageDigest.getInstance("SHA1"); + byte[] b = str.getBytes(); + md.update(b); + byte[] b2 = md.digest(); + int len = b2.length; + String strA = "0123456789abcdef"; + char[] ch = strA.toCharArray(); + char[] chs = new char[len * 2]; + for (int i = 0, k = 0; i < len; i++) { + byte b3 = b2[i]; + chs[k++] = ch[b3 >>> 4 & 0xf]; + chs[k++] = ch[b3 & 0xf]; + } + return new String(chs); + } catch (Exception e) { + throw new SaTokenException(e); + } + } + + /** + * sha256加密 + * + * @param str 指定字符串 + * @return 加密后的字符串 + */ + public static String sha256(String str) { + try { + str = (str == null ? "" : str); + MessageDigest messageDigest = MessageDigest.getInstance("SHA-256"); + messageDigest.update(str.getBytes("UTF-8")); + + byte[] bytes = messageDigest.digest(); + StringBuilder builder = new StringBuilder(); + String temp; + for (int i = 0; i < bytes.length; i++) { + temp = Integer.toHexString(bytes[i] & 0xFF); + if (temp.length() == 1) { + builder.append("0"); + } + builder.append(temp); + } + + return builder.toString(); + } catch (Exception e) { + throw new SaTokenException(e); + } + } + + /** + * md5加盐加密: md5(md5(str) + md5(salt)) + * @param str 字符串 + * @param salt 盐 + * @return 加密后的字符串 + */ + public static String md5BySalt(String str, String salt) { + return md5(md5(str) + md5(salt)); + } + + + // ----------------------- 对称加密 AES ----------------------- + + /** + * 默认密码算法 + */ + private static final String DEFAULT_CIPHER_ALGORITHM = "AES/ECB/PKCS5Padding"; + + /** + * AES加密 + * + * @param key 加密的密钥 + * @param text 需要加密的字符串 + * @return 返回Base64转码后的加密数据 + */ + public static String aesEncrypt(String key, String text) { + try { + Cipher cipher = Cipher.getInstance(DEFAULT_CIPHER_ALGORITHM); + byte[] byteContent = text.getBytes("utf-8"); + cipher.init(Cipher.ENCRYPT_MODE, getSecretKey(key)); + byte[] result = cipher.doFinal(byteContent); + return encoder.encodeToString(result); + } catch (Exception e) { + throw new SaTokenException(e); + } + } + + /** + * AES解密 + * @param key 加密的密钥 + * @param text 已加密的密文 + * @return 返回解密后的数据 + */ + public static String aesDecrypt(String key, String text) { + try { + Cipher cipher = Cipher.getInstance(DEFAULT_CIPHER_ALGORITHM); + cipher.init(Cipher.DECRYPT_MODE, getSecretKey(key)); + byte[] result = cipher.doFinal(decoder.decode(text)); + return new String(result, "utf-8"); + } catch (Exception e) { + throw new SaTokenException(e); + } + } + + /** + * 生成加密秘钥 + * @param password 秘钥 + * @return SecretKeySpec + * @throws NoSuchAlgorithmException + */ + private static SecretKeySpec getSecretKey(final String password) throws NoSuchAlgorithmException { + KeyGenerator kg = KeyGenerator.getInstance("AES"); + SecureRandom random = SecureRandom.getInstance("SHA1PRNG"); + random.setSeed(password.getBytes()); + kg.init(128, random); + SecretKey secretKey = kg.generateKey(); + return new SecretKeySpec(secretKey.getEncoded(), "AES"); + } + + + // ----------------------- 非对称加密 RSA ----------------------- + + private static final String ALGORITHM = "RSA"; + + private static final int KEY_SIZE = 1024; + + + // ---------- 5个常用方法 + + /** + * 生成密钥对 + * @return Map对象 (private=私钥, public=公钥) + * @throws Exception 异常 + */ + public static HashMap rsaGenerateKeyPair() throws Exception { + + KeyPairGenerator keyPairGenerator = KeyPairGenerator.getInstance(ALGORITHM); + KeyPair keyPair; + + try { + keyPairGenerator.initialize(KEY_SIZE, + new SecureRandom(UUID.randomUUID().toString().replaceAll("-", "").getBytes())); + keyPair = keyPairGenerator.generateKeyPair(); + } catch (InvalidParameterException e) { + throw e; + } catch (NullPointerException e) { + throw e; + } + + RSAPublicKey rsaPublicKey = (RSAPublicKey) keyPair.getPublic(); + RSAPrivateKey rsaPrivateKey = (RSAPrivateKey) keyPair.getPrivate(); + + HashMap map = new HashMap(16); + map.put("private", encoder.encodeToString(rsaPrivateKey.getEncoded())); + map.put("public", encoder.encodeToString(rsaPublicKey.getEncoded())); + return map; + } + + /** + * RSA公钥加密 + * @param publicKeyString 公钥 + * @param content 内容 + * @return 加密后内容 + */ + public static String rsaEncryptByPublic(String publicKeyString, String content) { + try { + // 获得公钥对象 + PublicKey publicKey = getPublicKeyFromString(publicKeyString); + + Cipher cipher = Cipher.getInstance("RSA"); + cipher.init(Cipher.ENCRYPT_MODE, publicKey); + // 该密钥能够加密的最大字节长度 + int splitLength = ((RSAPublicKey) publicKey).getModulus().bitLength() / 8 - 11; + byte[][] arrays = splitBytes(content.getBytes(), splitLength); + StringBuffer stringBuffer = new StringBuffer(); + for (byte[] array : arrays) { + stringBuffer.append(bytesToHexString(cipher.doFinal(array))); + } + return stringBuffer.toString(); + } catch (Exception e) { + throw new SaTokenException(e); + } + } + + /** + * RSA私钥加密 + * @param privateKeyString 私钥 + * @param content 内容 + * @return 加密后内容 + */ + public static String rsaEncryptByPrivate(String privateKeyString, String content) { + try { + PrivateKey privateKey = getPrivateKeyFromString(privateKeyString); + + Cipher cipher = Cipher.getInstance("RSA"); + cipher.init(Cipher.ENCRYPT_MODE, privateKey); + // 该密钥能够加密的最大字节长度 + int splitLength = ((RSAPrivateKey) privateKey).getModulus().bitLength() / 8 - 11; + byte[][] arrays = splitBytes(content.getBytes(), splitLength); + StringBuffer stringBuffer = new StringBuffer(); + for (byte[] array : arrays) { + stringBuffer.append(bytesToHexString(cipher.doFinal(array))); + } + return stringBuffer.toString(); + } catch (Exception e) { + throw new SaTokenException(e); + } + } + + /** + * RSA公钥解密 + * @param publicKeyString 公钥 + * @param content 已加密内容 + * @return 解密后内容 + */ + public static String rsaDecryptByPublic(String publicKeyString, String content) { + + try { + PublicKey publicKey = getPublicKeyFromString(publicKeyString); + + Cipher cipher = Cipher.getInstance("RSA"); + cipher.init(Cipher.DECRYPT_MODE, publicKey); + // 该密钥能够加密的最大字节长度 + int splitLength = ((RSAPublicKey) publicKey).getModulus().bitLength() / 8; + byte[] contentBytes = hexStringToBytes(content); + byte[][] arrays = splitBytes(contentBytes, splitLength); + StringBuffer stringBuffer = new StringBuffer(); + for (byte[] array : arrays) { + stringBuffer.append(new String(cipher.doFinal(array))); + } + return stringBuffer.toString(); + } catch (Exception e) { + throw new SaTokenException(e); + } + } + + /** + * RSA私钥解密 + * @param privateKeyString 公钥 + * @param content 已加密内容 + * @return 解密后内容 + */ + public static String rsaDecryptByPrivate(String privateKeyString, String content) { + try { + PrivateKey privateKey = getPrivateKeyFromString(privateKeyString); + + Cipher cipher = Cipher.getInstance("RSA"); + cipher.init(Cipher.DECRYPT_MODE, privateKey); + // 该密钥能够加密的最大字节长度 + int splitLength = ((RSAPrivateKey) privateKey).getModulus().bitLength() / 8; + byte[] contentBytes = hexStringToBytes(content); + byte[][] arrays = splitBytes(contentBytes, splitLength); + StringBuffer stringBuffer = new StringBuffer(); + for (byte[] array : arrays) { + stringBuffer.append(new String(cipher.doFinal(array))); + } + return stringBuffer.toString(); + } catch (Exception e) { + throw new SaTokenException(e); + } + } + + + // ---------- 获取*钥 + + /** 根据公钥字符串获取 公钥对象 */ + private static PublicKey getPublicKeyFromString(String key) + throws NoSuchAlgorithmException, InvalidKeySpecException { + + // 过滤掉\r\n + key = key.replace("\r\n", ""); + + // 取得公钥 + X509EncodedKeySpec x509KeySpec = new X509EncodedKeySpec(decoder.decode(key)); + + KeyFactory keyFactory = KeyFactory.getInstance(ALGORITHM); + + PublicKey publicKey = keyFactory.generatePublic(x509KeySpec); + + return publicKey; + } + + /** 根据私钥字符串获取 私钥对象 */ + private static PrivateKey getPrivateKeyFromString(String key) + throws NoSuchAlgorithmException, InvalidKeySpecException { + + // 过滤掉\r\n + key = key.replace("\r\n", ""); + + // 取得私钥 + PKCS8EncodedKeySpec x509KeySpec = new PKCS8EncodedKeySpec(decoder.decode(key)); + + KeyFactory keyFactory = KeyFactory.getInstance(ALGORITHM); + + PrivateKey privateKey = keyFactory.generatePrivate(x509KeySpec); + + return privateKey; + } + + + // ---------- 一些辅助方法 + + /** 根据限定的每组字节长度，将字节数组分组 */ + private static byte[][] splitBytes(byte[] bytes, int splitLength) { + + // bytes与splitLength的余数 + int remainder = bytes.length % splitLength; + // 数据拆分后的组数，余数不为0时加1 + int quotient = remainder != 0 ? bytes.length / splitLength + 1 : bytes.length / splitLength; + byte[][] arrays = new byte[quotient][]; + byte[] array = null; + for (int i = 0; i < quotient; i++) { + // 如果是最后一组（quotient-1）,同时余数不等于0，就将最后一组设置为remainder的长度 + if (i == quotient - 1 && remainder != 0) { + array = new byte[remainder]; + System.arraycopy(bytes, i * splitLength, array, 0, remainder); + } else { + array = new byte[splitLength]; + System.arraycopy(bytes, i * splitLength, array, 0, splitLength); + } + arrays[i] = array; + } + return arrays; + } + + /** 将字节数组转换成16进制字符串 */ + private static String bytesToHexString(byte[] bytes) { + + StringBuffer sb = new StringBuffer(bytes.length); + String temp = null; + for (int i = 0; i < bytes.length; i++) { + temp = Integer.toHexString(0xFF & bytes[i]); + if (temp.length() < 2) { + sb.append(0); + } + sb.append(temp); + } + return sb.toString(); + } + + /** 将16进制字符串转换成字节数组 */ + private static byte[] hexStringToBytes(String hex) { + + int len = (hex.length() / 2); + hex = hex.toUpperCase(); + byte[] result = new byte[len]; + char[] chars = hex.toCharArray(); + for (int i = 0; i < len; i++) { + int pos = i * 2; + result[i] = (byte) (toByte(chars[pos]) << 4 | toByte(chars[pos + 1])); + } + return result; + } + + /** 将char转换为byte */ + private static byte toByte(char c) { + + return (byte) "0123456789ABCDEF".indexOf(c); + } + + + +} diff --git a/sa-token-doc/doc/use/dao-extend.md b/sa-token-doc/doc/use/dao-extend.md index 7a41f617..e9a5c774 100644 --- a/sa-token-doc/doc/use/dao-extend.md +++ b/sa-token-doc/doc/use/dao-extend.md @@ -50,7 +50,6 @@ Sa-token默认将会话数据保存在内存中，此模式读写速度最快， 需要！只有项目初始化了正确的Redis实例，`sa-token`才可以使用Redis进行数据持久化，参考：[application-dev.yml](https://gitee.com/sz6/sa-plus/blob/master/sp-server/src/main/resources/application-dev.yml) - **3. 集成Redis后，是我额外手动保存数据，还是框架自动保存？**
框架自动保存。集成`Redis`只需要引入对应的`pom依赖`即可，框架所有上层API保持不变