@pengzi/kms 1.1.0 → 1.2.0

package/README.md

@@ -10,6 +10,7 @@
 - **审计日志**：完整记录所有密钥操作
 - **TypeScript**：完整的类型定义
 - **易用性**：简洁的API设计
+- **CLI工具**：交互式命令行工具，无需编写代码即可管理密钥
 
 ## 安全特性
 
@@ -23,7 +24,13 @@
 ## 安装
 
 ```bash
-npm install @pzdemons/kms
+npm install @pengzi/kms
+```
+
+安装后即可使用 CLI 工具：
+
+```bash
+kms
 ```
 
 ## 前置要求
@@ -33,10 +40,39 @@ npm install @pzdemons/kms
 
 ## 快速开始
 
-### 1. 初始化客户端
+### 方式 1: 使用 CLI 工具（推荐新手）
+
+```bash
+# 启动交互式 CLI
+kms
+
+# 首次使用需要配置数据库连接
+# 按提示输入 MongoDB 连接字符串
+
+# 创建项目
+选择: 项目管理 → 创建新项目
+项目名称: my-project
+主密码: MySecurePassword123!
+
+# 创建密钥
+选择: 密钥管理 → 创建密钥
+项目: my-project
+密钥名称: mongodb-primary
+密钥类型: mongodb
+密钥值: mongodb://user:pass@localhost:27017/mydb
+
+# 获取密钥
+选择: 密钥管理 → 获取密钥值
+```
+
+详细 CLI 使用说明请查看：[CLI 使用指南](./docs/CLI_GUIDE.md)
+
+### 方式 2: 使用 Node.js SDK
+
+#### 1. 初始化客户端
 
 ```typescript
-import { KMSClient, KeyType } from '@pzdemons/kms';
+import { KMSClient, KeyType } from '@pengzi/kms';
 
 const kms = new KMSClient({
   connectionString: 'mongodb://localhost:27017',
@@ -203,12 +239,35 @@ app.listen(3000);
 
 为了确保系统的安全性，请遵循以下最佳实践：
 
-1. **主密码安全**
+1. **使用 TLS/SSL 连接** ⚠️ 重要
+   - 生产环境**必须**使用 TLS/SSL 加密连接
+   - MongoDB Atlas 默认启用 TLS，连接字符串使用 `mongodb+srv://`
+   - 自建 MongoDB 需配置 TLS 证书
+   ```javascript
+   // MongoDB Atlas（自动启用 TLS）
+   const kms = new KMSClient({
+     connectionString: 'mongodb+srv://user:pass@cluster.mongodb.net/kms',
+     databaseName: 'kms'
+   });
+
+   // 自建 MongoDB + TLS
+   const kms = new KMSClient({
+     connectionString: 'mongodb://localhost:27017/kms',
+     databaseName: 'kms',
+     connectionOptions: {
+       tls: true,
+       tlsCAFile: '/path/to/ca.pem'
+     }
+   });
+   ```
+   详细说明请查看：[TLS 连接指南](./docs/TLS_GUIDE.md)
+
+2. **主密码安全**
    - 使用至少12个字符的强密码
    - 包含大小写字母、数字和特殊字符
    - 定期轮换主密码（建议每180天）
 
-2. **密钥轮换**
+3. **密钥轮换**
    - 定期轮换数据库连接凭证（建议每90天）
    - 设置密钥过期时间