NetGuard/README.md

# NetGuard

*NetGuard* is a simple way to block access to the internet - no root required.
Applications can individually be allowed or denied access via your Wi-Fi and/or mobile connection.

Blocking access to the internet can help:

* save your data allowance
* save your battery
* increase your privacy

Downloads:

* [GitHub](https://github.com/M66B/NetGuard/releases)
* [Play store](https://play.google.com/apps/testing/eu.faircode.netguard) (beta)
* [F-Droid](https://f-droid.org/repository/browse/?fdfilter=netguard&fdid=eu.faircode.netguard) (unsupported)

<img src="screenshot.png" />

Features
--------

* No root required
* Simple to use
* Free of charge
* Open source
* No extra battery usage
* No calling home
* No tracking or analytics
* No ads
* IPv4/IPv6 TCP/UDP supported
* Block both system and user applications

NetGuard doesn't even require *internet* permission.
NetGuard is possibly the first free and open source no-root firewall for Android.

Most of these features are the result of sending selected traffic to a sinkhole, instead of filtering all internet traffic.
This means that advanced features, like address based filtering (needed for ad blocking), traffic logging and on demand configuration, are not possible.
Routing selected traffic into a sinkhole relies on an API introduced in Android 5.0 (Lollipop),
so older Android versions can unfortunately not be supported.

Usage
-----

* Enable the firewall using the switch in the action bar
* Allow/deny WiFi/mobile internet access using the icons at the right side of the application list

Permissions
-----------

* ACCESS_NETWORK_STATE: to check if the device is connected to the internet through WiFi
* RECEIVE_BOOT_COMPLETED: to start the firewall when starting the device

Compatibility
-------------

Devices / ROMs with a broken VPN implementation:

* [Samsung Galaxy A5 / Android 5.02](https://github.com/M66B/NetGuard/issues/20) (all traffic blocked)

NetGuard will crash when the package *com.android.vpndialogs* has been removed.

Frequently Asked Questions (FAQ)
--------------------------------

<a name="FAQ1"></a>
**(1) Can NetGuard completely protect my privacy?**

No - nothing can completely protect your privacy.
NetGuard will do its best, but it is limited by the fact it must use the VPN service.
This is the trade-off required to make a firewall which does not require root access.
The firewall can only start when Android "allows" it to start,
so it will not offer protection during early boot-up (although your network may not be loaded at that time).
It will, however, be much better than nothing, especially if you are not rebooting often.

If you want to protect yourself more, you can (at least in theory) disable WiFi and mobile data before rebooting,
and only enable them on reboot, after the firewall service has started (and the small key icon is visible in the status bar).

Thanks @[pulser](https://github.com/pulser/)

<a name="FAQ2"></a>
**(2) Can I use VPN applications while using NetGuard?**

If the VPN application is using the [VPN service](http://developer.android.com/reference/android/net/VpnService.html),
then no, because NetGuard needs to use this service, and Android allows only one application at a time to use this service.

<a name="FAQ3"></a>
**(3) Can I use NetGuard on any Android version?**

No, because the method [addDisallowedApplication](http://developer.android.com/reference/android/net/VpnService.Builder.html#addDisallowedApplication(java.lang.String))
is being used, the minimum required Android version is 5.0 (Lollipop).

<a name="FAQ4"></a>
**(4) Will NetGuard use extra battery power?**

No, unlike most of the similar closed source alternatives.

<a name="FAQ5"></a>
**(5) Can you add selective allowing/blocking applications/IP addresses?**

Unfortunately this is not possible without using significant battery power
and adding a lot of complex code to do network translation from OSI layer 3 to layer 4
(and thus implementing a TCP/IP stack), which will inevitably introduce bugs as well.
This is how most (all?) other no root firewalls work.
NetGuard is unique, because it doesn't implement a TCP/IP stack and is therefore both highly efficient and simple.

For more advanced use cases, while not sacrificing battery usage,
rooting your device and using a iptables based firewall,
like [AFWall+](https://github.com/ukanth/afwall) might be a better option.

<a name="FAQ6"></a>
**(6) Will NetGuard send my internet traffic to an external (VPN) server?**

No, it even can't, because NetGuard has no *internet* permission.

<a name="FAQ7"></a>
**(7) Why are applications without internet access shown?**

Internet permission can be granted with each application update without user consent.
Not filtering applications without internet access allows you to block internet access before such an update occurs.

Support
-------

* Questions: please [use this XDA-Developers forum thread](http://forum.xda-developers.com/showthread.php?t=3233012)
* Feature requests and bugs: please [report an issue on GitHub](https://github.com/M66B/NetGuard/issues/new)

Please do not use GitHub for questions.

Contributing
------------

Translations:

* Translations to other languages are welcomed
* Check if the language [is supported by Android](http://stackoverflow.com/questions/7973023/what-is-the-list-of-supported-languages-locales-on-android) and find its locale
* Copy [this file](https://github.com/M66B/NetGuard/blob/master/app/src/main/res/values/strings.xml) to the correct locale folder
* Translate the strings in the copied file and omit all lines with **translatable="false"**
* Create a [pull request on GitHub](https://help.github.com/articles/using-pull-requests) for the new/updated translation

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)

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/).
Initial commit 2015-10-24 17:59:20 +00:00			`# NetGuard`
Initial commit 2015-10-24 18:01:55 +00:00
Updated description 2015-10-29 10:03:14 +00:00			`NetGuard is a simple way to block access to the internet - no root required.`
			`Applications can individually be allowed or denied access via your Wi-Fi and/or mobile connection.`

			`Blocking access to the internet can help:`

			`* save your data allowance`
			`* save your battery`
			`* increase your privacy`
Updated read me 2015-10-25 12:02:25 +00:00
Updated read me 2015-10-31 10:46:50 +00:00			`Downloads:`

			`* [GitHub](https://github.com/M66B/NetGuard/releases)`
			`* [Play store](https://play.google.com/apps/testing/eu.faircode.netguard) (beta)`
Updated downloads Closes #23 2015-10-31 11:39:40 +00:00			`* [F-Droid](https://f-droid.org/repository/browse/?fdfilter=netguard&fdid=eu.faircode.netguard) (unsupported)`
Updated read me 2015-10-31 10:46:50 +00:00
Updated screenshot 2015-10-29 10:59:30 +00:00			`<img src="screenshot.png" />`
Added screenshot 2015-10-25 12:48:35 +00:00
Updated read me 2015-10-25 13:21:14 +00:00			`Features`
			`--------`

			`* No root required`
			`* Simple to use`
Improvements to README.MD At Marcel's request :-) 2015-10-26 10:12:35 +00:00			`* Free of charge`
			`* Open source`
Simplify black hole service Solves threading issues, but needs testing 2015-10-25 15:16:20 +00:00			`* No extra battery usage`
Updated read me 2015-10-25 13:21:14 +00:00			`* No calling home`
Improvements to README.MD At Marcel's request :-) 2015-10-26 10:12:35 +00:00			`* No tracking or analytics`
Updated read me 2015-10-25 13:21:14 +00:00			`* No ads`
Updated read me 2015-10-26 12:43:37 +00:00			`* IPv4/IPv6 TCP/UDP supported`
Updated description 2015-10-29 10:03:14 +00:00			`* Block both system and user applications`
Updated read me 2015-10-25 13:21:14 +00:00
Updated description 2015-10-29 10:03:14 +00:00			`NetGuard doesn't even require internet permission.`
			`NetGuard is possibly the first free and open source no-root firewall for Android.`
Updated read me 2015-10-25 15:59:15 +00:00
Updated description 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.`
Updated description 2015-10-30 08:36:01 +00:00			`This means that advanced features, like address based filtering (needed for ad blocking), traffic logging and on demand configuration, are not possible.`
Updated description 2015-10-29 06:46:05 +00:00			`Routing selected traffic into a sinkhole relies on an API introduced in Android 5.0 (Lollipop),`
			`so older Android versions can unfortunately not be supported.`

Added usage section 2015-10-25 13:06:16 +00:00			`Usage`
			`-----`

			`* Enable the firewall using the switch in the action bar`
Improvements to README.MD At Marcel's request :-) 2015-10-26 10:12:35 +00:00			`* Allow/deny WiFi/mobile internet access using the icons at the right side of the application list`
Updated read me 2015-10-25 12:02:25 +00:00
Updated read me 2015-10-25 13:21:14 +00:00			`Permissions`
			`-----------`

Improvements to README.MD At Marcel's request :-) 2015-10-26 10:12:35 +00:00			`* ACCESS_NETWORK_STATE: to check if the device is connected to the internet through WiFi`
Updated read me 2015-10-25 13:21:14 +00:00			`* RECEIVE_BOOT_COMPLETED: to start the firewall when starting the device`

Added compatibility section Refs #6 Refs #20 2015-10-31 09:01:28 +00:00			`Compatibility`
			`-------------`

			`Devices / ROMs with a broken VPN implementation:`

			`* [Samsung Galaxy A5 / Android 5.02](https://github.com/M66B/NetGuard/issues/20) (all traffic blocked)`

			`NetGuard will crash when the package com.android.vpndialogs has been removed.`

Improvements to README.MD At Marcel's request :-) 2015-10-26 10:12:35 +00:00			`Frequently Asked Questions (FAQ)`
			`--------------------------------`
Added FAQ 2015-10-25 12:13:52 +00:00
			`<a name="FAQ1"></a>`
Updated FAQ Thanks @pulser 2015-10-26 09:38:53 +00:00			`(1) Can NetGuard completely protect my privacy?`
Added FAQ 2015-10-25 12:13:52 +00:00
Updated FAQ Thanks @pulser 2015-10-26 09:38:53 +00:00			`No - nothing can completely protect your privacy.`
			`NetGuard will do its best, but it is limited by the fact it must use the VPN service.`
			`This is the trade-off required to make a firewall which does not require root access.`
VPN service handover 2015-10-26 13:32:14 +00:00			`The firewall can only start when Android "allows" it to start,`
			`so it will not offer protection during early boot-up (although your network may not be loaded at that time).`
Improvements to README.MD At Marcel's request :-) 2015-10-26 10:12:35 +00:00			`It will, however, be much better than nothing, especially if you are not rebooting often.`
Updated FAQ Thanks @pulser 2015-10-26 09:38:53 +00:00
Improvements to README.MD At Marcel's request :-) 2015-10-26 10:12:35 +00:00			`If you want to protect yourself more, you can (at least in theory) disable WiFi and mobile data before rebooting,`
Updated FAQ Thanks @pulser 2015-10-26 09:38:53 +00:00			`and only enable them on reboot, after the firewall service has started (and the small key icon is visible in the status bar).`

			`Thanks @[pulser](https://github.com/pulser/)`
Added FAQ 2015-10-25 12:13:52 +00:00
Updated FAQ 2015-10-25 13:25:42 +00:00			`<a name="FAQ2"></a>`
			`(2) Can I use VPN applications while using NetGuard?`

Updated FAQ 2015-10-25 13:49:56 +00:00			`If the VPN application is using the [VPN service](http://developer.android.com/reference/android/net/VpnService.html),`
Improvements to README.MD At Marcel's request :-) 2015-10-26 10:12:35 +00:00			`then no, because NetGuard needs to use this service, and Android allows only one application at a time to use this service.`
Added FAQ 2015-10-25 12:13:52 +00:00
Updated FAQ 2015-10-25 13:49:56 +00:00			`<a name="FAQ3"></a>`
			`(3) Can I use NetGuard on any Android version?`

			`No, because the method [addDisallowedApplication](http://developer.android.com/reference/android/net/VpnService.Builder.html#addDisallowedApplication(java.lang.String))`
Improvements to README.MD At Marcel's request :-) 2015-10-26 10:12:35 +00:00			`is being used, the minimum required Android version is 5.0 (Lollipop).`
Updated FAQ 2015-10-25 13:49:56 +00:00
Updated FAQ 2015-10-25 15:36:14 +00:00			`<a name="FAQ4"></a>`
			`(4) Will NetGuard use extra battery power?`

			`No, unlike most of the similar closed source alternatives.`

Fixed FAQ numbering 2015-10-26 16:47:31 +00:00			`<a name="FAQ5"></a>`
Updated FAQ 2015-10-28 21:07:49 +00:00			`(5) Can you add selective allowing/blocking applications/IP addresses?`
Added FAQ Refs #4 2015-10-26 16:45:52 +00:00
Updated FAQ 2015-10-26 17:08:27 +00:00			`Unfortunately this is not possible without using significant battery power`
Added FAQ Refs #4 2015-10-26 16:45:52 +00:00			`and adding a lot of complex code to do network translation from OSI layer 3 to layer 4`
			`(and thus implementing a TCP/IP stack), which will inevitably introduce bugs as well.`
Updated FAQ 2015-10-26 17:08:27 +00:00			`This is how most (all?) other no root firewalls work.`
			`NetGuard is unique, because it doesn't implement a TCP/IP stack and is therefore both highly efficient and simple.`

Uodated FAQ Refs #29 2015-11-01 06:13:18 +00:00			`For more advanced use cases, while not sacrificing battery usage,`
			`rooting your device and using a iptables based firewall,`
Updated FAQ 2015-10-26 17:08:27 +00:00			`like [AFWall+](https://github.com/ukanth/afwall) might be a better option.`
Updated FAQ 2015-10-25 15:36:14 +00:00
Updated FAQ 2015-10-30 12:32:59 +00:00			`<a name="FAQ6"></a>`
			`(6) Will NetGuard send my internet traffic to an external (VPN) server?`

			`No, it even can't, because NetGuard has no internet permission.`

Uodated FAQ Refs #29 2015-11-01 06:13:18 +00:00			`<a name="FAQ7"></a>`
			`(7) Why are applications without internet access shown?`

			`Internet permission can be granted with each application update without user consent.`
			`Not filtering applications without internet access allows you to block internet access before such an update occurs.`

Added support section 2015-10-25 13:36:49 +00:00			`Support`
			`-------`

Improvements to README.MD At Marcel's request :-) 2015-10-26 10:12:35 +00:00			`* Questions: please [use this XDA-Developers forum thread](http://forum.xda-developers.com/showthread.php?t=3233012)`
			`* Feature requests and bugs: please [report an issue on GitHub](https://github.com/M66B/NetGuard/issues/new)`
Added support section 2015-10-25 13:36:49 +00:00
			`Please do not use GitHub for questions.`

Updated read me 2015-10-25 12:02:25 +00:00			`Contributing`
			`------------`

Updated contributing section 2015-10-26 08:06:39 +00:00			`Translations:`

			`* Translations to other languages are welcomed`
			`* Check if the language [is supported by Android](http://stackoverflow.com/questions/7973023/what-is-the-list-of-supported-languages-locales-on-android) and find its locale`
			`* Copy [this file](https://github.com/M66B/NetGuard/blob/master/app/src/main/res/values/strings.xml) to the correct locale folder`
			`* Translate the strings in the copied file and omit all lines with translatable="false"`
Improvements to README.MD At Marcel's request :-) 2015-10-26 10:12:35 +00:00			`* Create a [pull request on GitHub](https://help.github.com/articles/using-pull-requests) for the new/updated translation`
Updated contributing section 2015-10-26 08:06:39 +00:00
Updated read me 2015-10-25 12:02:25 +00:00			`Please note that you agree to the license below by contributing, including the copyright.`

Using Picasso for launcher icon loading 2015-11-01 07:20:58 +00:00			`Attribution`
			`-----------`

			`NetGuard uses:`

			`* [Picasso](http://square.github.io/picasso/)`
			`* [Android Support Library](https://developer.android.com/tools/support-library/index.html)`
Updated read me 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/).`