|
| 1 | +# Integrity Helper Magisk/APatch/KernelSU Module |
| 2 | + |
| 3 | +<div align="center"> |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | + |
| 8 | + |
| 9 | +**Universal web-based UI to manage and install integrity-related Magisk modules** |
| 10 | + |
| 11 | +[📥 Download Latest Release](https://github.com/himanshujjp/IntegrityHelper/releases) • [📖 Documentation](#usage) • [🐛 Report Issues](https://github.com/himanshujjp/IntegrityHelper/issues) |
| 12 | + |
| 13 | +</div> |
| 14 | + |
| 15 | +--- |
| 16 | + |
| 17 | +## ✨ Features |
| 18 | + |
| 19 | +- 🌐 **Web UI**: Lightweight web interface running on `localhost:8585` |
| 20 | +- 📦 **Module Management**: Download, install, and track status of required modules |
| 21 | +- 🔄 **Auto-Updates**: Always fetches latest releases from official GitHub repositories |
| 22 | +- ⚡ **Batch Install**: "Install All" button for convenient setup |
| 23 | +- 📊 **Status Tracking**: Persistent state of installed module versions |
| 24 | +- 🔒 **Safety First**: Only downloads from official repos with clear disclaimer |
| 25 | +- 🔧 **Universal Support**: Works with Magisk, APatch, and KernelSU automatically |
| 26 | + |
| 27 | +## 🛠️ Compatibility |
| 28 | + |
| 29 | +| Root Solution | Status | Support Level | |
| 30 | +|---------------|--------|---------------| |
| 31 | +| **Magisk** | ✅ Full | Complete support | |
| 32 | +| **APatch** | ✅ Full | Complete support | |
| 33 | +| **KernelSU** | ✅ Full | Complete support | |
| 34 | + |
| 35 | +*The module automatically detects your root solution and configures itself accordingly.* |
| 36 | + |
| 37 | +## 📦 Required Modules |
| 38 | + |
| 39 | +This module manages the following integrity-related Magisk modules: |
| 40 | + |
| 41 | +| Module | Description | Repository | |
| 42 | +|--------|-------------|------------| |
| 43 | +| [**PlayIntegrityFork**](https://github.com/osm0sis/PlayIntegrityFork) | Play Integrity API bypass | `osm0sis/PlayIntegrityFork` | |
| 44 | +| [**TrickyStore**](https://github.com/5ec1cff/TrickyStore) | Advanced store restrictions bypass | `5ec1cff/TrickyStore` | |
| 45 | +| [**PlayStoreSelfUpdateBlocker**](https://github.com/himanshujjp/PlayStoreSelfUpdateBlocker) | Blocks Play Store auto-updates | `himanshujjp/PlayStoreSelfUpdateBlocker` | |
| 46 | +| [**yurikey**](https://github.com/YurikeyDev/yurikey) | Yuri Key integrity module | `YurikeyDev/yurikey` | |
| 47 | +| [**ZygiskNext**](https://github.com/Dr-TSNG/ZygiskNext) | Next-generation Zygisk implementation | `Dr-TSNG/ZygiskNext` | |
| 48 | + |
| 49 | +## 🚀 Installation |
| 50 | + |
| 51 | +### Step 1: Download |
| 52 | +Download `IntegrityHelper.zip` from the [latest release](https://github.com/himanshujjp/IntegrityHelper/releases) |
| 53 | + |
| 54 | +### Step 2: Flash |
| 55 | +Flash the ZIP via your root manager: |
| 56 | +- **Magisk Manager** → Modules → Install from storage |
| 57 | +- **APatch** → Install → Select ZIP |
| 58 | +- **KernelSU** → Install → Select ZIP |
| 59 | + |
| 60 | +### Step 3: Reboot |
| 61 | +Reboot your device to activate the module |
| 62 | + |
| 63 | +### Step 4: Access UI |
| 64 | +The web UI will automatically start on boot. Access it at: `http://127.0.0.1:8585` |
| 65 | + |
| 66 | +## 🎯 Quick Access |
| 67 | + |
| 68 | +After installation, use these commands to open the UI: |
| 69 | + |
| 70 | +**For Magisk/APatch:** |
| 71 | +```bash |
| 72 | +sh /data/adb/modules/IntegrityHelper/open_ui.sh |
| 73 | +``` |
| 74 | + |
| 75 | +**For KernelSU:** |
| 76 | +```bash |
| 77 | +sh /data/adb/ksu/modules/IntegrityHelper/open_ui.sh |
| 78 | +``` |
| 79 | + |
| 80 | +## 📖 Usage |
| 81 | + |
| 82 | +1. **Access the Web UI** at `http://127.0.0.1:8585` |
| 83 | +2. **View Module Status**: See all required modules with their current installation status |
| 84 | +3. **Download Modules**: Click "Download" to fetch the latest release for a specific module |
| 85 | +4. **Install Modules**: Click "Install" to install the downloaded module |
| 86 | +5. **Batch Install**: Use "Install All" to download and install all modules at once |
| 87 | +6. **View Repositories**: Click "Open Repo" to view the module's GitHub page |
| 88 | + |
| 89 | +### UI Features |
| 90 | + |
| 91 | +- 🔄 **Real-time Status**: Shows installed versions vs latest available |
| 92 | +- 📥 **One-click Download**: Downloads latest releases automatically |
| 93 | +- ⚙️ **Smart Installation**: Handles permissions and dependencies |
| 94 | +- 📊 **Progress Tracking**: Visual feedback during operations |
| 95 | +- 🔍 **Repository Links**: Direct access to source code |
| 96 | + |
| 97 | +## 🔧 Technical Details |
| 98 | + |
| 99 | +| Component | Technology | Details | |
| 100 | +|-----------|------------|---------| |
| 101 | +| **Backend** | Shell Scripts | Busybox utilities with CGI support | |
| 102 | +| **Web Server** | Busybox httpd | Lightweight CGI-capable server | |
| 103 | +| **Frontend** | HTML/JS | Bootstrap-styled responsive interface | |
| 104 | +| **Communication** | AJAX | RESTful API calls to CGI endpoints | |
| 105 | +| **Storage** | JSON | State saved in `/data/adb/IntegrityHelper/state.json` | |
| 106 | +| **Downloads** | Temporary | Files stored in `/data/local/tmp/modules/` | |
| 107 | + |
| 108 | +## ⚠️ Safety & Disclaimer |
| 109 | + |
| 110 | +> **⚠️ Use at your own risk! This tool downloads and installs third-party modules.** |
| 111 | +
|
| 112 | +### Important Notes: |
| 113 | +- Always backup your data before installing modules |
| 114 | +- Review module descriptions and source code before use |
| 115 | +- Only install modules you understand and trust |
| 116 | +- Installing third-party modules can potentially harm your device |
| 117 | +- May violate terms of service for certain apps/services |
| 118 | + |
| 119 | +### What this tool does: |
| 120 | +- ✅ Downloads from official GitHub repositories only |
| 121 | +- ✅ Verifies module integrity during installation |
| 122 | +- ✅ Provides clear version tracking |
| 123 | +- ✅ Offers easy uninstallation options |
| 124 | + |
| 125 | +## 🐛 Troubleshooting |
| 126 | + |
| 127 | +### Common Issues |
| 128 | + |
| 129 | +| Issue | Solution | |
| 130 | +|-------|----------| |
| 131 | +| **UI not loading** | Check if module is enabled in your root manager | |
| 132 | +| **Download fails** | Ensure internet connection and GitHub access | |
| 133 | +| **Install fails** | Check root manager logs and module compatibility | |
| 134 | +| **Permission issues** | Ensure proper root access and SELinux status | |
| 135 | +| **Port conflicts** | Verify no other service uses port 8585 | |
| 136 | + |
| 137 | +### Debug Commands |
| 138 | + |
| 139 | +```bash |
| 140 | +# Check if service is running |
| 141 | +ps | grep httpd |
| 142 | + |
| 143 | +# View service logs |
| 144 | +cat /data/adb/IntegrityHelper/service.log |
| 145 | + |
| 146 | +# Test API endpoints |
| 147 | +curl http://127.0.0.1:8585/api_test.sh |
| 148 | + |
| 149 | +# Check module status |
| 150 | +ls -la /data/adb/modules/IntegrityHelper/ |
| 151 | +``` |
| 152 | + |
| 153 | +## 📁 Module Structure |
| 154 | + |
| 155 | +``` |
| 156 | +IntegrityHelper/ |
| 157 | +├── META-INF/com/google/android/update-binary # Installer |
| 158 | +├── module.prop # Module properties |
| 159 | +├── service.sh # Boot service |
| 160 | +├── open_ui.sh # UI launcher script |
| 161 | +├── webroot/ # Web interface |
| 162 | +│ ├── index.html # Main UI |
| 163 | +│ ├── script.js # Frontend logic |
| 164 | +│ ├── manifest.json # Module list |
| 165 | +│ ├── httpd.conf # Server config |
| 166 | +│ └── api_*.sh # CGI endpoints |
| 167 | +└── scripts/ # Backend scripts |
| 168 | + ├── api_server.sh |
| 169 | + ├── download.sh |
| 170 | + ├── get_state.sh |
| 171 | + └── handle_request.sh |
| 172 | +``` |
| 173 | + |
| 174 | +## 📋 Changelog |
| 175 | + |
| 176 | +### v1.0 (Current) |
| 177 | +- ✨ Initial release with full functionality |
| 178 | +- 🌐 Web-based UI for module management |
| 179 | +- 📦 Support for 5 essential integrity modules |
| 180 | +- 🔄 Automatic latest version detection |
| 181 | +- ⚡ Batch install functionality |
| 182 | +- 🔒 CORS-enabled API endpoints |
| 183 | +- 📊 Persistent state tracking |
| 184 | +- 🔧 Universal root solution support (Magisk/APatch/KernelSU) |
| 185 | + |
| 186 | +## 🤝 Contributing |
| 187 | + |
| 188 | +Contributions are welcome! Please: |
| 189 | + |
| 190 | +1. Fork the repository |
| 191 | +2. Create a feature branch |
| 192 | +3. Make your changes |
| 193 | +4. Test thoroughly on your device |
| 194 | +5. Submit a pull request |
| 195 | + |
| 196 | +### Development Setup |
| 197 | + |
| 198 | +```bash |
| 199 | +# Clone the repository |
| 200 | +git clone https://github.com/himanshujjp/IntegrityHelper.git |
| 201 | +cd IntegrityHelper |
| 202 | + |
| 203 | +# Make your changes |
| 204 | +# Test on device |
| 205 | +# Submit PR |
| 206 | +``` |
| 207 | + |
| 208 | +## 📄 License |
| 209 | + |
| 210 | +This project is released under the **MIT License**. |
| 211 | + |
| 212 | +Individual managed modules maintain their own licenses. Please refer to each module's repository for license information. |
| 213 | + |
| 214 | +## 🙏 Acknowledgments |
| 215 | + |
| 216 | +- **osm0sis** - PlayIntegrityFork |
| 217 | +- **5ec1cff** - TrickyStore |
| 218 | +- **YurikeyDev** - yurikey |
| 219 | +- **Dr-TSNG** - ZygiskNext |
| 220 | +- **Magisk/APatch/KernelSU teams** - Root solutions |
| 221 | + |
| 222 | +## 📞 Support |
| 223 | + |
| 224 | +- 📧 **Issues**: [GitHub Issues](https://github.com/himanshujjp/IntegrityHelper/issues) |
| 225 | +- 💬 **Discussions**: [GitHub Discussions](https://github.com/himanshujjp/IntegrityHelper/discussions) |
| 226 | +- 📖 **Documentation**: This README |
| 227 | + |
| 228 | +--- |
| 229 | + |
| 230 | +<div align="center"> |
| 231 | + |
| 232 | +**Made with ❤️ by [himanshujjp](https://github.com/himanshujjp)** |
| 233 | + |
| 234 | +⭐ Star this repo if you found it useful! |
| 235 | + |
| 236 | +</div> |
0 commit comments