commit 414373fac02304d6d8c5ba5f30d9ec354fe445dc Author: McPcholkin Date: Wed Mar 27 15:50:46 2019 +0200 init commit diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..ef062af --- /dev/null +++ b/README.rst @@ -0,0 +1,27 @@ +=== +tor +=== + +Simple Salt formula to install unattended-upgrades on debian. + +.. note:: + + See the full `Salt Formulas installation and usage instructions + `_. + +Available states +================ + +.. contents:: + :local: + +``tor`` +----------------------- + +Install packets and setup config files. + +``tor.install`` +------------------------------- + +Only install packets. + diff --git a/pillar-example.sls b/pillar-example.sls new file mode 100644 index 0000000..a6bc2f8 --- /dev/null +++ b/pillar-example.sls @@ -0,0 +1,35 @@ +tor: + torrc: + SOCKSPort: '0.0.0.0:9050' + RelayBandwidthRate: '500 KBytes' + AccountingMax: '20 GBytes' + AccountingStart: 'day 00:00' + ContactInfo: '0xFFFFFFFF LOL ??<>??' + # no exits allowed + ExitPolicy: 'reject *:*' + ExitRelay: '0' + ControlSocket: '0' + MaxMemInQueues: '800 MB' + + torsocks: + TorAddress: '0.0.0.0' + + fingerprint: 'Unnamed 88888888888888888888888888888888888888888888' + + # base64 + ed25519_master_id_public_key: | + sOKsdsdsdsdsdsdsdsdsdsdsU5x9SDWcVn + hl58888888888888888888888888888 + + # base64 + ed25519_master_id_secret_key: | + PT098696986986986986986986986986986986986986986986986986986860fvfXct6B + nN7q1iIh65463543546354354354354354354354354354354563khAb + + secret_id_key: | + -----BEGIN RSA PRIVATE KEY----- + lksj;ljksdflksjedflslkfjdl;skjfglskdjfgl;sdjfglsdjfgl;sdjfglsdfj + szdklfjskldjfl;kasjdfl;jasdl;fajdfkjdkfjsdkjfkjdfadfjsdkfjlakdjf + -----END RSA PRIVATE KEY----- + + diff --git a/tor/config.sls b/tor/config.sls new file mode 100644 index 0000000..eef8501 --- /dev/null +++ b/tor/config.sls @@ -0,0 +1,151 @@ +{% from "tor/map.jinja" import map with context %} + +include: + - tor.repo + - tor.install + +deploy_tor_torrc: + file.managed: + - name: {{ map.config_torrc }} + - source: salt://{{ slspath }}/files/ini.jinja + - user: root + - group: root + - mode: 644 + - template: jinja + - defailts: + config: {{ map.torrc }} + - reguire: + - pkg: install_tor + - watch_in: + - service: install_tor + +deploy_tor_torsocks: + file.managed: + - name: {{ map.config_torsocks }} + - source: salt://{{ slspath }}/files/ini.jinja + - user: root + - group: root + - mode: 644 + - template: jinja + - defailts: + config: {{ map.torsocks }} + - reguire: + - pkg: install_tor + - watch_in: + - service: install_tor + +{% set fingerprint_path = map.torrc.DataDirectory + '/fingerprint' %} + +{% if not salt['file.contains'](fingerprint_path, salt['pillar.get']('tor:fingerprint', False) ) %} + +{% if salt['pillar.get']('tor:fingerprint', False) %} +deploy_tor_fingerprint: + file.managed: + - name: {{ map.torrc.DataDirectory }}/fingerprint + - contents_pillar: tor:fingerprint + - user: debian-tor + - group: debian-tor + - mode: 600 + - reguire: + - file: deploy_tor_torrc + - watch_in: + - service: install_tor +{% endif %} + +{% if salt['pillar.get']('tor:secret_id_key', False) %} +deploy_tor_secret_id_key: + file.managed: + - name: {{ map.torrc.DataDirectory }}/keys/secret_id_key + - contents_pillar: tor:secret_id_key + - user: debian-tor + - group: debian-tor + - mode: 600 + - reguire: + - file: deploy_tor_torrc + - watch_in: + - service: install_tor +{% endif %} + +{% if salt['pillar.get']('tor:ed25519_master_id_public_key', False) %} + +send_tor_master_id_public_key: + file.managed: + - name: /tmp/ed25519_master_id_public_key.base64 + - contents_pillar: tor:ed25519_master_id_public_key + - user: root + - group: root + - mode: 600 + - reguire: + - file: deploy_tor_torrc + - require_in: + - cmd: decode_tor_master_id_public_key + +decode_tor_master_id_public_key: + cmd.run: + - name: "base64 -d /tmp/ed25519_master_id_public_key.base64 > {{ map.torrc.DataDirectory }}/keys/ed25519_master_id_public_key" + - reguire: + - file: send_tor_master_id_public_key + - require_in: + - file: set_ownner_tor_master_id_public_key + +set_ownner_tor_master_id_public_key: + file.managed: + - name: {{ map.torrc.DataDirectory }}/keys/ed25519_master_id_public_key + - user: debian-tor + - group: debian-tor + - mode: 600 + - reguire: + - file: deploy_tor_torrc + - watch_in: + - service: install_tor + - reguire_in: + - file: clean_temp_tor_master_id_public_key + +clean_temp_tor_master_id_public_key: + file.absent: + - name: /tmp/ed25519_master_id_public_key.base64 + +{% endif %} + +{% if salt['pillar.get']('tor:ed25519_master_id_secret_key', False) %} + +send_tor_master_id_secret_key: + file.managed: + - name: /tmp/ed25519_master_id_secret_key.base64 + - contents_pillar: tor:ed25519_master_id_secret_key + - user: root + - group: root + - mode: 600 + - reguire: + - file: deploy_tor_torrc + - require_in: + - cmd: decode_tor_master_id_secret_key + +decode_tor_master_id_secret_key: + cmd.run: + - name: "base64 -d /tmp/ed25519_master_id_secret_key.base64 > {{ map.torrc.DataDirectory }}/keys/ed25519_master_id_secret_key" + - reguire: + - file: send_tor_master_id_secret_key + - require_in: + - file: set_ownner_tor_master_id_secret_key + +set_ownner_tor_master_id_secret_key: + file.managed: + - name: {{ map.torrc.DataDirectory }}/keys/ed25519_master_id_secret_key + - user: debian-tor + - group: debian-tor + - mode: 600 + - reguire: + - file: deploy_tor_torrc + - watch_in: + - service: install_tor + - reguire_in: + - file: clean_temp_tor_master_id_secret_key + +clean_temp_tor_master_id_secret_key: + file.absent: + - name: /tmp/ed25519_master_id_secret_key.base64 + +{% endif %} + +{% endif %} diff --git a/tor/defaults.yaml b/tor/defaults.yaml new file mode 100644 index 0000000..521eccf --- /dev/null +++ b/tor/defaults.yaml @@ -0,0 +1,246 @@ +tor: + pkgs: + - tor + service: tor + https_support_pkg: apt-transport-https + config_torrc: '/etc/tor/torrc' + config_torsocks: '/etc/tor/torsocks.conf' + repo_url: 'https://deb.torproject.org/torproject.org' + repo_key_url: 'https://deb.torproject.org/torproject.org/A3C4F0F979CAA22CDBA8F512EE8CBC9E886DDD89.asc' + fingerprint: False + + 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. + SOCKSPort: '9050' # Default: Bind to localhost:9050 for local connections. + + ## 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: 'accept6 FC00::/7' + #SOCKSPolicy: 'reject *' + SOCKSPolicy: 'accept *' + + ## 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. + + #HiddenServiceDir: '/var/lib/tor/hidden_service/' + #HiddenServicePort: '80 127.0.0.1:80' + + #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. + ## 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 + ORPort: '9001' + + + ## 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. + ## Nicknames must be between 1 and 19 characters inclusive, and must + ## contain only the characters [a-zA-Z0-9]. + #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 75 kilobytes per second. + ## 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 KBytes' # Throttle traffic to 100KB/s (800Kbps) + #RelayBandwidthBurst: '200 KBytes' # But allow bursts up to 200KB (1600Kb) + + ## 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 "40 GB" may allow up to 80 GB total before + ## hibernating. + ## + ## Set a maximum of 40 gigabytes each way per period. + #AccountingMax: '40 GBytes' + ## 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 potentially 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 allow the same ports on IPv4 and IPv6, write your rules + ## using accept/reject *. If you want to allow different ports on IPv4 and + ## IPv6, write your IPv6 rules using accept6/reject6 *6, and your IPv4 rules + ## using accept/reject *4. + ## + ## 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 the configured primary public IPv4 and IPv6 addresses, + ## and any public IPv4 and IPv6 addresses on any interface on the relay. + ## See the man page entry for ExitPolicyRejectPrivate if you want to allow + ## "exit enclaving". + ## + #ExitPolicy: 'accept *:6660-6667,reject *:*' # allow irc ports on IPv4 and IPv6 but no more + #ExitPolicy: 'accept *:119' # accept nntp ports on IPv4 and IPv6 as well as default exit policy + #ExitPolicy: 'accept *4:119' # accept nntp ports on IPv4 only as well as default exit policy + #ExitPolicy: 'accept6 *6:119' # accept nntp ports on IPv6 only 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' + + torsocks: + # Default Tor address and port. By default, Tor will listen on localhost for + # any SOCKS connection and relay the traffic on the Tor network. + TorAddress: '127.0.0.1' + TorPort: '9050' + + # Tor hidden sites do not have real IP addresses. This specifies what range of + # IP addresses will be handed to the application as "cookies" for .onion names. + # Of course, you should pick a block of addresses which you aren't going to + # ever need to actually connect to. This is similar to the MapAddress feature + # of the main tor daemon. + OnionAddrRange: '127.42.42.0/24' + + # SOCKS5 Username and Password. This is used to isolate the torsocks connection + # circuit from other streams in Tor. Use with option IsolateSOCKSAuth (on by + # default) in tor(1). TORSOCKS_USERNAME and TORSOCKS_PASSWORD environment + # variable overrides these options. + #SOCKS5Username: + #SOCKS5Password: + + # Set Torsocks to accept inbound connections. If set to 1, listen() and + # accept() will be allowed to be used with non localhost address. (Default: 0) + #AllowInbound: '1' + + # Set Torsocks to allow outbound connections to the loopback interface. + # If set to 1, connect() will be allowed to be used to the loopback interface + # bypassing Tor. If set to 2, in addition to TCP connect(), UDP operations to + # the loopback interface will also be allowed, bypassing Tor. This option + # should not be used by most users. (Default: 0) + #AllowOutboundLocalhost: '1' + + # Set Torsocks to use an automatically generated SOCKS5 username/password based + # on the process ID and current time, that makes the connections to Tor use a + # different circuit from other existing streams in Tor on a per-process basis. + # If set, the SOCKS5Username and SOCKS5Password options must not be set. + # (Default: 0) + #IsolatePID: '1' + + diff --git a/tor/files/ini.jinja b/tor/files/ini.jinja new file mode 100644 index 0000000..07a4cce --- /dev/null +++ b/tor/files/ini.jinja @@ -0,0 +1,29 @@ +{%- set exclude = [] -%} + +{%- macro set_config(config, spacer=' ') -%} +{% for parameter in config | sort -%} +{% if parameter not in exclude -%} +{% set value = config.get(parameter) -%} +{% if value is mapping -%} +{{ set_config(value) }} +{%- elif value is sequence and value is not string -%} +{% for item in value -%} +{{ parameter }}{{ spacer }}{{ item }} +{% endfor -%} +{%- elif value is not none -%} +{{ parameter }}{{ spacer }}{{ value }} +{% endif -%} +{% endif -%} +{% endfor -%} +{% endmacro -%} + +# +# **** DO NOT EDIT THIS FILE **** +# +# This file is managed by Salt +# + +{% if config -%} +{{ set_config(config) }} +{% endif -%} + diff --git a/tor/init.sls b/tor/init.sls new file mode 100644 index 0000000..c9533ff --- /dev/null +++ b/tor/init.sls @@ -0,0 +1,5 @@ + +include: + - tor.repo + - tor.install + - tor.config diff --git a/tor/install.sls b/tor/install.sls new file mode 100644 index 0000000..8b12704 --- /dev/null +++ b/tor/install.sls @@ -0,0 +1,16 @@ +{% from "tor/map.jinja" import map with context %} + +include: + - tor.repo + +install_tor: + pkg.installed: + - pkgs: {{ map.pkgs }} + - require: + - pkgrepo: install_tor_repo + service.running: + - name: {{ map.service }} + - restart: True + - enable: True + - require: + - pkg: install_tor diff --git a/tor/map.jinja b/tor/map.jinja new file mode 100644 index 0000000..1eb8eeb --- /dev/null +++ b/tor/map.jinja @@ -0,0 +1,10 @@ +{% import_yaml "tor/defaults.yaml" as defaults %} +{% import_yaml "tor/osfamilymap.yaml" as osfamilymap %} + +{% set map = salt['grains.filter_by'](defaults, + + merge=salt['grains.filter_by']( osfamilymap, grain='os_family', + merge=salt['pillar.get']('tor', {}), ), +base='tor') %} + + diff --git a/tor/osfamilymap.yaml b/tor/osfamilymap.yaml new file mode 100644 index 0000000..12bd0f7 --- /dev/null +++ b/tor/osfamilymap.yaml @@ -0,0 +1,9 @@ +Debian: + pkgs: + - tor + service: tor + config_file: '/etc/tor/torrc' + config_torsocks: '/etc/tor/torsocks.conf' + https_support_pkg: apt-transport-https + + diff --git a/tor/repo.sls b/tor/repo.sls new file mode 100644 index 0000000..0cc2acc --- /dev/null +++ b/tor/repo.sls @@ -0,0 +1,22 @@ +{% from "tor/map.jinja" import map with context %} +{% set osfamily = salt['grains.get']('os_family', False) %} + +{% if osfamily == 'Debian' %} +{% set codename = salt['grains.get']('lsb_distrib_codename') %} + +add_apt_https_support: + pkg.installed: + - name: {{ map.https_support_pkg }} + - require_in: + - pkgrepo: install_tor_repo + +install_tor_repo: + pkgrepo.managed: + - name: deb {{ map.repo_url }} {{ codename }} main + - file: /etc/apt/sources.list.d/tor.list + - key_url: {{ map.repo_key_url }} + - require: + - pkg: add_apt_https_support + + +{% endif %}