diff options
| -rw-r--r-- | LICENSE | 29 | ||||
| -rw-r--r-- | README | 43 | ||||
| -rw-r--r-- | TODO | 22 | ||||
| -rw-r--r-- | admin.py | 0 | ||||
| -rw-r--r-- | config.py | 0 | ||||
| -rw-r--r-- | config.py.example | 0 | ||||
| -rw-r--r-- | helpers/administration.py | 0 | ||||
| -rw-r--r-- | helpers/wireless.py | 0 |
8 files changed, 86 insertions, 8 deletions
@@ -0,0 +1,29 @@ +Copyright (c) 2012 The Tor Project. + +Some rights reserved. + +Redistribution and use in source and binary forms of the software as well as +documentation, 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. + +* The names of the contributors may not be used to endorse or promote products + derived from this software without specific prior written permission. + +THIS SOFTWARE AND DOCUMENTATION 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 OWNER 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 AND DOCUMENTATION, EVEN IF ADVISED +OF THE POSSIBILITY OF SUCH DAMAGE. @@ -1,2 +1,43 @@ -$ python torouterui.py + _____ _ _ ___ _____ _ _ _ ___ + |_ _| | | |_ _|_ |_ _|__ _ __ ___ _ _| |_ ___ _ __ | | | |_ _| + | | | | | || |(_) | |/ _ \| '__/ _ \| | | | __/ _ \ '__| | | | || | + | | | |_| || | _ | | (_) | | | (_) | |_| | || __/ | | |_| || | + |_| \___/|___(_) |_|\___/|_| \___/ \__,_|\__\___|_| \___/|___| + + a part of the torouter project + https://trac.torproject.org/projects/tor/wiki/doc/Torouter + + +This is a simple/minimalist web interface for torouters, allowing owners/users +to configure a basic "home router"-style network and enable Tor onion-routed +services and daemons. It is writen in python. + +### Features + +- integrates elegantly with conventional Linux configuration files +- no javascript, just HTML5 and CSS +- no cookies, sessions, or server-side state +- compatible with lynx + +### Dependancies + +- Augueas config file editing library, plus python bindings. +- The Flask lightweight pythonic web framework +- basic UNIX utilities: top, uptime, hostname, etc +- ifupdown +- iproute2: supplies the 'ip' command +- procfs +- iw + +### Development + +To resolve dependancies on debian-based systems (wheezy or newer?): + + $ sudo apt-get install python-flask python-augeas ifupdown iw + +You can run try running the UI on any old Linux machine, just don't submit any +forms unless you want your network configuration clobbered: + + $ ./torouterui.py + @@ -1,5 +1,5 @@ -# The Plan for Now +# The Plan - imitate Tomato firmware style/layout - flask python web framework @@ -43,20 +43,28 @@ enable bridge common configuration -# Later +# Soon -- dhcp configuration -- enable/disable hotplug in interfaces when method changes - flesh out README - installation script +- display DHCP lease status of WAN port +- modify DHCP lease settings for ethernet LAN +- enable/disable hotplug in interfaces when method changes + +# Then + - debian packaging - admin authentication scheme +- only listen on local ethernet interface (enforce with firewall?) - not-root permissions scheme for: interfaces, tor, wireless, ssh keys + +# Later + - firewall configuration port forwarding enable remote login -- historical bandwidth etc charts with mrtg -- realtime charts with http://www.flotcharts.org/ or similar - i18n: http://packages.python.org/Flask-Babel/ - OONI -- only listen on local ethernet interface (enforce with firewall?) +- historical bandwidth etc charts with mrtg +- realtime charts with http://www.flotcharts.org/ or similar + diff --git a/admin.py b/admin.py deleted file mode 100644 index e69de29..0000000 --- a/admin.py +++ /dev/null diff --git a/config.py b/config.py deleted file mode 100644 index e69de29..0000000 --- a/config.py +++ /dev/null diff --git a/config.py.example b/config.py.example deleted file mode 100644 index e69de29..0000000 --- a/config.py.example +++ /dev/null diff --git a/helpers/administration.py b/helpers/administration.py deleted file mode 100644 index e69de29..0000000 --- a/helpers/administration.py +++ /dev/null diff --git a/helpers/wireless.py b/helpers/wireless.py deleted file mode 100644 index e69de29..0000000 --- a/helpers/wireless.py +++ /dev/null |