Skip to content

Latest commit

 

History

History
223 lines (158 loc) · 6.02 KB

Readme.md

File metadata and controls

223 lines (158 loc) · 6.02 KB
Raw

Self-signed SSL for https onion urls

License: AGPL v3

Note: there is a rewrite over here to separate the code into re-usable modules and improve logging, code quality and reduce the amount of duplicate code within this organisation.

Create your own httpS://example31415926535.onion websites, with your own self-signed https certificates, in a single command.

*The difference being that all those services are in the "trusted" list of all of your computers, phones and browsers, whereas your own certificate is not. That is why this project also adds your own root CA to those trusted lists.

Set up 2 onion domains and SSH on server

alt-text-1

Get the root CA and set up passwordless ssh into server

alt-text-2

Usage

Clone this repo on 2 devices;

  • server - a regular computer with Ubuntu, will host your onion websites
  • client - access the onion websites from this device

Setup Server

You can create 3 https onion domains, for 2 services, and an ssh access into the server, with:

./src/main.sh \
  --delete-onion-domain \
  --delete-projects-ssl-certs \
  --delete-root-ca-certs \
  --firefox-to-apt \
  --services 443:gitlab:443/9001:dash:9002/22:ssh:22 \
  --ssl-password somepassword \
  --get-onion-domain

This creates an ssh tunnel, and 2 dash plots that you can visit:

This is the default service that is created on your onion domain:

Get your public root ca certificate

You now have self-signed your SSL certificates for your onion domain(s) on your server.

Since it is not standard that you as a user have the authority to be an authority, you have to tell your devices to respect your new authority. This is done by adding your self-signed root ca (ca.crt) to your browser, or even computer. This is automated for you. You need the:

  • Ubuntu username of your server.
  • ssh onion of your server (shown in that last green line of the server setup gif).

Then run this on your client:

./src/main.sh \
 --1-domain-1-service \
 --setup-ssh-client \
 --get-root-ca-certificate \
 --set-server-username <Ubuntu username of your server> \
 --set-server-ssh-onion <server ssh onion>.onion

Passwordless SSH into server

As a side affect, you can now ssh into your server, from anywhere in the world, safely and passwordless:

torsocks ssh ubuntu_username@31415926535abc...onion

(It uses your unique, private & public ssh-key pair for authentication.)

Developer Requirements

(Re)-install the required submodules with:

chmod +x install-bats-libs.sh
./install-bats-libs.sh

Install:

sudo gem install bats
sudo apt install bats -y
sudo gem install bashcov
sudo apt install shfmt -y
pre-commit install
pre-commit autoupdate

Pre-commit

Run pre-commit with:

pre-commit run --all

Tests

Run the tests with:

bats test/*

Code coverage

bashcov bats test

CLI recorder

To update the two gifs in the above Readme, use:

./src/main.sh --record-cli ~/server
./src/main.sh --record-cli ~/client

To get the server.gif into your client, set up the server in qemu and ssh-copy it from your client with:

./src/main.sh \
 --setup-ssh-client \
 --set-server-username <Ubuntu username of your server> \
 --set-server-ssh-onion <server ssh onion>.onion \
 --get-server-gif

Starting QEMU (Optional)

Using qemu is not necessary, but it is a nice sandbox to give this code a try, keeping your own system nice and clean.

One can create an Ubuntu 22.10 virtual machine in qemu with:

sudo apt install qemu-system-x86 -y
mkdir -p ~/qemus
cd ~/qemus

# Download the ubuntu-22.04.2-desktop-amd64.iso into this directory.
#wget https://releases.ubuntu.com/jammy/ubuntu-22.04.2-desktop-amd64.iso
wget https://releases.ubuntu.com/lunar/ubuntu-23.04-desktop-amd64.iso

# Create the image in which the Ubuntu 22.04 VM will be created.
qemu-img create ubuntu22.img 30G

# Create the Ubuntu 2x.xx Ubuntu image.
qemu-system-x86_64 \
 --enable-kvm \
 -m 1024 \
 -machine smm=off \
 -cdrom $PWD/ubuntu-23.04-desktop-amd64.iso \
 -boot order=d ubuntu23.img

# Now manually install Ubuntu (TODO: automate, using kickstart).

And then run Ubuntu 22.04 in a sandbox on your device with:

qemu-system-x86_64 --enable-kvm -m 4096 -machine smm=off -boot order=d \
  ubuntu22*.img -smp 4 \
  -chardev qemu-vdagent,id=ch1,name=vdagent,clipboard=on \
  -device virtio-serial-pci \
  -device virtserialport,chardev=ch1,id=ch1,name=com.redhat.spice.0

Then press Ctrl+Alt+G to capture the keyboard (and mouse).

Help

Feel free to create an issue if you have any questions :)

How to help

An quick and easy way to contribute is to:

  • Reduce the output of the (main) script, make it more simple/silent.

And if you like this project, feel free to:

  • Pick an issue and fix it.
  • Create support for Windows and/or Mac.
  • Improve the test-coverage by writing more (meaningful) tests.
  • Move the developer instructions into a separate documentation, similar to: https://bats-core.readthedocs.io/en/stable/
  • Help make this repository Readme more simple. (To me this makes sense, but perhaps to a new person coming into this some context is missing. And I believe less is more in this case.)