You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,8 @@ If you find a bug, please [open an issue](https://github.com/HelloPrincePal/Droi
8
8
* Your Android device model and OS version.
9
9
* Relevant logs from `/var/log/droidtether.log`.
10
10
11
+
**⚠️ Important**: For security vulnerabilities, please do **NOT** open a public issue. See our [Security Policy](.github/SECURITY.md) for private reporting instructions.
12
+
11
13
### 2. Suggest a Feature ✨
12
14
Have an idea for v1.0? Please open a feature request issue! We're particularly interested in testing with more Android device manufacturers.
Copy file name to clipboardExpand all lines: PRIVACY.md
+5Lines changed: 5 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,5 +18,10 @@ DroidTether has **no telemetry, no analytics, and no "call-home" features**. It
18
18
19
19
---
20
20
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
+
21
26
### Questions?
22
27
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).
Copy file name to clipboardExpand all lines: README.md
+24-1Lines changed: 24 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,17 @@ DroidTether is a lightweight userspace daemon that brings high-performance USB t
19
19
20
20
---
21
21
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
+
22
33
## 🛠️ Verified Test Environment
23
34
24
35
| Phone Name | Android Version | Host Name | OS Version | Results |
@@ -70,6 +81,16 @@ sudo ./build/droidtether
70
81
71
82
---
72
83
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
+
73
94
## 📖 How to Use
74
95
75
96
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! 🚀
Copy file name to clipboardExpand all lines: VERSIONS.md
+5Lines changed: 5 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,11 @@ v1.0.0 = MVP complete and working on M1/M2/M3.
10
10
11
11
---
12
12
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.
- 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