docs: record v0.3.0 CLI OIDC rollout and verification [skip ci]

This commit is contained in:
Anya Tokugawa committed 2026-11-01 20:55:25 +09:00
1 parent 60f5fb1881
commit 5821254535
3 files changed
+102 -6

No files matched your search

+2 -2
View File
@@ -39,7 +39,7 @@
- [x] HTTPクライアント初期版 `pages-cli`/コマンド `pages`(2026-11-01ホストのユーザーPATHへ配置済み。実ユーザログインは未実施):configureによる接続先・既定プロファイル・言語管理、パスワード/TOTP、Bearer保持・失効、ls/cd/cat/view/get、既存Page edit/put、Path補完、メモリ内履歴、検索候補、ブラウザ引き継ぎ。詳細と原設計整合は [遠隔CLI](remote-cli.md)。既存DB直アクセスCLIは変更しない。
- [x] 専用起動コマンドとセッション保持は独立HTTPクライアント `pages` として実装。既存 `data/pageswiki-cli` のDB直接操作とは分離し、資格情報に0600の保護と失効/ログアウトを設ける。
- [ ] `Ctrl+P` のfuzzy検索と、ローカル `$EDITOR` 編集。現在版/ETagを保持してアップロード時の競合を検出し、上書き・差分・キャンセルを選べるようにする。
- [x] ターミナルにURLを表示するブラウザ認証(OIDC)。`pages login --oidc [--no-browser]`、S256、5分の単回grant、確認コード/CSRF/TOTP、失効再確認、poll・発行上限を実装。2026-11-01ソース検証済み、本番未反映。契約は[遠隔CLI](remote-cli.md)を参照。
- [x] ターミナルにURLを表示するブラウザ認証(OIDC)。`pages login --oidc [--no-browser]`、S256、5分の単回grant、確認コード/CSRF/TOTP、失効再確認、poll・発行上限を実装。2026-11-01 v0.3.0でサーバー・ホストCLIへ本番反映済み。実providerでの本人承認は利用者確認が残る。契約は[遠隔CLI](remote-cli.md)を参照。
- [ ] ターミナル表示が難しい内容はブラウザに引き継ぐ。short linkは認証を迂回しない内部リンクとし、公開share link発行とは分離する。自動公開しない。
## チェックポイントと進捗
@@ -123,7 +123,7 @@
現行 `data/pageswiki-cli` はSQLite/Document Storeへ直接アクセスする運用CLI。shell、補完、履歴、`$PAGER`/`$EDITOR` は既にあるが、Web認証を受けるリモートクライアントではない。Webユーザの認可をSQLite直アクセスへ継ぎ足さず、HTTP transportを持つ別コマンド(仮称 `pageswiki remote`)として段階導入する。
2026-11-01:試作名 `data/pageswiki-remote` から、ユーザ指定によりサブプロジェクト `pages-cli`/実行名 `pages` へ整理。`pages configure` と既定値により通常操作のprofile/lang引数を不要とした。OIDCハンドオフは後続ソース実装・検証まで完了。本番反映、Ctrl+P、新規作成、強制上書きの対話選択、short linkは残件。[範囲・制限・検証](remote-cli.md)を参照。
2026-11-01:試作名 `data/pageswiki-remote` から、ユーザ指定によりサブプロジェクト `pages-cli`/実行名 `pages` へ整理。`pages configure` と既定値により通常操作のprofile/lang引数を不要とした。OIDCハンドオフはv0.3.0で本番反映済み。実providerでの本人承認、Ctrl+P、新規作成、強制上書きの対話選択、short linkは残件。[範囲・制限・検証](remote-cli.md)を参照。
1. パスワード+TOTPの既存JSONログイン、失効/logout、接続先・Principal・Domain別セッション保存。秘密情報はコマンド引数/履歴/ログへ出さず、保存先0700・資格情報0600相当、TLS検証必須。
2. `ls/cd/view/get/edit` と現在Pathの保持。検索は認可付き・件数制限・キャンセル可能なAPIを使用し、`Ctrl+P` のfuzzy選択へ接続。端末の制御シーケンスは本文/タイトルから除去する。
+5 -4
View File
@@ -69,7 +69,7 @@ TabはPath候補を取得し、上下キーは当該プロセス内の履歴を
一覧は既存の件数制限を維持し、truncatedを表示する。巨大な全階層を再帰取得しない。読み取りのRaw言語選択は既存サーバの候補選択に従うが、編集は指定言語のheadを必須とし、存在しない場合は拒否する。
## OIDCブラウザ引き継ぎ(2026-11-01実装、本番未反映)
## OIDCブラウザ引き継ぎ(v0.3.0本番反映済み)
`pages login --oidc` はブラウザを開き、`--no-browser` はURLだけを表示する。
CLI側に受信ポートは不要で、SSH先から開始して別のPC/スマホで承認できる。
@@ -155,8 +155,9 @@ OIDCは署名付き模擬providerによるcallback→承認→交換のHTTP試
2026-11-01の実行結果:全Goテスト(キャッシュなし)、全Go vet、関連store/serverのrace検査、
Python 18件、OIDCとパスワードのCLI HTTP統合試験、承認画面と既存CookieログインのChromium試験が成功。
CLI承認画面のモバイルスクリーンショットも確認した。実機Safariは未確認。
前段のイベントログ修正を保持し、本番のv0.2.0・ユーザーPATH上の旧CLIは変更していない。
OIDCは機能追加なので、ログ修正単独のPATCHと区別しv0.3.0で公開する。
前段のイベントログ修正を保持し、OIDCは機能追加としてv0.3.0で公開した。
同日20:52 JSTに本番サーバーとユーザーPATH上のCLIへ反映済み。
[本番反映記録](../../operations/deployments/2026-11-01-v0.3.0.md)にCI再実行、schema移行、公開API確認と復旧条件を記載した。
サーバーとCLIの両方が必要。開始APIの404/405/501は未対応または接続先の誤りとして明示し、
OIDC無効の403と区別する。エラー時のログイン要求は自動再送せず、資格情報も保存しない。
@@ -170,5 +171,5 @@ OIDC関連18ファイルのみで、本番DB・鍵・セッション・前段の
1. Ctrl+Pによる検索選択、補完の引用文字/途中カーソル対応、永続履歴の明示opt-in。
2. 新規Page+Path+初回Revisionの原子的な作成API、create/upload-only権限、並行作成の衝突、言語分岐。
3. 競合の対話選択・復旧コマンド、巨大転送のstreamingとキャンセル、mget/mput(globのlocal/remoteを明示)。
4. OIDC引き継ぎの本番schema適用・サーバ/CLI配布・実providerログイン確認。初期実装は上記のとおり完了、v0.2.0環境への反映は未実施。
4. OIDC引き継ぎの本番schema適用・サーバ/CLI配布はv0.3.0で完了。実providerでの本人ログイン・承認は利用者確認が残る。
5. OS keyring、Windows対応、非公開の短縮リンク引き継ぎ。自動的な公開shareは行わない。
@@ -0,0 +1,95 @@
# PagesWiki v0.3.0 のCLI OIDC認証と本番反映
2026-11-01 20:52:08 JST、CLIのブラウザー経由OIDC認証を含むv0.3.0を本番へ反映した。
サーバーだけでなく、ホストの `/home/anya/.local/bin/pages` も同じリリースのCLIへ更新した。
以前の `Not found or not readable.` は、新CLIが要求する `POST /_/auth/cli/start` を
本番v0.2.1が持たず404を返していたためである。
## 配布物
- ソースcommit:`60f5fb18817d115a56b424dce2602198ac2c89f3`。
- 注釈付きGitタグ:`v0.3.0`。タグobject:`d02116577a79a1396b96c88fbadd7139dd158bd8`。
- [ビルド run 16](https://git.anya.jp/anya/wikipages/actions/runs/16):再実行で全工程成功。
- [リリース昇格 run 17](https://git.anya.jp/anya/wikipages/actions/runs/17):全工程成功。
- 後方互換な認証機能追加なので、SemVerのMINORを更新した。v0.2.1の配布物は変更していない。
対象はapp、app2、adaptor-gateway、excalidraw-viewer。code-server、Kroki、Mermaidは再作成していない。
registry prefixは `git.anya.jp/anya/`。3種類ともSHAタグとリリースタグのmanifest digestが一致し、
OCI revisionはソースcommitと一致する。昇格時の再ビルドは行っていない。
| イメージ | v0.3.0 manifest digest |
| --- | --- |
| pageswiki-app | `sha256:49e7e5f0fffcefc3ac272a1e2a29308884065d1384f2e5df6d24717b1a4a65f5` |
| pageswiki-adaptor-gateway | `sha256:246e2f1150c814679ca01d0f8f8636e006fa70a280cb1ab4e934e2d84fa5aa46` |
| pageswiki-excalidraw-viewer | `sha256:a9d992e521dfc2e942dedc2ed0296dc30fd8d0b24d8591bf057cd9f7fe4c612f` |
## 認証の範囲
`pages login --oidc` はブラウザー承認を開始し、`--no-browser` は自動起動せずURLを表示する。
確認コードを入力し、必要なTOTPを確認した後、CLI専用のBearerセッションを取得する。
S256 PKCE、5分の有効期限、単回交換、Domain/origin/ブラウザーへの束縛、CSRF、
発行・poll・承認試行の上限を設ける。ブラウザーCookieやOIDC providerのトークンをCLIへ転送しない。
通信断で交換結果が不明な場合は自動再送しない。詳細は [遠隔CLI設計](../../design/ja/remote-cli.md) を参照。
開始APIの404/405/501は、CLI認証未対応または接続先の誤りを示す専用メッセージにした。
OIDC無効の403と区別し、未対応サーバーで権限不足と誤解されないようにした。
## 検証とCI再実行
- 全Goテストをキャッシュなしで実行し成功。
- `go test -race ./internal/store ./internal/server -run 'Test(CLI|RemoteCLI)' -count=3` と全Go vetが成功。
- Python CLIの18試験が成功。未対応サーバー・OIDC無効の診断、秘密を出力しないこと、自動再送しないことを含む。
- 署名付き模擬OIDC providerでcallbackから承認・単回交換・失効まで検証。
- Python CLIのHTTP統合試験で認証後のAPI利用を検証。
- 承認画面はChromiumの1440px/390pxで入力・承認・保存を確認し、モバイル画像も目視確認した。
最初のCIは、既存のカレンダー、検索、匿名公開、outboxテストでDB初期化/処理の
`context deadline exceeded` により失敗した。大容量コピーと時間帯が重なっておりI/O競合が疑われるが、原因を断定しない。
コピー完了後、同じcommitを再実行して全工程が成功した。タイムアウト延長・テスト除外・実装変更で通したものではない。
今後は大容量保全とCIを重ねず、runnerの資源分離・負荷計測を継続課題とする。
## スキーマ移行と本番確認
追加は `cli-auth` version 1の要求管理テーブル・索引とmigration履歴。
既存の文書・カレンダー・タスクの正本変換や既存行の削除はない。
v0.2.1切替直前の整合バックアップから独立コピーを2系統作り、CIイメージで起動した。
network none、CPU 2、メモリ2GiB、コピーだけのDR設定でworkers無効、外部enroll引数なしとした。
移行前はcli-authのみpending、起動後は10コンポーネントすべてcurrentで、health成功・起動エラー0件だった。
本番切替後も、4サービスのrevision一致・再起動0回、公開HTTPSのhealth/ログイン200、
アプリ2台とgateway・Excalidrawのhealth成功、2台とも10コンポーネントcurrentを確認した。
更新したホストCLIとリポジトリの実行ファイルはバイト一致した。
実ユーザーの資格情報を使わず、公開HTTPSで次を確認した。
- CLI開始APIが200を返し、有効期限300秒・poll間隔5秒の要求を作成する。
- 要求の承認入口が200でOIDCログインリンクを表示し、no-storeを返す。
- 未承認要求のtoken APIは `authorization_pending` を返し、セッションを発行しない。
この確認で作成した未承認要求1件は5分で失効する。確認コード・device code・verifierは出力/保存していない。
実OIDC providerでの本人ログインと最終承認は利用者による確認が残る。
外部から取り込んだカレンダーの内容は開いていない。
切替後の観察で、20:54:03 JSTに `city.reconcile` のexecute段階でSQLITE_BUSY(5)を1件検出した。
当該ジョブは2回目の自動再試行でsucceededとなった。認証処理や開始/進捗/完了ログ保存の失敗ではない。
panic・fatal・再起動はなく、イベントログ保存失敗も0件だった。
City再構成の書込競合と取消確認を含むexecute経路の切り分けは後続課題として残す。
## 保全と復旧
保全先は `.deployment-backups/release-v0.3.0-20261101/`。親ディレクトリは0700。
`cutover/data`・`cutover/data2` は20:52:02 JSTに確定した切替前の整合コピー。
20:51:28 JSTに停止を開始し、約6.22GBの最終同期・DBバイト一致・filesystem sync後、20:52:08 JSTに切替を完了した。
`config/` に旧Compose、`.env.release`、0600の `.env`、旧ホストCLIを保持した。
本番とのhardlink共有はない。既存バックアップは保持し、検証専用コピーだけを削除した。
切替後のホスト空き容量は約21GB。世代整理・別媒体への退避は自動削除せず別途判断する。
Git無視対象 `.env.release` は `PAGESWIKI_IMAGE_TAG=v0.3.0`。
通常の `.env` とregistry overlayを併用し、`up --no-build` で起動する。
ローカル3イメージのlatest互換タグもv0.3.0へ揃えた。registryのlatestは更新していない。
旧v0.2.1は各ローカルrepositoryの `rollback-before-v0.3.0-20261101` タグで保持した。
隔離コピーに対する旧版のschema checkは `cli-auth: unknown` で終了コード1となった。
**旧イメージへの差替えだけを検証済みの復旧手順とは扱わない。**
復旧前に書込みを止め、切替後データも保全し、追加component・発行済みセッションとの互換性を確認する。
schema履歴を消してcheckを通さない。バックアップ復元は切替後の書込みを失うため、別途承認と復旧範囲の確認を必要とする。