加/解密器工厂

io.github.pangju666.framework.boot.crypto.factory.CryptoFactory

概述

为二进制、文本、整型与高精度小数四类数据提供加密器与解密器的获取方法。

我默认自动装配了四种实现：

• AES256CryptoFactory（基于PBEWithHMACSHA512AndAES_256算法）
• BasicCryptoFactory（基于PBEWithMD5AndDES算法）
• RSACryptoFactory（基于RSA/ECB/OAEPWithSHA-256AndMGF1Padding算法）
• StrongCryptoFactory（基于PBEWithMD5AndTripleDES算法）

NOTE

四种默认实现的Spring Bean是同时存在的，所以使用时不能直接注入CryptoFactory类型的Bean，而是注入具体实现类型的Bean。

也可以使用CryptoAlgorithm结合StaticSpringContext来根据算法类型获取。

CryptoFactory cryptoFactory = StaticSpringContext.getBeanFactory().getBean(CryptoAlgorithm.RSA.getFactoryClass());

IMPORTANT

除了RSA的其他内置算法都是PBE类型的基于口令的算法，加解密使用的是同一口令。

RSA算法加密需要传入Base64编码的公钥，解密需要传入Base64编码的私钥

RSA密钥文档

配置

pangju:
    crypto:
      max-cache-crypto-key-size: 16 #加密工厂缓存的最大密钥数量，默认值：16

接口定义

public interface CryptoFactory {
	BinaryEncryptor getBinaryEncryptor(String key);

	TextEncryptor getTextEncryptor(String key);

	IntegerNumberEncryptor getIntegerNumberEncryptor(String key);

	DecimalNumberEncryptor getDecimalNumberEncryptor(String key);

	default BinaryEncryptor getBinaryDecryptor(String key) {
		return getBinaryEncryptor(key);
	}

	default TextEncryptor getTextDecryptor(String key) {
		return getTextEncryptor(key);
	}

	default IntegerNumberEncryptor getIntegerNumberDecryptor(String key) {
		return getIntegerNumberEncryptor(key);
	}

	default DecimalNumberEncryptor getDecimalNumberDecryptor(String key) {
		return getDecimalNumberEncryptor(key);
	}
}

使用示例

@Service
public class CryptoService {
    private final RSACryptoFactory cryptoFactory;
    
    public CryptoService(RSACryptoFactory cryptoFactory) {
        this.cryptoFactory = cryptoFactory;
    }

	public void test() {
	    // RSA加密
	    RSAKey rasKey = RSAKey.random();
	    String rawText = "hello world";
	    
	    // 加密
		String publicKey = Base64.encodeBase64String(rasKey.getPublicKey().getEncoded());
		String encryptText;
		try {
			encryptText = cryptoFactory.getTextEncryptor(publicKey).encrypt(rawText);
		} catch (IllegalArgumentException e) {
			// 处理密钥无效异常
		} catch (EncryptionOperationNotPossibleException e) {
			// 处理加密失败异常
		}
		
		// 解密
		String privateKey = Base64.encodeBase64String(rasKey.getPrivateKey().getEncoded());
		String decryptText;
		try {
			decryptText = cryptoFactory.getTextDecryptor(privateKey).decrypt(encryptText);
		} catch (IllegalArgumentException e) {
			// 处理密钥无效异常
		} catch (EncryptionOperationNotPossibleException e) {
			// 处理解密失败异常
		}
		
		// AES加密
		CryptoFactory cryptoFactory = CryptoAlgorithm.AES256.getFactory();
		String password = "123456";
	    String rawText = "hello world";
	    
	    // 加密
		String encryptText;
		try {
			encryptText = cryptoFactory.getTextEncryptor(password).encrypt(rawText);
		} catch (IllegalArgumentException e) {
			// 处理密钥无效异常
		} catch (EncryptionOperationNotPossibleException e) {
			// 处理加密失败异常
		}
		
		// 解密
		String decryptText;
		try {
			decryptText = cryptoFactory.getTextDecryptor(password).decrypt(encryptText);
		} catch (IllegalArgumentException e) {
			// 处理密钥无效异常
		} catch (EncryptionOperationNotPossibleException e) {
			// 处理解密失败异常
		}
	}
}

自定义算法

可以实现其他加密算法工厂，也可以替换掉上述的算法工厂默认实现。

自定义算法实现参考

public class CustomCryptoFactory implements CryptoFactory {
	@Override
	public BinaryEncryptor getBinaryEncryptor(String key) {
		return null;
	}
	
	@Override
	public TextEncryptor getTextEncryptor(String key) {
		return null;
	}

	@Override
	public IntegerNumberEncryptor getIntegerNumberEncryptor(String key) {
		return null;
	}

	@Override
	public DecimalNumberEncryptor getDecimalNumberEncryptor(String key) {
		return null;
	}

	@Override
	public BinaryEncryptor getBinaryDecryptor(String key) {
		return null;
	}
	
	@Override
	public TextEncryptor getTextDecryptor(String key) {
		return null;
	}

	@Override
	public IntegerNumberEncryptor getIntegerNumberDecryptor(String key) {
		return null;
	}

	@Override
	public DecimalNumberEncryptor getDecimalNumberDecryptor(String key) {
		return null;
	}
}

@SpringBootConfiguration
public class BeanConfig {
	@Bean
	public CustomCryptoFactory customCryptoFactory() {
		return new CustomCryptoFactory();
	}
}

替换RSA默认加密方案

RSA加密工厂可以修改默认的加密方案，默认使用RSA/ECB/OAEPWithSHA-256AndMGF1Padding，具体说明请查看相关文档。

@SpringBootConfiguration
public class BeanConfig {
	@Bean
	public RSACryptoFactory customRSACryptoFactory(CryptoProperties properties) {
		return new RSACryptoFactory(properties.getMaxCacheCryptoKeySize(), new RSAPKCS1PaddingTransformation());
	}
}

替换加密算法默认实现

可以直接继承内置的加密算法工厂，然后重写其中的逻辑，再将其定义为Spring Bean来替换默认实现。

public class CustomAes256CryptoFactory extends AES256CryptoFactory {
	@Override
	public BinaryEncryptor getBinaryEncryptor(String key) {
		return null;
	}

	@Override
	public TextEncryptor getTextEncryptor(String key) {
		return null;
	}

	@Override
	public IntegerNumberEncryptor getIntegerNumberEncryptor(String key) {
		return null;
	}

	@Override
	public DecimalNumberEncryptor getDecimalNumberEncryptor(String key) {
		return null;
	}

	@Override
	public BinaryEncryptor getBinaryDecryptor(String key) {
		return null;
	}

	@Override
	public TextEncryptor getTextDecryptor(String key) {
		return null;
	}

	@Override
	public IntegerNumberEncryptor getIntegerNumberDecryptor(String key) {
		return null;
	}

	@Override
	public DecimalNumberEncryptor getDecimalNumberDecryptor(String key) {
		return null;
	}
}

@SpringBootConfiguration
public class BeanConfig {
	@Bean
	public Aes256CryptoFactory customAes256CryptoFactory() {
		return new CustomAes256CryptoFactory();
	}
}