Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 72 additions & 0 deletions SECURITY.md
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 |
Comment on lines +7 to +14

Copilot AI Apr 14, 2026

Copy link

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 “main branch” (releases are typically tags), and the table row label “Latest main” can be read ambiguously. Consider rephrasing to consistently describe the supported artifact (e.g., “latest commit on main” or “latest GitHub Release/tag only”) and align the table row to match.

Suggested change
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 |
This project tracks a single active line. Only the latest commit on the
`main` branch receives fixes. If you are running an older commit or tag,
please upgrade before reporting an issue.
| Version | Supported |
|--------------------------|-----------|
| Latest commit on `main` | Yes |
| Older commits/tags | No |

Copilot uses AI. Check for mistakes.

## 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
Loading