From 6c96fe5180c9b337d729c33822f74f2556d27706 Mon Sep 17 00:00:00 2001 From: meaz Date: Tue, 17 Jan 2023 14:25:11 +0000 Subject: [PATCH] tor (#38) Co-authored-by: muppeth Co-authored-by: meaz Co-authored-by: muppeth Reviewed-on: https://git.disroot.org/Disroot-Ansible/nginx/pulls/38 Reviewed-by: muppeth --- defaults/main.yml | 8 + handlers/main.yml | 5 + tasks/main.yml | 13 +- tasks/onion_vhost.yml | 43 +++++ tasks/tor.yml | 42 +++++ tasks/vhost.yml | 4 + templates/etc/nginx/nginx.conf.j2 | 4 +- templates/etc/nginx/sites-available/core.j2 | 9 +- templates/etc/tor/torrc.j2 | 195 ++++++++++++++++++++ 9 files changed, 320 insertions(+), 3 deletions(-) create mode 100644 tasks/onion_vhost.yml create mode 100644 tasks/tor.yml create mode 100644 templates/etc/tor/torrc.j2 diff --git a/defaults/main.yml b/defaults/main.yml index f3fbcc8..a83dc8c 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -75,3 +75,11 @@ letsencrypt_copy_certs: 'false' letsencrypt_copy_cert_from: - name: '' letsencrypt_dest: '' + +# TOR +enable_tor: 'true' +tor_apt: + - apt-transport-https + - tor + - deb.torproject.org-keyring +tor_server_names_hash_bucket_size: 128 diff --git a/handlers/main.yml b/handlers/main.yml index f2d5c1c..97c4ea8 100644 --- a/handlers/main.yml +++ b/handlers/main.yml @@ -9,3 +9,8 @@ systemd: name: nginx state: reloaded + +- name: restart tor + systemd: + name: tor + state: restarted diff --git a/tasks/main.yml b/tasks/main.yml index 87f8060..01b42a0 100644 --- a/tasks/main.yml +++ b/tasks/main.yml @@ -7,7 +7,18 @@ include_tasks: config.yml - name: "[NGINX] - Set SSL configuration" - include_tasks: ssl.yml + include: ssl.yml + +- name: '[NGINX] - Deploy TOR for onion hidden services' + include: tor.yml + when: enable_tor == 'true' + +- name: '[NGINX] - Create onion addresses' + include_tasks: 'onion_vhost.yml' + when: enable_tor == 'true' + loop: '{{ nginx_vhosts }}' - name: "[NGINX] - Create Vhosts configuration" include_tasks: vhost.yml + + diff --git a/tasks/onion_vhost.yml b/tasks/onion_vhost.yml new file mode 100644 index 0000000..a3245d8 --- /dev/null +++ b/tasks/onion_vhost.yml @@ -0,0 +1,43 @@ +--- + +- name: '[ONION] - register onion address' + slurp: + src: "/var/lib/tor/{{ item.name }}/hostname" + register: "onion_address" + when: item.state is defined and item.onion is defined and item.onion == 'true' + +- name: "[ONION] - Create vhosts" + template: + src: etc/nginx/sites-available/{{ item.template }}.j2 + dest: "{{ nginx_etc_dir }}/sites-available/{{ item.name }}.onion" + notify: + - reload nginx + when: item.state is defined and item.onion is defined and item.onion == 'true' + +- name: "[ONION] - Delete vhosts" + file: + path: "{{ nginx_etc_dir }}/sites-available/{{ item.name }}.onion" + state: absent + notify: + - reload nginx + when: item.state is defined and item.state == 'delete' and item.onion is defined and item.onion == 'true' + + +- name: "[ONION] - Enable vhosts" + file: + src: "{{ nginx_etc_dir }}/sites-available/{{ item.name }}.onion" + dest: "{{ nginx_etc_dir }}/sites-enabled/{{ item.name }}.onion" + state: link + notify: + - reload nginx + when: item.state is defined and item.state == 'enable' and item.onion is defined and item.onion == 'true' + + +- name: "[ONION] - Disable vhosts" + file: + path: "{{ nginx_etc_dir}}/sites-enabled/{{ item.name }}.onion" + state: absent + notify: + - reload nginx + when: item.state is defined and (item.state == 'disable' or item.state == 'delete') and item.onion is defined and item.onion == 'true' + diff --git a/tasks/tor.yml b/tasks/tor.yml new file mode 100644 index 0000000..3caddcb --- /dev/null +++ b/tasks/tor.yml @@ -0,0 +1,42 @@ +--- + + +- name: '[TOR INSTALLDEPS] - Add torproject apt key' + apt_key: + url: https://deb.torproject.org/torproject.org/A3C4F0F979CAA22CDBA8F512EE8CBC9E886DDD89.asc + keyring: /usr/share/keyrings/tor-archive-keyring.gpg + state: present + +- name: '[TOR INSTALLDEPS] - Add repository for torproject' + apt_repository: + repo: deb [signed-by=/usr/share/keyrings/tor-archive-keyring.gpg] https://deb.torproject.org/torproject.org {{ ansible_distribution_release }} main + state: present + filename: 'tor' + +- name: '[TOR INSTALLDEPS] - Add repository for torproject' + apt_repository: + repo: deb-src [signed-by=/usr/share/keyrings/tor-archive-keyring.gpg] https://deb.torproject.org/torproject.org {{ ansible_distribution_release }} main + state: present + filename: 'tor' + +- name: '[TOR INSTALLDEPS] - Install dependencies' + apt: + name: "{{ tor_apt }}" + update_cache: yes + + +- name: '[TOR CONFIGURE] - Deploy tor config' + template: + src: etc/tor/torrc.j2 + dest: "/etc/tor/torrc" + owner: root + group: root + mode: 0644 + notify: + restart tor + +- name: Restart tor + systemd: + name: tor + state: restarted + diff --git a/tasks/vhost.yml b/tasks/vhost.yml index dcb849e..3b27c44 100644 --- a/tasks/vhost.yml +++ b/tasks/vhost.yml @@ -1,5 +1,9 @@ --- +- name: "[NGINX] - Create vhosts" + set_fact: + enable_tor: 'false' + - name: "[NGINX] - Create vhosts" template: src: etc/nginx/sites-available/{{ item.template }}.j2 diff --git a/templates/etc/nginx/nginx.conf.j2 b/templates/etc/nginx/nginx.conf.j2 index 87cfc6e..730dced 100644 --- a/templates/etc/nginx/nginx.conf.j2 +++ b/templates/etc/nginx/nginx.conf.j2 @@ -18,7 +18,9 @@ events { http { types_hash_max_size {{ nginx_http_types_hash_max_size }}; include {{ nginx_etc_dir }}/mime.types; - +{% if enable_tor == 'true' %} + server_names_hash_bucket_size {{ tor_server_names_hash_bucket_size }}; +{% endif %} default_type {{ nginx_http_default_type }}; access_log {{ nginx_http_access_log }}; error_log {{ nginx_http_error_log }}; diff --git a/templates/etc/nginx/sites-available/core.j2 b/templates/etc/nginx/sites-available/core.j2 index e200d4d..f5aade1 100644 --- a/templates/etc/nginx/sites-available/core.j2 +++ b/templates/etc/nginx/sites-available/core.j2 @@ -8,6 +8,11 @@ {% block server_info %} ## SERVER INFO +{% if item.onion is defined and enable_tor == 'true' and onion_address | length > 0 %} +server { + listen unix:/var/run/{{ item.name }}.sock; + server_name {{ onion_address.content | b64decode }}.onion; +{% else %} server { server_name {% if item.name is string %}{{ item.name }}{% else %}{{ item.name | join(' ') }}{% endif %}; {% if item.proto == 'http' %} @@ -27,6 +32,7 @@ server { {{ htpasswd(item.htpasswd, 1) }} {% endif %} {% endif %} +{% endif %} {% endblock %} {% block root %} {% endblock %} @@ -176,7 +182,8 @@ server { return 301 https://{{ item.name }}$request_uri; } {% endif %} -{% if item.redirect_https is defined and item.redirect_https %} + +{% if item.redirect_https is defined and item.redirect_https and enable_tor != 'true' %} ## REDIRECTS diff --git a/templates/etc/tor/torrc.j2 b/templates/etc/tor/torrc.j2 new file mode 100644 index 0000000..4f3afb4 --- /dev/null +++ b/templates/etc/tor/torrc.j2 @@ -0,0 +1,195 @@ +## Configuration file for a typical Tor user +## Last updated 9 October 2013 for Tor 0.2.5.2-alpha. +## (may or may not work for much older or much newer versions of Tor.) +## +## Lines that begin with "## " try to explain what's going on. Lines +## that begin with just "#" are disabled commands: you can enable them +## by removing the "#" symbol. +## +## See 'man tor', or https://www.torproject.org/docs/tor-manual.html, +## for more options you can use in this file. +## +## Tor will look for this file in various places based on your platform: +## https://www.torproject.org/docs/faq#torrc + +## Tor opens a socks proxy on port 9050 by default -- even if you don't +## configure one below. Set "SocksPort 0" if you plan to run Tor only +## as a relay, and not make any local application connections yourself. +#SocksPort 9050 # Default: Bind to localhost:9050 for local connections. +#SocksPort 192.168.0.1:9100 # Bind to this address:port too. + +## Entry policies to allow/deny SOCKS requests based on IP address. +## First entry that matches wins. If no SocksPolicy is set, we accept +## all (and only) requests that reach a SocksPort. Untrusted users who +## can access your SocksPort may be able to learn about the connections +## you make. +#SocksPolicy accept 192.168.0.0/16 +#SocksPolicy reject * + +## Logs go to stdout at level "notice" unless redirected by something +## else, like one of the below lines. You can have as many Log lines as +## you want. +## +## We advise using "notice" in most cases, since anything more verbose +## may provide sensitive information to an attacker who obtains the logs. +## +## Send all messages of level 'notice' or higher to /var/log/tor/notices.log +#Log notice file /var/log/tor/notices.log +## Send every possible message to /var/log/tor/debug.log +#Log debug file /var/log/tor/debug.log +## Use the system log instead of Tor's logfiles +#Log notice syslog +## To send all messages to stderr: +#Log debug stderr + +## Uncomment this to start the process in the background... or use +## --runasdaemon 1 on the command line. This is ignored on Windows; +## see the FAQ entry if you want Tor to run as an NT service. +#RunAsDaemon 1 + +## The directory for keeping all the keys/etc. By default, we store +## things in $HOME/.tor on Unix, and in Application Data\tor on Windows. +#DataDirectory /var/lib/tor + +## The port on which Tor will listen for local connections from Tor +## controller applications, as documented in control-spec.txt. +#ControlPort 9051 +## If you enable the controlport, be sure to enable one of these +## authentication methods, to prevent attackers from accessing it. +#HashedControlPassword 16:872860B76453A77D60CA2BB8C1A7042072093276A3D701AD684053EC4C +#CookieAuthentication 1 + +############### This section is just for location-hidden services ### + +## Once you have configured a hidden service, you can look at the +## contents of the file ".../hidden_service/hostname" for the address +## to tell people. +## +## HiddenServicePort x y:z says to redirect requests on port x to the +## address y:z. + +{% for item in nginx_vhosts %} +{% if item.onion is defined and item.onion == 'true' %} +HiddenServiceDir /var/lib/tor/{{ item.name }}/ +HiddenServicePort {{ item.listen }} unix:/var/run/{{ item.name }}.sock +{% endif %} +{% endfor %} + +#HiddenServiceDir /var/lib/tor/other_hidden_service/ +#HiddenServicePort 80 127.0.0.1:80 +#HiddenServicePort 22 127.0.0.1:22 + +################ This section is just for relays ##################### +# +## See https://www.torproject.org/docs/tor-doc-relay for details. + +## Required: what port to advertise for incoming Tor connections. +#ORPort 9001 +## If you want to listen on a port other than the one advertised in +## ORPort (e.g. to advertise 443 but bind to 9090), you can do it as +## follows. You'll need to do ipchains or other port forwarding +## yourself to make this work. +#ORPort 443 NoListen +#ORPort 127.0.0.1:9090 NoAdvertise + +## The IP address or full DNS name for incoming connections to your +## relay. Leave commented out and Tor will guess. +#Address noname.example.com + +## If you have multiple network interfaces, you can specify one for +## outgoing traffic to use. +# OutboundBindAddress 10.0.0.5 + +## A handle for your relay, so people don't have to refer to it by key. +#Nickname ididnteditheconfig + +## Define these to limit how much relayed traffic you will allow. Your +## own traffic is still unthrottled. Note that RelayBandwidthRate must +## be at least 20 KB. +## Note that units for these config options are bytes per second, not bits +## per second, and that prefixes are binary prefixes, i.e. 2^10, 2^20, etc. +#RelayBandwidthRate 100 KB # Throttle traffic to 100KB/s (800Kbps) +#RelayBandwidthBurst 200 KB # But allow bursts up to 200KB/s (1600Kbps) + +## Use these to restrict the maximum traffic per day, week, or month. +## Note that this threshold applies separately to sent and received bytes, +## not to their sum: setting "4 GB" may allow up to 8 GB total before +## hibernating. +## +## Set a maximum of 4 gigabytes each way per period. +#AccountingMax 4 GB +## Each period starts daily at midnight (AccountingMax is per day) +#AccountingStart day 00:00 +## Each period starts on the 3rd of the month at 15:00 (AccountingMax +## is per month) +#AccountingStart month 3 15:00 + +## Administrative contact information for this relay or bridge. This line +## can be used to contact you if your relay or bridge is misconfigured or +## something else goes wrong. Note that we archive and publish all +## descriptors containing these lines and that Google indexes them, so +## spammers might also collect them. You may want to obscure the fact that +## it's an email address and/or generate a new address for this purpose. +#ContactInfo Random Person +## You might also include your PGP or GPG fingerprint if you have one: +#ContactInfo 0xFFFFFFFF Random Person + +## Uncomment this to mirror directory information for others. Please do +## if you have enough bandwidth. +#DirPort 9030 # what port to advertise for directory connections +## If you want to listen on a port other than the one advertised in +## DirPort (e.g. to advertise 80 but bind to 9091), you can do it as +## follows. below too. You'll need to do ipchains or other port +## forwarding yourself to make this work. +#DirPort 80 NoListen +#DirPort 127.0.0.1:9091 NoAdvertise +## Uncomment to return an arbitrary blob of html on your DirPort. Now you +## can explain what Tor is if anybody wonders why your IP address is +## contacting them. See contrib/tor-exit-notice.html in Tor's source +## distribution for a sample. +#DirPortFrontPage /etc/tor/tor-exit-notice.html + +## Uncomment this if you run more than one Tor relay, and add the identity +## key fingerprint of each Tor relay you control, even if they're on +## different networks. You declare it here so Tor clients can avoid +## using more than one of your relays in a single circuit. See +## https://www.torproject.org/docs/faq#MultipleRelays +## However, you should never include a bridge's fingerprint here, as it would +## break its concealability and potentionally reveal its IP/TCP address. +#MyFamily $keyid,$keyid,... + +## A comma-separated list of exit policies. They're considered first +## to last, and the first match wins. If you want to _replace_ +## the default exit policy, end this with either a reject *:* or an +## accept *:*. Otherwise, you're _augmenting_ (prepending to) the +## default exit policy. Leave commented to just use the default, which is +## described in the man page or at +## https://www.torproject.org/documentation.html +## +## Look at https://www.torproject.org/faq-abuse.html#TypicalAbuses +## for issues you might encounter if you use the default exit policy. +## +## If certain IPs and ports are blocked externally, e.g. by your firewall, +## you should update your exit policy to reflect this -- otherwise Tor +## users will be told that those destinations are down. +## +## For security, by default Tor rejects connections to private (local) +## networks, including to your public IP address. See the man page entry +## for ExitPolicyRejectPrivate if you want to allow "exit enclaving". +## +#ExitPolicy accept *:6660-6667,reject *:* # allow irc ports but no more +#ExitPolicy accept *:119 # accept nntp as well as default exit policy +#ExitPolicy reject *:* # no exits allowed + +## Bridge relays (or "bridges") are Tor relays that aren't listed in the +## main directory. Since there is no complete public list of them, even an +## ISP that filters connections to all the known Tor relays probably +## won't be able to block all the bridges. Also, websites won't treat you +## differently because they won't know you're running Tor. If you can +## be a real relay, please do; but if not, be a bridge! +#BridgeRelay 1 +## By default, Tor will advertise your bridge to users through various +## mechanisms like https://bridges.torproject.org/. If you want to run +## a private bridge, for example because you'll give out your bridge +## address manually to your friends, uncomment this line: +#PublishServerDescriptor 0