init

tor/CHANGELOG.md

@@ -0,0 +1,14 @@
+## What’s changed
+
+## ⬆️ Dependency updates
+
+- ⬆️ Bump brpaz/hadolint-action from v1.4.0 to v1.5.0 @dependabot (#67)
+- ⬆️ Bump frenck/action-addon-linter from 2 to 2.1 @dependabot (#68)
+- ⬆️ Bump actions/stale from 3.0.18 to 3.0.19 @dependabot (#69)
+- ⬆️ Bump frenck/action-addon-information from 1.0.0 to 1.1 @dependabot (#70)
+- ⬆️ Bump micnncim/action-label-syncer from 1.2.0 to 1.3.0 @dependabot (#71)
+- ⬆️ Bump docker/build-push-action from 2.4.0 to 2.5.0 @dependabot (#72)
+- ⬆️ Bump docker/setup-qemu-action from 1.1.0 to 1.2.0 @dependabot (#73)
+- ⬆️ Bump actions/cache from 2.1.5 to 2.1.6 @dependabot (#74)
+- ⬆️ Bump frenck/action-addon-information from 1.1 to 1.2.2 @dependabot (#76)
+- ⬆️ Upgrades add-on base image to v9.2.2 @frenck (#77)

tor/DOCS.md

@@ -0,0 +1,256 @@
+# Home Assistant Community Add-on: Tor
+
+This Tor add-on allows you to access you Home Assistant instance as an Onion site,
+trough [Tor's Hidden Service][tor-hidden-service] feature. With this feature
+enabled, you do not need to open your firewall ports or setup HTTPS to enable
+secure remote access.
+
+This is useful if you want to have:
+
+- Access your Home Assistant instance remotely without opening a firewall port
+  or setting up a VPN.
+- Don’t want to or know how to get an SSL/TLS certificate and HTTPS
+  configuration setup.
+- Want to block attackers from even being able to access/scan your port and
+  server at all.
+- Want to block anyone from knowing your home IP address and seeing your
+  traffic to your Home Assistant.
+
+The add-on also offers the possibility to open a Sock proxy into the
+Tor network. Allowing you to access Tor from any of your (SOCKS supporting)
+applications through your Home Assistant installation.
+
+## Installation
+
+The installation of this add-on is pretty straightforward and not different in
+comparison to installing any other Home Assistant add-on.
+
+1. Search for the "Tor" add-on in the Supervisor add-on store and install it.
+1. Start the "Tor" add-on
+1. Check the logs of the "Tor" add-on to see if everything went well. The log
+   will also display your Tor .onion address.
+
+## Configuration
+
+**Note**: _Remember to restart the add-on when the configuration is changed._
+
+Example add-on configuration:
+
+```yaml
+log_level: info
+socks: true
+hidden_services: true
+stealth: true
+client_names:
+  - haremote1
+  - haremote2
+ports:
+  - 8123
+```
+
+**Note**: _This is just an example, don't copy and past it! Create your own!_
+
+### Option: `log_level`
+
+The `log_level` option controls the level of log output by the addon and can
+be changed to be more or less verbose, which might be useful when you are
+dealing with an unknown issue. Possible values are:
+
+- `trace`: Show every detail, like all called internal functions.
+- `debug`: Shows detailed debug information.
+- `info`: Normal (usually) interesting events.
+- `warning`: Exceptional occurrences that are not errors.
+- `error`: Runtime errors that do not require immediate action.
+- `fatal`: Something went terribly wrong. Add-on becomes unusable.
+
+Please note that each level automatically includes log messages from a
+more severe level, e.g., `debug` also shows `info` messages. By default,
+the `log_level` is set to `info`, which is the recommended setting unless
+you are troubleshooting.
+
+These log level also affects the log levels of the Tor program.
+
+### Option: `socks`
+
+Setting this option to `true` opens port `9050` to listen for connections from
+SOCKS-speaking applications. Enabling this feature allows you to use other
+applications on your network to use the Tor network.
+
+**Note**: _The SOCKS protocol is unencrypted and (as we use it) unauthenticated,
+so exposing it in this way could leak your information to anybody watching your
+network, and allow anybody to use your computer as an open proxy._
+
+### Option: `hidden_services`
+
+The `hidden_services` options allows you to enable
+[Tor's Hidden Service][tor-hidden-service] feature in this add-on. You can offer
+a web server, SSH server, etc., without revealing your IP address to its users.
+In fact, because you don not use any public address, you can run a hidden
+service from behind your firewall.
+
+### Option: `stealth`
+
+The “stealth” entry above ensures traffic to and from your Home Assistant
+instance over Tor is hidden even from other nodes on the Tor network.
+
+Using a traditional Hidden Service, a hidden server publishes in the Tor network
+how to begin communication with it (not its real location). Tor uses a complex
+middle nodes link setup for bidirectional route anonymization; the server and
+client knows nothing about end point's location. A client asks the network how
+to reach a Hidden Service with this info.
+
+This option put the Tor Hidden Service in the authorize client mode. The
+hidden server publishes encrypted instructions on how to begin the
+communication, a client with the right key can decipher this info.
+If you are an authorized client, you only can locate the Hidden Service path
+and then try to establish a connection if you have this key.
+
+Enabling `stealth` can prevent a DDOS because if the client does not have the
+key, it can not find the path to the server. It does, however, require
+configuration of the client as well.
+
+### Option: `client_names`
+
+This option is required as soon as you enable the `stealth` option.
+
+Only clients that are listed here are authorized to access the hidden service.
+Valid client names are 1 to 16 characters long and only use characters in
+`A-Za-z0-9+-_` (no spaces). If this option is set, the hidden service is not
+accessible for clients without authorization anymore.
+
+Clients need to put this authorization data in their configuration file using
+HidServAuth.
+
+### Option: `ports`
+
+Configures hosts and ports to publish via a Tor Hidden Service.
+You can list multiple hosts and ports to publish.
+
+For example:
+
+```yaml
+ports:
+  - "homeassistant:8123:80"
+  - 22
+```
+
+The accepted syntaxs of this configuration is:
+
+- hostname:local_port:published_port `"homeassistant:8123:8080"`
+- local_ip:local_port:published_port `"192.168.1.60:8123:8080"`
+- hostname:local_port `"homeassistant:8123"`
+- local_port:published_port `"8123:8080"`
+- local_port `"8123"`
+
+If you do not define a published port, the local port will be used.
+If you do not define a hostname or IP adress `homeassistant` will be used.
+
+## Tor client access setup
+
+Using this add-on, you can access your Home Assistant instance over Tor from
+your laptop or mobile device, using Tor Browser and other software.
+
+However, with the `stealth` option enabled, the client would need extra
+configuration to be able to connect.
+
+Add the authentication cookie to your `torrc` client configuration on your
+laptop or mobile device. It would look like this:
+
+```bash
+HidServAuth abcdef1234567890.onion adEG02FAsdq/GAFeNSeLvc haremote1
+```
+
+For Tor Browser on Windows, Mac or Linux, you can find the torrc file here:
+`<tor browser install directory>/Browser/TorBrowser/tor/ssl/torrc`
+
+Once you have added the entry, restart the browser, and then browse to the
+"dot onion" site address to connect to your Home Assistant instance.
+
+For [Orbot: Tor on Android][orbot], add it in **Orbot** -> **Menu**
+-> **Settings** to the "Torrc Custom Config" entry. Restart Orbot, and then
+use the [Orfox browser app][orfox], and browse to the "dot onion" site name to
+access your Home Assistant instance. You can also use Orbot's VPN mode,
+to enable Tor access from any application on your device,
+such as Tasker or Owntracks.
+
+To our knowledge, there are currently no iOS apps available supporting the
+stealth feature.
+
+You can use the standard FireFox browser to access .onion domains, but you need
+to enable this in FireFix settings. In FireFox, type "about:config" in the
+address bar and click 'I accept the risk' to open the advanced settings.
+Search for "onion" to find the setting "network.dns.blockDotOnion" and toggle
+the setting so that it is set to "false". Now you should be able to access
+.onion sites.
+
+## Changelog & Releases
+
+This repository keeps a change log using [GitHub's releases][releases]
+functionality.
+
+Releases are based on [Semantic Versioning][semver], and use the format
+of `MAJOR.MINOR.PATCH`. In a nutshell, the version will be incremented
+based on the following:
+
+- `MAJOR`: Incompatible or major changes.
+- `MINOR`: Backwards-compatible new features and enhancements.
+- `PATCH`: Backwards-compatible bugfixes and package updates.
+
+## Support
+
+Got questions?
+
+You have several options to get them answered:
+
+- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on
+  support and feature requests.
+- The [Home Assistant Discord chat server][discord-ha] for general Home
+  Assistant discussions and questions.
+- The Home Assistant [Community Forum][forum].
+- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]
+
+You could also [open an issue here][issue] GitHub.
+
+## Authors & contributors
+
+The original setup of this repository is by [Franck Nijhof][frenck].
+
+For a full list of all authors and contributors,
+check [the contributor's page][contributors].
+
+## License
+
+MIT License
+
+Copyright (c) 2017-2021 Franck Nijhof
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+[contributors]: https://github.com/hassio-addons/addon-tor/graphs/contributors
+[discord-ha]: https://discord.gg/c5DvZ4e
+[discord]: https://discord.me/hassioaddons
+[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-tor/33822?u=frenck
+[frenck]: https://github.com/frenck
+[issue]: https://github.com/hassio-addons/addon-tor/issues
+[orbot]: https://guardianproject.info/apps/orbot
+[orfox]: https://guardianproject.info/apps/orfox
+[reddit]: https://reddit.com/r/homeassistant
+[releases]: https://github.com/hassio-addons/addon-tor/releases
+[semver]: http://semver.org/spec/v2.0.0.htm
+[tor-hidden-service]: https://www.torproject.org/docs/hidden-services.html.en

tor/README.md

@@ -0,0 +1,47 @@
+# Home Assistant Community Add-on: Tor
+
+[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield]
+
+[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum]
+
+[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors]
+
+[![Support Frenck on Patreon][patreon-shield]][patreon]
+
+Protect your privacy and access Home Assistant via Tor.
+
+## About
+
+This Tor add-on allows you to access you Home Assistant instance as an Onion site,
+trough [Tor's Hidden Service][tor-hidden-service] feature. With this feature
+enabled, you do not need to open your firewall ports or setup HTTPS to enable
+secure remote access.
+
+This is useful if you want to have:
+
+- Access your Home Assistant instance remotely without opening a firewall port
+  or setting up a VPN.
+- Don’t want to or know how to get an SSL/TLS certificate and HTTPS
+  configuration setup.
+- Want to block attackers from even being able to access/scan your port and
+  server at all.
+- Want to block anyone from knowing your home IP address and seeing your
+  traffic to your Home Assistant.
+
+The add-on also offers the possibility to open a Sock proxy into the
+Tor network. Allowing you to access Tor from any of your (SOCKS supporting)
+applications through your Home Assistant installation.
+
+[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
+[discord]: https://discord.me/hassioaddons
+[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
+[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-tor/33822?u=frenck
+[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png
+[github-sponsors]: https://github.com/sponsors/frenck
+[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg
+[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png
+[patreon]: https://www.patreon.com/frenck
+[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
+[release-shield]: https://img.shields.io/badge/version-v3.0.5-blue.svg
+[release]: https://github.com/hassio-addons/addon-tor/tree/v3.0.5
+[tor-hidden-service]: https://www.torproject.org/docs/hidden-services.html.en

tor/config.json

@@ -0,0 +1,47 @@
+{
+  "name": "Tor",
+  "version": "3.0.5",
+  "slug": "tor",
+  "description": "Protect your privacy and access Home Assistant via Tor.",
+  "url": "https://github.com/hassio-addons/addon-tor",
+  "startup": "services",
+  "arch": [
+    "aarch64",
+    "amd64",
+    "armhf",
+    "armv7",
+    "i386"
+  ],
+  "init": false,
+  "ports": {
+    "9050/tcp": 9050
+  },
+  "ports_description": {
+    "9050/tcp": "Tor SOCKS proxy port"
+  },
+  "map": [
+    "ssl:rw"
+  ],
+  "options": {
+    "socks": false,
+    "hidden_services": true,
+    "stealth": false,
+    "client_names": [],
+    "ports": [
+      "8123"
+    ]
+  },
+  "schema": {
+    "log_level": "list(trace|debug|info|notice|warning|error|fatal)?",
+    "socks": "bool",
+    "hidden_services": "bool",
+    "stealth": "bool",
+    "client_names": [
+      "match(^[A-Za-z0-9+-_]{1,16}$)"
+    ],
+    "ports": [
+      "match(^(.*:)?(?:[0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])?$)"
+    ]
+  },
+  "image": "ghcr.io/hassio-addons/tor/{arch}"
+}