6 Star 27 Fork 18

任鑫 / truelicense应用

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

truelicense框架应用

重构版本更好用,提供了Springboot的快速接入模块:dlicense

介绍

基于springboot构建的应用证书授权验证服务

数字证书

入门博客参考

数字证书
代码如诗-数字证书

使用java命令行生成密钥库

依赖jdk的keytool命令

  1. 生成私钥库:
keytool -genkeypair -keysize 1024 -validity 3650 -alias "privateKey" -keystore "privateKeys.keystore" -storepass "renxin123" -keypass "renxin123" -dname "CN=littleutry, OU=utry, O=hy, L=HZ, ST=ZJ, C=CN"

命令参数说明:

参数 说明 备注
keysize 生成密钥长度 请务必设为1024
validity 密钥有效期(单位:天) 生成证书时证书有效期不应大于密钥有效期
alias 私钥别名
keystore 生成私钥库的文件名
storepass 私钥库口令 必须为小写字母和数字组合,否则程序校验不通过
keypass 密钥口令 保持与私钥库口令一致,否则解密证书会出现问题
dname 密钥的Distinguished name 程序生成证书会用到
  1. 导出公钥证书文件
keytool -exportcert -alias "privateKey" -keystore "privateKeys.keystore" -storepass "renxin123" -file "certfile.cer"

命令参数说明:

参数 说明 备注
alias 私钥别名
keystore 上一步生成的私钥库的文件名
storepass 私钥库口令 上一步设置的私钥库文件名
file 导出后的的公钥证书文件名
  1. 将公钥证书导入公钥库
keytool -import -alias "publicCert" -file "certfile.cer" -keystore "publicCerts.keystore" -storepass "renxin123"

命令参数说明:

参数 说明 备注
alias 公钥别名
file 要导入的公钥文件
keystore 要导入的公钥库的文件名
storepass 公钥库口令,保持与第一步设置的私钥库口令一致,否则证书安装将不通过

工程简介

  1. 工程结构
    使用springboot1.5.21构建web工程
    完整代码见:license-verify
    license-server工程使用swagger在线文档,工程启动后访问host:port/doc.html查看接口文档
  • license-verify 父工程,抽取公共依赖

  • license-common 公共模块,提供扩展校验逻辑接口

  • license-server 授权证书颁发服务,提供接口用于生成并下载数字证书

  • license-client 授权引入数字证书授权案例工程

  • keystore 示例工程默认使用的密钥库文件

使用说明

生成密钥库

按前述步骤生成两个密钥库文件privateKeys.keystore和publicCerts.keystore,详细记录相关参数。

使用license-server工程生成证书
  1. 将私钥库文件privateKeys.keystore,拷贝到/resource/license/privateKeys.keystore
  2. 按注释完善核心配置文件/resource/license/config.properties,该配置文件对应配置类是com.utry.license.server.license.LicenseConfigBean
  3. 启动工程,按接口文档(host:port/doc.html)提示创建并下载生成的证书文件,保存好证书文件待用
    注意!务必仔细阅读接口文档
license-client工程验证证书有效性

该工程是一个示例工程,用以指导为应用程序引入证书校验功能,引入步骤如下

  1. 首先引入license-common模块依赖包(license-client已经引入);
  2. 工程启动类上使用注解@ComponentScan(basePackages = {"com.utry.license.common.verify","com.utry.license.client"})将证书校验功能引入;
  3. 将公钥库文件publicCerts.keystore拷贝到/resource/license/publicCerts.keystore,将证书文件拷贝到/resource/license/license.lic
  4. 按注释提示完善核心配置文件/resource/license/config.properties的配置,该配置文件对应配置类是com.utry.license.common.verify.LicenseConfigBean
license-common模块抽取公共逻辑,可用于扩展校验逻辑

该模块功能主要是有:

  • 校验功能核心配置读取
  • 证书有效性以及扩展参数(IP地址、mac地址等)的校验。
  • 自定义扩展:
    • 实现com.utry.license.common.verify.CustomLicenseVerifier接口,在customVerify方法中书写扩展校验逻辑
    • 将该实现类的bean注入spring容器即可
      扩展校验参数为com.utry.license.common.ExtraLicenseContent的customContent字段

使用过程中其他问题

Q1
为什么将私钥库密码、公钥库密码、私钥密码设为一致且必须为小写字母和数字组合?
A1
公私密钥库密码不统一将导致证书文件解密失败,这个坑很大,因为异常信息是在jdk解密工具包抛出,很难联想到需要公私钥库不统一。
Q2
如何扩展校验逻辑?
A2
如何扩展,前面已有说明,这里重点说一下,重写customVerify方法扩展了spring容器启动过程中和定时校验证书有效性的逻辑,其他细粒度权限校验, 如接口权限等的校验需要自己扩展接口拦截器,注入DefaultLicenseVerifier通过它的getCustomLicenseContent方法可获得自定义扩展校验参数。
Q3
为什么限制扩展参数长度?
A3
所有校验参数最终都被truelicense框架序列化为xml字符串,经过私钥加密生成证书文件,使用证书时需要以字节数组形式读入证书文件,truelicense框架限制最大读入1024*1024大小的证书文件,
非对称加解密本身消耗系统资源比较大,因此不建议使用太庞大的扩展参数最终导致证书文件过大。

其他问题

  1. 有关证书使用者修改服务器时间会导致证书有效期校验不准确问题

答:目前证书校验逻辑中是取系统时间和证书解密后包含的有效时间段做了对比,因此若使用者修改系统时间使之偏离正常时间确实会导致校验不准确问题。
由于我们的程序除从系统获取时间外不能从其他渠道获取到时间,因此要避免这个问题,只能考虑其他时间校验方式,比如校验证书的使用时长,起始三十天,使用过程中。

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

基于springboot构建的应用证书授权验证服务 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/heartpower/license-verify.git
git@gitee.com:heartpower/license-verify.git
heartpower
license-verify
truelicense应用
master

搜索帮助