Plist-Dateien lesen und bearbeiten

Eine Plist-Datei zu lesen und zu bearbeiten, heißt mit Apples Konfigurationsformat zu arbeiten — den Schlüssel-Wert-Dateien, die macOS und iOS leise am Laufen halten. Jede App trägt eine Info.plist, jede geplante Hintergrundaufgabe ist eine launchd-Plist, jedes Provisioning-Profil und jedes .mobileconfig-Geräteprofil ist darunter eine Plist. Das Format selbst ist einfach: Dictionaries, Arrays, Strings, Zahlen, Booleans, Daten und binäre Datenblöcke, beliebig tief verschachtelt. Die Schwierigkeiten beginnen, weil dasselbe Format in zwei Kostümen ausgeliefert wird — menschenlesbarem XML und einer kompakten Binärform, die in einem Texteditor wie Datenmüll aussieht — und weil ein einziger falscher Typ einen Job lautlos daran hindern kann, jemals zu laufen. Sie können jede Plist in die Plist Workbench einfügen und sie im Browser lesen, bearbeiten, konvertieren und validieren — nichts wird hochgeladen — aber dieser Artikel lehrt Sie, die Dateien selbst zu lesen, damit der Baum für Sie nie eine Blackbox ist.

Was eine Plist ist — und die vier Kostüme, die sie trägt

Eine Property List, kurz Plist, ist Apples Art, strukturierte Konfiguration zu speichern: ein Baum aus Dictionaries und Arrays, dessen Blätter Strings, Integer, reelle Zahlen, Booleans, Daten und binäre Datenblöcke sind. Es ist dieselbe Idee wie ein JSON-Objekt oder eine YAML-Datei, aber auf Apple-Plattformen älter als beide und im Betriebssystem verankert — macOS und iOS lesen ständig Plists, ohne Sie je zu fragen. Wenn Sie sich je gefragt haben, wo eine App ihre Bundle-ID, ihre Version oder die Berechtigungen speichert, die sie anfordert: Die Antwort ist eine Plist, und sie lag die ganze Zeit offen vor Ihnen.

Dasselbe Format taucht an vier Stellen auf, die unzusammenhängend wirken, bis man den Trick kennt. In jedem App-Bundle deklariert die Info.plist die Identität der App: ihre Bundle-ID, Version, unterstützte Dokumenttypen und die Berechtigungen, die sie anfordert. In ~/Library/LaunchAgents und /Library/LaunchDaemons beschreiben launchd-Jobdateien Hintergrundaufgaben — was ausgeführt wird, wann und unter welchen Bedingungen. Ein .mobileprovision-Provisioning-Profil ist eine Plist (eingehüllt in eine CMS-Signatur), die auflistet, welche Geräte und Berechtigungen eine App nutzen darf. Und ein .mobileconfig-Geräteprofil ist eine Plist, die WLAN, VPN, Zertifikate und Einschränkungen beschreibt, die auf einem Gerät installiert werden. Dasselbe Format, vier Kostüme — wer eines lesen kann, kann alle vier lesen.

Binär vs. XML: das bplist00-Magic, und warum das Bearbeiten einer binären Plist von Hand sie beschädigt

Eine Plist hat zwei Serialisierungen. Die XML-Form beginnt mit <?xml und <plist version="1.0"> und lässt sich in jedem Texteditor lesen: Schlüssel in <key>-Tags, Werte in <string>, <integer>, <true/>, <array> und <dict>. Die Binärform ist eine kompakte Kodierung, die mit den acht Magic-Bytes bplist00 beginnt, gefolgt von einer Objekttabelle, einer Offset-Tabelle und einem Trailer, der festhält, wo alles liegt. Binäre Plists sind kleiner und für das System schneller zu laden — deshalb sind die meisten Plists auf einem echten Mac binär, und deshalb zeigt das Öffnen in einem Texteditor nur Datenmüll.

Woran Sie erkennen, welche Sie haben: Sehen Sie sich die ersten Bytes an. bplist00 bedeutet binär; <?xml oder <plist bedeutet XML. Und hier ist die Regel, die Dateien rettet: Bearbeiten Sie die Binärbytes niemals von Hand. Eine binäre Plist ist ein Netz aus Offsets — ändern Sie einen String zu einem längeren, stimmen alle Offsets danach nicht mehr, der Trailer passt nicht mehr zur Tabelle, und die Datei ist beschädigt, obwohl der Text, den Sie geändert haben, gut aussieht. Der sichere Weg ist immer derselbe: binär nach XML konvertieren, das XML bearbeiten, zurück nach binär konvertieren und das Ergebnis dann erneut parsen, um zu beweisen, dass es noch gültig ist. Auf einem Mac sind das plutil -convert xml1 und plutil -convert binary1; im Browser übernimmt die Plist Workbench denselben Hin- und Rückweg für Sie.

Einen launchd-Job von Hand lesen: Label, ProgramArguments, RunAtLoad, KeepAlive, StartCalendarInterval

Ein launchd-Job ist eine Plist mit kleinem Vokabular, und man kann einen in unter einer Minute lesen, sobald man die Schlüssel kennt. Label ist der eindeutige Name des Jobs, üblicherweise eine umgekehrte Domain wie com.example.backup — launchd nutzt ihn, um den Job zu identifizieren, und zwei Jobs mit demselben Label kollidieren. ProgramArguments ist ein Array aus Strings: das auszuführende Programm, gefolgt von seinen Argumenten, also führt ["/usr/local/bin/backup.sh"] dieses Skript ohne Argumente aus. RunAtLoad ist ein Boolean: true bedeutet, den Job auszuführen, sobald er geladen wird. KeepAlive, ebenfalls ein Boolean, bedeutet, ihn neu zu starten, sobald er beendet wird. Diese vier Schlüssel beschreiben die meisten Jobs, denen Sie je begegnen.

Der Schlüssel für die Zeitplanung ist StartCalendarInterval, ein Dictionary aus Kalenderfeldern — Minute, Hour, Day, Weekday, Month — von denen Sie jedes weglassen können, sodass {Hour: 3, Minute: 30} jeden Tag um 03:30 Uhr bedeutet. Sein einfacherer Vetter StartInterval ist eine einzelne Ganzzahl: alle N Sekunden ausführen. Das Beispiel im Codeblock unten ist ein vollständiger, funktionierender Job in dieser Form — Label, ProgramArguments, RunAtLoad, StartCalendarInterval — und es lohnt sich, ihn Zeile für Zeile zu lesen, denn jeder launchd-Job, dem Sie begegnen, ist eine Variation davon: dieselben Schlüssel, andere Werte, und gelegentlich ein Extra wie WorkingDirectory oder StandardOutPath dafür, wohin die Ausgabe geht.

Die Schlüssel, die Dinge kaputtmachen: Typfehler, falsche Container, Zahlen außerhalb des Bereichs

Die meisten kaputten launchd-Jobs werden nicht durch Tippfehler kaputtgemacht — sie werden durch Typen kaputtgemacht. launchd erwartet, dass ProgramArguments ein Array aus Strings ist; geben Sie ihm einen einzelnen String, lädt der Job nicht, mit einer Fehlermeldung, die sehr wenig sagt. KeepAlive, RunAtLoad und Disabled müssen Booleans sein, nicht die Strings "true" und "false" — ein String, der "true" buchstabiert, ist nicht true, und launchd wird ihn als Typfehler behandeln. StartInterval muss eine positive Ganzzahl sein; null oder eine negative Zahl ist sinnlos und wird abgelehnt. Das sind die Fehler, die ein Texteditor niemals erkennt, weil das XML perfekt wohlgeformt ist — nur die Bedeutung ist falsch.

Die zweite Familie von Schäden sind Zahlen außerhalb ihres Bereichs. In StartCalendarInterval muss Minute 0–59 sein, Hour 0–23, Weekday 0–7, Day 1–31 und Month 1–12 — eine Hour von 25 bedeutet nicht "morgen um 1 Uhr", sondern dass der Job niemals läuft, und launchd sagt Ihnen möglicherweise nicht einmal, warum. Die dritte Familie ist das Paar, das nicht gemeinsam auftreten darf: Program und ProgramArguments sind zwei Arten, dasselbe zu sagen, und beide anzugeben ist mehrdeutig — wählen Sie eines, und bevorzugen Sie ProgramArguments, die Form, die Apple dokumentiert. Ein Validator, der Typen, Bereiche und diese Konflikte prüft, fängt alle drei Familien ab, bevor der Job je launchd erreicht — genau das tun die launchd-Prüfungen der Workbench.

Sicher bearbeiten: sichern, konvertieren, bearbeiten, zurückkonvertieren, prüfen

Sicheres Bearbeiten von Plists ist ein Ritual aus fünf Schritten, und die Reihenfolge ist wichtig. Erstens: Sichern Sie die Originaldatei — kopieren Sie sie woandershin, bevor Sie sie anfassen, denn ein launchd-Job oder ein Geräteprofil hat keinen Rückgängig-Knopf. Zweitens: Wenn die Datei binär ist, konvertieren Sie sie nach XML; bearbeiten Sie Binärbytes niemals direkt, aus den oben genannten Offset-Gründen. Drittens: Nehmen Sie die Änderung im XML vor — ändern Sie einen Wert, benennen Sie einen Schlüssel um, fügen Sie ein Array-Element hinzu — und halten Sie die Typen richtig: ein String, wo ein String hingehört, ein Array, wo ein Array hingehört. Viertens: Konvertieren Sie zurück nach binär, wenn das Original binär war, damit die Datei in der Form zurückkehrt, die das System erwartet.

Fünftens, und am häufigsten übersprungen: Prüfen Sie durch erneutes Parsen. Führen Sie plutil -lint auf dem Ergebnis aus, oder fügen Sie es in die Workbench ein und beobachten Sie, wie es sauber geparst wird — wenn die Datei sich erneut parsen lässt und die Werte, die zurückkommen, die sind, die Sie wollten, hat die Bearbeitung funktioniert. Wenn sie sich nicht parsen lässt, haben Sie immer noch die Sicherung aus Schritt eins, und die Datei auf der Platte wurde vom Editor nie berührt: Die Workbench bearbeitet eine Kopie im Speicher und schreibt eine Datei erst, wenn Sie sie ausdrücklich exportieren. Diese letzte Eigenschaft ist der ganze Sinn des Bearbeitens im Browser — das Original bleibt intakt, bis Sie entscheiden, dass die neue Version gut ist.

Was die Plist Workbench tut — und was sie nicht tut

Die Workbench parst beide Formen von Plist — binäres bplist00 und XML — in einen Baum, den Sie aufklappen, nach Pfad durchsuchen (wie StartCalendarInterval.Hour) und direkt bearbeiten können: einen Skalar ändern, einen Schlüssel umbenennen, Schlüssel und Array-Elemente hinzufügen oder löschen und den Typ eines Werts ändern, wo das eindeutig ist. Jeder Export — XML-Plist, binäre Plist, JSON oder ein CSV der abgeflachten Pfadtabelle — spiegelt das bearbeitete Modell wider, nicht die Originaldatei. Wenn die Plist wie ein launchd-Job aussieht, führt sie die semantischen Prüfungen aus den vorherigen Abschnitten aus: Label vorhanden, genau eines von Program und ProgramArguments, Kalenderfelder im Bereich, Booleans tatsächlich boolesch. Das ist die ganze Aufgabe, und alles geschieht in Ihrem Browser: Die Datei verlässt Ihr Gerät nie.

Was sie nicht tut, ist genauso wichtig. Sie installiert nichts — sie wird Ihren Job nicht in launchd laden, kein .mobileconfig auf einem Gerät installieren und keine App provisionieren; das sind Systemaktionen, und eine Webseite sollte sie nicht ausführen. Sie validiert keine Codesignaturen oder Provisioning-Berechtigungen gegen Apple, sodass eine bearbeitete .mobileprovision perfekt parsen kann und trotzdem vom System abgelehnt wird, weil ihre Signatur nicht mehr stimmt — Parsen ist nicht Vertrauen. Und sie führt nichts aus der Plist aus: Ein launchd-Job, der auf ein Skript zeigt, ist Daten, bis launchd ihn ausführt, und die Workbench behandelt ihn als Daten. Für das Android-Äquivalent — das Manifest in einem APK — nutzen Sie den APK Analyzer; für launchds Linux-Vetter, systemd-Units, den systemd Unit Auditor.

Selbst ausprobieren: ein launchd-Job, den Sie lesen, konvertieren und prüfen können

# 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

Quellen

Häufig gestellte Fragen

Ich habe eine .plist in einem Texteditor geöffnet und sie sieht wie Datenmüll aus — ist die Datei beschädigt?

Fast sicher nicht: Es ist eine binäre Plist. Öffnen Sie die Datei und sehen Sie sich die ersten Bytes an — wenn dort bplist00 steht, liegt die Datei in Apples kompakter Binärform vor, die für Maschinen gemacht ist, nicht für Augen. Konvertieren Sie sie zuerst nach XML (plutil -convert xml1 auf einem Mac, oder fügen Sie sie in die Plist Workbench ein, die das Magic erkennt und sie für Sie konvertiert), und Sie sehen dieselben Schlüssel und Werte in lesbarer Form. Sorgen Sie sich nur, wenn die Datei weder mit bplist00 noch mit

Kann ich eine .mobileprovision oder .mobileconfig genauso bearbeiten?

Das Format ist dasselbe — beide sind darunter Plists — aber die Folgen unterscheiden sich. Eine .mobileconfig ist eine einfache Plist und lässt sich sauber bearbeiten. Eine .mobileprovision ist eine Plist, die in eine CMS-Signatur eingehüllt ist, sodass das Ändern eines Werts darin die Signatur bricht und Apples Werkzeuge das bearbeitete Profil ablehnen, obwohl es sich noch parsen lässt. Die Workbench parst und bearbeitet beide, validiert aber keine Signaturen gegen Apple — behandeln Sie eine geparste .mobileprovision also als "lesbar", nicht als "noch gültig". Im Zweifel erzeugen Sie das Profil neu über Apples Portal, statt es zu bearbeiten.

Warum ignoriert launchd meinen Job oder weigert sich, ihn zu laden?

Prüfen Sie die üblichen Verdächtigen in dieser Reihenfolge. Erstens: Ist Label vorhanden, ein String und eindeutig? Zweitens: Ist ProgramArguments ein Array aus Strings — ein einzelner String dort ist der häufigste Fehler. Drittens: Liegen die StartCalendarInterval-Felder im Bereich — eine Hour von 25 bedeutet, dass der Job niemals läuft. Viertens: Führen Sie plutil -lint auf der Datei aus, um fehlerhaftes XML zu finden, und prüfen Sie, ob die Datei im richtigen Verzeichnis liegt (~/Library/LaunchAgents für Ihren Benutzer, /Library/LaunchDaemons für das System) mit der richtigen Eigentümerschaft. Wenn sie sich immer noch nicht laden lässt, fügen Sie sie in die Plist Workbench ein — ihre launchd-Prüfungen markieren jedes dieser Probleme mit einer Lösung in einfachem Englisch.