Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better parity with macOS XML plist parsing #37

Merged
merged 3 commits into from
Dec 5, 2024

Conversation

korylprince
Copy link
Contributor

This PR intends to bring this library in better alignment with macOS's plist parsing (e.g. plutil, PlistBuddy). This stems from some discussion on the MacAdmins Slack where MDM commands successfully parsed by this library were rejected by macOS's plist parser.

There's two commits:

  • add a test suite of valid and invalid plists as determined by plutil -lint
    • if plutil is present in $PATH, the test will use the actual command to compare parse errors. Otherwise it will use a pre-baked list of invalid plists
    • this should make it easier to add similar test cases in the future if other issues arise
  • clean up the XML parser by:
    • only allowing specific tags on for loops in parsing <plist>, <dict>, and <array> tags, so that extraneous tags or chardata returns an error like plutil does
    • verifying that all start tags are escaped with end tags, like plutil does

It should be noted that it's not possible to gain full parity with plutil. For example an malformed DOCTYPE like

<!DOCTYPE PUBLIC "-//Apple//DTD PLIST>

will be happily parsed by plutil, but Go's XML parser will go to EOF looking for the missing ", with no control to stop it.

However, this PR should bring us to much closer parity than we are now, and it seems to me it's better to have this parser be more stringent than plutil, instead of the other way around.

@korylprince
Copy link
Contributor Author

Note: the original test used os.ReadDir and os.ReadFile, which failed the testers running Go versions older than 1.16. I force-pushed a version that uses ioutil's equivalents instead to appease the testers.

@jessepeterson
Copy link
Member

Would this catch #3?

@korylprince
Copy link
Contributor Author

Would this catch #3?

Yep, the testdata/xml/invalid-data.plist case matches #3.

@jessepeterson jessepeterson linked an issue Nov 27, 2024 that may be closed by this pull request
decode_test.go Outdated Show resolved Hide resolved
Copy link
Member

@jessepeterson jessepeterson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @korylprince!

@korylprince korylprince merged commit 6cf8243 into micromdm:main Dec 5, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Plist failing plutil -lint is successfully parsed
2 participants