コンテンツにスキップ

現在のセッションにプライベートな認証情報を提供する

プライベートの認証情報を使用して、データベースのパスワード、リポジトリのトークン、またはSSHのプライベートキーを提供します。現在のセッション内で使用可能な通常のシェルコマンドもこれらを使用できます。これらはチャットメッセージとしてモデルに送信されることはありません。

obscli

チャットで /credentials を入力します。メニューには Write と Delete のみが表示され、セッションの単一の Agent に自動的に紐付けられます。Write では、同じ非公開フォームに Key と Value を入力します。Tab でフィールドを切り替え、Enter で送信します。既定の種類はテキストで、Value は常に非表示です。既存の名前に書き込む場合は、上書きの確認が必要です。

サービス応答を待っている間、Ctrl+CまたはEscを2回押して待機をキャンセルできます。待機中に入力したテキストは破棄され、チャットのドラフト、ログ、キャッシュには保存されません。既に送信されたメッセージをキャンセルしても、サーバー上の操作は元に戻りません。再試行する前に結果を確認してください。

ファイルにも同じフォームを使います。Ctrl+T で file に切り替えると Value が消去されます。Value に @ で始まるパスを入力してください。絶対パス、~/、相対パスを使用できます。矢印キーで選択し、Tab で補完し、Shift+Tab で Key に戻ります。補完は現在のディレクトリ接頭辞にある隠しファイルも対象とし、再帰検索は行いません。アップロード前に選択したパスとサイズを確認してください。obscli は貼り付けたテキストをファイルに変換しません。

フォームには認証情報の一覧や更新機能はありません。通常のチャットで Agent に認証情報の名前と種類の一覧を依頼してください。値は返されません。Delete には正確な名前と確認が必要です。失敗すると入力はフォームに残り、手動で再試行するか、Edit key and value を使用できます。キャンセル、閉じる操作、成功時には入力が消去されます。組み込みの TUI メニュー、プロンプト、エラーは英語です。ユーザーの内容とモデル出力は変更されません。

git-rgトークンを追加する

git-rgには、以下のセッション認証情報のみが必要です:

名前 目的
GITRG_TOKEN 検索し、リポジトリを読む
GITRG_WRITE_TOKEN リポジトリを読み込み、変更内容をプレビューし、新しいブランチやコミットを作成することができます。また、ドラフトPRやMRも作成できます。

タスクに必要な最小限の権限で、対象プラットフォーム上でトークンを作成します。

プラットフォーム 読み取りアクセス 書き込みアクセス
GitHub ターゲットリポジトリ:Contents: Read-only ターゲットリポジトリ:Contents: Read and write, Pull requests: Read and write
GitLab Reporter, read_api Developer, api
Gitee projects projects、pull_requests、そして対象リポジターへの書き込みアクセス権

トークンを現在のセッションに提出します:

  1. /credentialsを入力し、Writeを選択してください。
  2. 読み取り専用のタスクについては、KeyをGITRG_TOKENに設定してください。編集用のタスクについては、GITRG_WRITE_TOKENを使用してください。
  3. プラットフォームのトークンをValueに貼り付け、その後Enterキーを押してください。

両方の Token を用意する必要はありません。Token をチャットに入力しないでください。セッションの終了、Agent の再起動、または接続の終了時に認証情報は無効になります。

これらの独立したコマンドは、自動化や互換性のために引き続き利用可能です。IDや名前は例示的なものであり、実際にはコマンドラインに秘密の値を入力することはありません。テキスト値は隠蔽された入力を通じて入力されます。ファイルの内容はAgentに秘密裏に保存され、その変数にはファイルのローカルパスが含まれます。listは、名前とタイプのみを返します。

obscli session credential put --workspace-uuid WS --session-uuid SESSION --agent-uuid AGENT
obscli session credential put --workspace-uuid WS --session-uuid SESSION --agent-uuid AGENT --name GITRG_TOKEN
obscli session credential put --workspace-uuid WS --session-uuid SESSION --agent-uuid AGENT --name GITRG_WRITE_TOKEN
obscli session credential put --workspace-uuid WS --session-uuid SESSION --agent-uuid AGENT --name SSH_KEY_FILE --file ./id_ed25519
obscli session credential list --workspace-uuid WS --session-uuid SESSION --agent-uuid AGENT
obscli session credential delete --workspace-uuid WS --session-uuid SESSION --agent-uuid AGENT --name GITRG_TOKEN

--stdinを使用して、安全な入力源からテキストを読み取ります。末尾の改行を含むバイトは保持されます。コマンドや引数に秘密のリテラルを含めないでください。そうすると、それがシェルヒストリーに記録される可能性があります。

ワンショットタスクのインポート

obscli run --import-credential /secure/credentials.jsonは、タスクを送信する前に認証情報をインポートします。例:JSONおよび呼び出し方:

{
  "kv": {"DB_PASSWORD": "your-password", "GITRG_TOKEN": "your-read-token", "GITRG_WRITE_TOKEN": "your-write-token"},
  "files": {"SSH_KEY_FILE": "./id_ed25519"}
}
obscli run --agent-uuid "$AGENT" \
  --import-credential /secure/credentials.json \
  --prompt '使用 DB_PASSWORD 和 SSH_KEY_FILE 执行任务'

JSON のみをサポートします。kv または files は省略できます。相対ファイルパスは JSON ファイルのディレクトリを基準に解決されます。$VARIABLE と ~ は展開されず、シェルコードも実行されません。名前は両セクションを通じて一意で、値は空でない文字列、ファイルは読み取り可能な通常ファイルである必要があります。JSON ファイルは最大 8 MiB、名前は最大 64 個、各項目は最大 256 KiB、デコード後の認証情報の合計は最大 8 MiB です。

クライアントは、すべての入力内容を確認し、空のセッションを作成し、認証情報をアップロードし、各確認が完了するまで待ちます。アップロードに失敗したり、確認が行われなかった場合、タスクは開始されず、自動的に再試行されません。クライアントはセッションを閉じようとし、クリーニングの失敗を報告します。元のJSONおよびローカルファイルは保持されます。これらは自分で管理してください。できれば0600の権限で管理することが望ましいです。コマンドラインにはインポートパスのみ表示されます。認証情報の内容はチャット、モデル、またはアプリケーションのログには表示されません。

アップロードは自動的にタスクを開始するものではありません。確認後、目的の使用法について普通のチャットで説明し、続行を求めます。次の通常のモデル呼び出しでは、名前や型のみが受け取られ、通常のシェル構文が使用されます。

PGPASSWORD="$DB_PASSWORD" psql -h db.example.com -U readonly
git-rg --auth env -F 'timeout' github:OWNER/REPO
ssh -i "$SSH_KEY_FILE" deploy@host

有効期限と使用許可

  • 同じ名前を書くことで、その名前は将来のコマンドに対する値を上書きします。既に実行中のコマンドは、古い値を保持することができます。
  • セッション内でメッセージを送信できるユーザーは、その認証情報を管理できます。このセッションはAgentに紐結されており、他のセッションは認証情報を継承しません。
  • テキストは Agent のメモリに保存されます。ファイル用ディレクトリのモードは 0700、ファイルは 0600 で、どちらも Agent アカウントが所有します。ファイル認証情報には Unix の権限の仕組みが必要です。Windows Agents は受け付けませんが、Windows クライアントから Unix Agents へのアップロードは可能です。
  • セッションを閉じるか、Agentを再起動すると、認証情報が無効になります。異常な終了後に残ったファイルは、次の起動時にクリーニングされます。古い値は復元されません。
  • AgentをBeakから切断すると、認証情報も無効になります。再接続後に再申請する必要があります。セッションを再開しても、認証情報は回復しません。
  • 各セッションでは、最大 64 個の名前と、項目ごとに最大 256 KiB を使用できます。累積送信量の上限は 8 MiB です。削除してもカウンターはリセットされません。マスキング用の断片は作成されなくなりました。
  • Agents がオフラインの場合、処理はキューに入らず直ちに失敗します。確認がタイムアウトした場合、結果は不明です。何も保存されなかったと判断せず、名前の一覧を確認するか、同じ名前で再送信してください。
  • 認証情報を含むコマンドが返されるとき、そのプロセスグループ内のバックグラウンドでの子プロセスはクリアされます。このメカニズムを使用して長時間実行されるサービスを起動しないでください。

通常のコマンドは、セッション変数やファイルパスを受け取ります。既存のシェル承認ルールは依然として適用されます。ツールによって印刷された認証情報は、履歴、ログ、トレース、およびモデルに、文字列の置換なしで元の形式で記録されます。ファイルの削除は、ディスクのフォレンジック検出、スナップショット、またはバックアップからの保護には効果がありません。同じOSアカウントや管理者は、ファイルの許可制限の境界外に存在します。

認証情報は、所属するセッションのコマンドサブプロセスにのみ注入され、Agentのグローバル環境は変更されません。他のセッションは自動的にそれらを継承しません。ただし、同じAgent上のセッションは通常、同じOSアカウントを共有します。他のセッションにある制限のないシェルは、そのアカウントが所有するファイルを読み取ることができます。処理環境へのアクセスは、OSの権限に依存します。セッションの範囲は、別々のアカウント、コンテナ、またはOSサンドボックスを置き換えるものではありません。

ウェブエントリー

Web の認証情報入力には、対応するフロントエンドのバージョンとデプロイ後の受け入れ検証が必要です。Beak と Agent のみを更新しても、自動的には利用可能になりません。

現在のセッションでは、認証情報のエントリを選択します。ダイアログボックスでは、「書き込み」「置換」「削除」のオプションが提供されます。リストやリフレッシュ、またはAgentのセレクターはありません。新しいタスクは、モデルを呼び出さずに空のセッションを作成し、その後、メッセージはそのセッションを再利用します。

テキスト入力は非表示です。ファイルは、貼り付けたマルチ行の内容からアップロードまたは作成できます。空白文字や改行は保持されます。上書きや削除には確認が必要です。入力に失敗した内容は、手動での再試行のために現在のフォームのメモリにのみ保持されます。セッションを閉じたり、セッションを切り替えたり、入力に成功した場合は、その内容はクリアされます。ユーザーは、構造化されたデータを記述する必要はありません。

Beak は認証情報をメモリ上で短時間だけ中継します。リバースプロキシ、APM、Redis のコマンドデバッグで、これらのリクエスト本文を記録しないように設定してください。本番環境では HTTPS/WSS を使用してください。

フィードバック

このページは役に立ちましたか?