The Enterprise Onion Toolkit
 
 
 
 
 
 
Go to file
Alec Muffett 83762af937 commit: more docs 2017-02-01 12:01:29 +00:00
secrets.d commit: 2017-02-01 08:38:03 +00:00
templates.d commit: proxy buffers 2017-02-01 09:56:44 +00:00
tools commit: simplify demos, fix start/stop perms 2017-02-01 09:35:54 +00:00
.gitignore commit: fix ssl listener, better bounce, hello-onion also takes underscore 2017-02-01 09:00:51 +00:00
000-setup-osx.sh commit: more docs, and a slight rearrangement of the osx setup script 2017-02-01 11:39:26 +00:00
001-configure-demo.sh commit: 2017-02-01 08:38:03 +00:00
LICENSE Initial commit 2017-02-01 08:19:04 +00:00
README.md commit: more docs 2017-02-01 12:01:29 +00:00
onion-tk.sh commit: fic name change for config script 2017-02-01 08:40:45 +00:00

README.md

The Enterprise Onion Toolkit

eotk (c) 2017 Alec Muffett

Status

The code is currently pre-alpha - too hacky for words. It will improve.

The goal is to provide a tool for prototyping, and eventually deploying at scale, HTTP and HTTPS onion sites to provide official presence for popular websites.

The results are certainly impactful upon security, pose all manner of risk; set them up only for your own sites or for sites which do not require login credentials of any kind.

The resulting NGINX configs are probably buggy or not terribly well tuned; please consider this project to be very much "early days", but I shall try not to mess with the configuration file format.

The softmap support is untested, and needs some more work to make it nice to launch and integrate with OnionBalance; please avoid it for the moment.

Usage Notes

When using the resulting onions over HTTP/SSL, you will be using wildcard self-signed SSL certificates - you will encounter many "broken links" which are due to the SSL certificate not being valid.

This is expected and proper behaviour.

For any domain (eg: www.foofoofoofoofoof.onion) the EOTK provides a fixed url:

  • https://www.foofoofoofoofoof.onion/hello-onion/

...which is internally served by the NGINX proxy and provides a fixed point for SSL certificate acceptance; inside TorBrowser another effective solution is to open all the broken links, images and resources "in a new Tab" and accept the certificate there.

In production, of course, one would expect to use an SSL EV certificate to provide identity and assurance to an onion site.

Requirements

Installation: OSX

Currently works on OSX with Homebrew:

  • install homebrew - http://brew.sh/
  • git clone https://github.com/alecmuffett/eotk.git
  • cd eotk
  • sh ./000-setup-osx.sh # installs required software; if you're worried, check it first
  • sh ./001-configure-demo.sh # creates a working config file
  • sh ./onion-tk.sh config # creates tor & onion configuration files; lists onion sites
  • (review your config file - onion-tk.conf for interest)
  • ./projects.d/default.d/start.sh
  • (connect to one of the onion sites cited in the default project)
  • (play SSL-Certificate-Whackamole)
  • (browse a little)
  • ./projects.d/default.d/stop.sh # to stop the default project

Installation: Debian/Raspbian/Ubuntu

Work in progress. Feedback welcome.