-
Notifications
You must be signed in to change notification settings - Fork 0
docs: add security policy #7
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
Changes from all commits
Commits
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,72 @@ | ||
| # Security Policy | ||
|
|
||
| Thank you for helping keep YT6801 Auto Installer and its users safe. | ||
|
|
||
| ## Supported versions | ||
|
|
||
| This project tracks a single active line. Only the latest release on the | ||
| `main` branch receives fixes. If you are running an older version, please | ||
| upgrade before reporting an issue. | ||
|
|
||
| | Version | Supported | | ||
| |---------|-----------| | ||
| | Latest `main` | Yes | | ||
| | Older tags | No | | ||
|
|
||
| ## Reporting a vulnerability | ||
|
|
||
| **Please do not open a public GitHub issue for security problems.** | ||
|
|
||
| Instead, report the issue privately using GitHub's | ||
| [private vulnerability reporting][advisory] feature on this repository: | ||
|
|
||
| 1. Go to the [Security tab][security-tab] of this repository. | ||
| 2. Click **Report a vulnerability**. | ||
| 3. Fill out the form with a clear description, reproduction steps, and the | ||
| impact you observed. | ||
|
|
||
| If you are unable to use private vulnerability reporting, you may contact | ||
| the maintainer [@finallyjay](https://github.com/finallyjay) directly on | ||
| GitHub and request a private channel. | ||
|
|
||
| ## What to include | ||
|
|
||
| A good report contains: | ||
|
|
||
| - The affected file, script, or systemd unit | ||
| - The distribution and kernel version you reproduced on | ||
| - Exact steps to reproduce | ||
| - The observed impact (e.g., privilege escalation, persistence, data | ||
| exposure) | ||
| - Any logs from `/opt/yt6801-auto-installer/install_yt6801.log` or | ||
| `journalctl -u yt6801-reinstall.service` that help confirm the issue | ||
|
|
||
| ## What to expect | ||
|
|
||
| - **Acknowledgement:** within 7 days of receiving your report. | ||
| - **Triage:** the maintainer will investigate, confirm the impact, and | ||
| agree on a fix timeline with you. | ||
| - **Fix and disclosure:** once a fix is available, a release will be | ||
| published and the advisory will be made public, crediting the reporter | ||
| unless they prefer to remain anonymous. | ||
|
|
||
| ## Scope | ||
|
|
||
| In scope: | ||
|
|
||
| - The shell scripts in this repository (`setup.sh`, `uninstall.sh`, | ||
| `install_yt6801_if_needed.sh`, `check_yt6801_and_reboot.sh`) | ||
| - The systemd unit (`yt6801-reinstall.service`) | ||
| - The packaging of the `.deb` driver file shipped under `deb/` | ||
|
|
||
| Out of scope: | ||
|
|
||
| - Vulnerabilities in the upstream Motorcomm/Tuxedo YT6801 driver itself — | ||
| please report those to the driver vendor. | ||
| - Issues that require an attacker to already have root on the target | ||
| machine. | ||
|
|
||
| Thank you for practicing responsible disclosure. | ||
|
|
||
| [advisory]: https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability | ||
| [security-tab]: https://github.com/finallyjay/yt6801-auto-installer/security | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The wording here mixes “latest release” with “
mainbranch” (releases are typically tags), and the table row label “Latestmain” can be read ambiguously. Consider rephrasing to consistently describe the supported artifact (e.g., “latest commit onmain” or “latest GitHub Release/tag only”) and align the table row to match.