feat: 增加客户端授权测试工具说明
This commit is contained in:
wood911010 committed
1 parent
cc13b4db93
commit
d1fbc4896b
6 files changed
+147
-1
No files matched your search
@@ -0,0 +1,51 @@
|
||||
# License Manager Python SDK 正式发布！全套精细化授权管控能力现已支持 Python 生态
|
||||
|
||||
大家好！我们非常高兴地宣布，**License Manager Python SDK** 现已正式发布！🎉
|
||||
|
||||
作为 License Manager 授权管控中枢的官方 Python 客户端，本次发布的 SDK 专为各类的 Python 软件项目、AI 算法模型落地以及跨平台的私有化部署应用量身打造。我们的目标是为广大 Python 开发者提供从在线激活、离线鉴权、设备机器指纹绑定到云端后台实时心跳管控的“一站式”应用授权治理方案。
|
||||
|
||||
## License Manager产品定位
|
||||
软件商业化是一场系统性工程。从产品定价到用户获取，从试用到转化，从续费到升级，每一个环节都至关重要。License Manager作为您的商业化基石，提供完整的货币化技术栈。
|
||||
License Manager支持企业级管理后台和用户端自助服务，实现B2B+B2C双轨运营，企业客户和个人用户均可享受便捷的授权体验。
|
||||
|
||||
|
||||
## 🌟 核心亮点与能力
|
||||
|
||||
1. **强硬件指纹锁定（一机一码防滥用）**：
|
||||
SDK 内置了坚固的跨平台设备特征提取能力（支持一键防伪造提取 MAC、CPU、Hostname 等多维指纹），与 SaaS 云端深度联动，有效防止已授权的软件被随意拷贝至其他机器泛滥使用。
|
||||
|
||||
2. **混合鉴权模式（连网优先 + 脱机兜底）**：
|
||||
- **在线激活**：在联网状态下，用户只需输入短版产品激活码，即可自动从云端拉取下发许可证，全程对用户透明。
|
||||
- **离线侧载验证**：针对军工、工厂车间等物理隔离的无完全外网环境，我们完美支持通过“离线验证信封（Envelope）”机制，携带授权公钥完成高强度的本地化验签体验。
|
||||
|
||||
3. **银行级数据防篡改保护**：
|
||||
依托于非对称加密系统（RSA-PSS + AES-GCM），无论是在网络传输过程中，还是最终生成的本地 `license.lic` 授权持久化缓存文件，均需经过不可逆的严格签名验证，从根源上抵御任何形式的客户端篡改和破解欺骗。
|
||||
|
||||
4. **云端毫秒级实时管控响应 (Heartbeat)**：
|
||||
SDK 底层内置了轻量级、防干扰的心跳守护线程。这意味着，即便您的软件已经交付到了客户机，如果管理者在云端控制台执行了针对该设备的“禁止登录”、“解绑收回”操作，或是许可证到期，客户端将在极短的心跳周期内拉取阻断状态，并立刻回调挂起或锁死您的核心业务系统。
|
||||
|
||||
## 典型接入场景
|
||||
|
||||
- 机器视觉软件、AI 检测算法大模型、以及上位机控制系统的私有化分发交付。
|
||||
- 桌面客户端、边缘网关与 License Manager 云端管控保持实时授权生命周期同步。
|
||||
- 解决开源工具套件想要实现快速变现、分级订阅模式的授权落地难题。
|
||||
|
||||
## 快速接入体验
|
||||
|
||||
我们深知开发者体验的重要性，因此将底层复杂的非对称加密和通信排队逻辑全都进行了高级别封装。现在，您仅需一步引入：
|
||||
|
||||
```bash
|
||||
pip install cedarv-license-manager-sdk
|
||||
```
|
||||
|
||||
只要几行代码来配置您的后台产品身份，设置好相关的状态告警日志回调，就可以立刻为您珍贵的项目加上企业级基础设施的安全锁。
|
||||
*Tips：我们在 SDK 的 `examples/客户案例1` 目录下同时也提供了一款基于可视化的 **Client Simulator (客户端授权测试工具) Demo**，附带 Windows 可执行程序，帮助您零代码跑通连网下发与防拉黑拦截的全流程。*
|
||||
|
||||
---
|
||||
|
||||
欢迎访问以下资源了解更多详情，或直接获取详尽的接入指南：
|
||||
|
||||
**License Manager 官方网站**：[https://www.cedar-v.com](https://www.cedar-v.com)
|
||||
**开发者快速接入文档库**：[https://docs.lm.cedar-v.com](https://docs.lm.cedar-v.com)
|
||||
|
||||
期待各位 Pythonist 的接入与体验！如果您在使用过程中产生任何灵感、功能建议或遇到疑惑，非常欢迎在 Gitee 仓库给我们提 Issue 进行交流讨论。
|
||||
@@ -134,6 +134,7 @@ export default withMermaid(
|
||||
{ text: '操作指南', link: '/guide/operating_guide' },
|
||||
{ text: '许可证结构与验证（客户端要点）', link: '/guide/license-token-structure' },
|
||||
{ text: '客户端 SDK', link: '/guide/sdk' },
|
||||
{ text: '客户端授权测试工具', link: '/guide/client-simulator' },
|
||||
{ text: '商业价值', link: '/guide/business_value' },
|
||||
{ text: '接口文档', link: '/guide/api' },
|
||||
{ text: '社区发展策略', link: '/guide/community_strategy' }
|
||||
@@ -161,6 +162,7 @@ export default withMermaid(
|
||||
{ text: 'Getting Started', link: '/en/guide/getting-started' },
|
||||
{ text: 'Operating Guide', link: '/en/guide/operating_guide' },
|
||||
{ text: 'Client SDK', link: '/en/guide/sdk' },
|
||||
{ text: 'Client Authorization Test Tool', link: '/en/guide/client-simulator' },
|
||||
{ text: 'Business Value', link: '/en/guide/business_value' },
|
||||
{ text: 'License Structure & Validation', link: '/en/guide/license-token-structure' },
|
||||
{ text: 'API Reference', link: '/en/guide/api' },
|
||||
|
||||
@@ -0,0 +1,44 @@
|
||||
# Client Simulator Demo
|
||||
|
||||
To help you quickly understand and test the License Manager SDK (especially the Python client experience), we provide a **Client Simulator** Demo based on a desktop environment. This tool primarily simulates the typical authentication and management workflow of clients such as machine vision applications.
|
||||
|
||||
You can find the relevant code and design documents in the `examples/客户案例1` directory of the Python SDK.
|
||||
|
||||
### ⬇️ Download Experience
|
||||
|
||||
- **Windows 64-bit Standalone Executable**: [LMClientSimulator-win64.exe](https://github.com/cedar-v/license-manager-sdk-python/releases/download/v1.0.1/LMClientSimulator-win64.exe)
|
||||
|
||||
## Interface Overview
|
||||
|
||||
The Demo visually demonstrates the actual operation of device fingerprint recognition, authorization status, local activation, and real-time cloud management.
|
||||
|
||||
|
||||
|
||||
## Core Functional Areas
|
||||
|
||||
The tool interface is divided into three main parts to ensure the transparency and real-time nature of the authorization status:
|
||||
|
||||
### 1. Device Recognition and Status Display Area (Top Panel)
|
||||
- **Device Fingerprint (Hardware ID)**: Automatically extracts the unique hardware characteristic Hash of the current machine (implementing "one machine, one code" to prevent abuse). You can perfectly copy this fingerprint to issue an offline license manually in the backend.
|
||||
- **Current Authorization Status**: Prominently indicates whether the current authorization is valid (Trial/Authorized) or abnormal (Unactivated/Expired/Banned) through traffic light signals and colored text.
|
||||
- **Device Quota and Validity Period**: Transparently displays the current license's usage limits and expiration time.
|
||||
|
||||
### 2. Authorization Operation Area (Middle Panel)
|
||||
- **Product Activation Code Input**:
|
||||
- **Online Activation**: Enter a pure `LIC-xxxx` format activation code. In a networked state, it will automatically request the cloud server to issue a license.
|
||||
- **Offline Sideloading**: Designed for air-gapped environments without external network access. Enter the complete offline authentication envelope data containing `&`. The tool will extract the envelope content and save it to the disk, achieving extremely fast validation under physical isolation.
|
||||
- **Clear Local Cache**: One-click deletion of the locally generated `license.lic`, quickly resetting the tool to the "unauthorized" state, making it convenient for repeated testing.
|
||||
|
||||
### 3. Business Simulation and Base Log Area (Bottom Panel)
|
||||
- **Start Business Inspection (Simulation Button)**: Simulates the startup of the core business engine (e.g., machine vision inspection). Authentication is triggered before clicking:
|
||||
- If within the valid authorization period: A success popup appears.
|
||||
- If the authorization is invalid or locked by the heartbeat hook: Execution is blocked and a warning is issued.
|
||||
- **Runtime Console Log**: Transparently displays the base heartbeat status (e.g., attempting to report status to the server every 30 seconds) and network behavior. Even if the network is briefly disconnected, the business will not be completely stuck thanks to the hybrid authentication mechanism.
|
||||
|
||||
## High-Frequency Testing Scenario Suggestions
|
||||
|
||||
We recommend you test the robustness of the authorization system through the following common scenarios:
|
||||
|
||||
1. **Second-level Signature Verification in Disconnected Environment**: Unplug the network cable, paste the complete offline authentication code containing `&` and activate it. Verify that it passes quickly without network access and you can successfully click to start the simulated business.
|
||||
2. **Anti-freeloading Audit under Network Connection**: Restore the network. At this point, you can forcefully kick out the license bound to the device or execute the unbind operation in the SaaS backend.
|
||||
3. **Millisecond-level Heartbeat Blocking Response**: Wait for one heartbeat cycle (shortened to 30 seconds by default in the tool for demonstration purposes). Once the heartbeat returns "banned," without needing to restart the program, the interface will instantly turn red and automatically block the execution of the core business.
|
||||
@@ -0,0 +1,44 @@
|
||||
# 客户端授权测试工具 (Client Simulator)
|
||||
|
||||
为了方便您快速了解和测试 License Manager SDK（特别是基于 Python 的客户端体验），我们提供了一个基于桌面环境的 **客户端授权测试工具 (Client Simulator)** Demo。该工具主要模拟了机器视觉应用软件等客户端的典型鉴权与管控流程。
|
||||
|
||||
您可以在 Python SDK 的 `examples/客户案例1` 目录下找到相关代码与设计文档。
|
||||
|
||||
### ⬇️ 下载体验
|
||||
|
||||
- **Windows 64位 独立可执行程序**: [LMClientSimulator-win64.exe](https://github.com/cedar-v/license-manager-sdk-python/releases/download/v1.0.1/LMClientSimulator-win64.exe)
|
||||
|
||||
## 界面概览
|
||||
|
||||
该 Demo 直观展示了设备指纹识别、授权状态、本地激活与云端实时管控的实际运行效果。
|
||||
|
||||
|
||||
|
||||
## 核心功能区
|
||||
|
||||
工具界面分为三个主要部分，以保证授权状态的透明与实时性：
|
||||
|
||||
### 1. 设备识别与状态显式区 (Top Panel)
|
||||
- **设备指纹 (Hardware ID)**: 自动提取当前机器的唯一硬件特征 Hash（实现“一机一码”防滥用）。您可以一键复制该指纹用于后台人工派发离线许可。
|
||||
- **当前授权状态**: 通过红绿灯及文字醒目提示当前授权是合法（试用中/已授权）还是异常（未激活/已过期/被封禁）。
|
||||
- **设备额度与有效期**: 透明展示当前许可证的使用限制与过期时间。
|
||||
|
||||
### 2. 授权操作区 (Middle Panel)
|
||||
- **产品激活码输入**:
|
||||
- **在线激活**: 输入纯 `LIC-xxxx` 格式激活码，联网状态下自动向云端服务器请求下发许可。
|
||||
- **离线侧载**: 针对无外网隔离环境，输入包含 `&` 的完整离线鉴权信封数据，工具会提取信封内容并落盘，实现物理隔离下的极速验证。
|
||||
- **清理本地缓存**: 一键删除本地生成的 `license.lic`，快速重置工具为“未授权”状态，方便反复测试。
|
||||
|
||||
### 3. 业务模拟与底座日志区 (Bottom Panel)
|
||||
- **启动业务检测 (模拟按钮)**: 模拟核心业务（例如机器视觉检测）引擎的启动。点击前触发鉴权：
|
||||
- 若在有效授权期内：成功弹窗。
|
||||
- 若授权无效或被心跳钩子锁定：阻拦执行并警告。
|
||||
- **运行控制台日志**: 透明展示底座心跳情况（如每30秒向服务端尝试上报状态）和网络行为。即使网络短暂断开，通过混合鉴权机制也不会卡死业务。
|
||||
|
||||
## 高频测试场景建议
|
||||
|
||||
我们建议您通过以下几个常见场景测试授权体系的稳健性：
|
||||
|
||||
1. **断网环境的秒级验签**：拔掉网线，粘贴包含 `&` 的完整离线鉴权码并激活，验证无网极速通过并成功点击启动模拟业务。
|
||||
2. **连接网络下的防白嫖稽核**：恢复网络，此时可以在 SaaS 后台强制踢出该设备绑定的许可或执行解绑操作。
|
||||
3. **心跳毫秒级阻断响应**：等待一个心跳周期（工具内默认缩短为30秒用于演示），一旦心跳反馈“被封禁”，无需重启程序，界面秒变红，并自动阻断核心业务的执行。
|
||||
+6
-1
@@ -4,7 +4,12 @@ License Manager 提供可复用的客户端 SDK，涵盖许可证解析、验签
|
||||
|
||||
## 快速入口
|
||||
|
||||
- GitHub 仓库（含 README、示例与 API 说明）：[https://github.com/cedar-v/license-manager-sdk-go](https://github.com/cedar-v/license-manager-sdk-go)
|
||||
目前官方提供了以下语言的客户端 SDK 仓库（含 README、示例与 API 说明）：
|
||||
|
||||
- **Go SDK**: [https://github.com/cedar-v/license-manager-sdk-go](https://github.com/cedar-v/license-manager-sdk-go)
|
||||
- **Python SDK**: [https://github.com/cedar-v/license-manager-sdk-python](https://github.com/cedar-v/license-manager-sdk-python)
|
||||
- PyPI 安装: `pip install cedarv-license-manager-sdk`
|
||||
|
||||
- 许可证结构参考：[`/guide/license-token-structure`](/guide/license-token-structure)
|
||||
|
||||
> SDK 具体使用方法（安装、配置、代码示例等）请直接参考仓库 README；这里只保留索引，确保信息只维护一份。
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 34 KiB |
Reference in new issue
Block a user