[PSC-711] feat: add install copilot command for MCP server#146
Open
[PSC-711] feat: add install copilot command for MCP server#146
Conversation
Extract shared plugin download/setup logic into PluginInstaller and add a new `install copilot` subcommand that registers the Armis AppSec MCP server in VS Code's user-level mcp.json for GitHub Copilot. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
|
| Severity | Count |
|---|---|
| 🟠 HIGH | 3 |
| 🟡 MEDIUM | 2 |
Total: 5
View all 5 findings
🟠 HIGH (3)
CWE-522_armis-cli_38295677_internal/install/plugin.go_347_2_347_150 - Insecure Design (CWE-522
Location: internal/install/plugin.go:347
Insufficiently Protected Credentials): The function writeEnvFromEnvironment reads two environment variables, ARMIS_CLIENT_ID and ARMIS_CLIENT_SECRET. If both are set, it builds a text string that contains the secret value and writes that string to a file (the ".env" file) on disk. The file is created with permissions that allow only the file owner to read or write it (mode 0600). Even though the permissions are restrictive, the secret is now stored on the filesystem. Any other program or user that can run as the same system user, or that can gain access to the file (for example, through a backup, a mis‑configured backup script, or a compromised account), could read the secret. This means the credential is no longer kept only in memory or in the environment where it was originally set, increasing the risk of it being leaked. An attacker who can access the file could obtain the ARMIS_CLIENT_SECRET and use it to impersonate the application or access protected resources. The code does not perform any additional checks or encryption before writing the secret, so the risk is real. To reduce this risk, avoid writing the secret to a file altogether, or encrypt it before storing it. If a file must be used, consider stronger protection mechanisms (such as using a dedicated secret manager) and ensure the file is stored in a location that only trusted processes can reach.
Code snippet is redacted as it contains secrets.
CWEs: CWE-522: Insufficiently Protected Credentials
CWE-22_armis-cli_38295677_internal/install/editors.go_215_3_215_29 - Broken Access Control (CWE-22
Location: internal/install/editors.go:215
Improper Limitation of a Pathname to a Restricted Directory ('Path Traversal')): The program builds a file path by reading the APPDATA environment variable and then appending sub‑folders such as "Code/User/mcp.json". An attacker who can set the APPDATA variable before the program runs can change the base of that path. Because the code does not check or clean the value, the final path may point to any location on the file system. Later, the program writes configuration data to that path (through functions like writeJSON). This means a malicious user could cause the program to write files outside the intended application‑support directory, potentially overwriting important files or placing malicious files where they will be read later. No validation is performed on the environment variable, so the risky operation is reachable from attacker‑controlled input. To fix the issue, the code should verify that the APPDATA value points to a trusted directory or use a safe, fixed location instead of trusting the environment variable directly.
CWEs: CWE-22: Improper Limitation of a Pathname to a Restricted Directory ('Path Traversal')
CWE-22_armis-cli_38295677_internal/install/editors.go_206_3_206_37 - Broken Access Control (CWE-22
Location: internal/install/editors.go:206
Improper Limitation of a Pathname to a Restricted Directory ('Path Traversal')): The code builds a file path by reading the XDG_CONFIG_HOME environment variable and then joining it with other directory names. Because the environment variable can be set by anyone who runs the program, an attacker could change its value to point to a location they control. The resulting path is later used to read or write configuration files. Since there is no check that the path stays inside the intended configuration directory, an attacker could cause the program to read from or write to files outside the safe area, potentially exposing or overwriting sensitive data. No validation or restriction is applied to the environment‑provided value, so the risky operation is reachable from user‑controlled input.
CWEs: CWE-22: Improper Limitation of a Pathname to a Restricted Directory ('Path Traversal')
🟡 MEDIUM (2)
CWE-253_armis-cli_38295677_internal/install/claude.go_24_2_24_28 - The code calls `os.UserHomeDir()` to find the user's home directory, but it completely ignores the error value that the function returns
Location: internal/install/claude.go:24
The code calls os.UserHomeDir() to find the user's home directory, but it completely ignores the error value that the function returns. If the call fails (for example, if the operating system cannot determine the home directory), the variable home will be an empty string. The next line builds a file path with filepath.Join(home, ".claude"). When home is empty, the path becomes just ".claude", which points to a location relative to the current working directory instead of the intended user’s home folder. Because the error is not checked, the program may unintentionally read from or write to the wrong place on the file system. This could cause the installer to create or modify files in an unexpected directory, potentially overwriting other data or leaving configuration files where they don’t belong. No external user input reaches this part of the code, so an attacker cannot directly control the path. However, the bug is still a problem because the program makes an unsafe assumption about a system call’s success. Adding a proper error check after os.UserHomeDir() and handling the failure case (e.g., returning an error) would fix the issue.
CWEs: CWE-253: Incorrect Check of Function Return Value
CWE-22_armis-cli_38295677_internal/install/editors.go_302_2_302_61 - Broken Access Control (CWE-22
Location: internal/install/editors.go:302
Improper Limitation of a Pathname to a Restricted Directory ('Path Traversal')): The function readJSONFileAsMap opens a file whose name is passed in as the path argument. It does not check whether the supplied path stays inside a safe directory, so if someone could control that argument they could cause the program to read any file on the system. In the surrounding code, the only places that call this function build the file name from known configuration locations, not from user input. Because the path is not influenced by external data, an attacker cannot currently reach the risky operation, which keeps the actual danger low. However, the lack of validation means that if the function were ever called with a value that came from outside the program, it could be exploited to read arbitrary files.
CWEs: CWE-22: Improper Limitation of a Pathname to a Restricted Directory ('Path Traversal')
Test Coverage Reporttotal: (statements) 77.6% Coverage by function |
Replace separate install claude/copilot commands with a unified `armis-cli install [editor...]` that downloads the plugin once and registers it across all detected editors. Supported editors: VS Code, Cursor, Windsurf, Zed, Cline, Amazon Q, Continue, Claude Code. JetBrains requires per-project .jb-mcp.json. Also auto-configures credentials from ARMIS_CLIENT_ID/ARMIS_CLIENT_SECRET environment variables into the shared .env file (0600 permissions). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…nfig paths Add Antigravity editor (~/.gemini/antigravity/mcp_config.json) with standard mcpServers format. Update Amazon Q path from Application Support to ~/.aws/amazonq/mcp.json to match current CLI. Migrate Continue from deprecated config.json to ~/.continue/mcpServers/ directory-based discovery, which works with both config.yaml and legacy config.json. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Run gofmt to fix const block alignment. Skip Unix file permission assertion on Windows where 0600 is not enforced. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Use 0750 directory permissions in test to satisfy gosec G301. Add nosec directive for G703 false positive on envPath which is internally constructed from pluginDir + ".env". Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
| } | ||
| base = filepath.Join(home, "Library", "Application Support") | ||
| case "linux": | ||
| base = os.Getenv("XDG_CONFIG_HOME") |
| base = filepath.Join(home, ".config") | ||
| } | ||
| case osWindows: | ||
| base = os.Getenv("APPDATA") |
|
|
||
| func readJSONFileAsMap(path string) map[string]interface{} { | ||
| data := make(map[string]interface{}) | ||
| if b, err := os.ReadFile(filepath.Clean(path)); err == nil { |
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
2 participants
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
ClaudeInstallerinto a reusablePluginInstallerininternal/install/plugin.goarmis-cli install copilotsubcommand that installs the Armis AppSec MCP server for GitHub Copilot in VS Codemcp.jsonwith stdio transport, pointing to the plugin's venv Python andserver.pyTest plan
internal/installtests pass (23 tests)CopilotInstaller: constructor, env detection, version tracking, MCP server registration, preserving existing MCP configPluginInstaller: release fetch, download/extract, version tracking, GitHub URL validationfindPythonPATH lookup) — mitigated by symlink resolution, absolute path check, and hardcoded name allowlist; same pattern shipped in [PPSC-648] feat: add install feature #143armis-cli install copilotcreates~/.armis/plugins/armis-appsec-mcp/and registers in VS Codemcp.jsonarmis-cli install copilot --versionreports installed versionarmis-cli install claudestill works after refactor🤖 Generated with Claude Code