Spring Boot实现License生成与校验详解

博客主页: 南来_北往

系列专栏：Spring Boot实战

在软件开发领域，License（许可证）机制是保护软件版权、控制软件使用范围的重要手段。通过为软件生成唯一的License，开发者可以确保只有合法用户才能使用软件，并有效防止盗版和非法复制。本文将详细介绍如何使用Spring Boot框架实现License的生成与校验功能。

一、引言

Spring Boot作为Java领域一款轻量级的框架，以其简洁、快速和高效的特点，深受开发者喜爱。它提供了丰富的功能组件和便捷的开发工具，使得开发者可以专注于业务逻辑的实现，而无需过多关注底层配置和集成问题。在License管理系统中，Spring Boot同样可以发挥重要作用，帮助我们快速搭建起一个稳定、高效的License生成与校验平台。

二、License生成机制

License的生成通常涉及以下几个关键步骤：

生成唯一标识：为每个软件实例生成一个唯一的标识符（如UUID），用于区分不同的软件实例。
加密处理：为了保护License信息的安全，通常需要对唯一标识进行加密处理。可以使用对称加密算法（如AES）或非对称加密算法（如RSA）来实现。
添加附加信息：在License中还可以添加一些附加信息，如软件版本、有效期、使用限制等，以便在后续的校验过程中进行验证。
生成License文件：将加密后的唯一标识和附加信息按照特定的格式（如JSON、XML等）进行封装，并生成一个License文件或字符串。

在Spring Boot中，我们可以利用Spring Security等安全框架来简化加密处理过程，并使用Java的IO流操作来生成License文件。

三、License校验机制

License的校验是确保软件合法使用的关键步骤。在软件启动时或特定操作执行前，系统需要读取并校验License文件。校验过程通常包括以下几个步骤：

读取License文件：从指定路径或资源中读取License文件的内容。
解密处理：使用与生成过程中相同的加密算法对License文件进行解密，获取其中的唯一标识和附加信息。
校验唯一标识：将解密后的唯一标识与软件实例中的标识进行对比，确保它们一致。
校验附加信息：根据附加信息中的软件版本、有效期等限制条件进行校验，确保软件使用合法。
处理校验结果：根据校验结果进行相应的处理，如通过校验则允许软件继续使用，否则提示用户重新获取合法的License或退出软件。

在Spring Boot中，我们可以将License校验逻辑封装为一个服务类，并在软件启动或特定操作执行前调用该服务进行校验。

四、实现步骤

一、准备阶段

1. 生成密钥对

在生成License之前，首先需要生成一对公私钥。这可以通过JDK自带的KeyTool工具来完成。例如，在命令行中运行以下命令：

keytool -genkeypair -keysize 1024 -validity 3650 -alias "privateKey" -keystore "privateKeys.keystore" -storepass "public_password1234" -keypass "private_password1234" -dname "CN=localhost, OU=localhost, O=localhost, L=SH, ST=SH, C=CN"

此命令将生成一个名为privateKeys.keystore的私钥库文件，并设置私钥的别名为privateKey，私钥库密码为public_password1234，私钥密码为private_password1234。

接着，导出私钥库中的公钥到一个证书文件中：

keytool -exportcert -alias "privateKey" -keystore "privateKeys.keystore" -storepass "public_password1234" -file "certfile.cer"

然后，将导出的证书文件导入到一个公钥库文件中：

keytool -import -alias "publicCert" -file "certfile.cer" -keystore "publicCerts.keystore" -storepass "public_password1234"

此时，将生成三个文件：privateKeys.keystore（私钥库）、publicCerts.keystore（公钥库）和certfile.cer（临时证书文件，可以删除）。

2. 添加Maven依赖

在Spring Boot项目的pom.xml文件中，添加TrueLicense的依赖项：

<dependency>  
    <groupId>de.schlichtherle.truelicense</groupId>  
    <artifactId>truelicense-core</artifactId>  
    <version>1.33</version>  
</dependency>

二、生成License

1. 编写生成License的接口

创建一个Spring Boot控制器类，用于提供生成License的RESTful接口。例如：

@RestController  
@RequestMapping("/license")  
public class LicenseCreatorController {  
  
    @Autowired  
    private LicenseCreatorService licenseCreatorService;  
  
    @PostMapping("/generate")  
    public ResponseEntity<String> generateLicense(@RequestBody LicenseCreatorParam param) {  
        try {  
            licenseCreatorService.createLicense(param);  
            return ResponseEntity.ok("License generated successfully");  
        } catch (Exception e) {  
            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("Failed to generate license: " + e.getMessage());  
        }  
    }  
}

其中，LicenseCreatorParam是一个包含生成License所需参数的DTO类，如私钥别名、私钥密码、私钥库路径、License有效期等。

2. 实现生成License的服务类

在服务类中，使用TrueLicense库来生成License。例如：

@Service  
public class LicenseCreatorService {  
  
    public void createLicense(LicenseCreatorParam param) throws Exception {  
        // 加载私钥库  
        KeyStore privateKeyStore = KeyStore.getInstance(KeyStore.getDefaultType());  
        privateKeyStore.load(new FileInputStream(param.getPrivateKeysStorePath()), param.getStorePass().toCharArray());  
        PrivateKey privateKey = (PrivateKey) privateKeyStore.getKey(param.getPrivateAlias(), param.getKeyPass().toCharArray());  
  
        // 设置License信息  
        LicenseParam licenseParam = new LicenseParam();  
        licenseParam.setSubject(param.getSubject());  
        licenseParam.setIssued(new Date());  
        licenseParam.setNotBefore(param.getNotBefore());  
        licenseParam.setNotAfter(param.getNotAfter());  
        // 添加其他自定义信息，如IP地址、MAC地址等  
  
        // 生成License  
        LicenseManager licenseManager = new LicenseManager();  
        byte[] licenseData = licenseManager.store(licenseParam, privateKey);  
  
        // 将License保存到文件  
        FileOutputStream fos = new FileOutputStream(param.getLicensePath());  
        fos.write(licenseData);  
        fos.close();  
    }  
}

三、校验License

1. 编写校验License的接口

创建一个Spring Boot控制器类，用于提供校验License的RESTful接口。例如：

@RestController  
@RequestMapping("/license")  
public class LicenseVerifyController {  
  
    @Autowired  
    private LicenseVerifyService licenseVerifyService;  
  
    @PostMapping("/verify")  
    public ResponseEntity<String> verifyLicense(@RequestBody LicenseVerifyParam param) {  
        try {  
            boolean isValid = licenseVerifyService.verifyLicense(param);  
            return ResponseEntity.ok(isValid ? "License is valid" : "License is invalid");  
        } catch (Exception e) {  
            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("Failed to verify license: " + e.getMessage());  
        }  
    }  
}

其中，LicenseVerifyParam是一个包含校验License所需参数的DTO类，如公钥库路径、License文件路径等。

2. 实现校验License的服务类

在服务类中，使用TrueLicense库来校验License。例如：

@Service  
public class LicenseVerifyService {  
  
    public boolean verifyLicense(LicenseVerifyParam param) throws Exception {  
        // 加载公钥库  
        KeyStore publicKeyStore = KeyStore.getInstance(KeyStore.getDefaultType());  
        publicKeyStore.load(new FileInputStream(param.getPublicKeysStorePath()), param.getStorePass().toCharArray());  
        Certificate publicKeyCert = publicKeyStore.getCertificate(param.getPublicAlias());  
        PublicKey publicKey = publicKeyCert.getPublicKey();  
  
        // 读取License文件  
        FileInputStream fis = new FileInputStream(param.getLicensePath());  
        byte[] licenseData = fis.readAllBytes();  
        fis.close();  
  
        // 校验License  
        LicenseManager licenseManager = new LicenseManager();  
        License license = licenseManager.load(licenseData);  
  
        // 验证License是否有效，如检查是否过期、是否被篡改等  
        return licenseManager.verify(license, publicKey);  
    }  
}