Comment lire et modifier les fichiers plist

Savoir lire et modifier un fichier plist, c'est travailler avec le format de configuration d'Apple — les fichiers clé-valeur qui font tourner macOS et iOS en silence. Chaque app porte un Info.plist, chaque tâche planifiée en arrière-plan est un plist launchd, chaque profil de provisionnement et chaque profil d'appareil .mobileconfig est un plist en dessous. Le format lui-même est simple : dictionnaires, tableaux, chaînes, nombres, booléens, dates et blocs de données binaires, imbriqués aussi profondément que vous voulez. Les ennuis commencent parce que le même format est distribué sous deux déguisements — du XML lisible par un humain, et une forme binaire compacte qui ressemble à du bruit dans un éditeur de texte — et parce qu'un seul type erroné peut empêcher silencieusement une tâche de jamais s'exécuter. Vous pouvez coller n'importe quel plist dans le Plist Workbench et le lire, le modifier, le convertir et le valider dans votre navigateur — rien n'est téléversé — mais cet article vous apprend à lire les fichiers vous-même, pour que l'arbre ne soit jamais une boîte noire.

Ce qu'est un plist — et les quatre déguisements qu'il porte

Une liste de propriétés, ou plist, est la façon qu'a Apple de stocker la configuration structurée : un arbre de dictionnaires et de tableaux dont les feuilles sont des chaînes, des entiers, des nombres réels, des booléens, des dates et des blocs de données binaires. C'est la même idée qu'un objet JSON ou un fichier YAML, mais elle est antérieure aux deux sur les plateformes Apple et elle est intégrée au système d'exploitation — macOS et iOS lisent des plists en permanence, sans jamais vous le demander. Si vous vous êtes déjà demandé où une app conserve son bundle ID, sa version ou les autorisations qu'elle demande, la réponse est un plist, et il a toujours été bien en vue.

Le même format apparaît à quatre endroits qui semblent sans rapport jusqu'à ce qu'on connaisse l'astuce. Dans chaque paquet d'app, Info.plist déclare l'identité de l'app : son bundle ID, sa version, les types de documents pris en charge et les autorisations qu'elle demande. Dans ~/Library/LaunchAgents et /Library/LaunchDaemons, les fichiers de tâches launchd décrivent des tâches en arrière-plan — quoi exécuter, quand et dans quelles conditions. Un profil de provisionnement .mobileprovision est un plist (enveloppé dans une signature CMS) qui énumère les appareils et les droits qu'une app peut utiliser. Et un profil d'appareil .mobileconfig est un plist qui décrit le Wi-Fi, le VPN, les certificats et les restrictions à installer sur un appareil. Même format, quatre déguisements — apprenez à en lire un et vous saurez lire les quatre.

Binaire contre XML : la magie bplist00, et pourquoi modifier un plist binaire à la main le corrompt

Un plist a deux sérialisations. La forme XML commence par <?xml et <plist version="1.0">, et se lit dans n'importe quel éditeur de texte : les clés dans des balises <key>, les valeurs dans <string>, <integer>, <true/>, <array> et <dict>. La forme binaire est un encodage compact qui commence par les huit octets magiques bplist00, suivis d'une table d'objets, d'une table de décalages et d'un trailer qui enregistre où vit chaque chose. Les plists binaires sont plus petits et plus rapides à charger pour le système, c'est pourquoi la plupart des plists d'un vrai Mac sont binaires — et pourquoi en ouvrir un dans un éditeur de texte n'affiche que du bruit.

Comment savoir lequel vous avez : regardez les premiers octets. bplist00 signifie binaire ; <?xml ou <plist signifie XML. Et voici la règle qui sauve les fichiers : ne modifiez jamais les octets binaires à la main. Un plist binaire est une toile de décalages — changez une chaîne en une plus longue et tous les décalages qui suivent sont faux, le trailer ne correspond plus à la table, et le fichier est corrompu même si le texte que vous avez changé a l'air correct. Le chemin sûr est toujours le même : convertir le binaire en XML, modifier le XML, reconvertir en binaire, puis réanalyser le résultat pour prouver qu'il est toujours valide. Sur un Mac, c'est plutil -convert xml1 et plutil -convert binary1 ; dans le navigateur, le Plist Workbench fait le même aller-retour pour vous.

Lire une tâche launchd à la main : Label, ProgramArguments, RunAtLoad, KeepAlive, StartCalendarInterval

Une tâche launchd est un plist au vocabulaire restreint, et on peut en lire une en moins d'une minute une fois qu'on connaît les clés. Label est le nom unique de la tâche, par convention un domaine inversé comme com.example.backup — launchd l'utilise pour identifier la tâche, et deux tâches avec le même label entrent en collision. ProgramArguments est un tableau de chaînes : le programme à exécuter suivi de ses arguments, donc ["/usr/local/bin/backup.sh"] exécute ce script sans argument. RunAtLoad est un booléen : true signifie exécuter la tâche dès qu'elle est chargée. KeepAlive, lui aussi booléen, signifie la redémarrer chaque fois qu'elle se termine. Ces quatre clés décrivent la plupart des tâches que vous rencontrerez.

La clé de planification est StartCalendarInterval, un dictionnaire de champs calendaires — Minute, Hour, Day, Weekday, Month — dont vous pouvez omettre n'importe lequel, donc {Hour: 3, Minute: 30} signifie tous les jours à 03:30. Sa cousine plus simple, StartInterval, est un seul entier : exécuter toutes les N secondes. L'exemple du bloc de code ci-dessous est une tâche complète et fonctionnelle sous cette forme — Label, ProgramArguments, RunAtLoad, StartCalendarInterval — et il vaut la peine d'être lu ligne par ligne, parce que chaque tâche launchd que vous rencontrerez en est une variation : les mêmes clés, des valeurs différentes, et un extra occasionnel comme WorkingDirectory ou StandardOutPath pour dire où va la sortie.

Les clés qui cassent les choses : erreurs de type, conteneurs erronés, nombres hors limites

La plupart des tâches launchd cassées ne le sont pas par des fautes de frappe — elles le sont par des types. launchd attend que ProgramArguments soit un tableau de chaînes ; donnez-lui une seule chaîne et la tâche ne se charge pas, avec une erreur qui en dit très peu. KeepAlive, RunAtLoad et Disabled doivent être des booléens, pas les chaînes "true" et "false" — une chaîne qui épelle "true" n'est pas true, et launchd la traitera comme une erreur de type. StartInterval doit être un entier positif ; un zéro ou un nombre négatif n'a pas de sens et est rejeté. Ce sont les erreurs qu'un éditeur de texte ne détecte jamais, parce que le XML est parfaitement bien formé — seul le sens est faux.

La deuxième famille de casses est celle des nombres hors de leur plage. Dans StartCalendarInterval, Minute doit être entre 0 et 59, Hour entre 0 et 23, Weekday entre 0 et 7, Day entre 1 et 31, et Month entre 1 et 12 — un Hour de 25 ne signifie pas « demain à 1 h », il signifie que la tâche ne s'exécute jamais, et launchd ne vous dira peut-être même pas pourquoi. La troisième famille est la paire qui ne doit pas apparaître ensemble : Program et ProgramArguments sont deux façons de dire la même chose, et donner les deux est ambigu — choisissez-en une, et préférez ProgramArguments, la forme documentée par Apple. Un validateur qui vérifie les types, les plages et ces conflits attrape les trois familles avant que la tâche n'atteigne launchd, ce qui est exactement ce que font les vérifications launchd du workbench.

Modifier en sécurité : sauvegarder, convertir, modifier, reconvertir, vérifier

Modifier un plist en sécurité est un rituel en cinq étapes, et l'ordre compte. D'abord, sauvegardez le fichier original — copiez-le ailleurs avant d'y toucher, car une tâche launchd ou un profil d'appareil n'a pas de bouton annuler. Ensuite, si le fichier est binaire, convertissez-le en XML ; ne modifiez jamais les octets binaires directement, pour les raisons de décalage ci-dessus. Troisièmement, faites la modification dans le XML : changez une valeur, renommez une clé, ajoutez un élément au tableau — et gardez les types corrects, une chaîne là où va une chaîne, un tableau là où va un tableau. Quatrièmement, reconvertissez en binaire si l'original était binaire, pour que le fichier revienne sous la forme attendue par le système.

Cinquièmement, et c'est l'étape la plus souvent sautée : vérifiez en réanalysant. Lancez plutil -lint sur le résultat, ou collez-le dans le workbench et regardez-le s'analyser proprement — si le fichier se réanalyse et que les valeurs qui reviennent sont celles que vous vouliez, la modification a fonctionné. S'il ne s'analyse pas, vous avez toujours la sauvegarde de la première étape, et le fichier sur le disque n'a jamais été touché par l'éditeur : le workbench modifie une copie en mémoire et n'écrit un fichier que lorsque vous exportez explicitement. Cette dernière propriété est tout le sens de la modification dans le navigateur — l'original reste intact jusqu'à ce que vous décidiez que la nouvelle version est bonne.

Ce que fait le Plist Workbench — et ce qu'il ne fait pas

Le workbench analyse les deux formes de plist — binaire bplist00 et XML — en un arbre que vous pouvez déplier, rechercher par chemin (comme StartCalendarInterval.Hour) et modifier sur place : changer un scalaire, renommer une clé, ajouter ou supprimer des clés et des éléments de tableau, et changer le type d'une valeur quand ce n'est pas ambigu. Chaque export — plist XML, plist binaire, JSON, ou un CSV de la table des chemins aplatie — reflète le modèle modifié, pas le fichier original. Quand le plist ressemble à une tâche launchd, il exécute les vérifications sémantiques des sections précédentes : Label présent, exactement un de Program et ProgramArguments, champs calendaires dans les limites, booléens vraiment booléens. C'est tout le travail, et tout se passe dans votre navigateur : le fichier ne quitte jamais votre appareil.

Ce qu'il ne fait pas est tout aussi important. Il n'installe rien — il ne chargera pas votre tâche dans launchd, n'installera pas un .mobileconfig sur un appareil, ni ne provisionnera une app ; ce sont des actions système, et une page web ne devrait pas les accomplir. Il ne valide ni les signatures de code ni les droits de provisionnement auprès d'Apple, donc un .mobileprovision modifié peut s'analyser parfaitement et être quand même rejeté par le système parce que sa signature ne correspond plus — analyser n'est pas faire confiance. Et il n'exécute rien du plist : une tâche launchd qui pointe vers un script n'est que des données jusqu'à ce que launchd l'exécute, et le workbench la traite comme des données. Pour l'équivalent Android — le manifeste dans un APK — utilisez l'Analyseur d'APK ; pour le cousin de launchd sous Linux, les unités systemd, utilisez l'Auditeur d'unités systemd.

Essayez vous-même : une tâche launchd que vous pouvez lire, convertir et vérifier

# 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

Sources

Questions fréquentes

J'ai ouvert un .plist dans un éditeur de texte et il ressemble à du bruit — le fichier est-il cassé ?

Presque certainement non : c'est un plist binaire. Ouvrez le fichier et regardez les premiers octets — s'ils disent bplist00, le fichier est sous la forme binaire compacte d'Apple, faite pour les machines, pas pour les yeux. Convertissez-le d'abord en XML (plutil -convert xml1 sur un Mac, ou collez-le dans le Plist Workbench, qui détecte la magie et le convertit pour vous) et vous verrez les mêmes clés et valeurs sous forme lisible. Inquiétez-vous seulement si le fichier ne commence ni par bplist00 ni par

Puis-je modifier un .mobileprovision ou un .mobileconfig de la même façon ?

Le format est le même — les deux sont des plists en dessous — mais les conséquences diffèrent. Un .mobileconfig est un simple plist et se modifie proprement. Un .mobileprovision est un plist enveloppé dans une signature CMS, donc changer une valeur à l'intérieur casse la signature, et les outils d'Apple rejetteront le profil modifié même s'il s'analyse toujours. Le workbench analyse et modifie les deux, mais il ne valide pas les signatures auprès d'Apple, donc traitez un .mobileprovision analysé comme « lisible », et non comme « toujours valide ». Dans le doute, régénérez le profil depuis le portail d'Apple au lieu de le modifier.

Pourquoi launchd ignore-t-il ma tâche, ou refuse-t-il de la charger ?

Vérifiez les suspects habituels dans cet ordre. D'abord, Label est-il présent, est-ce une chaîne, et est-il unique ? Ensuite, ProgramArguments est-il un tableau de chaînes — une seule chaîne à cet endroit est l'échec le plus courant. Troisièmement, les champs de StartCalendarInterval sont-ils dans les limites — un Hour de 25 signifie que la tâche ne s'exécute jamais. Quatrièmement, lancez plutil -lint sur le fichier pour repérer le XML mal formé, et vérifiez que le fichier vit dans le bon répertoire (~/Library/LaunchAgents pour votre utilisateur, /Library/LaunchDaemons pour le système) avec le bon propriétaire. S'il ne se charge toujours pas, collez-le dans le Plist Workbench — ses vérifications launchd signalent chacun de ces problèmes avec une correction en langage clair.