Install and configure one or multiple Tor Onion Services (formerly known as Hidden Services).
Hostname and private key will be generated if not supplied as variable.
Hint: It may take up to one minute, until the service is announced in the tor network and reachable.
Be careful: Using the default 127.0.0.1 as Onion Service IP-address could possibly leak meta data: https://help.riseup.net/en/security/network-security/tor/onionservices-best-practices#be-careful-of-localhost-bypasses
Supports Next Gen Onion Services only if tor version >= 0.3.2.1!
Since Tor 0.3.5.0 HiddenServices v3 is the default. You have to set onion_version: 2 if you want to use former onion services.
Tested with Molecule, Docker, Vagrant and TravisCI.
# defaults file for onion
onion_active: True
onion_ipaddr: 127.0.0.1
onion_tor_apt_state: present
onion_services:
ssh:
onion_hostname:
onion_ports:
- [22, 22]
onion_authorized_clients: []
onion_private_key:
onions_configuration:
SocksPort: 9050
SocksPolicy: "reject *"
# List of auth cookies for connecting to Authenticated Tor Onion Services.
#
onion_hid_serv_auth: []
onion_monit_enabled: False
Download latest release with ansible-galaxy
ansible-galaxy install systemli.onion
- hosts: servers
roles:
- { role: systemli.onion }
onion_active: True
onion_ipaddr: 192.168.3.12
onion_services:
ssh:
onion_hostname:
onion_ports:
- [22, 22]
onion_private_key:
mail:
onion_hostname:
onion_ports:
- [25, 25] #[redirected_from, redirected_to]
- [587,587]
onion_private_key:
examplewithhostname:
onion_hostname: onionurl.onion
onion_ports:
- [25, 25]
- [587,587]
onion_private_key: |
-----BEGIN RSA PRIVATE KEY-----
the
private
key
-----END RSA PRIVATE KEY-----
absentonion:
onion_state: absent
onion_hostname: onionurl.onion
onion_ports:
- [25, 25]
- [587,587]
onion_private_key: |
-----BEGIN RSA PRIVATE KEY-----
the
private
key
-----END RSA PRIVATE KEY-----
#
# nextgeneration onion only available in tor >= 0.3.2.1
# https://trac.torproject.org/projects/tor/wiki/doc/NextGenOnions#Howtosetupyourownprop224service
#
nextgenonion:
onion_hostname:
onion_version: 3
onion_ports:
- [25, 25]
- [587,587]
onion_private_key:
#
# Example for torrc with special onion configurations
# such as Sandboxing, custom data directory, auth cookies ...
onion_services:
ssh:
onion_ports:
- [22, 22]
onion_authorized_clients:
- admin
onions_configuration:
SocksPort: 9050
SocksPolicy: "reject *"
RunAsDaemon: 1
# Enabling Sandbox for the first time may prevent
# the tor service from restarting. Make sure your
# SSH connection is not over Tor when enabling it.
Sandbox: 1
FetchDirInfoEarly: 1
FetchDirInfoExtraEarly: 1
DataDirectory: /var/lib/tor
# Hosts that specified `onion_authorized_clients` will generate
# auth cookies for restricted access. Collect those values from the
# hostname file and add them to the torrc for intended clients, e.g.
# the Ansible controller, via the list var below.
onion_hid_serv_auth:
- "r7w3xdf3r5smxokv.onion p0xMVci7ffeQFA4IWkcBxR # client: admin"
For developing and testing the role we use Travis CI, Molecule and Vagrant. On the local environment you can easily test the role with
Run local tests with:
molecule test
Requires Molecule, Vagrant and python-vagrant to be installed.For developing and testing the role we use Travis CI, Molecule and Vagrant. On the local environment you can easily test the role with
GPLv3