2018-08-31 05:41:06 -05:00
# Linux-router
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
Set Linux as router in one command. Able to Provide Internet, or create Wifi hotspot. Support transparent proxy (redsocks). Also useful for routing VM/containers.
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
It wraps `iptables` , `dnsmasq` etc. stuff. Use in one command, restore in one command or by `control-c` .
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
[Buy me a coffee ](https://github.com/garywill/receiving/blob/master/receiving_methods.md )
2018-08-31 05:41:06 -05:00
## Features
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
Basic features:
- Create a NATed sub-network
2018-08-31 05:41:06 -05:00
- Provide Internet
- DHCP server and RA
2018-08-31 05:41:06 -05:00
- DNS server
2018-08-31 05:41:06 -05:00
- IPv6 (NAT only for now)
2018-08-31 05:41:06 -05:00
- Creating Wifi hotspot:
- Channel selecting
- Choose encryptions: WPA2/WPA, WPA2, WPA, No encryption
- Hidden SSID
- Create AP on the same interface you are getting Internet (require same channel)
- Transparent proxy (redsocks)
- DNS proxy
2018-08-31 05:41:06 -05:00
- Compatible with NetworkManager (automatically set interface as unmanaged)
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
**For many other features, see below [CLI usage ](#cli-usage-and-other-features )**
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
### Useful in these situations
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
```
2018-08-31 05:41:06 -05:00
Internet----(eth0/wlan0)-Linux-(wlanX)AP
|--client
|--client
2018-08-31 05:41:06 -05:00
```
```
Internet
Wifi AP(no DHCP) |
|----(wlan1)-Linux-(eth0/wlan0)------
| (DHCP)
2018-08-31 05:41:06 -05:00
|--client
|--client
2018-08-31 05:41:06 -05:00
```
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
```
Internet
Switch |
|---(eth1)-Linux-(eth0/wlan0)--------
2018-08-31 05:41:06 -05:00
|--client
|--client
2018-08-31 05:41:06 -05:00
```
```
2018-08-31 05:41:06 -05:00
Internet----(eth0/wlan0)-Linux-(eth1)------Another PC
2018-08-31 05:41:06 -05:00
```
```
2018-08-31 05:41:06 -05:00
Internet----(eth0/wlan0)-Linux-(virtual interface)-----VM/container
2018-08-31 05:41:06 -05:00
```
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
## Usage
2018-08-31 05:41:06 -05:00
### Provide Internet to an interface
2018-08-31 05:41:06 -05:00
```
# lnxrouter -i eth1
```
2018-08-31 05:41:06 -05:00
### Provide an interface's Internet to another interface
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
```
# lnxrouter -i eth1 -o vpn0 --dhcp-dns 1.1.1.1
```
2018-08-31 05:41:06 -05:00
### Create Wifi hotspot
2018-08-31 05:41:06 -05:00
```
# lnxrouter --ap wlan0 MyAccessPoint --password MyPassPhrase
```
2018-08-31 05:41:06 -05:00
### LAN without Internet
2018-08-31 05:41:06 -05:00
```
2018-08-31 05:41:06 -05:00
# lnxrouter -n -i eth1
# lnxrouter -n --ap wlan0 MyAccessPoint --password MyPassPhrase
2018-08-31 05:41:06 -05:00
```
2018-08-31 05:41:06 -05:00
### Transparent proxy with Tor
2018-08-31 05:41:06 -05:00
```
2018-08-31 05:41:06 -05:00
# lnxrouter -i eth1 --tp 9040 --dns 9053
2018-08-31 05:41:06 -05:00
```
In `torrc`
```
TransPort 0.0.0.0:9040
DNSPort 0.0.0.0:9053
2018-08-31 05:41:06 -05:00
TransPort [::]:9040
DNSPort [::]:9053
2018-08-31 05:41:06 -05:00
```
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
### Internet for LXC
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
Create a bridge
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
```
2018-08-31 05:41:06 -05:00
# brctl addbr lxcbr5
2018-08-31 05:41:06 -05:00
```
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
In LXC container `config`
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
```
lxc.network.type = veth
lxc.network.flags = up
2018-08-31 05:41:06 -05:00
lxc.network.link = lxcbr5
2018-08-31 05:41:06 -05:00
lxc.network.hwaddr = xx:xx:xx:xx:xx:xx
```
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
```
2018-08-31 05:41:06 -05:00
# lnxrouter -i lxcbr5
2018-08-31 05:41:06 -05:00
```
2018-08-31 05:41:06 -05:00
### Use as transparent proxy for LXD
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
Create a bridge
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
```
# brctl addbr lxdbr5
```
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
Create and add LXD profile
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
```
$ lxc profile create profile5
$ lxc profile edit profile5
### profile content ###
config: {}
description: ""
devices:
eth0:
name: eth0
nictype: bridged
parent: lxdbr5
type: nic
name: profile5
$ lxc profile add < container > profile5
```
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
That should make one container have 2 profiles. `profile5` will override `eth0` .
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
```
2018-08-31 05:41:06 -05:00
# lnxrouter -i lxdbr5 --tp 9040 --dns 9053
2018-08-31 05:41:06 -05:00
```
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
To remove that new profile from container
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
```
$ lxc profile remove < container > profile5
```
2018-08-31 05:41:06 -05:00
#### To not use profile
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
Add device `eth0` to container overriding default `eth0`
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
```
$ lxc config device add < container > eth0 nic name=eth0 nictype=bridged parent=lxdbr5
```
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
To remove the customized `eth0` to restore default `eth0`
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
```
$ lxc config device remove < container > eth0
```
2018-08-31 05:41:06 -05:00
### Use as transparent proxy for VirtualBox
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
On VirtualBox's global settings, create a host-only network `vboxnet5` with DHCP disabled.
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
```
2018-08-31 05:41:06 -05:00
# lnxrouter -i vboxnet5 --tp 9040 --dns 9053
2018-08-31 05:41:06 -05:00
```
2018-08-31 05:41:06 -05:00
### Use as transparent proxy for firejail
Create a bridge
```
# brctl addbr firejail5
```
```
# lnxrouter -i firejail5 -g 192.168.55.1 --tp 9040 --dns 9053
$ firejail --net=firejail5 --dns=192.168.55.1
```
2018-08-31 05:41:06 -05:00
### CLI usage and other features
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
```
2018-08-31 05:41:06 -05:00
Usage: lnxrouter < options >
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
Options:
2018-08-31 05:41:06 -05:00
-h, --help Show this help
--version Print version number
2018-08-31 05:41:06 -05:00
-i < interface > Interface to make NATed sub-network,
and to provide Internet to
(To create Wifi hotspot use '--ap' instead)
2018-08-31 05:41:06 -05:00
-o < interface > Specify an inteface to provide Internet from.
(Note using this with default DNS option may leak
queries to other interfaces)
-n Do not provide Internet
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
-g < ip > Set this host's IPv4 address, netmask is 24
2018-08-31 05:41:06 -05:00
-6 Enable IPv6 (NAT)
2018-08-31 05:41:06 -05:00
--p6 < prefix > Set IPv6 prefix (length 64) (example: fd00:1:2:3::)
2018-08-31 05:41:06 -05:00
--dns < ip > |< port > |< ip:port >
2018-08-31 05:41:06 -05:00
DNS server's upstream DNS.
Use ',' to seperate multiple servers
(default: use /etc/resolve.conf)
(Note IPv6 addresses need '[]' around)
--no-dns Do not serve DNS
--no-dnsmasq Disable dnsmasq server (DHCP, DNS, RA)
2018-08-31 05:41:06 -05:00
--catch-dns Transparent DNS proxy, redirect packets(TCP/UDP)
that destination port is 53 to this host
2018-08-31 05:41:06 -05:00
--log-dns Show DNS query log
2018-08-31 05:41:06 -05:00
--dhcp-dns < IP1 [ , IP2 ] > |no
2018-08-31 05:41:06 -05:00
Set IPv4 DNS offered by DHCP (default: this host)
2018-08-31 05:41:06 -05:00
--dhcp-dns6 < IP1 [ , IP2 ] > |no
2018-08-31 05:41:06 -05:00
Set IPv6 DNS offered by DHCP (RA)
(default: this host)
(Note IPv6 addresses need '[]' around)
2018-08-31 05:41:06 -05:00
--hostname < name > DNS server associate this name with this host.
Use '-' to read name from /etc/hostname
2018-08-31 05:41:06 -05:00
-d DNS server will take into account /etc/hosts
-e < hosts_file > DNS server will take into account additional
hosts file
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
--mac < MAC > Set MAC address
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
--tp < port > Transparent proxy,
2018-08-31 05:41:06 -05:00
redirect non-LAN TCP and UDP traffic to port.
2018-08-31 05:41:06 -05:00
Usually used with '--dns'
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
Wifi hotspot options:
--ap < wifi interface > < SSID >
Create Wifi access point
--password < password > Wifi password
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
--hidden Hide access point (not broadcast SSID)
--no-virt Do not create virtual interface
Using this you can't use same wlan interface
for both Internet and AP
-c < channel > Channel number (default: 1)
--country < code > Set two-letter country code for regularity
(example: US)
--freq-band < GHz > Set frequency band: 2.4 or 5 (default: 2.4)
--driver Choose your WiFi adapter driver (default: nl80211)
-w < WPA version > Use 1 for WPA, use 2 for WPA2, use 1+2 for both
(default: 1+2)
--psk Use 64 hex digits pre-shared-key instead of
passphrase
--mac-filter Enable Wifi hotspot MAC address filtering
--mac-filter-accept Location of Wifi hotspot MAC address filter list
(defaults to /etc/hostapd/hostapd.accept)
--hostapd-debug < level > 1 or 2. Passes -d or -dd to hostapd
--isolate-clients Disable wifi communication between clients
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
--ieee80211n Enable IEEE 802.11n (HT)
--ieee80211ac Enable IEEE 802.11ac (VHT)
--ht_capab < HT > HT capabilities (default: [HT40+])
--vht_capab < VHT > VHT capabilities
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
--no-haveged Do not run haveged automatically when needed
Instance managing:
--daemon Run in background
--list-running Show running instances
--list-clients < id > List clients of an instance
--stop < id > Stop a running instance
For < id > you can use PID or subnet interface name.
You can get them with '--list-running'
2018-08-31 05:41:06 -05:00
```
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
> These changes to system will not be restored by script's cleanup:
2018-08-31 05:41:06 -05:00
> 1. `/proc/sys/net/ipv4/ip_forward = 1` and `/proc/sys/net/ipv6/conf/all/forwarding = 1`, needed by NAT Internet sharing.
> 2. dnsmasq in Apparmor complain mode
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
## Dependencies
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
- bash
- procps or procps-ng
- iproute2
- dnsmasq
- iptables
Wifi hotspot:
- hostapd
- iw
- iwconfig (you only need this if 'iw' can not recognize your adapter)
- haveged (optional)
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
## TODO
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
- Option to ban private network access
2018-08-31 05:41:06 -05:00
- Option to randomize MAC
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
## Donate
[Buy me a coffee ](https://github.com/garywill/receiving/blob/master/receiving_methods.md )
2018-08-31 05:41:06 -05:00
## Thanks
2018-08-31 05:41:06 -05:00
2018-08-31 05:41:06 -05:00
Many thanks to project [create_ap ](https://github.com/oblique/create_ap ).