0.5.4

firejail

README.md

@@ -2,11 +2,10 @@
 
 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).
+It wraps `iptables`, `dnsmasq` etc. stuff. Use in one command, restore in one command or by `control-c`.
 
 [Buy me a coffee](https://github.com/garywill/receiving/blob/master/receiving_methods.md)
 
-
 ## Features
 
 Basic features:
@@ -15,10 +14,11 @@ Basic features:
 - Provide Internet
 - DHCP server and RA
 - DNS server 
-- IPv6 (behind NATed LAN, like IPv4)
+- IPv6 (NAT only for now)
 - 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
@@ -64,38 +64,49 @@ Internet----(eth0/wlan0)-Linux-(virtual interface)-----VM/container
 ### Provide Internet to an interface
 
 ```
-sudo lnxrouter -i eth1
+# lnxrouter -i eth1
 ```
 
 ### Provide an interface's Internet to another interface
 
 ```
-sudo lnxrouter -i eth1 -o vpn0 --dhcp-dns 1.1.1.1 -6 --dhcp-dns6 [2606:4700:4700::1111]
+# lnxrouter -i eth1 -o vpn0 --dhcp-dns 1.1.1.1
 ```
-> Read _Notice 1_
 
 ### Create Wifi hotspot
 
 ```
-sudo lnxrouter --ap wlan0 MyAccessPoint -p MyPassPhrase
+# lnxrouter --ap wlan0 MyAccessPoint --password MyPassPhrase
 ```
 
 ### LAN without Internet
 
 ```
-sudo lnxrouter -n -i eth1
+# lnxrouter -n -i eth1
-sudo lnxrouter -n --ap wlan0 MyAccessPoint -p MyPassPhrase
+# lnxrouter -n --ap wlan0 MyAccessPoint --password MyPassPhrase
 ```
 
-> Read _Notice 1_
+### Transparent proxy with Tor
 
+```
+# lnxrouter -i eth1 --tp 9040 --dns 9053
+```
+
+In `torrc`
+
+```
+TransPort 0.0.0.0:9040 
+DNSPort 0.0.0.0:9053
+TransPort [::]:9040 
+DNSPort [::]:9053
+```
 
 ### Internet for LXC
 
 Create a bridge
 
 ```
-sudo brctl addbr lxcbr5
+# brctl addbr lxcbr5
 ```
 
 In LXC container `config`
@@ -108,54 +119,22 @@ lxc.network.hwaddr = xx:xx:xx:xx:xx:xx
 ```
 
 ```
-sudo lnxrouter -i lxcbr5
+# lnxrouter -i lxcbr5
 ```
 
-### Transparent proxy 
-
-For example through Tor
-
-```
-sudo lnxrouter -i eth1 --tp 9040 --dns 9053 -g 192.168.55.1 --p6 fd00:5:6:7::
-```
-
-In `torrc`
-
-```
-TransPort 192.168.55.1:9040 
-DNSPort 192.168.55.1:9053
-TransPort [fd00:5:6:7::1]:9040 
-DNSPort [fd00:5:6:7::1]:9053
-```
-
-### Clients-in-sandbox network
-
-To not give our infomation to clients. Clients can still access Internet.
-
-```
-sudo lnxrouter -i eth1 \
-    --tp 9040 --dns 9053 \
-    --random-mac \
-    --ban-priv \
-    --catch-dns --log-dns   # optional
-```
-
-> This script comes with no warrenty, use on your own risk
-
-
 ### Use as transparent proxy for LXD
 
 Create a bridge
 
 ```
-sudo brctl addbr lxdbr5
+# brctl addbr lxdbr5
 ```
 
-Create and add a new LXD profile overriding container's `eth0`
+Create and add LXD profile
 
 ```
-lxc profile create profile5
+$ lxc profile create profile5
-lxc profile edit profile5
+$ lxc profile edit profile5
 
 ### profile content ###
 config: {}
@@ -168,39 +147,41 @@ devices:
     type: nic
 name: profile5
 
-lxc profile add <container> profile5
+$ lxc profile add <container> profile5
 ```
 
+That should make one container have 2 profiles. `profile5` will override `eth0`.
+
 ```
-sudo lnxrouter -i lxdbr5 --tp 9040 --dns 9053
+# lnxrouter -i lxdbr5 --tp 9040 --dns 9053
 ```
 
 To remove that new profile from container
 
 ```
-lxc profile remove <container> profile5
+$ lxc profile remove <container> profile5
 ```
 
 #### To not use profile
 
-Add new `eth0` to container overriding default `eth0`
+Add device `eth0` to container overriding default `eth0`
 
 ```
-lxc config device add <container> eth0 nic name=eth0 nictype=bridged parent=lxdbr5
+$ lxc config device add <container> eth0 nic name=eth0 nictype=bridged parent=lxdbr5
 ```
 
 To remove the customized `eth0` to restore default `eth0`
 
 ```
-lxc config device remove <container> eth0
+$ lxc config device remove <container> eth0
 ```
 
 ### Use as transparent proxy for VirtualBox
 
-In VirtualBox's global settings, create a host-only network `vboxnet5` with DHCP disabled.
+On VirtualBox's global settings, create a host-only network `vboxnet5` with DHCP disabled.
 
 ```
-sudo lnxrouter -i vboxnet5 --tp 9040 --dns 9053
+# lnxrouter -i vboxnet5 --tp 9040 --dns 9053
 ```
 
 ### Use as transparent proxy for firejail
@@ -208,12 +189,12 @@ sudo lnxrouter -i vboxnet5 --tp 9040 --dns 9053
 Create a bridge
 
 ```
-sudo brctl addbr firejail5
+# brctl addbr firejail5
 ```
 
 ```
-sudo lnxrouter -i firejail5 -g 192.168.55.1 --tp 9040 --dns 9053 
+# 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 --net=firejail5 --dns=192.168.55.1
 ```
 
 ### CLI usage and other features
@@ -231,18 +212,11 @@ Options:
     -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)
+    -g <ip>                 Set this host's IPv4 address, netmask is 24 
-                            (example: '192.168.5.1' or '5' shortly)
     -6                      Enable IPv6 (NAT)
-    --no4                   Disable IPv4 Internet (not forwarding IPv4)
+    --p6 <prefix>           Set IPv6 prefix (length 64) (example: fd00:1:2:3::)
-                            (See Notice 1). Usually used with '-6'
-                            
-    --p6 <prefix>           Set IPv6 LAN address prefix (length 64) 
-                            (example: 'fd00:0:0:5::' or '5' shortly) 
-                            Using this enables '-6'
                             
     --dns <ip>|<port>|<ip:port>
                             DNS server's upstream DNS.
@@ -252,7 +226,7 @@ Options:
     --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
+                            that destination port is 53 to this host
     --log-dns               Show DNS query log
     --dhcp-dns <IP1[,IP2]>|no
                             Set IPv4 DNS offered by DHCP (default: this host)
@@ -267,18 +241,15 @@ Options:
                             hosts file
     
     --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')
+                            Usually used with '--dns'
     
   Wifi hotspot options:
     --ap <wifi interface> <SSID>
                             Create Wifi access point
-    -p, --password <password>   
+    --password <password>   Wifi password
-                            Wifi password
-    --qr                    Show Wifi QR code in terminal
     
     --hidden                Hide access point (not broadcast SSID)
     --no-virt               Do not create virtual interface
@@ -289,8 +260,8 @@ Options:
                             (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>        '2' for WPA2, '1' for WPA, '1+2' for both
+    -w <WPA version>        Use 1 for WPA, use 2 for WPA2, use 1+2 for both
-                            (default: 2)
+                            (default: 1+2)
     --psk                   Use 64 hex digits pre-shared-key instead of
                             passphrase
     --mac-filter            Enable Wifi hotspot MAC address filtering
@@ -308,29 +279,16 @@ Options:
 
   Instance managing:
     --daemon                Run in background
-    -l, --list-running      Show running instances
+    --list-running          Show running instances
-    --lc, --list-clients <id|interface>     
+    --list-clients <id>     List clients of an instance
-                            List clients of an instance. Or list neighbors of
-                            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. `/proc/sys/net/ipv4/ip_forward = 1` and `/proc/sys/net/ipv6/conf/all/forwarding = 1`, needed by NAT Internet sharing.
-> 1. dnsmasq in Apparmor complain mode
+> 2. 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
-
 
 ## Dependencies
 
@@ -338,37 +296,24 @@ Options:
 - procps or procps-ng
 - iproute2
 - dnsmasq
-- iptables (legacy. nft not tested)
+- iptables
-- WiFi hotspot dependencies
+
-   - hostapd
+Wifi hotspot:
-   - iw
+
-   - iwconfig (you only need this if 'iw' can not recognize your adapter)
+- hostapd
-   - haveged (optional)
+- iw
-   - qrencode (optional)
+- iwconfig (you only need this if 'iw' can not recognize your adapter)
+- haveged (optional)
 
 ## TODO
 
-- WPA3
+- Option to ban private network access
-- Global IPv6
+- Option to randomize MAC
-- Explictly ban forwarding if not needed
-- Bring bridging method back
 
 ## Donate
 
-[Buy me a coffee](https://github.com/garywill/receiving/blob/master/receiving_methods.md) , this project took me lots of time!
+[Buy me a coffee](https://github.com/garywill/receiving/blob/master/receiving_methods.md)
 
+## Thanks
 
-[打赏一个](https://github.com/garywill/receiving/blob/master/receiving_methods.md) 
+Many thanks to project [create_ap](https://github.com/oblique/create_ap).
-
-## For developers
-
-**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)
-
-There're some TO-DOs listed, at both above and in the code file. We'll appreciate your help.
-
-------------------
-
-More of my projects: https://garywill.github.io
-