Plistファイルの読み方と編集方法

plistファイルを読んで編集するとは、Appleの設定ファイル形式を扱うことです——macOSとiOSを静かに動かしているキーと値のファイルです。すべてのアプリにはInfo.plistがあり、スケジュールされたすべてのバックグラウンドジョブはlaunchdのplistで、すべてのプロビジョニングプロファイルとすべての.mobileconfigデバイスプロファイルは、その中身がplistです。形式自体はシンプルです。辞書、配列、文字列、数値、真偽値、日付、バイナリデータが、好きなだけ深くネストできます。問題が始まるのは、同じ形式が2つの姿で配布されるからです——人間が読めるXMLと、テキストエディタではゴミに見えるコンパクトなバイナリ形式——そして、たった1つの型の間違いが、ジョブが二度と実行されない原因になるからです。どんなplistでもPlist Workbenchに貼り付けて、ブラウザで読む、編集する、変換する、検証することができます——何もアップロードされません——。この記事ではファイル自体を読む方法を教えます。そうすれば、ツリーがブラックボックスになることは決してありません。

plistとは何か——そしてそれがまとう4つの姿

プロパティリスト、すなわちplistは、Appleが構造化された設定を保存する方法です。辞書と配列のツリーで、葉は文字列、整数、実数、真偽値、日付、バイナリデータの塊です。JSONオブジェクトやYAMLファイルと同じ考え方ですが、Appleのプラットフォームではそれらより古くからあり、OSに組み込まれています。macOSとiOSは、あなたに尋ねることなく常にplistを読んでいます。アプリがバンドルIDやバージョン、要求する権限をどこに保存しているのか不思議に思ったことがあれば、答えはplistです。そしてそれはずっと目の前にありました。

同じ形式は、コツを知るまでは無関係に見える4つの場所に現れます。すべてのアプリバンドルの中では、Info.plistがアプリのアイデンティティを宣言しています。バンドルID、バージョン、対応するドキュメントの種類、要求する権限です。~/Library/LaunchAgentsと/Library/LaunchDaemonsでは、launchdのジョブファイルがバックグラウンドタスクを記述しています。何を実行するか、いつ、どんな条件で、です。.mobileprovisionプロビジョニングプロファイルはplistで(CMS署名で包まれています)、アプリが使えるデバイスと権限を列挙しています。そして.mobileconfigデバイスプロファイルもplistで、デバイスにインストールするWi-Fi、VPN、証明書、制限を記述しています。同じ形式、4つの姿——1つ読めれば、4つとも読めます。

バイナリとXML:bplist00というマジックと、バイナリplistを手で編集してはいけない理由

plistには2つのシリアライゼーションがあります。XML形式は<?xmlと<plist version="1.0">で始まり、どんなテキストエディタでも読めます。キーは<key>タグに、値は<string>、<integer>、<true/>、<array>、<dict>に入っています。バイナリ形式はコンパクトなエンコーディングで、8バイトのマジックbplist00で始まり、オブジェクトテーブル、オフセットテーブル、そしてすべてがどこにあるかを記録するトレーラーが続きます。バイナリplistは小さく、システムが読み込むのも速いため、実際のMac上のほとんどのplistはバイナリです——そして、テキストエディタで開くとゴミしか見えないのもそのためです。

どちらを持っているか見分ける方法は、先頭のバイトを見ることです。bplist00ならバイナリ、<?xmlや<plistならXMLです。そしてここに、ファイルを救うルールがあります。バイナリのバイトを決して手で編集してはいけません。バイナリplistはオフセットの網です。1つの文字列を長いものに変えれば、それ以降のすべてのオフセットが狂い、トレーラーはテーブルと合わなくなり、ファイルは破損します。変更したテキストが見た目は問題なくても、です。安全な道は常に同じです。バイナリをXMLに変換し、XMLを編集し、バイナリに戻し、結果を再パースしてまだ有効であることを証明する。Macではplutil -convert xml1とplutil -convert binary1です。ブラウザでは、Plist Workbenchが同じ往復を代わりにやってくれます。

launchdジョブを手で読む:Label、ProgramArguments、RunAtLoad、KeepAlive、StartCalendarInterval

launchdジョブは語彙の小さなplistで、キーさえ知っていれば1分以内に読めます。Labelはジョブの一意な名前で、慣習としてcom.example.backupのような逆ドメインです。launchdはこれでジョブを識別し、同じラベルのジョブが2つあると衝突します。ProgramArgumentsは文字列の配列です。実行するプログラムとその引数で、["/usr/local/bin/backup.sh"]はそのスクリプトを引数なしで実行します。RunAtLoadは真偽値で、trueは読み込まれたらすぐにジョブを実行することを意味します。KeepAliveも真偽値で、終了するたびに再起動することを意味します。この4つのキーが、あなたが出会うほとんどのジョブを説明します。

スケジュールのキーはStartCalendarIntervalで、カレンダーフィールドの辞書です。Minute、Hour、Day、Weekday、Monthのどれも省略でき、{Hour: 3, Minute: 30}は毎日03:30を意味します。よりシンプルな仲間であるStartIntervalは1つの整数で、N秒ごとに実行します。下のコードブロックのサンプルは、この形の完全で動作するジョブです——Label、ProgramArguments、RunAtLoad、StartCalendarInterval——。1行ずつ読む価値があります。なぜなら、あなたが出会うすべてのlaunchdジョブはそのバリエーションだからです。同じキー、異なる値、そしてときどき出力先を示すWorkingDirectoryやStandardOutPathのような追加項目があります。

ものを壊すキー:型の間違い、間違ったコンテナ、範囲外の数値

壊れたlaunchdジョブのほとんどは、タイプミスで壊れているのではありません。型で壊れています。launchdはProgramArgumentsが文字列の配列であることを期待します。1つの文字列を渡すと、ジョブは読み込めず、エラーメッセージはほとんど何も語りません。KeepAlive、RunAtLoad、Disabledは真偽値でなければならず、"true"や"false"という文字列ではありません。"true"と綴られた文字列はtrueではなく、launchdはそれを型エラーとして扱います。StartIntervalは正の整数でなければならず、0や負の数は無意味で拒否されます。これらはテキストエディタが決して見つけられない間違いです。XML自体は完全に整形式だからです。間違っているのは意味だけです。

2つ目の壊れ方の家族は、範囲外の数値です。StartCalendarIntervalでは、Minuteは0〜59、Hourは0〜23、Weekdayは0〜7、Dayは1〜31、Monthは1〜12でなければなりません。Hourが25というのは「明日の午前1時」ではなく、ジョブが二度と実行されないという意味で、launchdはその理由すら教えてくれないかもしれません。3つ目の家族は、両方あってはいけないペアです。ProgramとProgramArgumentsは同じことを言う2つの方法で、両方与えるのは曖昧です。どちらか1つを選び、Appleが文書化しているProgramArgumentsを優先してください。型、範囲、そしてこれらの競合をチェックするバリデータは、ジョブがlaunchdに届く前に3つの家族すべてを捕まえます。まさにそれが、ワークベンチのlaunchdチェックが行うことです。

安全に編集する:バックアップ、変換、編集、再変換、検証

安全なplist編集は5ステップの儀式で、順序が重要です。まず、元のファイルをバックアップします。触る前にどこか別の場所にコピーしてください。launchdジョブやデバイスプロファイルには元に戻すボタンがないからです。次に、ファイルがバイナリならXMLに変換します。バイナリのバイトを直接編集してはいけません。上のオフセットの理由からです。3番目に、XMLで編集を行います。値を変える、キーの名前を変える、配列の項目を追加する——そして型を正しく保ちます。文字列は文字列の場所に、配列は配列の場所に。4番目に、元がバイナリだったらバイナリに戻し、ファイルがシステムの期待する形で戻るようにします。

5番目、そして最もよく省略されるステップ:再パースによる検証です。結果に対してplutil -lintを実行するか、ワークベンチに貼り付けてきれいにパースされるのを確認します。ファイルが再パースでき、戻ってきた値が意図した値であれば、編集は成功です。パースできなければ、ステップ1のバックアップがまだあり、ディスク上のファイルはエディタに一度も触られていません。ワークベンチはメモリ内のコピーを編集し、明示的にエクスポートしたときにだけファイルを書き込みます。最後のこの性質こそ、ブラウザで編集することの意味そのものです。新しいバージョンが良いとあなたが判断するまで、元のファイルは無傷のままです。

Plist Workbenchができること——そしてできないこと

ワークベンチは両方の形式のplist——バイナリのbplist00とXML——を、展開できるツリーにパースします。パスで検索でき(StartCalendarInterval.Hourのように)、その場で編集できます。スカラーを変える、キーの名前を変える、キーや配列の項目を追加・削除する、曖昧さがない場合に値の型を変える、です。すべてのエクスポート——XML plist、バイナリplist、JSON、フラット化したパステーブルのCSV——は、元のファイルではなく編集後のモデルを反映します。plistがlaunchdジョブに見える場合、前のセクションのセマンティックチェックを実行します。Labelがあるか、ProgramとProgramArgumentsのどちらか一方だけか、カレンダーフィールドが範囲内か、真偽値が本当に真偽値か、です。それが仕事のすべてで、すべてあなたのブラウザの中で起こります。ファイルがデバイスを離れることは決してありません。

できないことも同じくらい重要です。何もインストールしません。ジョブをlaunchdに読み込んだり、デバイスに.mobileconfigをインストールしたり、アプリをプロビジョニングしたりしません。それらはシステムの動作であり、ウェブページが実行すべきものではありません。コード署名やプロビジョニングの権限をAppleと照合して検証することもありません。そのため、編集した.mobileprovisionは完璧にパースできても、署名が合わなくなったためにシステムに拒否されることがあります。パースできることは、信頼できることではありません。そして、plistの中のものを実行することもありません。スクリプトを指すlaunchdジョブは、launchdが実行するまではデータであり、ワークベンチはそれをデータとして扱います。Androidの equivalent——APK内のマニフェスト——にはAPK Analyzerを、launchdのLinuxのいとこであるsystemdユニットにはsystemd Unit Auditorを使ってください。

自分で試す:読んで、変換して、検証できるlaunchdジョブ

# A minimal launchd job, as XML — the form you can read and edit safely
<?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>com.example.backup</string>
    <key>ProgramArguments</key>
    <array>
        <string>/usr/local/bin/backup.sh</string>
    </array>
    <key>RunAtLoad</key>
    <true/>
    <key>StartCalendarInterval</key>
    <dict>
        <key>Hour</key>
        <integer>3</integer>
        <key>Minute</key>
        <integer>30</integer>
    </dict>
</dict>
</plist>

# Convert between the two forms on a Mac — never edit the binary bytes:
$ plutil -convert xml1 job.plist     # binary -> readable XML
$ plutil -convert binary1 job.plist  # XML -> compact binary, for shipping
$ plutil -lint job.plist             # re-parse to verify it is still valid

出典

よくある質問

.plistをテキストエディタで開いたらゴミのように見えます——ファイルが壊れているのですか?

ほぼ確実に壊れていません。それはバイナリplistです。ファイルを開いて先頭のバイトを見てください。bplist00と読めれば、そのファイルはAppleのコンパクトなバイナリ形式で、機械のためのもので、人の目のためのものではありません。まずXMLに変換してください(Macではplutil -convert xml1、またはPlist Workbenchに貼り付ければ、マジックを検出して代わりに変換してくれます)。そうすれば、同じキーと値が読める形で見えます。心配すべきは、ファイルがbplist00でも

.mobileprovisionや.mobileconfigも同じように編集できますか?

形式は同じです——どちらも中身はplistです——が、結果は異なります。.mobileconfigはプレーンなplistで、きれいに編集できます。.mobileprovisionはCMS署名で包まれたplistなので、中の値を変えると署名が壊れ、Appleのツールは編集されたプロファイルを拒否します。パースはできても、です。ワークベンチは両方をパースして編集しますが、Appleと照合して署名を検証しません。そのため、パースされた.mobileprovisionは「読める」ものとして扱い、「まだ有効」とは扱わないでください。迷ったら、編集するのではなく、Appleのポータルからプロファイルを再生成してください。

launchdが私のジョブを無視する、または読み込みを拒否するのはなぜですか?

この順序でよくある容疑者をチェックしてください。まず、Labelはあるか、文字列か、一意か。次に、ProgramArgumentsは文字列の配列か——そこに1つの文字列があるのが最も多い失敗です。3番目に、StartCalendarIntervalのフィールドは範囲内か——Hourが25だとジョブは二度と実行されません。4番目に、ファイルに対してplutil -lintを実行して不正なXMLを見つけ、ファイルが正しいディレクトリにあるか確認してください(自分のユーザーなら~/Library/LaunchAgents、システムなら/Library/LaunchDaemons)。それでも読み込めなければ、Plist Workbenchに貼り付けてください。そのlaunchdチェックがこれらの問題を1つずつ、わかりやすい修正方法とともに指摘します。