NetGuard/README.md

251 lines
11 KiB
Markdown
Raw Normal View History

2015-10-24 17:59:20 +00:00
# NetGuard
2015-10-24 18:01:55 +00:00
*NetGuard* provides a simple way to block access to the internet - no root required.
2015-11-15 19:18:48 +00:00
Applications can individually be allowed or denied access to your Wi-Fi and/or mobile connection.
2015-10-29 10:03:14 +00:00
Blocking access to the internet can help:
2015-11-01 08:40:27 +00:00
* reduce your data usage
2015-10-29 10:03:14 +00:00
* save your battery
* increase your privacy
2015-10-25 12:02:25 +00:00
2015-11-18 17:48:11 +00:00
NetGuard is the first free and open source no-root firewall for Android.
2015-11-07 18:11:43 +00:00
2015-11-17 07:25:29 +00:00
Features:
2015-10-25 13:21:14 +00:00
* No root required
* Simple to use
* Free of charge
* Open source
* No extra battery usage
2015-11-05 12:14:34 +00:00
* No bandwidth reduction
2015-10-25 13:21:14 +00:00
* No calling home
* No tracking or analytics
2015-10-25 13:21:14 +00:00
* No ads
2015-11-08 09:14:56 +00:00
* No internet permission required
2015-10-26 12:43:37 +00:00
* IPv4/IPv6 TCP/UDP supported
2015-11-09 11:23:06 +00:00
* Optionally allow when screen on
* Optionally block when roaming
2015-11-09 11:23:06 +00:00
* Optionally block system applications
2015-12-12 13:41:12 +00:00
* Graphical network speed display
2015-11-08 13:34:00 +00:00
* Material design
2015-10-25 13:21:14 +00:00
2015-11-29 12:26:46 +00:00
There is no other no-root firewall offering all these features.
Most other firewall solutions will use extra battery and reduce the overall network speed.
2015-10-29 06:46:05 +00:00
Most of these features are the result of sending selected traffic to a sinkhole, instead of filtering all internet traffic.
2015-11-01 08:40:27 +00:00
This means that advanced features, like address based filtering (needed for ad blocking), traffic logging, and on-demand configuration, are not possible.
2015-10-29 06:46:05 +00:00
Routing selected traffic into a sinkhole relies on an API introduced in Android 5.0 (Lollipop),
therefore older Android versions unfortunately cannot be supported.
2015-10-29 06:46:05 +00:00
2015-11-17 07:25:29 +00:00
Since NetGuard has no internet permission, you know your internet traffic is not being sent anywhere.
Downloads:
* [GitHub](https://github.com/M66B/NetGuard/releases)
* [On Google Play](https://play.google.com/store/apps/details?id=eu.faircode.netguard) (stable)
* [On Google Play](https://play.google.com/apps/testing/eu.faircode.netguard) (beta)
2015-11-17 07:25:29 +00:00
* [XDA Labs App](http://forum.xda-developers.com/android/apps-games/labs-t3241866) ([web page](https://labs.xda-developers.com/store/app/eu.faircode.netguard))
Usage:
2015-11-17 10:51:40 +00:00
2015-10-25 13:06:16 +00:00
* Enable the firewall using the switch in the action bar
2015-11-15 19:18:48 +00:00
* Allow/deny Wi-Fi/mobile internet access using the icons along the right side of the application list
2015-10-25 12:02:25 +00:00
2015-11-29 10:43:07 +00:00
You can use the settings menu to change from black list to white list mode.
2015-11-29 07:24:20 +00:00
* Orange = denied internet access
* Green = allowed internet access
2015-11-17 07:25:29 +00:00
<img src="screenshot1.png" width="320" height="569" />
2015-10-25 13:21:14 +00:00
2015-11-17 07:25:29 +00:00
<img src="screenshot2.png" width="320" height="569" />
2015-10-25 13:21:14 +00:00
Compatibility
-------------
Devices / ROMs with a broken VPN implementation:
2015-11-25 20:11:51 +00:00
* Asus™ ZenFone 2 / Android 5.0.2, [reported on XDA](http://forum.xda-developers.com/showpost.php?p=63619542&postcount=121) (all traffic blocked)
* Asus™ ZenFone 4 / Android 5.0 (reported in the Google Play™ store app) (all traffic blocked)
2015-12-01 18:14:25 +00:00
* Asus™ ZenFone 5 / Android 5.0 (reported through Google Play™ store app feedback) (VPN prepare fails)
* Asus™ ZenPad S 8.0 / Android 5.0, [reported on Github](https://github.com/M66B/NetGuard/issues/168) (all traffic blocked)
* BQ™ Aquaris E5/M5 / Android 5.0.2/5.0 (reported in the Google Play™ store app) (all traffic blocked)
2015-11-17 07:25:29 +00:00
* Lenovo™ Yoga Tablet Pro-1380L / 2 Pro / Android 5.0.1, [reported on XDA](http://forum.xda-developers.com/showpost.php?p=63784102&postcount=278) (all traffic blocked)
2015-12-01 18:14:25 +00:00
* LGE G Vista / Android 5.0 (reported through Google Play™ store app feedback) (VPN establish fails)
2015-12-06 08:48:27 +00:00
* Samsung™ Galaxy A3 / Android 5.0.2, [reported on XDA](http://forum.xda-developers.com/showpost.php?p=64142621&postcount=509) (all traffic blocked)
2015-11-15 10:14:50 +00:00
* Samsung™ Galaxy A5 / Android 5.0.2, [reported on Github](https://github.com/M66B/NetGuard/issues/20) (all traffic blocked)
2015-12-01 18:14:25 +00:00
* Samsung™ Galaxy Note3 / Android 5.0 (reported through Google Play™ store app feedback) (VPN prepare fails)
* Samsung™ Galaxy Note4 / Android 5.1.1 (reported through Google Play™ store app feedback and on XDA) (telephone unresponsive)
2015-12-08 07:40:07 +00:00
* Samsung™ Galaxy Note5 / Android ? (reported through Google Play™ store app feedback and on XDA) (?)
* Sony™ Xperia™ M4 Aqua Dual / Android 5.0 (reported in the Google Play™ store app) (all traffic blocked)
2015-11-18 14:35:51 +00:00
* Symphony Teleca™ / Micromax™ Canvas Knight 2 E471 / Android 5.0.2 (reported by e-mail) (VPN establish fails)
* TCT Mobile Limited™ (Alcatel) 6039Y / Android / Android 5.0 (reported in the Google Play™ store app) (all traffic blocked)
* TCT Mobile Limited™ (Alcatel) OneTouch Idol 3 / Android 5.0.2 (reported in the Google Play™ store app) (all traffic blocked)
2015-11-14 17:16:25 +00:00
2015-11-02 18:40:07 +00:00
NetGuard will crash when the package *com.android.vpndialogs* has been removed or otherwise is unavailable.
2015-12-19 18:34:19 +00:00
Wi-Fi/USB tethering and Wi-Fi will not work when NetGuard is enabled due to a bug in Android ([issue](https://github.com/M66B/NetGuard/issues/42)).
2015-11-17 07:36:26 +00:00
2015-11-25 08:05:20 +00:00
Unfortunately it is not possible to workaround any of these Android problems.
2015-11-03 09:44:34 +00:00
2015-11-17 07:25:29 +00:00
<a name="FAQ"></a>
Frequently Asked Questions (FAQ)
--------------------------------
2015-10-25 12:13:52 +00:00
2015-11-29 10:43:07 +00:00
<a name="FAQ0"></a>
[**(0) How do I use NetGuard?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ0)
2015-10-25 12:13:52 +00:00
<a name="FAQ1"></a>
2015-11-17 14:12:33 +00:00
[**(1) Can NetGuard completely protect my privacy?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ1)
2015-10-25 12:13:52 +00:00
2015-10-25 13:25:42 +00:00
<a name="FAQ2"></a>
2015-11-17 14:24:14 +00:00
[**(2) Can I use another VPN application while using NetGuard?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ2)
2015-10-25 12:13:52 +00:00
2015-10-25 13:49:56 +00:00
<a name="FAQ3"></a>
2015-11-17 14:12:33 +00:00
[**(3) Can I use NetGuard on any Android version?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ3)
2015-10-25 13:49:56 +00:00
2015-10-25 15:36:14 +00:00
<a name="FAQ4"></a>
2015-11-17 14:12:33 +00:00
[**(4) Will NetGuard use extra battery power?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ4)
2015-10-25 15:36:14 +00:00
2015-10-26 16:47:31 +00:00
<a name="FAQ5"></a>
2015-12-12 15:09:53 +00:00
[**(5) Can you add usage statistics?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ5)<br />
[**(5) Can you add popups to allow/block applications?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ5)<br />
2015-11-17 14:12:33 +00:00
[**(5) Can you add selective allowing/blocking applications/IP addresses?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ5)
2015-10-25 15:36:14 +00:00
2015-10-30 12:32:59 +00:00
<a name="FAQ6"></a>
2015-11-17 14:12:33 +00:00
[**(6) Will NetGuard send my internet traffic to an external (VPN) server?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ6)
2015-10-30 12:32:59 +00:00
2015-11-01 06:13:18 +00:00
<a name="FAQ7"></a>
2015-11-17 14:12:33 +00:00
[**(7) Why are applications without internet permission shown?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ7)
2015-11-01 06:13:18 +00:00
<a name="FAQ8"></a>
[**(8) What do I need to enable for the Google Play™ store app to work?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ8)
2015-11-08 06:28:43 +00:00
<a name="FAQ9"></a>
2015-11-17 14:24:14 +00:00
[**(9) Why is the VPN service being restarted?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ9)
2015-11-08 06:28:43 +00:00
2015-11-08 12:18:16 +00:00
<a name="FAQ10"></a>
2015-11-17 14:12:33 +00:00
[**(10) Will you provide a Tasker plug-in?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ10)
2015-11-08 12:18:16 +00:00
2015-11-09 06:16:09 +00:00
<a name="FAQ12"></a>
2015-11-17 14:12:33 +00:00
[**(12) Can you add on demand asking to block/allow access?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ12)
2015-11-08 21:08:10 +00:00
<a name="FAQ13"></a>
2015-11-17 14:12:33 +00:00
[**(13) How can I remove the ongoing NetGuard entry in the notification screen?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ13)
<a name="FAQ14"></a>
2015-11-17 14:12:33 +00:00
[**(14) Why can't I select OK to approve the VPN connection request?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ14)
2015-11-13 08:49:19 +00:00
<a name="FAQ15"></a>
2015-11-17 14:24:14 +00:00
[**(15) Why won't you support the F-Droid builds?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ15)
2015-11-13 08:49:19 +00:00
<a name="FAQ16"></a>
2015-11-17 14:12:33 +00:00
[**(16) Why are some applications shown dimmed?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ16)
2015-11-14 12:26:57 +00:00
<a name="FAQ17"></a>
2015-11-17 14:12:33 +00:00
[**(17) Why is NetGuard using so much memory?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ17)
2015-11-14 12:26:57 +00:00
2015-11-14 18:40:29 +00:00
<a name="FAQ18"></a>
[**(18) Why can't I find NetGuard in the Google Play™ store app?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ18)
2015-11-14 18:40:29 +00:00
2015-11-16 10:08:12 +00:00
<a name="FAQ19"></a>
2015-11-17 14:24:14 +00:00
[**(19) Why does aplication XYZ still have internet access?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ19)
2015-11-16 10:08:12 +00:00
2015-11-17 07:33:40 +00:00
<a name="FAQ20"></a>
2015-11-17 14:24:14 +00:00
[**(20) Can I Greenify/hibernate NetGuard?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ20)
2015-11-17 07:33:40 +00:00
2015-11-29 10:43:07 +00:00
<a name="FAQ21"></a>
[**(21) Does doze mode affect NetGuard?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ21)
<a name="FAQ22"></a>
[**(22) Can I tether while using NetGuard?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ22)
<a name="FAQ24"></a>
2015-11-29 20:09:13 +00:00
[**(24) Can you remove the notification from the status bar?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ24)
2015-11-29 10:43:07 +00:00
2015-11-17 07:25:29 +00:00
Permissions
-----------
* ACCESS_NETWORK_STATE: to check if the device is connected to the internet through Wi-Fi
2015-12-02 06:38:33 +00:00
* READ_PHONE_STATE: to detect mobile network changes, see [here](http://forum.xda-developers.com/showpost.php?p=64107371&postcount=489) for more details
2015-12-09 09:52:44 +00:00
* ACCESS_WIFI_STATE: to detect Wi-Fi network changes
2015-11-17 07:25:29 +00:00
* RECEIVE_BOOT_COMPLETED: to start the firewall when booting the device
* WAKE_LOCK: to reliably reload rules in the background on connectivity changes
* com.android.vending.BILLING: to accept donations via in-app billing
2015-10-25 13:36:49 +00:00
Support
-------
* Questions: please [use this XDA-Developers forum thread](http://forum.xda-developers.com/showthread.php?t=3233012)
* Feature requests and bugs: please [create an issue on GitHub](https://github.com/M66B/NetGuard/issues/new)
2015-10-25 13:36:49 +00:00
Please do not use GitHub for questions.
2015-10-25 12:02:25 +00:00
Contributing
------------
2015-10-26 08:06:39 +00:00
Translations:
* Translations to other languages are welcomed
2015-11-21 09:07:11 +00:00
* You can translate online [here](https://crowdin.com/project/netguard/)
* If your language is not listed, please send a message to marcel(plus)netguard(at)faircode(dot)eu
2015-10-26 08:06:39 +00:00
2015-11-04 20:32:07 +00:00
Current translations:
1. Arabic (ar)
1. Simplified Chinese (zh-rCN)
2015-11-23 09:10:54 +00:00
1. Dutch (nl)
2015-11-04 20:32:07 +00:00
1. English
1. French (fr)
1. German (de)
1. Italian (it)
2015-11-07 12:12:46 +00:00
1. Japanese (ja)
2015-11-04 20:32:07 +00:00
1. Korean (ko)
2015-11-07 16:23:20 +00:00
1. Polish (pl)
2015-11-23 09:10:54 +00:00
1. Portuguese/Brazilian (pt-rBR)
2015-11-04 20:59:45 +00:00
1. Romanian (ro)
2015-11-08 06:41:12 +00:00
1. Russian (ru)
2015-11-04 20:32:07 +00:00
1. Slovak (sk)
1. Spanish (es)
2015-11-23 07:45:59 +00:00
1. Turkish (tr)
2015-11-12 18:59:55 +00:00
1. Ukrainian (uk)
2015-11-04 20:32:07 +00:00
2015-11-23 07:45:59 +00:00
You can see the actual status of all translations [here](https://crowdin.com/project/netguard).
2015-10-25 12:02:25 +00:00
Please note that you agree to the license below by contributing, including the copyright.
Attribution
-----------
NetGuard uses:
* [Picasso](http://square.github.io/picasso/)
* [Android Support Library](https://developer.android.com/tools/support-library/index.html)
2015-10-25 12:02:25 +00:00
License
-------
[GNU General Public License version 3](http://www.gnu.org/licenses/gpl.txt)
Copyright (c) 2015 Marcel Bokhorst ([M66B](http://forum.xda-developers.com/member.php?u=2799345))
All rights reserved
This file is part of NetGuard.
NetGuard is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your discretion) any later version.
NetGuard is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with NetGuard. If not, see [http://www.gnu.org/licenses/](http://www.gnu.org/licenses/).
2015-11-29 15:52:23 +00:00
*Android is a trademark of Google Inc. Google Play is a trademark of Google Inc*