The Onion Name System - hidden service functionality
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
debian
src
.gitignore
.travis.yml
LICENSE
README.md
checkBuild.sh
devBuild.sh

README.md

#OnioNS - the Onion Name System

Tor-Powered Distributed DNS for Tor Hidden Services

OnioNS is a distributed, privacy-enhanced, metadata-free, and highly usable DNS for Tor hidden services. OnioNS allows hidden service operators to select a meaningful and globally-unique domain name for their service, which users can then reference from the Tor Browser. The system is powered by the Tor network, relies on a distributed database, and provides anonymity to both operators and users. This project aims to address the major usability issue that has been with Tor hidden services since their introduction in 2002.

Repository Details Build Status

This repository provides functionality for hidden service operator, such as the capability to claim an OnioNS domain name.

Supported Systems

Debian 7 and 8, Ubuntu 14.04 - 15.10, Mint 17 - 17.2, Fedora 21 - 23

Please see the OnioNS-common README for more information.

Installation

There are several methods to install the OnioNS software. The method of choice depends on your system. If you are on Ubuntu or an Ubuntu-based system (Lubuntu, Kubuntu, Mint) please use the PPA method. If you are running Debian Wheezy, please use the .deb method. Otherwise, for all other distributions, please install from source.

  • Install from PPA
  1. sudo add-apt-repository ppa:jvictors/tor-dev
  2. sudo apt-get update
  3. sudo apt-get install tor-onions-hs

This is the recommended method as it's very easy to stay up-to-date with my releases.

  • Install from .deb file

I provide builds for Debian Wheezy in the Releases section for several architectures. For other architectures, you may download from my PPA.

  • Install from source
  1. Install tor-onions-common by following these instructions.
  2. Download and extract the latest release from the Releases page.
  3. (mkdir build; cd build; cmake ../src; make; sudo make install)

If you are actively developing OnioNS, I have actively prepared two scripts, devBuild.sh and checkBuild.sh. Please see them for more information.

You can cleanup your build with rm -rf build

Usage

The hidden service edition of the OnioNS software is primarily a command-line utility. Currently it supports the ability to claim a domain name, a number of sub-domains, and send this information over a Tor circuit to the OnioNS network.

  1. Create a hidden service. See this guide for instructions on how to do this. As this is beta software, I do not recommend using a valuable hidden service in production, so I recommend making a new one for testing purposes.
  2. onions-hs --hsKey /var/lib/tor/hidden_service/private_key
  3. Follow the on-screen instructions. You may claim a single .tor domain (which will point to your hidden service) and up to 24 subdomains, which must point to a .tor or .onion address of your choosing.

A manpage is available for your convenience.

Minimum System Requirements

1 CPU core, 1 MB of free disk space, and N * 128 MB of available RAM where N is the number of available CPU cores. Please add "-w 1" if you have more than one CPU core but less than N * 128 MB available RAM. This can sometimes be the case if your HS is hosted on a minuscule VM.

Bug Reporting

Please open a ticket on Github. If you do not have a Github account, please contact kernelcorn on #tor-dev on OFTC IRC, or email kernelcorn at riseup dot net. Please follow the same process for filing enhancement requests. I use PGP key 0xC20BEC80. I accept pull requests if you want to contribute.