NGW TECH BLOG
← 記事一覧へ
·#107

UTM のリムーバブルUSBから外れた外付けイメージを、LaunchAgent から AppleScript で入れ直す

UTM がリムーバブルUSBに入れた外付けイメージを外し、VM がバックアップなしで起動することがある。LaunchAgent からは TCC により UTM の設定も外付けイメージの中身も読めない。UTM の AppleScript で空の枠(host size = 0)を検知し、VM の設定を壊さずに入れ直す方法と、本番と同じ文脈での試験方法をまとめる。

UTM でリムーバブルUSBとして VM に渡している外付けディスクイメージが、Mac の再起動をまたいで外れることがある。VM はそのディスクなしで起動する。

この記事では、次の3点を扱う。

  • LaunchAgent から見える情報と見えない情報(TCC)。ssh での確認が試験にならない理由
  • UTM の AppleScript で、空になったリムーバブルUSBの枠を検知する方法
  • 同じく AppleScript で、VM の設定を壊さずにイメージを入れ直す方法

構成

NGWメイン・NGWクローンは、それぞれ Mac mini の中の UTM(QEMU)で Ubuntu を動かしている。ディスクは4つ。

ディスクMac 側の実体VM の中
システム.utm の中の qcow2/
バックアップngw-backup.img/mnt/ngw-backup
添付書類ngw-files.img/mnt/ngw-files
NGWASngw-storage.img/mnt/ngw-storage

システムは通常のドライブ(VirtIO)で渡す。外付けの3つは、外付けSSD上のイメージ(/Volumes/NGW_BACKUP/・/Volumes/NGW_FILES/・/Volumes/NGW_STORAGE/)を リムーバブルUSB として渡す。NGWAS は NGWのNAS機能。

外付けの3つは、どれも同じ渡し方なので、同じように外れうる。NGWAS のディスク(NGW_STORAGE)は、NGW に内蔵した簡易ファイルサーバ(NGWAS は小規模団体専用)のファイルを置くディスクで、NGWメインとNGWクローンで同じ大きさにそろえている。

外付けSSD → イメージファイル → UTM のリムーバブルUSBの枠 → VM の sda → LUKS → /mnt/ngw-backup
                                  ↑ 外れるのはここ

なぜ、あえて外付けUSBにしているのか

データを暗号化するため。 バックアップ・添付書類・NGWAS は、あえてシステムディスクと分け、外付けUSBとして VM に渡している。

  • Mac の暗号化(FileVault)は使えない。 有効にすると、再起動のたびに人がパスワードを入れないと起動しない。停電からの復帰も、夜間の無人再起動もできなくなる。
  • だから、VM の中で暗号化する。 Linux 標準の LUKS を使う。VM が書き込んだ時点で暗号文になるので、Mac 側のイメージファイルも、外付けSSDの中身も暗号文になる。
  • データだけを別のディスクにする。 OS は先に起動し、そのあとでデータのディスクを Tang(相手機)の鍵で自動で開く。鍵はどこにも置かないので、機器や外付けSSDを LAN の外へ持ち出しても開かない。

暗号化と鍵の仕組みは完成する日は来るのだろうか、添付書類を外付けへ出した構成はbind mount で添付を外付けへ出すで書いた。

大規模団体を想定している。 小規模団体なら、データを VM の中(システムディスク)に置いても足りる。外付けUSBに出しているのは、バックアップ・添付書類・NGWAS のデータが大きく育つ大規模団体を想定した構成だからだ。

この構成の代償が、この記事の問題になる。外付けUSBの枠は、UTM が外すことがある。

見張りの仕組み

Mac 側では、起動側の見張り(ngwUtmBootcheck.sh)が LaunchAgent で動く。ログイン時と2分ごとに VM の応答を見て、止まっていれば UTM を起動し utmctl start で VM を起こす。夜間は 03:00 に VM を正常停止してから Mac ごと再起動する(毎晩3時に、ひとりでに立ち直る)。毎晩の再起動は、macOS の「49日問題(49.7日問題)」への対策として入れたもの。Mac を連続して49日17時間2分47秒以上稼働させると、新規のネットワーク通信(TCP接続)ができなくなる不具合で、サーバとしては致命的になる。

症状:枠が空になり、VM がバックアップなしで起動する

夜間再起動のあと、VM のバックアップが 0B になって起動した。

[    2.793945] sd 0:0:0:0: [sda] Media removed, stopped polling

UTM の設定画面では、リムーバブルUSBの枠の1つが「(空)」になる。今回外れたのはバックアップ(NGW_BACKUP)だった。イメージのファイルは外付けSSDの上に残っている。

原因:UTM の ExternalDrives から項目が消える

UTM は、リムーバブルUSBに入れたファイルを、設定(com.utmapp.UTM)の Registry → VM ごとの ExternalDrives に、パスとセキュリティスコープ付きのブックマークで保持している。消えるのはこの項目。

"ExternalDrives" => {
  "1419710A-…" => { "Bookmark" => <data>, "Path" => "/Volumes/NGW_BACKUP/ngw-backup.img", … }   ← 消えた
  "ECD7DDED-…" => { "Bookmark" => <data>, "Path" => "/Volumes/NGW_FILES/ngw-files.img", … }
}

書き換わった時刻は UTM の起動前、再起動の終了処理のあたり。終了時に外付けボリュームの取り外しと UTM の終了が競合していると推測しているが、未確認。同じ時刻帯で2か月前にも1度起きている。

既存の安全装置が効かなかった理由

見張りには「UTM が覚えている外付けイメージが実際に読めるまで、VM を起動しない」仕組みがあった。外付けSSDが壊れたまま VM を上げると、ゲストが壊れたディスクへ書き続けて ext4 を傷めるため。

これが効かない理由は2つ。

  1. 待つ対象を ExternalDrives から取っている。 項目が消えたイメージは、待つ対象からも消える。
  2. LaunchAgent からは ExternalDrives が読めない(次の節)。待つ対象が常に空に見え、素通りする。

LaunchAgent から見えるもの、見えないもの(TCC)

macOS は、ほかのアプリのデータ(サンドボックスのコンテナ)や外付けボリュームへのアクセスを TCC(プライバシー保護)で制限している。LaunchAgent の /bin/sh はフルディスクアクセスを持たない。

同じ確認を ssh と LaunchAgent で実行した結果。

確認sshLaunchAgent
設定を plutil -p読める読めない ※1
設定を cpできるできない ※2
defaults read読める読めない ※3
中身を head -c読める読めない
大きさを stat読める読める
AppleScript動く動く ※4
  • 設定は UTM の設定ファイル ~/Library/Containers/com.utmapp.UTM/…/com.utmapp.UTM.plist。defaults read は com.utmapp.UTM の Registry を読む
  • 中身・大きさは外付けイメージのもの(大きさは stat -f %z)。AppleScript は UTM の AppleScript
  • ※1 you don't have permission to view it
  • ※2 Operation not permitted
  • ※3 UTM の起動前は Domain 'com.utmapp.UTM' not found
  • ※4 オートメーション許可があれば

ssh で差が出ないのは、ssh の受け口(sshd-keygen-wrapper)にフルディスクアクセスが付いているため。ssh で確認すると、本番の見張りより強い権限で動く。 ssh で通っても、LaunchAgent で通る保証にはならない。

本番と同じ文脈で試す

試験用の LaunchAgent を作り、結果をファイルに書かせる。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0"><dict>
  <key>Label</key><string>ngw.test</string>
  <key>ProgramArguments</key><array><string>/bin/sh</string><string>/Users/<user>/test/t.sh</string></array>
  <key>RunAtLoad</key><true/>
</dict></plist>
launchctl bootstrap gui/$(id -u) ~/test/t.plist   # 読み込んだ時点で1回走る
cat ~/test/out.txt                                 # t.sh が書いた結果
launchctl bootout gui/$(id -u)/ngw.test            # 外す

本番の見張りを止めて試すときは、launchctl bootout gui/$(id -u)/com.ngwserver.utm.bootcheck で外し、終わったら bootstrap で戻す。止めておかないと、2分ごとの見張りが VM を起動してしまう。

AppleScript で空の枠を検知する

UTM は AppleScript の辞書(UTM.app/Contents/Resources/UTM.sdef)を持つ。VM の configuration の drives に、ドライブごとの id・removable・host size(MiB)がある。

on run argv
  tell application "UTM"
    set cfg to configuration of (virtual machine named (item 1 of argv))
    set out to ""
    repeat with d in (drives of cfg)
      set out to out & (id of d) & tab & (removable of d) & tab & (host size of d) & linefeed
    end repeat
    return out
  end tell
end run
1419710A-…	true	0         ← バックアップの枠が空
63253838-…	false	77895     ← システム
ECD7DDED-…	true	61440     ← 添付書類

(この出力は NGW_STORAGE を据え付ける前の機体のもの。据え付けた機体ではリムーバブルの行が3つになる。判定は同じ。)

removable が true で host size が 0 の枠が、空の枠。 ファイルを読まないので、LaunchAgent からでも判定できる。媒体が入っていれば、イメージの大きさ(バックアップなら 131072 MiB)が返る。

注意:drives of (configuration of vm) と1行で書くと -1700(specifier に変換できない)で失敗する。configuration をいったん変数に入れる。

AppleScript で入れ直す

ドライブの設定には source(既存のファイルをイメージとして使う)がある。update configuration で、空の枠に source を渡すと入れ直せる。

on run argv
  set vmName to item 1 of argv
  set did to item 2 of argv
  set f to POSIX file (item 3 of argv)        -- ★ tell の外で作る
  tell application "UTM"
    set vm to virtual machine named vmName
    set cfg to configuration of vm
    set nds to {}
    set hit to false
    repeat with d in (drives of cfg)
      if (id of d) is did and (removable of d) and (host size of d) is 0 then
        set end of nds to ({source:f} & (contents of d))   -- 空の枠にだけ source を足す
        set hit to true
      else
        set end of nds to (contents of d)                  -- ほかは読んだまま
      end if
    end repeat
    if not hit then return "skip"
    set drives of cfg to nds
    update configuration of vm with cfg
    return "ok"
  end tell
end run

要点は3つ。

  • drives は、読んだものを全部渡す。 一部だけ渡すと、UTM がドライブ一覧の置き換えと解釈しうる(システムディスクが VM の設定から外れる)。全部を渡す形で、VM の設定ファイル(.utm/config.plist)が変わらないことを md5 で確認した。入れ直した結果は ExternalDrives にだけ反映される。
  • POSIX file は tell application "UTM" の外で作る。 中で変数から作ると UTM への命令として送られ、UTM が POSIX file "/Volumes/…" を処理できずに失敗する。パスを直接書いた場合はコンパイル時にファイル参照になるため失敗しない。試験でパスを直書きすると見落とす。
  • VM が止まっているときだけ呼ぶ。 動作中の VM の設定は変更できない。

UTM はサンドボックスのアプリだが、AppleScript で渡したファイルは UTM 自身が開いてブックマークを作る。画面でファイルを選び直したのと同じ結果になる。

どの枠にどのイメージを入れるか

空の枠は host size が 0 なので、何が入っていたかは分からない。正常なときに対応を控えておく。

  • VM が動いている間(6時間ごと)に枠を読み、host size と外付けボリューム上のイメージの大きさ(stat -f %z ÷ 1048576)を突き合わせて、「枠ID → イメージのパス」を ~/.ngw-utm/drives.map に書く。大きさで1つに決まる枠だけ書く。
  • 控えが無いときは、空の枠も「どの枠にも付いていないイメージ」も1つだけの場合に限って組にする。
  • 決められないとき、控えのファイルが見当たらない(ボリュームが未マウント)ときは、入れずに警告を残し、VM はそのまま起動する。
1419710A-…	/Volumes/NGW_BACKUP/ngw-backup.img
ECD7DDED-…	/Volumes/NGW_FILES/ngw-files.img

NGW_STORAGE を据え付けた機体では、/Volumes/NGW_STORAGE/ngw-storage.img の行が加わる。

イメージの大きさは LaunchAgent から読めるので、照合の手がかりに使える。

見張りの流れ

VM が応答する
  └─ 6時間に1度、枠とイメージの対応を控える(+UTM を操作できたかを状態ファイルへ)

VM が応答しない
  ├─ UTM を起動(open -ga UTM)
  ├─ utmctl status が stopped なら
  │    ├─ AppleScript で枠を読む
  │    ├─ host size 0 の枠に、控えのイメージを入れ直す
  │    └─ もう一度読んで、大きさが戻ったかを確かめて記録
  └─ utmctl start

入れ直したあとは、VM の中で Tang による自動の開き直しが走り、暗号化ディスクが開いてマウントされる。VM 側の変更は不要。

開発環境の機体(利用者なし)で、バックアップの項目を ExternalDrives から消して再現したときのログ。

09:49:48 HTTP down: ensuring UTM app + VM 'NGWLinuxMain' are up
09:49:49 ALERT: リムーバブル USB の枠が空です(1419710A-…)— UTM が外付けイメージを外しています。入れ直します
09:49:49 note: 枠 1419710A-… に /Volumes/NGW_BACKUP/ngw-backup.img を入れ直しました(131072 MiB)
09:49:49 VM status='stopped'; issuing utmctl start
09:50:16 HTTP up after 20s (recovered)
$ lsblk   # VM の中
sda             128G
  └─ngwbackup   128G /mnt/ngw-backup

オートメーション許可の確認

sh が UTM を AppleScript で操作するには、「システム設定 → プライバシーとセキュリティ → オートメーション」で「sh → UTM」が必要。許可がアプリごとに別である点は落とし穴4を参照。ここでは追加の注意点だけ挙げる。

  • 未許可のまま走ると、画面に確認のダイアログが出て応答を待つ。誰も押さなければ Apple Event が時間切れ(-1712)になる。無人の機体では、設置直後に画面共有で一度許可しておく。
  • OS の更新で外れることがある。
  • 確認画面(NGW Mac設定)が自分自身の許可を見ても、見張りが UTM を操作できるかは分からない。

そのため、見張りが自分の文脈で実際に UTM を操作できたかを、見張り自身が状態ファイルに書く。

# ~/.ngw-utm/automation.status
automation=ok
checked=2026-11-19 10:02:20

NGW Mac設定はこれを読み、「UTM の操作許可(ウォッチドッグ):あり/なし/未確認」と、直近の自動の入れ直しの結果を表示する。「なし」のときは、オートメーションの設定場所を案内する。

VM 側の監視:暗号化ディスクが開かない理由を分ける

VM の中の監視(ngw-watchdog.sh)は、暗号化ディスクが閉じていると「Tang 待ちか、非常用パスフレーズで開く」と案内していた。枠が空のときは開く対象のディスクが VM に無いため、どちらでも開かない。

/etc/crypttab の UUID= が /dev/disk/by-uuid/ に無いものを分けて、案内を変える。

for n in $cc; do                                   # cc = 閉じている crypttab の名前
  src=$(awk -v n="$n" '$1 == n {print $2; exit}' /etc/crypttab)
  case "$src" in
    UUID=*) [ -e "/dev/disk/by-uuid/${src#UUID=}" ] || gone="$gone$n " ;;
    /dev/*) [ -e "$src" ] || gone="$gone$n " ;;
  esac
done
状態案内
基のディスクが見えない鍵や Tang の問題ではない。UTM の設定でリムーバブルUSBに外付けイメージを入れ直す
見えるが閉じている従来どおり「Tang 待ち/非常用パスフレーズ」

自己修復(ngw-selfheal.sh)も、基のディスクが見えないものには開き直しを流さない。

確認URLは :8080

見張りが VM の稼働を確かめる URL は、UTM の転送専用ポート http://localhost:8080/ にそろえた。:80 だと、Mac 側で別の Web サーバ(例:MAMP)が :80 を握ったとき、その応答を「VM が動いている」と誤判定する。

残っている課題

  • 外れる原因は断っていない。 夜間再起動の前に UTM を正常終了させれば防げる可能性がある。この仕組みは、外れたあとに直す安全網。
  • 再起動の回数を減らす。 49日問題を避けるだけなら、毎晩でなくてもよい。週末の再起動にすれば、枠が外れる機会そのものが減る。切り替えを検討している。
  • 「外付けイメージが読めるまで起動しない」は、LaunchAgent からは効かない。 イメージの中身を読めないため。別の確認方法が要る。

AIとの協働作業での学び

  • 権限で結果が変わる処理は、本番と同じ文脈(ここでは LaunchAgent)で試す。 ssh での確認は、フルディスクアクセス付きで動くため試験にならないことがある。
  • 設定を書き換える API は、渡し方で意味が変わる。 一部だけ渡すと置き換えになりうる。書き換える前に退避し、書き換えたあとに変わっていないこと(md5)を確かめる。
  • 監視の案内は、症状ではなく原因で分ける。 同じ「閉じている」でも、鍵が無いのとディスクが無いのとでは直し方が違う。