Add wireguard client.

wireguard-client/DOCS.md

@@ -0,0 +1,127 @@
+# Home Assistant Community Add-on: WireGuard Client
+
+[WireGuard®][wireguard] is an extremely simple yet fast and modern VPN that
+utilizes state-of-the-art cryptography. It aims to be faster, simpler, leaner,
+and more useful than IPsec, while avoiding the massive headache.
+
+It intends to be considerably more performant than OpenVPN. WireGuard is
+designed as a general-purpose VPN for running on embedded interfaces and
+supercomputers alike, fit for many different circumstances.
+
+Initially released for the Linux kernel, it is now cross-platform (Windows,
+macOS, BSD, iOS, Android) and widely deployable,
+including via an Hass.io add-on!
+
+WireGuard is currently under heavy development, but already it might be
+regarded as the most secure, easiest to use, and the simplest VPN solution
+in the industry.
+
+## Sponsor
+
+Please, if You want support this kind of projects:
+
+<a href="https://www.buymeacoffee.com/bigmoby" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
+
+Many Thanks,
+
+Fabio Mauro
+
+## Authors & contributors
+
+Fabio Mauro Bigmoby
+
+Project forked from [Wireguard add-on][original_project].
+
+For a full list of all authors and contributors,
+check [the contributor's page][contributors].
+
+## Installation
+
+WireGuard Client add-on is pretty simple, however, can be quite complex for user that isn't
+familiar with all terminology used. The add-on takes care of a lot of things
+for you (if you want).
+
+Follow the following steps for installation & a quick start:
+
+1. Search for the "WireGuard Client" add-on in the Supervisor add-on store
+   and install it.
+1. use the following configuration as example: 
+
+```yaml
+interface:
+  private_key: your-private-key
+  address: 10.6.0.2
+  dns:
+    - 8.8.8.8
+    - 8.8.4.4
+  post_up: iptables -t nat -A POSTROUTING -o wg0 -j MASQUERADE
+  post_down: iptables -t nat -D POSTROUTING -o wg0 -j MASQUERADE
+peers:
+  - public_key: your-public-key
+    pre_shared_key: your-preshared-key
+    endpoint: 'xxxxxxxxxxxxxxx.duckdns.org:51820'
+    allowed_ips:
+      - 10.6.0.0/24
+    persistent_keep_alive: 25
+```
+
+1. Save the configuration.
+1. Start the "WireGuard" add-on
+
+## WireGuard client status API
+
+This add-on provides a simple WireGuard status API. This API is not an
+official API, darn simple, and experimental, but does allow you to pull
+in data from the add-on into Home Assistant.
+
+With the use of the [Home Assistant RESTful][ha-rest] integration, one should
+be able to grab some interesting data from this add-on.
+
+Example:
+
+```yaml
+sensor:
+  - platform: rest
+    resource: http://a0d7b954-wireguard
+```
+
+At this moment, we do not have template or examples on how this could be
+used effectively with Home Assistant.
+If you have, sharing would be appreciated!
+
+## Authors & contributors
+
+The original setup of this repository is by [Fabio Mauro][bigmoby].
+
+This is a fork of Wireguard Add-on 
+
+## License
+
+MIT License
+
+Copyright (c) 2020-2021 Fabio Mauro
+
+Copyright (c) 2019-2020 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.
+
+[bigmoby]: https://github.com/bigmoby
+[wireguard]: https://www.wireguard.com
+[original_project]: https://github.com/hassio-addons/addon-wireguard
+[contributors]: https://github.com/bigmoby/addon-wireguard-client/graphs/contributors

wireguard-client/README.md

@@ -0,0 +1,33 @@
+# Home Assistant Bigmoby Add-on: WireGuard Client
+
+WireGuard: fast, modern, secure VPN tunnel.
+
+## About
+
+[WireGuard®][wireguard] is an extremely simple yet fast and modern VPN that
+utilizes state-of-the-art cryptography. It aims to be faster, simpler, leaner,
+and more useful than IPsec, while avoiding the massive headache.
+
+It intends to be considerably more performant than OpenVPN. WireGuard is
+designed as a general-purpose VPN for running on embedded interfaces and
+supercomputers alike, fit for many different circumstances.
+
+Initially released for the Linux kernel, it is now cross-platform (Windows,
+macOS, BSD, iOS, Android) and widely deployable,
+including via an Hass.io add-on!
+
+WireGuard is currently under heavy development, but already it might be
+regarded as the most secure, easiest to use, and the simplest VPN solution
+in the industry.
+
+## Sponsor
+
+Please, if You want support this kind of projects:
+
+<a href="https://www.buymeacoffee.com/bigmoby" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
+
+Many Thanks,
+
+Fabio Mauro
+
+[wireguard]: https://www.wireguard.com

wireguard-client/config.yaml

@@ -0,0 +1,56 @@
+---
+name: WireGuard Client
+version: 0.2.0
+slug: wireguard_client
+description: Fast, modern, secure Wireguard tunnel (client)
+url: https://github.com/bigmoby/addon-wireguard-client
+arch:
+  - aarch64
+  - amd64
+  - armhf
+  - armv7
+  - i386
+apparmor: true
+host_network: true
+init: false
+ports:
+  80/tcp: 80
+ports_description:
+  80/tcp: WireGuard client status API
+hassio_api: true
+privileged:
+  - NET_ADMIN
+devices:
+  - /dev/net/tun
+map:
+  - ssl:rw
+options:
+  interface:
+    private_key: ""
+    address: 10.6.0.2
+    dns: [ 8.8.8.8, 8.8.4.4]
+    post_up: "iptables -t nat -A POSTROUTING -o wg0 -j MASQUERADE"
+    post_down: "iptables -t nat -D POSTROUTING -o wg0 -j MASQUERADE"
+  peers:
+    - public_key: ""
+      pre_shared_key: ""
+      endpoint: "xxxxxx.duckdns.com:51820"
+      allowed_ips: [ "10.6.0.0/24" ]
+      persistent_keep_alive: "25"
+schema:
+  log_level: list(trace|debug|info|notice|warning|error|fatal)?
+  interface:
+    private_key: password?
+    address: str
+    dns:
+      - str?
+    post_up: str?
+    post_down: str?
+  peers:
+    - public_key: str?
+      pre_shared_key: str?
+      endpoint: str
+      allowed_ips:
+        - str
+      persistent_keep_alive: int
+image: "bigmoby/{arch}-addon-wireguard-client"