Prevent local extension installations with invalid names and conflicts with core commands and other extensions #9794

BagToad · 2024-10-20T22:47:10Z

This adds validation for local extension installation, preventing installation in the following situations:

If the extension to be installed conflicts with a built-in command
If the extension to be installed conflicts with an already installed extension
If the directory specified does not have the gh- prefix
- While not reported in Local extensions can override core commands #9699, there is an additional bug where a local extension without the gh- prefix could be installed, but could then never be executed or removed with gh extension remove, causing a bad state requiring manual intervention.

Demo

Commands to setup and test with (copied from #9699 - I recommend a clean cli/cli codespace on kw/cli-9699-validate-local-extension-installs branch):

# build the CLI from the kw/cli-9699-validate-local-extension-installs branch
make
# For convenience:
gh_path="/workspaces/cli/bin/gh"
# We need to delete any default aliases to reproduce core command overriding 
$gh_path alias delete co

# ACTUAL TEST SAMPLE: 
# Create an extension that overrides a core command, install it, and the installation should fail
$gh_path ext create pr && cd gh-pr && $gh_path ext install . && $gh_path pr

Conflict with built in command

$ $gh_path ext create pr && cd gh-pr && $gh_path ext install . && $gh_path pr
✓ Created directory gh-pr
✓ Initialized git repository
✓ Made initial commit
✓ Set up extension scaffolding

gh-pr is ready for development!

Next Steps
- run 'cd gh-pr; gh extension install .; gh pr' to see your new extension in action
- run 'gh repo create' to share your extension with others

For more information on writing extensions:
https://docs.github.com/github-cli/github-cli/creating-github-cli-extensions
"pr" matches the name of a built-in command or alias

Improperly named local extension

$ $gh_path ext create bad-name && mv gh-bad-name bad-name && cd bad-name && $gh_path ext install . && $gh_path bad-name
✓ Created directory gh-bad-name
✓ Initialized git repository
✓ Made initial commit
✓ Set up extension scaffolding

gh-bad-name is ready for development!

Next Steps
- run 'cd gh-bad-name; gh extension install .; gh bad-name' to see your new extension in action
- run 'gh repo create' to share your extension with others

For more information on writing extensions:
https://docs.github.com/github-cli/github-cli/creating-github-cli-extensions
extension directory name must start with `gh-`

Conflict with other extension

$ $gh_path ext create my-extension && cd gh-my-extension && $gh_path ext install . && $gh_path my-extension
✓ Created directory gh-my-extension
✓ Initialized git repository
✓ Made initial commit
✓ Set up extension scaffolding

gh-my-extension is ready for development!

Next Steps
- run 'cd gh-my-extension; gh extension install .; gh my-extension' to see your new extension in action
- run 'gh repo create' to share your extension with others

For more information on writing extensions:
https://docs.github.com/github-cli/github-cli/creating-github-cli-extensions
Hello gh-my-extension!

$ mkdir testing-temp
$ cd testing-temp
$ $gh_path ext create my-extension && cd gh-my-extension && $gh_path ext install . && $gh_path my-extension
✓ Created directory gh-my-extension
✓ Initialized git repository
✓ Made initial commit
✓ Set up extension scaffolding

gh-my-extension is ready for development!

Next Steps
- run 'cd gh-my-extension; gh extension install .; gh my-extension' to see your new extension in action
- run 'gh repo create' to share your extension with others

For more information on writing extensions:
https://docs.github.com/github-cli/github-cli/creating-github-cli-extensions
there is already an installed extension that provides the "my-extension" command

No conflict with built in commands or installed extensions

$ $gh_path ext create new-command && cd gh-new-command && $gh_path ext install . && $gh_path new-command
✓ Created directory gh-new-command
✓ Initialized git repository
✓ Made initial commit
✓ Set up extension scaffolding

gh-new-command is ready for development!

Next Steps
- run 'cd gh-new-command; gh extension install .; gh new-command' to see your new extension in action
- run 'gh repo create' to share your extension with others

For more information on writing extensions:
https://docs.github.com/github-cli/github-cli/creating-github-cli-extensions
Hello gh-new-command!

Fixes #9699

pkg/cmd/extension/command_test.go

pkg/cmd/extension/command.go

pkg/cmd/extension/command_test.go

andyfeller

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [cli/cli](https://github.com/cli/cli) | minor | `v2.59.0` -> `v2.62.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>cli/cli (cli/cli)</summary> ### [`v2.62.0`](https://github.com/cli/cli/releases/tag/v2.62.0): GitHub CLI 2.62.0 [Compare Source](cli/cli@v2.61.0...v2.62.0) #### What's Changed - Update monotonic verification logic and testing by [@malancas](https://github.com/malancas) in cli/cli#9856 - Check extension for latest version when executed by [@andyfeller](https://github.com/andyfeller) in cli/cli#9866 - Shorten extension release checking from 3s to 1s by [@andyfeller](https://github.com/andyfeller) in cli/cli#9914 - Mention GitHub CLI team on discussion issues by [@andyfeller](https://github.com/andyfeller) in cli/cli#9920 **Full Changelog**: cli/cli@v2.61.0...v2.62.0 #### Security - A security vulnerability has been identified in GitHub CLI that could allow remote code execution (RCE) when users connect to a malicious Codespace SSH server and use the `gh codespace ssh` or `gh codespace logs` commands. For more information, see GHSA-p2h2-3vg9-4p87 #### GitHub CLI notifies users about latest extension upgrades Similar to the notification of latest `gh` releases, the `v2.62.0` version of GitHub CLI will notify users about latest extension upgrades when the extension is used: ```shell $ gh ado2gh ... A new release of ado2gh is available: 1.7.0 → 1.8.0 To upgrade, run: gh extension upgrade ado2gh --force https://github.com/github/gh-ado2gh ``` ##### Why does this matter? This removes a common pain point of extension authors as they have had to reverse engineer and implement a similar mechanism within their extensions directly. With this quality of life improvement, there are 2 big benefits: 1. Extension authors will hopefully see increased adoption of newer releases while having lower bar to maintaining their extensions. 2. GitHub CLI users will have greater awareness of new features, bug fixes, and security fixes to the extensions used. ##### What do you need to do? Extension authors should review their extensions and consider removing any custom logic previously implemented to notify users of new releases. ### [`v2.61.0`](https://github.com/cli/cli/releases/tag/v2.61.0): GitHub CLI 2.61.0 [Compare Source](cli/cli@v2.60.1...v2.61.0) #### Ensure users understand consequences before making repository visibility changes In `v2.61.0`, `gh repo edit` command has been enhanced to inform users about [consequences of changing visibility](https://gh.io/setting-repository-visibility) and ensure users are intentional before making irreversible changes: 1. Interactive `gh repo edit` visibility change requires confirmation when changing from `public`, `private`, or `internal` 2. Non-interactive `gh repo edit --visibility` change requires new `--accept-visibility-change-consequences` flag to confirm 3. New content to inform users of consequences - Incorporate [GitHub Docs content](https://gh.io/setting-repository-visibility) into help usage and interactive `gh repo edit` experience - Expanded help usage to call out most concerning consequences - Display repository star and watcher counts to understand impact before confirming #### What's Changed - Add acceptance test for `project` command by [@jtmcg](https://github.com/jtmcg) in cli/cli#9816 - Add comprehensive testscript for `gh ruleset` by [@andyfeller](https://github.com/andyfeller) in cli/cli#9815 - Add comprehensive testscript for gh ext commandset by [@andyfeller](https://github.com/andyfeller) in cli/cli#9810 - Require visibility confirmation in `gh repo edit` by [@andyfeller](https://github.com/andyfeller) in cli/cli#9845 - Clean up skipped online tests for `gh attestation verify` by [@malancas](https://github.com/malancas) in cli/cli#9838 - `gh attestation verify` should only verify provenance attestations by default by [@malancas](https://github.com/malancas) in cli/cli#9825 - Set `dnf5` commands as default by [@its-miroma](https://github.com/its-miroma) in cli/cli#9844 - Fix verbiage for deleting workflow runs by [@akx](https://github.com/akx) in cli/cli#9876 - Bump github.com/creack/pty from 1.1.23 to 1.1.24 by [@dependabot](https://github.com/dependabot) in cli/cli#9862 - `gh attestation verify` policy enforcement refactor by [@malancas](https://github.com/malancas) in cli/cli#9848 - Simplify Sigstore verification result handling in `gh attestation verify` by [@malancas](https://github.com/malancas) in cli/cli#9877 - Print empty array for `gh cache list` when `--json` is provided by [@williammartin](https://github.com/williammartin) in cli/cli#9883 - Bump actions/attest-build-provenance from 1.4.3 to 1.4.4 by [@dependabot](https://github.com/dependabot) in cli/cli#9884 - Create the automatic key when specified with -i by [@cmbrose](https://github.com/cmbrose) in cli/cli#9881 - fix: `gh pr create -w` ignore template flag by [@nilvng](https://github.com/nilvng) in cli/cli#9863 #### New Contributors - [@akx](https://github.com/akx) made their first contribution in cli/cli#9876 - [@nilvng](https://github.com/nilvng) made their first contribution in cli/cli#9863 **Full Changelog**: cli/cli@v2.60.1...v2.61.0 ### [`v2.60.1`](https://github.com/cli/cli/releases/tag/v2.60.1): GitHub CLI 2.60.1 [Compare Source](cli/cli@v2.60.0...v2.60.1) This is a small patch release to fix installing `gh` via `go install` which was broken with v2.60.0. #### What's Changed - Update testscript to use hard fork by [@williammartin](https://github.com/williammartin) in cli/cli#9821 **Full Changelog**: cli/cli@v2.60.0...v2.60.1 ### [`v2.60.0`](https://github.com/cli/cli/releases/tag/v2.60.0): GitHub CLI 2.60.0 [Compare Source](cli/cli@v2.59.0...v2.60.0) #### What's Changed - Add ArchivedAt field by [@tsukasaI](https://github.com/tsukasaI) in cli/cli#9790 - Include startedAt, completedAt in run steps data by [@andyfeller](https://github.com/andyfeller) in cli/cli#9774 - Adjust environment help for host and tokens by [@williammartin](https://github.com/williammartin) in cli/cli#9809 - Add handling of empty titles for Issues and MRs by [@jtmcg](https://github.com/jtmcg) in cli/cli#9701 - `LiveSigstoreVerifier.Verify` should error if no attestations are present by [@phillmv](https://github.com/phillmv) in cli/cli#9742 - `gh at verify` retries fetching attestations if it receives a 5xx by [@phillmv](https://github.com/phillmv) in cli/cli#9797 - Prevent local extension installations with invalid names and conflicts with core commands and other extensions by [@BagToad](https://github.com/BagToad) in cli/cli#9794 - Rewrite a sentence in CONTRIBUTING.md by [@muzimuzhi](https://github.com/muzimuzhi) in cli/cli#9772 - Use new GitHub preview terms in `working-with-us.md` by [@BagToad](https://github.com/BagToad) in cli/cli#9800 - Use new GitHub previews terminology in attestation commands' help docs by [@BagToad](https://github.com/BagToad) in cli/cli#9799 - Clarify in README that `gh` is supported on GitHub Enterprise Cloud by [@BagToad](https://github.com/BagToad) in cli/cli#9805 - build(deps): bump github.com/gabriel-vasile/mimetype from 1.4.5 to 1.4.6 by [@dependabot](https://github.com/dependabot) in cli/cli#9752 ##### Acceptance Test Changes - Add acceptance tests for `workflow`, `run`, and `cache` commands by [@BagToad](https://github.com/BagToad) in cli/cli#9766 - Add basic `api` acceptance tests by [@BagToad](https://github.com/BagToad) in cli/cli#9770 - Add acceptance tests for `release` commands by [@BagToad](https://github.com/BagToad) in cli/cli#9771 - Add acceptance tests for `org` and `ssh-key` commands by [@BagToad](https://github.com/BagToad) in cli/cli#9812 - Add acceptance tests for `gh auth` commands by [@jtmcg](https://github.com/jtmcg) in cli/cli#9787 - Add acceptance tests for `repo` commands by [@jtmcg](https://github.com/jtmcg) in cli/cli#9783 - Add acceptance tests for `search` command by [@BagToad](https://github.com/BagToad) in cli/cli#9786 - Add acceptance tests for `variable` commands by [@andyfeller](https://github.com/andyfeller) in cli/cli#978 - Add testscripts for gpg-key and label commands by [@williammartin](https://github.com/williammartin) in cli/cli#9811 - Use forked testscript for token redaction by [@williammartin](https://github.com/williammartin) in cli/cli#9804 - Add acceptance tests for `secret` commands by [@andyfeller](https://github.com/andyfeller) in cli/cli#9782 - Note token redaction in Acceptance test README by [@williammartin](https://github.com/williammartin) in cli/cli#9813 #### New Contributors - [@tsukasaI](https://github.com/tsukasaI) made their first contribution in cli/cli#9790 **Full Changelog**: cli/cli@v2.59.0...v2.60.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

add validation for local ext install

6923fb5

BagToad requested a review from a team as a code owner October 20, 2024 22:47

BagToad requested a review from andyfeller October 20, 2024 22:47

cliAutomation added the external pull request originating outside of the CLI core team label Oct 20, 2024

BagToad commented Oct 20, 2024

View reviewed changes

pkg/cmd/extension/command_test.go Show resolved Hide resolved

andyfeller reviewed Oct 21, 2024

View reviewed changes

pkg/cmd/extension/command.go Outdated Show resolved Hide resolved

Refactor to remove code duplication

cc32f33

BagToad commented Oct 21, 2024

View reviewed changes

pkg/cmd/extension/command_test.go Show resolved Hide resolved

Fix tests for invalid extension name

35aa852

andyfeller approved these changes Oct 21, 2024

View reviewed changes

Check extOwner for no value instead

daec7a0

BagToad enabled auto-merge October 21, 2024 19:32

BagToad merged commit 6dab689 into trunk Oct 21, 2024

BagToad deleted the kw/cli-9699-validate-local-extension-installs branch October 21, 2024 19:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Prevent local extension installations with invalid names and conflicts with core commands and other extensions #9794

Prevent local extension installations with invalid names and conflicts with core commands and other extensions #9794

Uh oh!

BagToad commented Oct 20, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

andyfeller left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Prevent local extension installations with invalid names and conflicts with core commands and other extensions #9794

Prevent local extension installations with invalid names and conflicts with core commands and other extensions #9794

Uh oh!

Conversation

BagToad commented Oct 20, 2024

Demo

Uh oh!

Uh oh!

Uh oh!

Uh oh!

andyfeller left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants