feat: hide password config on first use

Author: sleepinginsummer

README.md

@@ -12,7 +12,7 @@
   <a href="https://nodejs.org/"><img src="https://img.shields.io/badge/Node.js-%3E%3D18-339933?logo=node.js&logoColor=white" alt="Node.js >=18"></a>
   <a href="https://www.npmjs.com/"><img src="https://img.shields.io/badge/npm-%3E%3D8-CB3837?logo=npm&logoColor=white" alt="npm >=8"></a>
   <a href="https://github.com/sleepinginsummer/agent-ssh-cli"><img src="https://img.shields.io/badge/sys-win%2Fmac%2Flinux-0078D6" alt="sys win/mac/linux"></a>
-  <a href="https://github.com/sleepinginsummer/agent-ssh-cli/releases"><img src="https://img.shields.io/badge/release-v0.2.9-blue" alt="release v0.2.9"></a>
+  <a href="https://github.com/sleepinginsummer/agent-ssh-cli/releases"><img src="https://img.shields.io/badge/release-v0.3.0-blue" alt="release v0.3.0"></a>
   <a href="https://github.com/sleepinginsummer/agent-ssh-cli/pulls"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen" alt="PRs welcome"></a>
 </p>
 
@@ -88,7 +88,7 @@ AGENT_SSH_CONFIG=/path/to/config.json
 - `name`: 连接名，必须唯一
 - `host`: SSH 主机地址
 - `username`: SSH 用户名
-- `password` / `privateKey`: 认证方式，二者必须且只能配置一个
+- `password` / `passwordRef` / `privateKey`: 认证方式，密码、密码引用、私钥三类认证只能保留一种
 - `port`: SSH 端口，默认 `22`
 - `passphrase`: 私钥口令，仅配合 `privateKey` 使用
 - `pty`: 是否分配伪终端，默认 `false`，也可通过 `exec --pty` 临时开启
@@ -100,6 +100,8 @@ AGENT_SSH_CONFIG=/path/to/config.json
 
 完整示例见 [example.config.json](example.config.json)。`~/.agent-ssh-cli/config.json` 保存真实连接信息。
 
+为防止配置文件中的密码泄露，密码认证会在第一次使用该服务器时被动加密保存：首次写入明文 `password` 后，执行 `exec`、`upload` 或 `download` 连接该服务器时，CLI 会把密码加密保存到配置目录下的 `secrets.json`，生成本地 `secret.key`，并把配置中的 `password` 置空、写入 `passwordRef`。后续运行通过 `passwordRef` 解密认证；如需修改密码，把空的 `password` 重新填成新密码，下次连接会自动覆盖旧密文。
+
 参考配置
 
 ```json
@@ -109,7 +111,8 @@ AGENT_SSH_CONFIG=/path/to/config.json
     "host": "192.0.2.10",
     "port": 22,
     "username": "root",
-    "password": "******",
+    "password": "",
+    "passwordRef": "agentsshcli:密码服务器",
     "commandBlacklist": [
       "(^|[;&|()\\s])rm(\\s|$)",
       "(^|[;&|()\\s])shutdown(\\s|$)",

README_EN.md

@@ -12,7 +12,7 @@ Remote exec · File upload · File download · Connection config · Command whit
   <a href="https://nodejs.org/"><img src="https://img.shields.io/badge/Node.js-%3E%3D18-339933?logo=node.js&logoColor=white" alt="Node.js >=18"></a>
   <a href="https://www.npmjs.com/"><img src="https://img.shields.io/badge/npm-%3E%3D8-CB3837?logo=npm&logoColor=white" alt="npm >=8"></a>
   <a href="https://github.com/sleepinginsummer/agent-ssh-cli"><img src="https://img.shields.io/badge/sys-win%2Fmac%2Flinux-0078D6" alt="sys win/mac/linux"></a>
-  <a href="https://github.com/sleepinginsummer/agent-ssh-cli/releases"><img src="https://img.shields.io/badge/release-v0.2.9-blue" alt="release v0.2.9"></a>
+  <a href="https://github.com/sleepinginsummer/agent-ssh-cli/releases"><img src="https://img.shields.io/badge/release-v0.3.0-blue" alt="release v0.3.0"></a>
   <a href="https://github.com/sleepinginsummer/agent-ssh-cli/pulls"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen" alt="PRs welcome"></a>
 </p>
 
@@ -87,7 +87,7 @@ The configuration file is an array, and each item represents one server:
 - `name`: Connection name, must be unique
 - `host`: SSH host address
 - `username`: SSH username
-- `password` / `privateKey`: Authentication method; exactly one of the two must be configured
+- `password` / `passwordRef` / `privateKey`: Authentication method; keep exactly one authentication type among password, password reference, and private key
 - `port`: SSH port, defaults to `22`
 - `passphrase`: Private key passphrase, only used with `privateKey`
 - `pty`: Whether to allocate a pseudo-terminal, defaults to `false`; it can also be enabled per command with `exec --pty`
@@ -99,6 +99,8 @@ The configuration file is an array, and each item represents one server:
 
 See the full example in [example.config.json](example.config.json). Store real connection information in `~/.agent-ssh-cli/config.json`.
 
+To reduce password leakage from configuration files, password authentication is passively encrypted the first time that server is used: after you write a plaintext `password`, the next `exec`, `upload`, or `download` for that server encrypts the password into `secrets.json` under the config directory, creates a local `secret.key`, then writes the config back with an empty `password` and a `passwordRef`. Later runs decrypt through `passwordRef`. To change the password, replace the empty `password` with the new plaintext password; the next connection overwrites the old encrypted value.
+
 Reference configuration
 
 ```json
@@ -108,7 +110,8 @@ Reference configuration
     "host": "192.0.2.10",
     "port": 22,
     "username": "root",
-    "password": "******",
+    "password": "",
+    "passwordRef": "agentsshcli:password-server",
     "commandBlacklist": [
       "(^|[;&|()\\s])rm(\\s|$)",
       "(^|[;&|()\\s])shutdown(\\s|$)",

SKILL.md

@@ -88,6 +88,21 @@ mkdir -p ~/.agent-ssh-cli
 ~/.agent-ssh-cli/config.json
 ```
 
+为防止配置文件中的密码泄露，密码认证会在第一次使用该服务器时被动加密保存：如果目标连接的 `password` 是非空明文，下一次执行 `exec`、`upload` 或 `download` 连接该服务器前，CLI 会把密码加密写入配置目录的 `secrets.json`，生成本地 `secret.key`，并把 `config.json` 中该连接改成 `password: ""` 加 `passwordRef`。改密码时直接把空的 `password` 重新填成新密码，下一次连接会自动覆盖旧密文。私钥认证不参与这个流程。
+
+隐藏后的密码配置示例：
+
+```json
+{
+  "name": "server",
+  "host": "192.0.2.10",
+  "port": 22,
+  "username": "root",
+  "password": "",
+  "passwordRef": "agentsshcli:server"
+}
+```
+
 指定其它配置文件：
 
 ```bash

example.config.json

@@ -4,7 +4,8 @@
     "host": "192.0.2.10",
     "port": 22,
     "username": "root",
-    "password": "******",
+    "password": "",
+    "passwordRef": "agentsshcli:密码服务器",
     "allowedLocalPaths": [
       "./tmp"
     ],

native/Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "agentsshcli-native"
-version = "0.2.9"
+version = "0.3.0"
 edition = "2021"
 
 [[bin]]
@@ -9,7 +9,10 @@ path = "src/main.rs"
 
 [dependencies]
 libc = "0.2"
+base64 = "0.22"
+chacha20poly1305 = "0.10"
 regex = "1"
+rand_core = { version = "0.6", features = ["getrandom"] }
 sha2 = "0.10"
 serde = { version = "1", features = ["derive"] }
 serde_json = "1"