# license

**Repository Path**: qq296141266/license

## Basic Information

- **Project Name**: license
- **Description**: 开发的系统需要设置授权才能使用，需要支持一些个性化参数，例如用户注册数量、在线用户数量等，本项目使用TrueLicense生成授权证书。   
我不喜欢麻烦，尽量做到开箱即用，内置了密钥对，也可以使用keytool生产自己的密钥对，填写一下配置文件就好。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2022-05-25
- **Last Updated**: 2022-05-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 授权证书
[![Java](https://img.shields.io/badge/JDK-1.8-green.svg)]()
[![Spring Boot](https://img.shields.io/badge/Spring%20Boot-2.4.5.RELEASE-brightgreen.svg)](https://spring.io/projects/spring-boot)
[![auth](https://img.shields.io/badge/作者-张德芳-success.svg??style=for-the-badge&logo=superuser)]()

[TOC]

[![](https://img-blog.csdnimg.cn/fc2d71ae5f424a698ded07d8539dc5c5.png)]()  
[![](https://img-blog.csdnimg.cn/74b4beddea214c6fb716de40dcbbe68d.png)]()

## 1. 介绍
开发的系统需要设置授权才能使用，需要支持一些个性化参数，例如用户注册数量、在线用户数量等，本项目使用TrueLicense生成授权证书。   
我不喜欢麻烦，尽量做到开箱即用，内置了密钥对，也可以使用keytool生产自己的密钥对，填写一下配置文件就好。


## 2. 项目结构
license-core 证书相关操作核心代码  
license-creator-spring-boot-starter 生成证书  
license-creator-webapp 生成证书的一个webapp  
license-verify-spring-boot-starter 证书校验模块  
license-verify-demo 证书校验示例

## 3. 使用方法

* 新建项目引入`license-verify-spring-boot-starter`模块
* 创建个性化参数校验,新建一个类继承`ACustomVerifyListener` 
```java
/**
 * springboot在初始化这个类时就已经装载到了证书的监听管理
 */
@Component
public class UserNumVerifyListener extends ACustomVerifyListener {
    /**
     *  userNum 个性化校验
     */
    private Integer userNum=0;
    /**
     *  ParamType 在生成证书和获取申请码以及展示上有重要作用
     */
    private static final ParamType paramType = new ParamType("userNum", "用户数量", java.lang.Integer.class);
    
    /**
     *  证书在安装时候回调的方法，LicenseExtraParam 中包含很多额外的参数，
     *  用户自定义参数一般在 params 中，key是 ParamType 中的 key
     */
    @Override
    public void install(LicenseExtraParam licenseExtra) {
        userNum = Integer.parseInt(licenseExtra.getParams().get(paramType.getKey()).toString());
    }
    
    /**
     *  证书在卸载时候回调的方法，将参数归零
     */
    @Override
    public void uninstall() {
        userNum = 0;
    }
    
    /**
     *  生成证书申请码时候会被调用
     */
    @Override
    public ParamType paramType() {
        return UserNumVerifyListener.paramType;
    }
    
    /**
     *  自定义验证方法，返回是否校验通过
     */
    public boolean verify(Integer userNum){
        return userNum < this.userNum;
    }
}
```
* 在需要校验的地方引入这个类并调用校验方法
* 可以使用 `@VLicense` 在关键入口做校验，验证证书是否过期
* 校验使用可以参考`TestController`
* creator配置文件(可以不写，内置有密钥对)
```yaml
license:
    generate:
        filename: license.lic
        subject: cspt
        privateAlias: privateKey
        keyPass: wsn++123
        storePass: wsn++123
        privateKeysStorePath: /privateKeys.store

```
* verify配置文件(可以不写，内置有密钥对)
```yaml
license:
    verify:
        subject: cspt
        publicAlias: publiccert
        publicKeysStorePath: /publicCerts.store
        storePass: wsn++123
        licensePath: license.lic
```

## 4. 示例
提供两个可运行的项目示例
1. license-creator-webapp
    > 生成证书webapp，可以直接拿来用
2. license-verify-demo
    > 校验证书示例app
## 5.生成证书
```
keytool -genkeypair -keysize 1024 -validity 3650 -alias "privateKey" -keystore "privateKeys.keystore" -storepass "ydkj2022" -keypass "ydkj2022" -dname "CN=ZT, OU=YiDian, O=Xi'an Yidian Technology, L=Xi'an, ST=ShaanXi, C=CN"

# 导出命令
keytool -exportcert -alias "privateKey" -keystore "privateKeys.keystore" -storepass "ydkj2022" -file "certfile.cer"

#导入命令
keytool -import -alias "publicCert" -file "certfile.cer" -keystore "publicCerts.keystore" -storepass "ydkj2022"
```