Skip to content

Commit 02a70e4

Browse files
docs: add security policy, transparency notes, and audit documentation
1 parent 924f701 commit 02a70e4

5 files changed

Lines changed: 82 additions & 1 deletion

File tree

.github/SECURITY.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# 🛡️ Security Policy
2+
3+
## Supported Versions
4+
5+
DroidTether currently supports the following versions for security updates. We recommend always running the latest version available.
6+
7+
| Version | Supported |
8+
| ------- | ------------------ |
9+
| [Latest Release](https://github.com/HelloPrincePal/DroidTether/releases/latest) | :white_check_mark: |
10+
| v0.8.x | :white_check_mark: |
11+
| < v0.8.0| :x: |
12+
13+
## Reporting a Vulnerability
14+
15+
**Please do not report security vulnerabilities through public GitHub issues.**
16+
17+
If you discover a potential security vulnerability in DroidTether, please report it through one of the following channels:
18+
19+
### 1. GitHub Private Vulnerability Reporting (Preferred)
20+
You can report vulnerabilities privately directly through the GitHub repository:
21+
1. Go to the [Security tab](https://github.com/HelloPrincePal/DroidTether/security/advisories) of the repository.
22+
2. Click on **Report a vulnerability**.
23+
3. Provide a detailed summary of the vulnerability, including steps to reproduce.
24+
25+
### 2. Direct Contact
26+
If you prefer, you can reach out to the author privately via:
27+
- 🔗 **LinkedIn**: [Prince Pal](https://www.linkedin.com/in/theprincepal/)
28+
- 🤖 **Reddit**: [u/PrincePal_](https://www.reddit.com/user/PrincePal_/)
29+
30+
---
31+
32+
### What to Include in Your Report
33+
To help us triage and respond to your report as quickly as possible, please include:
34+
- A description of the vulnerability and its potential impact.
35+
- Step-by-step instructions to reproduce the issue (including proof-of-concept code, if possible).
36+
- The version of DroidTether, macOS, and Android being used.
37+
- Any relevant logs (e.g., `/var/log/droidtether.log`).
38+
39+
### Our Commitment
40+
- We will acknowledge receipt of your report within **48 hours**.
41+
- We will keep you informed of our progress as we investigate and work on a fix.
42+
- We will provide public credit for your discovery (if you wish) once the vulnerability has been resolved.
43+
44+
---
45+
46+
Thank you for helping keep DroidTether and its users safe! 🚀

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ If you find a bug, please [open an issue](https://github.com/HelloPrincePal/Droi
88
* Your Android device model and OS version.
99
* Relevant logs from `/var/log/droidtether.log`.
1010

11+
**⚠️ Important**: For security vulnerabilities, please do **NOT** open a public issue. See our [Security Policy](.github/SECURITY.md) for private reporting instructions.
12+
1113
### 2. Suggest a Feature ✨
1214
Have an idea for v1.0? Please open a feature request issue! We're particularly interested in testing with more Android device manufacturers.
1315

PRIVACY.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,10 @@ DroidTether has **no telemetry, no analytics, and no "call-home" features**. It
1818

1919
---
2020

21+
### 📝 Audit & Transparency
22+
To ensure full trust, the entire core logic is implemented in less than **2,000 lines of Go code**. This makes it easy for any security researcher or user to audit the source code in a single afternoon. We believe transparency is the foundation of security.
23+
24+
---
25+
2126
### Questions?
2227
If you have any questions about this Privacy Policy or how DroidTether handles your data, please open an issue in the [GitHub repository](https://github.com/HelloPrincePal/DroidTether).

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,17 @@ DroidTether is a lightweight userspace daemon that brings high-performance USB t
1919

2020
---
2121

22+
## 🛡️ Transparency & Privacy
23+
DroidTether is built on a "local-only" model.
24+
- 📂 **100% Open Source**: Every line of code is available for audit in this repository.
25+
- 🚫 **No Telemetry**: No tracking, no analytics, and no "call-home" features.
26+
- 🔒 **Local Connectivity**: All networking happens strictly between your Mac and your Android device. No external servers are involved in the packet relay process.
27+
- 🕵️ **Log Privacy**: Logs reside only on your local machine at `/var/log/droidtether.log` for debugging purposes.
28+
29+
> 📝 **Audit Note**: The entire core logic of DroidTether is contained in less than **2,000 lines of Go code**, making it exceptionally easy to audit for security and transparency. We believe in simplicity and clear source code as the ultimate form of trust.
30+
31+
---
32+
2233
## 🛠️ Verified Test Environment
2334

2435
| Phone Name | Android Version | Host Name | OS Version | Results |
@@ -70,6 +81,16 @@ sudo ./build/droidtether
7081

7182
---
7283

84+
## 🔑 Why `sudo` is Required?
85+
Because DroidTether operates at the system network level, it requires elevated privileges for specific operations:
86+
1. **Network Interface Management**: Creating and configuring the virtual `utun` interface on macOS is a kernel-restricted task.
87+
2. **Routing Table Injection**: Updating your Mac's routing table to prioritize the phone's internet connection requires superuser permissions.
88+
3. **Log Management**: Writing operational logs to `/var/log/droidtether.log` for system-wide transparency.
89+
90+
*DroidTether performs these tasks purely in userspace—no persistent kernel extensions are installed.*
91+
92+
---
93+
7394
## 📖 How to Use
7495

7596
1. **Connect** your Android phone to your Mac via a USB-C cable.
@@ -154,4 +175,6 @@ Feel free to reach out or follow the project’s journey! 🚀
154175
MIT — © PrincePal
155176

156177
## 🤝 Contributing
157-
Found a bug? Have a feature request for v1.0? Please open an issue or submit a PR!
178+
Found a bug? Have a feature request for v1.0? Please open an issue or submit a PR!
179+
180+
**⚠️ Security**: For security vulnerabilities, please refer to our [Security Policy](.github/SECURITY.md) for private reporting instructions.

VERSIONS.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ v1.0.0 = MVP complete and working on M1/M2/M3.
1010

1111
---
1212

13+
## v0.8.3 — 2026-03-29
14+
- Milestone: Transparency & Verification (The "Trust" Release)
15+
- What works: Added `.github/SECURITY.md` for private vulnerability reports. Enhanced `README.md` and `PRIVACY.md` with sections on **Why sudo is required**, **Audit Notes** (~2k lines of Go), and **Local-only connectivity**. Verified commit signing via SSH is now active.
16+
- Next: Finalize Homebrew Formula logic for `brew install` support.
17+
1318
## v0.8.2 — 2026-03-28
1419
- Milestone: One-Line Installer Stability (Production Ready)
1520
- What works: `install.sh` now correctly handles macOS "Error 5" launchctl bootstrap failures, initializes log files with correct permissions, and ensures `root:wheel` binary ownership. Fixed `ethType` dispatch logic in `relay.go` using an idiomatic tagged switch.

0 commit comments

Comments
 (0)