feat: declare plugin permissions and validate them#10
Merged
Conversation
The SpaceUX app shows a plugin's declared permissions before enabling it, so declare them here: the FreeCAD plugin uses network (its bridge socket) and filesystem (the bridge install), and the example launcher uses exec. Extend validate-plugins.mjs to check the optional `permissions` field (known values, no duplicates), and document it in CONTRIBUTING. Refs Maik-0000FF/SpaceUX#426
Report which permission(s) are unknown (e.g. ["bogus"]) instead of only listing the allowed set, so a plugin author sees exactly what to fix. Refs Maik-0000FF/SpaceUX#426
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
1 participant
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.
What
Plugins now declare the sensitive permissions they need (the SpaceUX app shows them before a user enables a plugin):
org.spaceux.freecad:network(its bridge socket) +filesystem(the bridge install).org.spaceux.example-launch:exec(it spawns programs).Plus
validate-plugins.mjsnow checks the optionalpermissionsfield (known values, no duplicates), mirroring the app's loader, andCONTRIBUTING.mddocuments it.Coupling
Declaring permissions changes those two plugins' content, so their content hashes change. The matching update to the app's shipped
OFFICIAL_PLUGIN_HASHESis in Maik-0000FF/SpaceUX#430; the two should merge together so the official plugins keep verifying. (Users with an older installed copy re-verify after re-importing the updated plugin.)Refs Maik-0000FF/SpaceUX#426