fix: serialize launchd plist safely - #64
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
_build_plist()withplistlib.Reproduction
With the current implementation, a ProgramArgument such as
/tmp/tool&nameor a config/log path containing&,<, or>is inserted into XML unescaped. Parsing the generated plist then fails withExpatError: not well-formed.Root cause
_build_plist()manually interpolates arbitrary strings into XML<string>elements instead of using a plist serializer.Validation
1 passed320 passedplutil -lintgit diff --check: cleanruff check .: 462 findings, identical toupstream/main's pre-existing baselineruff format --check .: same 26 pre-existing unformatted files asupstream/main; the new test file is formattedCompatibility
The generated plist keeps the same launchd semantics:
LabelProgramArgumentsRunAtLoadKeepAliveStandardOutPathStandardErrorPathOnly serialization/escaping is changed; textual XML formatting is intentionally not treated as an API.
Non-changes