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

Expand plugin spec with installation details #150

Merged
merged 7 commits into from
Apr 27, 2022

Conversation

qmuntal
Copy link
Contributor

@qmuntal qmuntal commented Apr 25, 2022

This PR expands the plugin extensibility spec so it is more clear and specific on how a plugin is installed.

These are the detailed changes:

  • Document the plugin location for Windows
  • Remark that windows binaries must end with .exe.
  • Document notation plugin list command, which was not in the new spec but implemented in feat-kv-extensibility.
  • Document that the plugin should implement the discover command to be considered valid.
  • Edited: Rename discover to get-plugin-metadata
  • Few typos corrected

@SteveLasker

Copy link
Contributor

@SteveLasker SteveLasker left a comment

Choose a reason for hiding this comment

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

Thanks for the clarification @qmuntal
LGTM

To be considered a valid plugin a candidate must pass each of these "plugin candidate tests":

* The directory must contain an executable named `notation-{plugin-name}`.
* The executable can be a regular file or a symbolic link.
Copy link
Contributor

Choose a reason for hiding this comment

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

Symlink support expands the threat model, as there are ways to exploit them. I'd explicitly mention that we don't support symlinks for now.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agree, will do that.

specs/plugin-extensibility.md Show resolved Hide resolved
@qmuntal qmuntal force-pushed the plugin-lifecycle branch 2 times, most recently from 3097371 to 10a8fdb Compare April 26, 2022 18:24
@qmuntal qmuntal requested a review from gokarnm April 26, 2022 18:27
@qmuntal qmuntal force-pushed the plugin-lifecycle branch 4 times, most recently from 39b7c81 to 051af10 Compare April 26, 2022 19:10
qmuntal and others added 7 commits April 26, 2022 21:11
Signed-off-by: qmuntal <qmuntaldiaz@microsoft.com>
Signed-off-by: qmuntal <qmuntaldiaz@microsoft.com>
Co-authored-by: Milind Gokarn <milind81@gmail.com>
Signed-off-by: qmuntal <qmuntaldiaz@microsoft.com>
Signed-off-by: qmuntal <qmuntaldiaz@microsoft.com>
Signed-off-by: qmuntal <qmuntaldiaz@microsoft.com>
Co-authored-by: Milind Gokarn <milind81@gmail.com>
Signed-off-by: qmuntal <qmuntaldiaz@microsoft.com>
Signed-off-by: qmuntal <qmuntaldiaz@microsoft.com>
@SteveLasker SteveLasker merged commit 2d3c8dd into notaryproject:main Apr 27, 2022
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.

4 participants