# 複数PCへ設定ファイルを自動配布する仕組みの設計と落とし穴 社内の複数PCへ APIキーや通知先などの設定ファイルを配り、以後は人手を介さず更新し続けるための設計。 実運用で踏んだ「静かに壊れる」失敗を先に潰す形で書いてある。 ## 前提の構成 - 配布サーバ: `POST /api/keys` が `{ files: { "<ファイル名>": "<中身>" } }` を返す - 認証: 各PCが持つ共有秘密で `HMAC-SHA256(秘密, unixtime)` を送る（時刻ずれ±300秒・`timingSafeEqual`） - クライアント: 各PCの常駐スクリプトが日次で取得し `~/<設定ディレクトリ>/` へ書く ## 落とし穴 1: 「既存ファイルはスキップ」は値の差し替えを永久に届かなくする 最初の実装はこうなりがち。 ```js if (fs.existsSync(destination)) continue; // ← これが罠 fs.writeFileSync(destination, contents, { flag: 'wx', mode: 0o600 }); ``` 新規PCには配れるが、**既に配布済みのPCには二度と新しい値が届かない**。しかもエラーも出ないので 数日〜数週間気付かない。通知先を差し替えた・キーをローテーションした瞬間に全台が古い値で動き続ける。 ### 対策: キー単位のマージ更新にする ファイル全体を上書きすると、PC固有の値（そのPCの表示名など）まで潰れる。キー単位で merge する。 ```js export const PRESERVE_LOCAL_KEYS = new Set(['']); export function mergeEnvFile(existingText, incomingText, preserveKeys = PRESERVE_LOCAL_KEYS) { const incoming = parseEnvText(incomingText); const existing = parseEnvText(existingText); const handled = new Set(); const lines = existingText.split(/\r?\n/).map((line) => { const m = line.match(/^(\s*(?:export\s+)?)([A-Za-z_][A-Za-z0-9_]*)(\s*=\s*)(.*)$/); if (!m || !Object.prototype.hasOwnProperty.call(incoming, m[2])) return line; // コメント行は素通り handled.add(m[2]); if (preserveKeys.has(m[2]) || existing[m[2]] === incoming[m[2]]) return line; return `${m[1]}${m[2]}${m[3]}${incoming[m[2]]}`; }); const additions = Object.keys(incoming).filter((k) => !handled.has(k)).map((k) => `${k}=${incoming[k]}`); return [...lines, ...additions].join('\n'); // 行順・コメントを保つ } ``` 要件は4つ。**配布キーは更新する / ローカル専用キーは消さない / PC固有キーはローカル優先 / 実質変化が無いときは書き込まない**（毎回 "updated" ログが出るとノイズで本当の更新が埋もれる）。 ## 落とし穴 2: 「配っているはず」を確認せずに原因を追うと丸ごとズレる 「値が届かない」障害で、クライアント側のコードだけ見て原因を探すと外す。 **サーバが実際にそのファイルを配っているか**を先に実測すること。 実例では、クライアントのコードにファイル名が出てくるので配布対象だと思い込んでいたが、 そこは配布ではなく旧認証のフォールバック読み取りで、**サーバは一度も配っていなかった**。 確認は、値を出さずファイル名と生死だけ出す使い捨てスクリプトで足りる。 ```js const ts = Math.floor(Date.now() / 1000).toString(); const auth = crypto.createHmac('sha256', secret).update(ts).digest('hex'); const r = await fetch(url, { method: 'POST', headers: { 'x-ts': ts, 'x-auth': auth } }); const payload = await r.json(); console.log('配布ファイル:', Object.keys(payload.files).join(', ')); // ← 中身は絶対に出さない ``` ## 落とし穴 3: 秘密のローテーションが全台を恒久ロックアウトする 落とし穴1と組み合わさると事故になる。サーバ側の共有秘密を張り替えた瞬間、 クライアントは古い秘密で叩き続け、**新しい秘密を受け取る手段が「配布」しかないのに配布が届かない**。 自己回復不能になる。 **ローテーション前に必ず順に確認する。** 1. クライアントは秘密ファイルを**上書き更新できる**か（落とし穴1が潰れているか） 2. 旧秘密を `LEGACY` として一時的に受理する口があるか（複数本を受け付ける） 3. 切替後、**旧秘密で叩いて401・新秘密で叩いて200**を実際にHTTPで確認したか ステータス表示（"認証経路: primary"）は**どのファイルを読んだか**を示すだけで、 その中身が現行かは何も保証しない。表示を完了判定に使わない。 ## 落とし穴 4: 設定ファイルのコピーでPCの識別が混ざる セットアップ時に他PCの設定ファイルをコピーすると、そのPCは**他機の名前を名乗り続ける**。 集計が別PCへ混ざり、しかも本人も管理者も気付かない。 ### 対策: 名前を「刻んだ機体」に紐付ける ```js export function resolveReporterLabel({ envText, hostname }) { const env = parseEnvText(envText); if (env.HOST_BINDING && env.HOST_BINDING !== hostname) { // 他機からコピーされた設定。自機名へ戻す let next = upsertEnvValue(envText, 'HOST_BINDING', hostname); next = upsertEnvValue(next, 'LABEL', hostname); return { label: hostname, nextEnvText: next, reason: 'copied-from-other-host' }; } if (!env.HOST_BINDING) { // 初回。既存ラベルを尊重して刻印だけ追加する（既存PCの表示名を壊さない） return { label: env.LABEL || hostname, nextEnvText: upsertEnvValue(envText, 'HOST_BINDING', hostname), reason: 'adopted' }; } return { label: env.LABEL || hostname, nextEnvText: envText, reason: 'ok' }; } ``` 注意点が3つ。 - **`HOST_BINDING` を配布対象から外す**（PC固有の判定基準なので配布値で上書きされてはいけない） - **全呼び出し側が同じ hostname 取得方法を使う**。片方が `os.hostname()`、片方が Windows の `COMPUTERNAME` だと、両者が互いを「コピー」と判定して**毎回名前を書き換え合う**（無限フリップフロップ） - 自動修正したときは**通知に1行出す**。名前が黙って変わると別の混乱になる - 限界: 刻印**前**にコピーされたファイルは初回に現ラベルを「正」として採用するので遡って直らない。 通知に hostname を併記しておけば、同一ラベルが別 hostname から届いたときに中央側で検出できる ## 落とし穴 5: env の末尾改行を落とすと後続の追記が行を壊す キーを追記するヘルパで末尾改行を落とすと、後から別ツールが1行足したときに `LAST=v` と `NEXT=w` が同じ行に連結して設定ファイルが壊れる。 ```js const endsWithNewline = source.endsWith('\n') || source.endsWith('\r'); const separator = endsWithNewline ? '' : newline; return `${source}${separator}${replacement}${endsWithNewline ? newline : ''}`; ``` ## 検証は「本番同等の偽ホーム」で行う 単体テストだけでは配布経路は守れない。環境変数でホームディレクトリを差し替えられるようにしておき、 **壊れた状態を再現した偽ホーム**に対して本物のスクリプトを実行する。 ```bash HOME_OVERRIDE=/tmp/fakehome node tools/sync.mjs # 1回目: 期待する更新が出るか HOME_OVERRIDE=/tmp/fakehome node tools/sync.mjs # 2回目: 書き込みが起きない（冪等）か rm -rf /tmp/fakehome # 実鍵が降りてくるので必ず破棄する ``` 確認するのは3点。**壊れた値が直るか / PC固有の値と無関係なキーが保持されるか / 2回目で書き込みが無いか。** ## チェックリスト - [ ] 既存ファイルでも配布キーが更新されるか（新規PCだけで試して満足しない） - [ ] PC固有キーは保持されるか - [ ] サーバが実際にそのファイルを配っているか（ファイル名一覧を実測） - [ ] 秘密ローテーション時、旧秘密で401・新秘密で200を実測したか - [ ] 失敗は人の見える場所へ出るか（ログファイルだけだと数日誰も気付かない） - [ ] 偽ホームでの冪等性テストがあるか - [ ] 配布物の取得先はコミットSHAで固定していないか（固定すると改修のたびに全員へ貼り替え依頼が出る） ---