|
1 | 1 | # OpenRoot |
2 | 2 |
|
3 | | -<div align="center"> |
4 | | - <img src="docs/logo.png" alt="OpenRoot Logo" width="200"/> |
5 | | - <p><strong>A Cross-Unix Root Emulation Solution</strong></p> |
6 | | - <p> |
7 | | - <a href="LICENSE"><img src="https://img.shields.io/badge/license-GPL%20v3-blue.svg"/></a> |
8 | | - <a href="https://github.com/oakymacintosh/OpenRoot/releases"><img src="https://img.shields.io/github/v/release/oakymacintosh/OpenRoot"/></a> |
9 | | - <a href="https://github.com/oakymacintosh/OpenRoot/stargazers"><img src="https://img.shields.io/github/stars/oakymacintosh/OpenRoot"/></a> |
10 | | - </p> |
11 | | -</div> |
12 | | - |
13 | | -## Introduction |
14 | | - |
15 | 3 | OpenRoot is an innovative root emulation layer that provides root-like capabilities without requiring actual root access or bootloader unlocking. It works across Unix-like systems and Android devices, offering a safe way to execute privileged operations through a controlled emulation environment. |
16 | 4 |
|
17 | | -### Key Features |
18 | | - |
19 | | -- **No Unlocked Bootloader Required**: Works on locked bootloader devices |
20 | | -- **Cross-Platform Support**: Works on Android and other Unix-like systems |
21 | | -- **Safe Root Emulation**: Controlled environment for root-like operations |
22 | | -- **Easy-to-Use Interface**: Both GUI (Droid-Chan) and CLI options |
23 | | -- **Fine-Grained Permissions**: Control what apps and operations are allowed |
24 | | -- **Live Updates**: No reboots required for most operations |
25 | | - |
26 | | -## Installation |
27 | | - |
28 | | -### Android |
29 | | - |
30 | | -1. Download the latest APK from [Releases](https://github.com/oakymacintosh/OpenRoot/releases) |
31 | | -2. Install the APK: |
32 | | - ```bash |
33 | | - adb install OpenRoot.apk |
34 | | - ``` |
35 | | -3. Launch the Droid-Chan app and follow the setup wizard |
36 | | - |
37 | | -### Other Unix Systems |
38 | | - |
39 | | -1. Install dependencies: |
40 | | - ```bash |
41 | | - # Debian/Ubuntu |
42 | | - sudo apt install build-essential cmake nlohmann-json3-dev libspdlog-dev |
43 | | - |
44 | | - # Fedora |
45 | | - sudo dnf install gcc-c++ cmake nlohmann-json-devel spdlog-devel |
46 | | - |
47 | | - # Arch Linux |
48 | | - sudo pacman -S base-devel cmake nlohmann-json spdlog |
49 | | - ``` |
50 | | - |
51 | | -2. Build from source: |
52 | | - ```bash |
53 | | - git clone https://github.com/oakymacintosh/OpenRoot.git |
54 | | - cd OpenRoot |
55 | | - mkdir build && cd build |
56 | | - cmake .. |
57 | | - make |
58 | | - sudo make install |
59 | | - ``` |
60 | | - |
61 | | -## Usage |
62 | | - |
63 | | -### Android Interface (Droid-Chan) |
64 | | - |
65 | | -1. Launch the Droid-Chan app |
66 | | -2. Grant necessary permissions |
67 | | -3. Enable root emulation |
68 | | -4. Manage apps and permissions through the UI |
69 | | - |
70 | | -### Command Line Interface |
71 | | - |
72 | | -Basic operations: |
73 | | -```bash |
74 | | -# Check root emulation status |
75 | | -rootd status |
76 | | - |
77 | | -# Allow an app to use root emulation |
78 | | -rootd grant com.example.app |
79 | | - |
80 | | -# Revoke root emulation from an app |
81 | | -rootd revoke com.example.app |
82 | | - |
83 | | -# List allowed apps |
84 | | -rootd list |
85 | | - |
86 | | -# Configure permissions |
87 | | -rootd config set allow_mount true |
88 | | -``` |
89 | | - |
90 | | -### Web Interface |
91 | | - |
92 | | -1. Access the web interface at `http://localhost:8080` or through Droid-Chan |
93 | | -2. Log in with your credentials |
94 | | -3. Manage root operations through the web dashboard |
95 | | - |
96 | | -## How It Works |
97 | | - |
98 | | -OpenRoot creates a controlled environment that intercepts and emulates root operations: |
99 | | - |
100 | | -1. **Process Interception**: Captures privileged operation requests |
101 | | -2. **Permission Verification**: Checks against configured allowed operations |
102 | | -3. **Safe Execution**: Performs operations in a sandboxed environment |
103 | | -4. **Result Emulation**: Returns appropriate responses to the requesting app |
104 | | - |
105 | | -```mermaid |
106 | | -graph TD |
107 | | - A[App Request] --> B[OpenRoot Daemon] |
108 | | - B --> C{Permission Check} |
109 | | - C -->|Allowed| D[Emulated Execution] |
110 | | - C -->|Denied| E[Operation Rejected] |
111 | | - D --> F[Return Result] |
112 | | - E --> F |
113 | | -``` |
114 | | - |
115 | | -## Security Considerations |
116 | | - |
117 | | -- OpenRoot does NOT break system security |
118 | | -- All operations are emulated in a controlled environment |
119 | | -- Fine-grained permission system prevents abuse |
120 | | -- Regular security audits and updates |
121 | | - |
122 | | -## Contributing |
123 | | - |
124 | | -We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details. |
125 | | - |
126 | | -1. Fork the repository |
127 | | -2. Create your feature branch |
128 | | -3. Commit your changes |
129 | | -4. Push to the branch |
130 | | -5. Create a Pull Request |
131 | | - |
132 | 5 | ## Building from Source |
133 | 6 |
|
134 | 7 | ### Prerequisites |
@@ -159,31 +32,6 @@ OpenRoot is inspired by various root solutions and Unix system designs: |
159 | 32 | - [Wine](https://www.winehq.org/) |
160 | 33 | - [Darling](https://www.darlinghq.org/) |
161 | 34 |
|
162 | | -## License |
163 | | - |
164 | | -OpenRoot is licensed under the GNU General Public License v3.0. See [LICENSE](LICENSE) for details. |
165 | | - |
166 | | -## Support |
167 | | - |
168 | | -- [GitHub Issues](https://github.com/your-username/OpenRoot/issues) |
169 | | -- [Telegram Group](https://t.me/OpenRootOfficial) |
170 | | -- [XDA Thread](#) |
171 | | - |
172 | | -## FAQ |
173 | | - |
174 | | -### Q: Is this a "real" root solution? |
175 | | -A: No, OpenRoot is a root emulation layer. It provides root-like capabilities without actually requiring root access. |
176 | | - |
177 | | -### Q: Will this void my warranty? |
178 | | -A: No, OpenRoot doesn't modify system files or require bootloader unlocking. |
179 | | - |
180 | | -### Q: Is this safe to use? |
181 | | -A: Yes, OpenRoot runs in a controlled environment and can't perform actual system modifications without explicit permission. |
182 | | - |
183 | | -### Q: Does this work on all devices? |
184 | | -A: OpenRoot should work on most Android devices and Unix-like systems. Check our compatibility list for details. |
185 | | - |
186 | | -## Documentation |
187 | 35 |
|
188 | 36 | For detailed documentation, please visit our [Wiki](https://github.com/your-username/OpenRoot/wiki). |
189 | 37 |
|
|
0 commit comments