From 8c1f580a209490630f57c3ca57d85eaf6703c6ad Mon Sep 17 00:00:00 2001 From: iris Date: Tue, 8 Sep 2026 20:21:55 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E8=A6=8F=E5=8A=83=E5=80=8B=E4=BA=BA?= =?UTF-8?q?=E8=87=AA=E5=8A=A9=E6=8C=87=E4=BB=A4=E7=BE=A4=E4=BB=8B=E9=9D=A2?= =?UTF-8?q?=E8=A6=8F=E6=A0=BC=EF=BC=88issue=20#11=EF=BC=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 11 ++- docs/commands.md | 199 ++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 205 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ce83ef4..00bb40a 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,12 @@ Bear 目前所有流程都依賴「瀏覽器」：登入 `/login`、儀表板 La | `bear logout` | 撤銷 refresh token（`POST /revoke`） | P2 | | `bear status` | 顯示登入狀態與 token 剩餘效期 | P2 | | `bear apps list/show/create/update/rotate-secret/toggle` | App 管理（需 bear App 管理 JSON API，PAT 登入、admin 限定） | P3 | +| `bear profile show/set` | 個人資料檢視／更新（需 bear 個人自助 JSON API） | P3 | +| `bear password change` | 變更密碼（互動輸入，不進 shell history） | P3 | +| `bear email change --new EMAIL` | 變更 email（雙向驗證碼流程） | P3 | +| `bear sessions list/revoke/revoke-others` | 管理網頁 session | P3 | +| `bear tokens list/create/revoke` | 管理 PAT（create 一次性顯示明文） | P3 | +| `bear mfa status/setup/disable/recovery-codes` | TOTP 兩因子管理 | P3 | 完整指令規格（選項、行為、輸出、退出碼）見 [`docs/commands.md`](docs/commands.md)。 @@ -41,6 +47,7 @@ Bear 目前所有流程都依賴「瀏覽器」：登入 `/login`、儀表板 La | `bear logout` | ✅ 已實作（清除本機憑證；PAT 需至網頁撤銷） | | `bear status` | ✅ 已實作（純本機判定，顯示 PAT／環境變數模式） | | `bear apps` | ⏳ 待 #5 規格與 alterminal/bear#28 API 就緒後實作 | +| `bear profile`／`password`／`email`／`sessions`／`tokens`／`mfa` | ⏳ 規格已納入 `docs/commands.md` §3.7（#11）；待 alterminal/bear#35 API 就緒後實作 | ### 建置與執行 @@ -111,7 +118,7 @@ $ bear login --token |------|------| | **P1 伺服器：Device Flow** | `device_codes` 資料表、`POST /device_authorization`、`GET/POST /device` 授權頁、token 端點 `device_code` grant、Discovery 更新（於 bear 倉庫） | | **P2 CLI 登入** | 本倉庫實作 `login`（Device Flow 或 `--token `）／`whoami`／`token`／`logout`／`status`、憑證儲存 0600 | -| **P3 進階** | `bear apps` 管理指令群（list／show／create／update／rotate-secret／toggle，依賴 bear App 管理 JSON API）、QR 顯示、系統 keyring、發行二進位 | +| **P3 進階** | `bear apps` 管理指令群（依賴 bear App 管理 JSON API）、個人自助指令群 `profile`／`password`／`email`／`sessions`／`tokens`／`mfa`（依賴 bear 個人自助 JSON API，#11）、QR 顯示、系統 keyring、發行二進位 | --- @@ -119,4 +126,4 @@ $ bear login --token - **語言**：Elixir（與 Bear 主專案一致），HTTP 一律使用 `Req`。 - **發行**：`mix escript`（單檔可執行）或 `mix release` 自包含二進位（待定）。 -- **安全**：device_code 只存 SHA-256 雜湊、user_code 限流、憑證檔 0600、token 與 PAT 一律不入 log／commit（PAT 僅在建立當下顯示一次，CLI 只「使用」不「管理」）。 +- **安全**：device_code 只存 SHA-256 雜湊、user_code 限流、憑證檔 0600、token 與 PAT 一律不入 log／commit；一次性明文（`apps` 的 client_secret、`tokens create` 的 PAT、`mfa` 的 recovery codes）僅在成功當下顯示一次；密碼與驗證碼一律互動輸入、不回顧。 diff --git a/docs/commands.md b/docs/commands.md index c33f1e2..5a76600 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -1,7 +1,7 @@ # Bear CLI 指令規劃（Command Spec） > 狀態：P2 PAT 模式 MVP 已實作（見第 9 節）；Device Flow 待伺服器端 P1。 -> 範圍：本文件為指令介面規格；App 管理指令（`bear apps` CRUD）另見 #5 規劃。 +> 範圍：本文件為指令介面規格；App 管理指令（`bear apps` CRUD）另見 #5 規劃、個人自助指令（`bear profile` 等）另見 #11 規劃。 > 登入採用的 OIDC Device Authorization Grant（RFC 8628）細節，見 bear 倉庫 `docs/cli-feature-plan.md`（issue #17）。 > 另支援以**個人存取權杖（PAT）**登入（bear 已於 profile 頁提供 PAT 建立／列表／撤銷，`/userinfo` 接受 PAT 作為 Bearer）。 @@ -338,6 +338,181 @@ bear apps update [--url URL] [--title TITLE] --- +### 3.7 `bear profile`：個人自助指令群（P3，規劃中） + +> 依賴：bear 伺服器端**個人自助 JSON API**（alterminal/bear#35，資源前綴 `/api/v1/profile`，PAT Bearer 認證、**任何有效 PAT 帳號**可用，不限 admin）。API 落地前本節僅為規格；端點細節以 #35 定案為準。 + +比照 `bear apps` 的「資源群組」例外：個人自助操作若攤平命名同樣會造成指令名爆炸（`bear password-change`…），收斂為 `bear <資源> <動詞>` 的六個子群組。頭像（picture）檔案上傳需要 multipart 與本機圖片，終端體驗差，**不在本期範圍**（#35 有對應端點，未來有需要再評估）；如需更換頭像，可自行上傳圖片後以 `profile set --picture URL` 設定。 + +``` +bear profile show [--json] +bear profile set [選項] [--json] +bear password change +bear email change --new EMAIL [--json] +bear sessions list|revoke |revoke-others [--json] +bear tokens list|create|revoke [選項] [--json] +bear mfa status|setup|disable|recovery-codes [--json] +``` + +**認證與授權（群組共通）**： + +- 一律使用既有 PAT 憑證（`bear login --token` 登入，或 `BEAR_TOKEN` 環境變數）作為 Bearer 呼叫 API；不提供其他登入方式。 +- 與 `apps` 群組不同，個人自助操作**任何有效 PAT 帳號皆可**（非 admin 限定）。`401`（token 無效／已撤銷）→ 退出碼 `3`，提示重新 `bear login`；`403` → 退出碼 `8`（正常情況不應出現，保留對應）；`404`／`422` → 退出碼 `1`；網路／伺服器錯誤 → `6`。退出碼沿用 §4 總表，群組共通部分同 §3.6 表。 +- **敏感輸入一律互動提示讀取且不回顯**：目前密碼、新密碼、email 驗證碼、MFA 驗證碼。不接受命令列明文參數（不進 shell history、不出現在 `ps`）。非 TTY 環境執行需要互動輸入的指令 → 退出碼 `2`，提示需在終端機執行。 +- **一次性明文**（`tokens create` 的 PAT、`mfa setup`／`recovery-codes` 產生的 recovery codes）只於成功當下輸出於 stdout，不寫入憑證檔、log、`--verbose` 輸出或版本庫（同 `apps create` 的 `client_secret` 處理）。 +- 密碼與 email 變更不因 CLI 放寬：沿用伺服器端現行密碼驗證與 email 雙向驗證碼流程，CLI 只是通道。 + +#### 3.7.1 `bear profile show` + +顯示完整個人資料。 + +**行為**：`GET /api/v1/profile`（Bearer PAT），印出全部 OIDC profile 欄位（name、given_name、family_name、nickname、preferred_username、picture、profile、website、gender、birthdate、zoneinfo、locale、phone_number、address_*、email、email_verified、totp_enabled 等），格式同 `whoami` 的 `key : value`。 + +**輸出範例**： + +``` +sub : 0190...uuid +email : alice@example.com +email_verified: true +name : Alice Chen +given_name : Alice +family_name : Chen +nickname : ali +locale : zh_TW +zoneinfo : Asia/Taipei +mfa_enabled : true +``` + +**`--json` 輸出範例**：`{"ok": true, "profile": {…同上欄位…}}` + +#### 3.7.2 `bear profile set [選項]` + +更新個人資料。**只更新有給的欄位**（部分更新，同 `apps update` 語意）；`email` 不可由此改（走 `bear email change`），`sub`、`email_verified`、`totp_enabled` 唯讀。 + +``` +bear profile set [--name NAME] [--given-name NAME] [--family-name NAME] + [--nickname NAME] [--preferred-username NAME] + [--profile URL] [--picture URL] [--website URL] + [--gender male|female|other] [--birthdate YYYY-MM-DD] + [--zoneinfo TZ] [--locale LOC] [--phone-number E164] + [--phone-verified] [--address-formatted TEXT] + [--address-street-address TEXT] [--address-locality TEXT] + [--address-region TEXT] [--address-postal-code TEXT] + [--address-country TEXT] [--json] +``` + +| 選項 | 說明 | +|------|------| +| `--name` 等 20 個欄位選項 | 對應網頁 `/profile/edit` 表單的同一欄位集合（`profile_changeset` 的 `profile_fields`） | +| `--gender` | 列舉 `male`／`female`／`other`（非法值 → 退出碼 `2`） | +| `--birthdate` | `YYYY-MM-DD` | +| `--phone-verified` | 布林旗標（設定 `phone_number_verified`；清除不在本期，避免自我標記已驗證的濫用——**待 #35 確認是否開放**） | +| URL 類（`--profile`／`--picture`／`--website`） | 需 `http(s)://` 開頭，否則 `422` → 退出碼 `1` | + +**行為**：`PUT /api/v1/profile`（Bearer PAT），只送有給的欄位。成功後印出更新後摘要；`422` 驗證失敗時逐欄位列出錯誤（退出碼 `1`）。`preferred_username` 與他人重複 → `422`，退出碼 `1`。 + +**`--json` 輸出範例**：`{"ok": true, "profile": {…更新後完整物件…}}` + +#### 3.7.3 `bear password change` + +變更密碼。**無任何命令列參數**（密碼一律互動輸入）。 + +**行為**： + +1. 互動提示（不回顯）依序讀取：`目前密碼`、`新密碼`、`確認新密碼`。 +2. 兩次新密碼不一致 → 退出碼 `2`（本地檢查），不發請求。 +3. `POST /api/v1/profile/password`（Bearer PAT，body 帶 `current_password`／`new_password`）。 +4. 成功 → 印出 `密碼已變更`；現行密碼錯誤 → 退出碼 `1`；新密碼不符伺服器強度規則 → `422`，退出碼 `1`。 + +比照網頁流程，變更密碼**不**自動撤銷其他 session；需要時另用 `bear sessions revoke-others`。 + +#### 3.7.4 `bear email change --new EMAIL` + +變更 email（雙向驗證碼流程）。驗證碼一律互動輸入，不接受命令列參數。 + +| 選項 | 說明 | +|------|------| +| `--new EMAIL` | （必填）新 email 位址 | + +**行為**： + +1. `POST /api/v1/profile/email/request-codes`（Bearer PAT，`new_email`）→ 伺服器向**現有與新**信箱各寄一組驗證碼。 +2. 終端印出 `驗證碼已寄至 alice@example.com 與 new@example.com`，互動提示（不回顯）讀取：`現有信箱驗證碼`、`新信箱驗證碼`。 +3. `POST /api/v1/profile/email`（`current_code`／`new_code`）。 +4. 成功 → 印出 `email 已更新：new@example.com`，並提醒 `bear login` 用的 PAT 不受影響（PAT 不綁 email）。 + +錯誤：`same_email`／`email_taken`／`invalid_email` → 退出碼 `1`；驗證碼錯誤或逾期 → 退出碼 `1`，提示重新執行（會重寄驗證碼）；伺服器限流（`429`）→ 退出碼 `1`，提示稍後再試。 + +**`--json` 輸出範例（成功）**：`{"ok": true, "email": "new@example.com"}` + +#### 3.7.5 `bear sessions` + +管理**網頁 session**（裝置登入狀態）；與 PAT 無關——撤銷 session 不影響 PAT，PAT 的撤銷用 `bear tokens revoke`。CLI 以 PAT 呼叫 API，本身沒有「目前 session」，清單不標記目前項。 + +- **`bear sessions list`**：`GET /api/v1/profile/sessions`（Bearer PAT），表格輸出，新到舊排序： + +``` +ID IP USER AGENT CREATED LAST SEEN EXPIRES +0192a1b0-… 203.0.113.10 Mozilla/5.0 (X11; Linux…) 2026-09-07 10:00:00Z 2026-09-08 09:00:00Z 2026-09-21 10:00:00Z +``` + + （`user_agent` 截斷至欄寬；`--json` 輸出完整值。） +- **`bear sessions revoke `**：`POST /api/v1/profile/sessions/{id}/revoke`。成功印出 `session 已撤銷`；不存在或非本人 → `404`，退出碼 `1`。 +- **`bear sessions revoke-others`**：`POST /api/v1/profile/sessions/revoke-others`。成功印出 `已撤銷 N 個其他 session`。 + +`` 為 session UUID（取自 `list` 輸出；不接受前綴比對）。 + +**`--json` 輸出範例**：`{"ok": true, "sessions": […]}`／`{"ok": true, "revoked": 3}` + +#### 3.7.6 `bear tokens` + +管理 PAT。**token 明文絕不出現在 `list`**（伺服器只存 SHA-256 雜湊）。 + +- **`bear tokens list`**：`GET /api/v1/profile/tokens`（Bearer PAT），新到舊排序： + +``` +ID NAME SCOPE CREATED EXPIRES LAST USED STATUS +0192a1c0-… ci-token openid, profile 2026-09-01 00:00:00Z 2026-10-01 00:00:00Z 2026-09-08 08:00:00Z active +0192a1b0-… old-laptop openid, profile 2026-08-01 00:00:00Z (無到期) (未使用) revoked +``` + + `STATUS`：`active`／`expired`／`revoked`（CLI 依 `expires_at`／`revoked_at` 本地判定）。 +- **`bear tokens create --name NAME [--expires-in DAYS|never] [--scope SCOPES]`**：`POST /api/v1/profile/tokens`（Bearer PAT）。成功後一次性顯示： + +``` +PAT 已建立：ci-token（30 天後到期） +token（只顯示這一次，請立即保存）： + 9f3a…（Base64url，43 字元，無前綴） +``` + + | 選項 | 預設 | 說明 | + |------|------|------| + | `--name` | （必填） | 顯示名稱；空白或重複名稱依伺服器規則 `422` → 退出碼 `1` | + | `--expires-in` | `30` | 天數（正整數）或 `never`（永不過期） | + | `--scope` | `openid profile email` | 空白分隔的 scope 清單（同伺服器預設） | + + `--json` 輸出範例：`{"ok": true, "token": {…list 之單一物件…}, "raw": "9f3a…"}`（`raw` 只出現這一次。） + 提醒：新 PAT 要使用須另以 `bear login --token` 登入（或設 `BEAR_TOKEN`）。 +- **`bear tokens revoke `**：`POST /api/v1/profile/tokens/{id}/revoke`（`` 為 UUID）。成功印出 `PAT 已撤銷：`；若撤銷的是**目前憑證用的 PAT**，後續指令會得到 `401`（退出碼 `3`），屆時重新 `bear login`；CLI 在撤銷成功後偵測到 `id` 對應本機憑證時，主動提示執行 `bear logout` 清除本機憑證。 + +#### 3.7.7 `bear mfa` + +TOTP 兩因子管理（WebAuthn／passkey 不在範圍）。 + +- **`bear mfa status`**：讀 `GET /api/v1/profile` 的 MFA 欄位，印出 `MFA（TOTP）：已啟用／未啟用`。 +- **`bear mfa setup`**：兩步互動流程—— + 1. `POST /api/v1/profile/mfa/setup`（無 code，Bearer PAT）→ 回傳 Base32 `secret` 與 `otpauth://` URI。終端印出 URI、secret，並在本機產生 ASCII QR（掃碼加入驗證器；QR 由 CLI 本地生成，不經伺服器）。 + 2. 互動提示（不回顯）讀取 6 位碼 → `POST /api/v1/profile/mfa/setup`（帶 code）確認。 + 3. 成功 → **一次性**顯示 recovery codes（提示同 PAT：只顯示這一次）。 + + 已啟用 MFA 再執行 → 退出碼 `1`，提示已啟用。驗證碼錯誤 → 退出碼 `1`，可重試（不重產 secret）。 +- **`bear mfa disable`**：互動提示（不回顯）讀取目前的 TOTP 碼或 recovery code → `POST /api/v1/profile/mfa/disable`。成功印出 `MFA 已停用`；碼錯誤 → 退出碼 `1`，未停用。 +- **`bear mfa recovery-codes`**：互動提示（不回顯）讀取目前的 TOTP 碼或 recovery code → `POST /api/v1/profile/mfa/recovery-codes`。成功後**一次性**顯示整組新的 recovery codes（舊組全部失效）。 + +**`--json` 輸出範例**：`{"ok": true, "totp_enabled": true}`；setup 確認成功：`{"ok": true, "recovery_codes": ["…", "…"]}`（只出現這一次）。 + +--- + ## 4. 退出碼總表 | 碼 | 語意 | @@ -374,6 +549,7 @@ bear apps update [--url URL] [--title TITLE] - 所有診斷訊息走 stderr；`--json` 模式將錯誤以 `{"ok": false, "error": "...", "code": N}` 輸出。 - token、user_code、device_code 一律不入 log、不入 stdout（除 `bear token` 之目的外）、不入版本庫。 - `client_secret`（App 管理）僅於 `apps create`／`apps rotate-secret` 成功當下一次性輸出；`403` 顯示「此操作需 admin 權限」並以退出碼 `8` 結束，不重試。 +- 個人自助的敏感輸入（密碼、email／MFA 驗證碼）一律互動提示、不回顧、不接受命令列參數；一次性明文（`tokens create` 的 PAT、`mfa` 的 recovery codes）僅於成功當下輸出（見 §3.7）。 - 網路層一律使用 `Req`，遵循 bear 倉庫 HTTP 客戶端慣例。 --- @@ -384,8 +560,10 @@ bear apps update [--url URL] [--title TITLE] 2. 發行格式：escript（目標機需 Erlang）或 self-contained release（bakeware/burrito）？ 3. `bear apps list --visibility public` 未來是否開放非 admin（僅公開／active 清單，同網頁 Launch）？目前規劃為 admin 限定。 4. 是否支援 `offline_access` scope，或沿用現行 refresh 輪轉即可？ -5. 是否在 CLI 提供「建立／撤銷 PAT」？目前 PAT 管理僅限網頁（需 session），傾向 CLI 只「使用」不「管理」。 +5. 是否在 CLI 提供「建立／撤銷 PAT」？原規劃傾向 CLI 只「使用」不「管理」；#35 的 PAT 端點落地後，`bear tokens` 已納入 §3.7.6 規格（管理自己帳號的 PAT），此題視為已解。 6. App 管理 API 的路徑參數最終採 UUID 或 `client_id`（alterminal/bear#28 規格為 `{id}`）？若為 UUID，CLI 需先以 list 解析 `client_id` → UUID，或伺服器提供以 `client_id` 直取的端點。 +7. `bear profile set --phone-verified`（自我標記電話已驗證）是否開放？#35 需決定 API 是否接受該欄位；不開放則 CLI 移除此選項。 +8. `mfa setup` 的 `secret`／`otpauth://` 屬敏感資料，#35 的 API 回應是否應限制僅 setup 流程期間回傳（未確認前不重送）？ --- @@ -404,8 +582,22 @@ bear apps update [--url URL] [--title TITLE] | `apps update` | `PUT /api/v1/apps/{id}` | | `apps rotate-secret` | `POST /api/v1/apps/{id}/rotate-secret` | | `apps toggle` | `POST /api/v1/apps/{id}/toggle` | +| `profile show` | `GET /api/v1/profile` | +| `profile set` | `PUT /api/v1/profile` | +| `password change` | `POST /api/v1/profile/password` | +| `email change` | `POST /api/v1/profile/email/request-codes` → `POST /api/v1/profile/email` | +| `sessions list` | `GET /api/v1/profile/sessions` | +| `sessions revoke ` | `POST /api/v1/profile/sessions/{id}/revoke` | +| `sessions revoke-others` | `POST /api/v1/profile/sessions/revoke-others` | +| `tokens list` | `GET /api/v1/profile/tokens` | +| `tokens create` | `POST /api/v1/profile/tokens` | +| `tokens revoke ` | `POST /api/v1/profile/tokens/{id}/revoke` | +| `mfa status` | `GET /api/v1/profile`（讀 MFA 欄位） | +| `mfa setup` | `POST /api/v1/profile/mfa/setup`（先無 code 取 secret，再帶 code 確認） | +| `mfa disable` | `POST /api/v1/profile/mfa/disable` | +| `mfa recovery-codes` | `POST /api/v1/profile/mfa/recovery-codes` | -> `apps` 群組依賴 alterminal/bear#28 的 App 管理 JSON API（PAT Bearer、admin 限定）。 +> `apps` 群組依賴 alterminal/bear#28 的 App 管理 JSON API（PAT Bearer、admin 限定）；`profile` 系列依賴 alterminal/bear#35 的個人自助 JSON API（PAT Bearer、任何有效帳號）。 --- @@ -421,6 +613,7 @@ bear apps update [--url URL] [--title TITLE] | `logout` | `POST /revoke`（撤銷 refresh token） | 僅清除本機憑證；PAT 需至網頁 `/profile/tokens` 撤銷 | | `status` | 顯示 access token 剩餘秒數 | 純本機判定：顯示模式（PAT／BEAR_TOKEN 環境變數）與 issuer | | `apps` | P3 暫緩 | 未實作；App 管理指令規格見 #5，伺服器端 API 見 alterminal/bear#28 | +| `profile`／`password`／`email`／`sessions`／`tokens`／`mfa` | P3 暫緩 | 未實作；個人自助指令規格見 #11（§3.7），伺服器端 API 見 alterminal/bear#35 | 退出碼差異：`login`／`whoami` 的 token 無效（401）依 §3.1 為 `3`（本節實作一致）。