-
Notifications
You must be signed in to change notification settings - Fork 0
feat: update Makefile and README for linting support; add SECURITY.md for vulnerability reporting #2
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
Merged
Merged
feat: update Makefile and README for linting support; add SECURITY.md for vulnerability reporting #2
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
f9777e8
feat: add EditorConfig, Dependabot configuration, CI workflow, and ch…
trevorphillipscoding 73e183d
feat: update Makefile and README for linting support; add SECURITY.md…
trevorphillipscoding 130a8f8
chore: update Go setup action to version 6 in CI workflow
trevorphillipscoding 53c8ad1
chore: update checkout action to version 6 in CI workflow
trevorphillipscoding ae4c989
Refactor fetch and version handling
trevorphillipscoding b6e51d2
Refactor version resolution to use semantic versioning
trevorphillipscoding File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # https://editorconfig.org | ||
| root = true | ||
|
|
||
| [*] | ||
| charset = utf-8 | ||
| end_of_line = lf | ||
| insert_final_newline = true | ||
| trim_trailing_whitespace = true | ||
|
|
||
| [*.go] | ||
| indent_style = tab | ||
| indent_size = 4 | ||
|
|
||
| [*.{yml,yaml}] | ||
| indent_style = space | ||
| indent_size = 2 | ||
|
|
||
| [*.md] | ||
| indent_style = space | ||
| indent_size = 2 | ||
| trim_trailing_whitespace = false | ||
|
|
||
| [Makefile] | ||
| indent_style = tab | ||
| indent_size = 4 |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| version: 2 | ||
| updates: | ||
| - package-ecosystem: gomod | ||
| directory: / | ||
| schedule: | ||
| interval: weekly | ||
| commit-message: | ||
| prefix: "deps" | ||
| labels: | ||
| - dependencies | ||
| open-pull-requests-limit: 5 | ||
|
|
||
| - package-ecosystem: github-actions | ||
| directory: / | ||
| schedule: | ||
| interval: weekly | ||
| commit-message: | ||
| prefix: "ci" | ||
| labels: | ||
| - ci | ||
| open-pull-requests-limit: 5 |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| version: "2" | ||
|
|
||
| formatters: | ||
| enable: | ||
| - gofmt |
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| # Security Policy | ||
|
|
||
| ## Reporting a Vulnerability | ||
|
|
||
| If you discover a security vulnerability in nvy, please report it responsibly. | ||
|
|
||
| **Do not open a public issue.** Instead, email security concerns to the maintainer or use [GitHub's private vulnerability reporting](https://github.com/trevorphillipscoding/nvy/security/advisories/new). | ||
|
|
||
| Please include: | ||
|
|
||
| - A description of the vulnerability | ||
| - Steps to reproduce the issue | ||
| - The potential impact | ||
| - Any suggested fixes (if applicable) | ||
|
|
||
| You should receive a response within 48 hours. We will work with you to understand the issue and coordinate a fix before any public disclosure. | ||
|
|
||
| ## Security Model | ||
|
|
||
| nvy is designed with security as a priority: | ||
|
|
||
| - **HTTPS only** — all downloads are performed over HTTPS. Plain HTTP URLs are rejected, and redirects to HTTP are blocked. | ||
| - **TLS 1.2+** — the HTTP client enforces a minimum TLS version of 1.2. | ||
| - **SHA-256 verification** — every downloaded archive is verified against its published SHA-256 checksum before extraction. Mismatches abort the install. | ||
| - **Zip Slip protection** — archive extraction validates that no entry escapes the destination directory, preventing path-traversal attacks. | ||
| - **Decompression bomb protection** — individual extracted files are capped at 2 GB to prevent disk exhaustion. | ||
| - **Atomic installs** — installations use a temp directory + rename strategy, ensuring the runtime directory is never in a partial state. | ||
| - **Symlink validation** — absolute symlinks and symlinks that escape the destination are rejected during extraction. | ||
| - **No shell evaluation** — version files are read as plain text; their contents are never executed. | ||
|
|
||
| ## Supported Versions | ||
|
|
||
| Security fixes are applied to the latest release only. We recommend always running the most recent version of nvy. | ||
|
|
||
| | Version | Supported | | ||
| | ------- | --------- | | ||
| | latest | Yes | | ||
| | older | No | | ||
|
|
||
| ## Dependencies | ||
|
|
||
| nvy has a single external dependency ([cobra](https://github.com/spf13/cobra)) and relies heavily on the Go standard library. We monitor dependencies for known vulnerabilities using `govulncheck` and Dependabot. | ||
trevorphillipscoding marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.