Compare commits
106 Commits
Author | SHA1 | Date |
---|---|---|
|
60d4b53236 | |
|
bef65d4b2b | |
|
1158b8b337 | |
|
8b3ebd8f67 | |
|
73aac55c34 | |
|
317de635d2 | |
|
cf9bc306c4 | |
|
3f8415a103 | |
|
7ffd74d4eb | |
|
3b036f4781 | |
|
c6d704e3aa | |
|
a511219b50 | |
|
7ecc846459 | |
|
bbb70b99ba | |
|
3ebbf37428 | |
|
958ebffd7f | |
|
ff15c19383 | |
|
bc8bfb5cab | |
|
d288b8f0ed | |
|
13a1654b91 | |
|
a18d4e75a4 | |
|
b4cbcbdbbb | |
|
205814a2ea | |
|
b6fe527472 | |
|
94949ba40b | |
|
9df05cd81a | |
|
01c99f8e4c | |
|
3900871977 | |
|
cfeadeb3bd | |
|
702c4f28f5 | |
|
3e23e0bd0c | |
|
fe2348a725 | |
|
7b374d1ee1 | |
|
e7ecf8707d | |
|
fbad56f05c | |
|
c376609896 | |
|
a8ae765f03 | |
|
d39b438161 | |
|
6aabef278b | |
|
8b57dcef1a | |
|
1def3deb96 | |
|
04f473dc64 | |
|
c1bb2668dd | |
|
a4e3089e69 | |
|
8c9e16dd17 | |
|
40872ebb9e | |
|
97b1ef5bd0 | |
|
9fc74d4bdb | |
|
8759ee43f1 | |
|
5f24246e85 | |
|
508fefa48f | |
|
791f6c314b | |
|
4db9dcbdb0 | |
|
97269da898 | |
|
9c9b3afde6 | |
|
3d3a63d53b | |
|
0274cd339b | |
|
32f168ec8c | |
|
f42dc4314d | |
|
78d481d083 | |
|
34e326f303 | |
|
cbaa19db72 | |
|
a86517294b | |
|
9790d3117b | |
|
e65228750b | |
|
718a1752f1 | |
|
5dcfacc418 | |
|
0c85f00297 | |
|
a2fcbc4781 | |
|
63cd88b5fc | |
|
957ed25f07 | |
|
183cf44934 | |
|
4e92b3ebf5 | |
|
992ad00ca1 | |
|
9d874dbe88 | |
|
b94cf7c43f | |
|
0acb16dbaa | |
|
73441c4ed3 | |
|
8527e1a9b6 | |
|
18a57119b9 | |
|
7f1ae6282e | |
|
4515dde9b4 | |
|
45ad35d29f | |
|
a663d9052b | |
|
e3941c560f | |
|
7ec589b1c2 | |
|
10ca7249cb | |
|
a414ac035b | |
|
b51a2d2349 | |
|
9e1d985623 | |
|
433b3b8d39 | |
|
e8284c5398 | |
|
c2da43250e | |
|
f6995bc30c | |
|
f8cbf5eded | |
|
15a2e0ce53 | |
|
083cd42afd | |
|
7c6113f1d2 | |
|
0ccdcf647a | |
|
61a5af2202 | |
|
d2bc2d9460 | |
|
2468b5a415 | |
|
3b71515e07 | |
|
c2b21bb391 | |
|
e5fc9efe48 | |
|
1e3c5004c3 |
42
NOTICE
42
NOTICE
|
@ -1,42 +0,0 @@
|
|||
Copyright (c) 2013, oblique
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
|
||||
* Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
================================================================================
|
||||
|
||||
linux-router
|
||||
Copyright (C) 2018 garywill
|
||||
|
||||
This library is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU Lesser General Public
|
||||
License as published by the Free Software Foundation; either
|
||||
version 2.1 of the License, or (at your option) any later version.
|
||||
|
||||
This library 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
|
||||
Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public
|
||||
License along with this library; if not, write to the Free Software
|
||||
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
369
README.md
369
README.md
|
@ -1,10 +1,11 @@
|
|||
# Linux-router
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
It wraps `iptables`, `dnsmasq` etc. stuff. Use in one command, restore in one command or by `control-c` (or even by closing terminal window).
|
||||
|
||||
[Buy me a coffee](https://github.com/garywill/receiving/blob/master/receiving_methods.md) :)
|
||||
[More tools and projects 🛠️](https://garywill.github.io) | [🍻 Buy me a coffee ❤️](https://github.com/garywill/receiving/blob/master/receiving_methods.md)
|
||||
|
||||
|
||||
## Features
|
||||
|
||||
|
@ -12,16 +13,23 @@ Basic features:
|
|||
|
||||
- Create a NATed sub-network
|
||||
- Provide Internet
|
||||
- DHCP server and RA
|
||||
- DHCP server (and RA)
|
||||
- Specify what DNS the DHCP server assigns to clients
|
||||
- DNS server
|
||||
- Specify upstream DNS (kind of a plain DNS proxy)
|
||||
- IPv6 (behind NATed LAN, like IPv4)
|
||||
- Creating Wifi hotspot:
|
||||
- Creating WiFi hotspot:
|
||||
- Wifi 3/4/5/6
|
||||
- 2.4GHz, 5GHz
|
||||
- Channel selecting
|
||||
- Choose encryptions: WPA2/WPA, WPA2, WPA, No encryption
|
||||
- Create AP on the same interface you are getting Internet (require same channel)
|
||||
- Create AP on the same interface you are getting Internet (Need hardware support. Usually require same channel)
|
||||
- Transparent proxy (redsocks)
|
||||
- DNS proxy
|
||||
- Compatible with NetworkManager (automatically set interface as unmanaged)
|
||||
- Transparent DNS proxy (hijack port 53 packets)
|
||||
- Detect and prevent interference from following Linux system daemons:
|
||||
- NetworkManager (handle interface (un)managed status)
|
||||
- firewalld (use temporary `trusted` zone)
|
||||
- Instances managing. You can run multiple instances, to create different sub-networks.
|
||||
|
||||
**For many other features, see below [CLI usage](#cli-usage-and-other-features)**
|
||||
|
||||
|
@ -35,7 +43,7 @@ Internet----(eth0/wlan0)-Linux-(wlanX)AP
|
|||
|
||||
```
|
||||
Internet
|
||||
Wifi AP(no DHCP) |
|
||||
WiFi AP(no DHCP) |
|
||||
|----(wlan1)-Linux-(eth0/wlan0)------
|
||||
| (DHCP)
|
||||
|--client
|
||||
|
@ -58,42 +66,87 @@ Internet----(eth0/wlan0)-Linux-(eth1)------Another PC
|
|||
Internet----(eth0/wlan0)-Linux-(virtual interface)-----VM/container
|
||||
```
|
||||
|
||||
## Install
|
||||
|
||||
1-file-script. Release on [Linux-router repo on Github](https://github.com/garywill/linux-router). Just download and run the bash script (meet the dependencies). In this case use without installation.
|
||||
|
||||
I'm currently not packaging for any distro. If you do, open a PR and add the link (can be with a version badge) to list here
|
||||
|
||||
| Linux distro | |
|
||||
| ------------ | ---------------------------------------------------------------------------------------------------------- |
|
||||
| Any | download [1-file-script](https://raw.githubusercontent.com/garywill/linux-router/master/lnxrouter) and run without installation |
|
||||
|
||||
### Dependencies
|
||||
|
||||
- bash
|
||||
- procps or procps-ng
|
||||
- iproute2
|
||||
- dnsmasq
|
||||
- iptables (or nftables with `iptables-nft` translation linked)
|
||||
- WiFi hotspot dependencies
|
||||
- hostapd
|
||||
- iw (or iwconfig, when iw can not recognize adapter)
|
||||
- haveged (optional)
|
||||
- crda and wireless-regdb (optional)
|
||||
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
### Provide Internet to an interface
|
||||
|
||||
```
|
||||
```bash
|
||||
sudo lnxrouter -i eth1
|
||||
```
|
||||
|
||||
### Provide an interface's Internet to another interface
|
||||
no matter which interface (other than `eth1`) you're getting Internet from.
|
||||
|
||||
```
|
||||
sudo lnxrouter -i eth1 -o vpn0 --dhcp-dns 1.1.1.1 -6 --dhcp-dns6 [2606:4700:4700::1111]
|
||||
```
|
||||
> Read _Notice 1_
|
||||
### Create WiFi hotspot
|
||||
|
||||
### Create Wifi hotspot
|
||||
|
||||
```
|
||||
```bash
|
||||
sudo lnxrouter --ap wlan0 MyAccessPoint -p MyPassPhrase
|
||||
```
|
||||
|
||||
### LAN without Internet
|
||||
no matter which interface you're getting Internet from (even from `wlan0`). Will create virtual Interface `x0wlan0` for hotspot.
|
||||
|
||||
### Provide an interface's Internet to another interface
|
||||
|
||||
Clients access Internet through only `isp5`
|
||||
|
||||
<details>
|
||||
|
||||
```bash
|
||||
sudo lnxrouter -i eth1 -o isp5 --no-dns --dhcp-dns 1.1.1.1 -6 --dhcp-dns6 [2606:4700:4700::1111]
|
||||
```
|
||||
|
||||
> In this case of usage, it's recommended to:
|
||||
>
|
||||
> 1. Stop serving local DNS
|
||||
> 2. Tell clients which DNS to use (ISP5's DNS. Or, a safe public DNS, like above example)
|
||||
|
||||
</details>
|
||||
|
||||
### Create LAN without providing Internet
|
||||
|
||||
<details>
|
||||
|
||||
```bash
|
||||
sudo lnxrouter -n -i eth1
|
||||
```
|
||||
|
||||
```bash
|
||||
sudo lnxrouter -n --ap wlan0 MyAccessPoint -p MyPassPhrase
|
||||
```
|
||||
|
||||
> Read _Notice 1_
|
||||
|
||||
</details>
|
||||
|
||||
### Internet for LXC
|
||||
|
||||
<details>
|
||||
|
||||
Create a bridge
|
||||
|
||||
```
|
||||
```bash
|
||||
sudo brctl addbr lxcbr5
|
||||
```
|
||||
|
||||
|
@ -106,14 +159,20 @@ lxc.network.link = lxcbr5
|
|||
lxc.network.hwaddr = xx:xx:xx:xx:xx:xx
|
||||
```
|
||||
|
||||
```
|
||||
```bash
|
||||
sudo lnxrouter -i lxcbr5
|
||||
```
|
||||
|
||||
### Transparent proxy with Tor
|
||||
</details>
|
||||
|
||||
```
|
||||
sudo lnxrouter -i eth1 --tp 9040 --dns 9053 -g 192.168.55.1 --p6 fd00:5:6:7::
|
||||
### Transparent proxy
|
||||
|
||||
All clients' Internet traffic go through, for example, Tor (notice this example is NOT an anonymity use)
|
||||
|
||||
<details>
|
||||
|
||||
```bash
|
||||
sudo lnxrouter -i eth1 --tp 9040 --dns 9053 -g 192.168.55.1 -6 --p6 fd00:5:6:7::
|
||||
```
|
||||
|
||||
In `torrc`
|
||||
|
@ -125,11 +184,19 @@ TransPort [fd00:5:6:7::1]:9040
|
|||
DNSPort [fd00:5:6:7::1]:9053
|
||||
```
|
||||
|
||||
> **Warn**: Tor's anonymity relies on a purpose-made browser. Using Tor like this (sharing Tor's network to LAN clients) will NOT ensure anonymity.
|
||||
>
|
||||
> Although we use Tor as example here, Linux-router does NOT ensure nor is NOT aiming at anonymity.
|
||||
|
||||
</details>
|
||||
|
||||
### Clients-in-sandbox network
|
||||
|
||||
To not give our infomation to clients:
|
||||
To not give our infomation to clients. Clients can still access Internet.
|
||||
|
||||
```
|
||||
<details>
|
||||
|
||||
```bash
|
||||
sudo lnxrouter -i eth1 \
|
||||
--tp 9040 --dns 9053 \
|
||||
--random-mac \
|
||||
|
@ -137,20 +204,23 @@ sudo lnxrouter -i eth1 \
|
|||
--catch-dns --log-dns # optional
|
||||
```
|
||||
|
||||
> This script comes with no warrenty, use on your own risk
|
||||
</details>
|
||||
|
||||
> Linux-router comes with no warranty. Use on your own risk
|
||||
|
||||
### Use as transparent proxy for LXD
|
||||
|
||||
<details>
|
||||
|
||||
Create a bridge
|
||||
|
||||
```
|
||||
```bash
|
||||
sudo brctl addbr lxdbr5
|
||||
```
|
||||
|
||||
Create and add a new LXD profile overriding container's `eth0`
|
||||
|
||||
```
|
||||
```bash
|
||||
lxc profile create profile5
|
||||
lxc profile edit profile5
|
||||
|
||||
|
@ -168,13 +238,13 @@ name: profile5
|
|||
lxc profile add <container> profile5
|
||||
```
|
||||
|
||||
```
|
||||
```bash
|
||||
sudo lnxrouter -i lxdbr5 --tp 9040 --dns 9053
|
||||
```
|
||||
|
||||
To remove that new profile from container
|
||||
|
||||
```
|
||||
```bash
|
||||
lxc profile remove <container> profile5
|
||||
```
|
||||
|
||||
|
@ -182,39 +252,55 @@ lxc profile remove <container> profile5
|
|||
|
||||
Add new `eth0` to container overriding default `eth0`
|
||||
|
||||
```
|
||||
```bash
|
||||
lxc config device add <container> eth0 nic name=eth0 nictype=bridged parent=lxdbr5
|
||||
```
|
||||
|
||||
To remove the customized `eth0` to restore default `eth0`
|
||||
|
||||
```
|
||||
```bash
|
||||
lxc config device remove <container> eth0
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Use as transparent proxy for VirtualBox
|
||||
|
||||
<details>
|
||||
|
||||
In VirtualBox's global settings, create a host-only network `vboxnet5` with DHCP disabled.
|
||||
|
||||
```
|
||||
```bash
|
||||
sudo lnxrouter -i vboxnet5 --tp 9040 --dns 9053
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Use as transparent proxy for firejail
|
||||
|
||||
<details>
|
||||
|
||||
Create a bridge
|
||||
|
||||
```
|
||||
```bash
|
||||
sudo brctl addbr firejail5
|
||||
```
|
||||
|
||||
```
|
||||
```bash
|
||||
sudo lnxrouter -i firejail5 -g 192.168.55.1 --tp 9040 --dns 9053
|
||||
firejail --net=firejail5 --dns=192.168.55.1 --blacklist=/var/run/nscd
|
||||
```
|
||||
|
||||
Firejail's `/etc/resolv.conf` doesn't obtain DNS from DHCP, so we need to assign.
|
||||
|
||||
nscd is domain name cache service, which shouldn't be accessed from in jail here.
|
||||
|
||||
</details>
|
||||
|
||||
### CLI usage and other features
|
||||
|
||||
<details>
|
||||
|
||||
```
|
||||
Usage: lnxrouter <options>
|
||||
|
||||
|
@ -224,62 +310,67 @@ Options:
|
|||
|
||||
-i <interface> Interface to make NATed sub-network,
|
||||
and to provide Internet to
|
||||
(To create Wifi hotspot use '--ap' instead)
|
||||
(To create WiFi hotspot use '--ap' instead)
|
||||
-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 (See Notice 1)
|
||||
-n Do not provide Internet
|
||||
--ban-priv Disallow clients to access my private network
|
||||
|
||||
-g <ip> This host's IPv4 address in subnet (mask is /24)
|
||||
(example: '192.168.5.1' or '5' shortly)
|
||||
-6 Enable IPv6 (NAT)
|
||||
--no4 Disable IPv4 Internet (not forwarding IPv4)
|
||||
(See Notice 1). Usually used with '-6'
|
||||
--no4 Disable IPv4 Internet (not forwarding IPv4).
|
||||
Usually used with '-6'
|
||||
|
||||
--p6 <prefix> Set IPv6 LAN address prefix (length 64)
|
||||
(example: fd00:1:2:3::) Using this enables '-6'
|
||||
(example: 'fd00:0:0:5::' or '5' shortly)
|
||||
Using this enables '-6'
|
||||
|
||||
--dns <ip>|<port>|<ip:port>
|
||||
DNS server's upstream DNS.
|
||||
Use ',' to seperate multiple servers
|
||||
(default: use /etc/resolve.conf)
|
||||
(default: use /etc/resolv.conf)
|
||||
(Note IPv6 addresses need '[]' around)
|
||||
--no-dns Do not serve DNS
|
||||
--no-dnsmasq Disable dnsmasq server (DHCP, DNS, RA)
|
||||
--catch-dns Transparent DNS proxy, redirect packets(TCP/UDP)
|
||||
whose destination port is 53 to this host
|
||||
--log-dns Show DNS query log
|
||||
--log-dns Show DNS query log (dnsmasq)
|
||||
--dhcp-dns <IP1[,IP2]>|no
|
||||
Set IPv4 DNS offered by DHCP (default: this host)
|
||||
Set IPv4 DNS offered by DHCP (default: this host).
|
||||
--dhcp-dns6 <IP1[,IP2]>|no
|
||||
Set IPv6 DNS offered by DHCP (RA)
|
||||
(default: this host)
|
||||
(Note IPv6 addresses need '[]' around)
|
||||
Using both above two will enable '--no-dns'
|
||||
--hostname <name> DNS server associate this name with this host.
|
||||
Use '-' to read name from /etc/hostname
|
||||
-d DNS server will take into account /etc/hosts
|
||||
-e <hosts_file> DNS server will take into account additional
|
||||
hosts file
|
||||
--dns-nocache DNS server no cache
|
||||
|
||||
--mac <MAC> Set MAC address
|
||||
--random-mac Use random MAC address
|
||||
|
||||
--tp <port> Transparent proxy,
|
||||
redirect non-LAN TCP and UDP traffic to port.
|
||||
(usually used with '--dns')
|
||||
redirect non-LAN TCP and UDP(not tested) traffic to
|
||||
port. (usually used with '--dns')
|
||||
|
||||
Wifi hotspot options:
|
||||
WiFi hotspot options:
|
||||
--ap <wifi interface> <SSID>
|
||||
Create Wifi access point
|
||||
Create WiFi access point
|
||||
-p, --password <password>
|
||||
Wifi password
|
||||
--qr Show Wifi QR code in terminal
|
||||
WiFi password
|
||||
--qr Show WiFi QR code in terminal (need qrencode)
|
||||
|
||||
--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)
|
||||
--virt-name <name> Set name of virtual interface
|
||||
-c <channel> Specify channel (default: use current, or 1 / 36)
|
||||
--country <code> Set two-letter country code for regularity
|
||||
(example: US)
|
||||
--freq-band <GHz> Set frequency band: 2.4 or 5 (default: 2.4)
|
||||
|
@ -288,75 +379,159 @@ Options:
|
|||
(default: 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
|
||||
--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
|
||||
|
||||
--ieee80211n Enable IEEE 802.11n (HT)
|
||||
--ieee80211ac Enable IEEE 802.11ac (VHT)
|
||||
--ht_capab <HT> HT capabilities (default: [HT40+])
|
||||
--vht_capab <VHT> VHT capabilities
|
||||
|
||||
--sta-timeout <seconds> Timeout to disconnect a no-signal client
|
||||
--no-haveged Do not run haveged automatically when needed
|
||||
--hs20 Enable Hotspot 2.0
|
||||
|
||||
WiFi 4 (802.11n) configs (2.4G/5GHz): (default: not enable)
|
||||
--wifi4 Enable IEEE 802.11n (HT, High Throughput)
|
||||
--ht-capab <HT caps> HT capabilities (example: '[HT40+][DSSS_CCK-40]')
|
||||
(default: '[HT40+]')
|
||||
--req-wifi4 Only support Wifi>=4 clients
|
||||
|
||||
WiFi 5 (802.11ac) configs (5GHz): (default: not enable)
|
||||
--wifi5 Enable IEEE 802.11ac (VHT, Very High Thoughtput)
|
||||
--vht-capab <VHT caps> VHT capabilities (example: '[VHT160][RXLDPC]')
|
||||
--vht-ch-width <index> Index of VHT channel width:
|
||||
0 for 20MHz or 40MHz (default)
|
||||
1 for 80MHz
|
||||
2 for 160MHz
|
||||
3 for 80+80MHz (Non-contigous 160MHz)
|
||||
--vht-seg0-ch <channel> Channel index of VHT center frequency for primary
|
||||
segment. Use with '--vht-ch-width'
|
||||
--vht-seg1-ch <channel> Channel index of VHT center frequency for secondary
|
||||
(second 80MHz) segment. Use with '--vht-ch-width 3'
|
||||
--req-wifi5 Only support Wifi>=5 clients
|
||||
|
||||
WiFi 6 (802.11ax) configs (2.4G/5GHz): (default: not enable)
|
||||
--wifi6 Enable IEEE 802.11ax (HE, High Efficiency)
|
||||
--he-ch-width <index> Index of HE channel width:
|
||||
0 for 20MHz or 40MHz (default)
|
||||
1 for 80MHz
|
||||
2 for 160MHz
|
||||
3 for 80+80MHz (Non-contigous 160MHz)
|
||||
--he-seg0-ch <channel> Channel index of HE center frequency for primary
|
||||
segment. Use with '--he-ch-width'
|
||||
--he-seg1-ch <channel> Channel index of HE center frequency for secondary
|
||||
(second 80MHz) segment. Use with '--he-ch-width 3'
|
||||
--he-su-bfe HE Single User Beamformee support
|
||||
--he-su-bfr HE Single User Beamformer support
|
||||
--he-mu-bfr HE Multi User Beamformer support
|
||||
--req-wifi6 Only support Wifi>=6 clients
|
||||
--p2ptwt Peer-to-Peer Target Wake Time support
|
||||
|
||||
Note: Some cutting-edge Wifi features strongly depends on hostapd built
|
||||
with specific flags enabled and compatible hardware
|
||||
|
||||
Instance managing:
|
||||
--daemon Run in background
|
||||
--list-running Show running instances
|
||||
--lc, --list-clients <id>
|
||||
--keep-confdir Don't delete the temporary config dir after exit
|
||||
|
||||
-l, --list-running Show running instances
|
||||
--lc, --list-clients <id|interface>
|
||||
List clients of an instance. Or list neighbors of
|
||||
any interface, even if it isn't handled by us
|
||||
an interface, even if it isn't handled by us.
|
||||
(passive mode)
|
||||
--stop <id> Stop a running instance
|
||||
For <id> you can use PID or subnet interface name.
|
||||
You can get them with '--list-running'
|
||||
|
||||
Notice 1: This script assume your host's default policy won't forward
|
||||
packets, so the script won't explictly ban forwarding in any
|
||||
mode. In some unexpected case may cause unwanted packets
|
||||
leakage between 2 networks, which you should be aware of if you
|
||||
want isolated network
|
||||
```
|
||||
|
||||
> These changes to system will not be restored by script's cleanup:
|
||||
> 1. `/proc/sys/net/ipv4/ip_forward = 1` and `/proc/sys/net/ipv6/conf/all/forwarding = 1`
|
||||
> 1. dnsmasq in Apparmor complain mode
|
||||
> 1. Kernel module `nf_nat_pptp` loaded
|
||||
> 1. The wifi device which is used to create hotspot is `rfkill unblock`ed
|
||||
> 1. Wifi country code, if user specified
|
||||
</details>
|
||||
|
||||
## What changes are done to Linux system
|
||||
|
||||
## Dependencies
|
||||
On exit of a linux-router instance, script **will do cleanup**, i.e. undo most changes to system. Though, **some** changes (if needed) will **not** be undone, which are:
|
||||
|
||||
- bash
|
||||
- procps or procps-ng
|
||||
- iproute2
|
||||
- dnsmasq
|
||||
- iptables
|
||||
- WiFi hotspot dependencies
|
||||
- hostapd
|
||||
- iw
|
||||
- iwconfig (you only need this if 'iw' can not recognize your adapter)
|
||||
- haveged (optional)
|
||||
- qrencode (opional)
|
||||
1. `/proc/sys/net/ipv4/ip_forward = 1` and `/proc/sys/net/ipv6/conf/all/forwarding = 1`
|
||||
2. dnsmasq in Apparmor complain mode
|
||||
3. hostapd in Apparmor complain mode
|
||||
4. Kernel module `nf_nat_pptp` loaded
|
||||
5. The wifi device which is used to create hotspot is `rfkill unblock`ed
|
||||
6. WiFi country code, if user assigns
|
||||
|
||||
## Meet contributor(s) and become one of them
|
||||
|
||||
Visit [**my homepage** 🏡](https://garywill.github.io) to see **more tools and projects** 🛠️.
|
||||
|
||||
> [❤️ Buy me a coffee](https://github.com/garywill/receiving/blob/master/receiving_methods.md) , this project took me lots of time! ([❤️ 扫码领红包并打赏一个!](https://github.com/garywill/receiving/blob/master/receiving_methods.md))
|
||||
>
|
||||
> 🥂 ( ^\_^) o自自o (^_^ ) 🍻
|
||||
|
||||
🤝 Bisides, thank [create_ap](https://github.com/oblique/create_ap) by [oblique](https://github.com/oblique). This script was forked from create\_ap. Now they are quite different. 🤝 Also thank those people who contributed to that project.
|
||||
|
||||
👨💻 You can be contributor, too!
|
||||
|
||||
- 🍃 There're some TO-DOs listed, in both [readme TODO](#todo) and [in the code file](https://github.com/garywill/linux-router/search?q=TODO&type=code)
|
||||
- 🍃 Also some [unfulfilled enhancements in the Issues](https://github.com/garywill/linux-router/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)
|
||||
- 🙋♂️ Contributions are not limited to coding. There're [some posts and questions](https://github.com/garywill/linux-router/issues) that need more people to answer
|
||||
|
||||
## TODO
|
||||
|
||||
- WPA3
|
||||
- Global IPv6
|
||||
- Explictly ban forwarding if not needed
|
||||
- Bring bridging method back
|
||||
|
||||
## Donate
|
||||
## License
|
||||
|
||||
[Buy me a coffee](https://github.com/garywill/receiving/blob/master/receiving_methods.md) , this project took me lots of time!
|
||||
linux-router is LGPL licensed
|
||||
|
||||
( ^\_^)o自自o(^_^ )
|
||||
<details>
|
||||
|
||||
No? Okay, or just give me a star!
|
||||
```
|
||||
linux-router
|
||||
Copyright (C) 2018 garywill
|
||||
|
||||
## For developers
|
||||
This library is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU Lesser General Public
|
||||
License as published by the Free Software Foundation; either
|
||||
version 2.1 of the License, or (at your option) any later version.
|
||||
|
||||
This library 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
|
||||
Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public
|
||||
License along with this library; if not, write to the Free Software
|
||||
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
Upstream create_ap was BSD licensed
|
||||
|
||||
<details>
|
||||
|
||||
```
|
||||
Copyright (c) 2013, oblique
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
|
||||
* Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
**Many thanks to project [create_ap](https://github.com/oblique/create_ap)**.
|
||||
|
||||
This script was forked from create\_ap. Now it's quite different from it. (See `history` branch for how I modified create_ap)
|
||||
|
|
Loading…
Reference in New Issue