Add integration of Acme.sh for SSL

LICENSE.md

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

scripts/bin/certs-daemon

@@ -0,0 +1,51 @@
+#!/usr/bin/env bash
+source "${SNAP}/init"
+
+DOMAIN=`snapctl get domain`
+
+if [ "${DOMAIN}" != "--not-set" ]; then
+    snapctl is-connected certs
+    if [ $? -ne 0 ]; then
+        logger "${SNAP_NAME} is disconnected (uuid: ${UUID})"
+        logger "${SNAP_NAME} domain is set to '--not-set'"
+        snapctl set domain="--not-set"
+        exit 1
+    fi
+
+    CERT_MATCH_NAME="${UUID}_${DOMAIN}"
+
+    readarray -d '' CERTIFICATES < <(find ${CERTS_DIR} -type f -name "*${CERT_MATCH_NAME}*" -print0)
+    logger "`expr ${#CERTIFICATES[@]} / 4` available for ${CERT_MATCH_NAME}"
+
+    if [ "${#CERTIFICATES[@]}" -ne 0 ]; then
+        gpg_start_agent
+        i=0
+        for CERTIFICATE in "${CERTIFICATES[@]}"; do
+            DEST="${SSL_DIR}/`basename "${CERTIFICATE}" ".gpg"`"
+            ORIG=""
+            if [ -f "${DEST}" ]; then
+                ORIG="`cat "${DEST}"`"
+            fi
+            gpg --batch --yes --output "${DEST}" --decrypt "${CERTIFICATE}"
+                
+            DIFF=`echo "${ORIG}" | diff "${DEST}" -`
+            RET=$?
+            if [ "${RET}" -ne 0 ]; then
+                echo "${ORIG}" > "${DEST}.backup"
+                (( i = $i + 1 ))
+            fi
+        done
+        if [ "${i}" -ne 0 ]; then
+            logger "Certificates (${DOMAIN}) changed for ${SNAP_NAME}-${UUID}, restart"
+            snapctl restart "${SNAP_NAME}.hass"
+        fi
+        gpg_close_agent
+    fi
+else
+    readarray -d '' CERTIFICATES < <(find ${CERTS_DIR} -type f -name "*${UUID}*" -print0)
+
+    if [ "${#CERTIFICATES[@]}" -ne 0 ]; then
+        logger "> `expr ${#CERTIFICATES[@]} / 4` available for ${SNAP_NAME} (uuid: ${UUID})"
+        logger "> Consider setting your domain with 'sudo snap set ${SNAP_NAME} domain=\"domain.tld\"'"
+    fi
+fi

scripts/bin/slot-certs

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+source "${SNAP}/init"
+
+exec $@

scripts/config/init

@@ -0,0 +1,43 @@
+#!/usr/bin/env bash
+
+CERTS_DIR="${SNAP_DATA}/certs"
+SSL_DIR="${SNAP_DATA}/.ssl"
+UUID_FILE="${SNAP_DATA}/.install-id"
+
+if ! [[ -f "${UUID_FILE}" ]]; then
+    logger "Generate UUID for ${SNAP_NAME}"
+    uuid > "${UUID_FILE}"
+    logger "${SNAP_NAME} (uuid: `cat ${UUID_FILE}`)"
+fi
+
+UUID=`cat ${UUID_FILE}`
+
+DOMAIN=`snapctl get domain`
+if [ -z "${DOMAIN}" ]; then
+    DOMAIN="--not-set"
+fi
+
+snapctl set domain="${DOMAIN}"
+
+function gpg_start_agent {
+    gpg-agent 2> /dev/null
+    if [ $? -ne 0 ]; then
+        logger "GPG-agent not here"
+        gpg-agent --daemon 2> /dev/null
+        if [ $? -eq 0 ]; then
+            logger "GPG-agent started"
+            return 0
+        fi
+        logger "Failed starting GPG-agent"
+        return 1
+    fi
+    return 0
+}
+
+function gpg_close_agent {
+    PID=`ps -T | grep gpg-agent | head -n 1 | cut -d' ' -f1`
+    if [ -n "${PID}" ]; then
+        logger "Kill GPG-agent: ${PID}"
+        kill -9 "${PID}" >> /dev/null
+    fi
+}

scripts/hooks/configure

@@ -0,0 +1,29 @@
+#!/usr/bin/env bash
+
+source "${SNAP}/init"
+
+DOMAIN=`snapctl get domain`
+
+if [ -z "${DOMAIN}" ]; then
+    DOMAIN="--not-set"
+else
+    snapctl is-connected certs
+    if [ $? -eq 0 ]; then
+        HIT=`ls -Al "${SNAP_DATA}/certs/" | grep "${UUID}_${DOMAIN}" | wc -l`
+        if [ "${HIT}" -eq 0 ]; then
+            echo "No certificate available for"
+            echo "Snap: ${SNAP_NAME}"
+            echo "UUID: ${UUID}"
+            echo "Domain: ${DOMAIN}"
+            echo "See 'acme-sh' (snap install acme-sh)"
+            DOMAIN="--not-set"
+        fi
+    else 
+        "Slot 'certs' not connected"
+        echo "See 'acme-sh' (snap install acme-sh)"
+        echo "then 'snap connect acme-sh:certs ${SNAP_DATA}:certs'"
+        DOMAIN='--not-set'
+    fi 
+fi
+
+snapctl set domain="${DOMAIN}"

scripts/hooks/install

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+source "${SNAP}/init"
+logger "Running install ${SNAP_NAME} (uuid: ${UUID})"

scripts/hooks/post-refresh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+source "${SNAP}/init"
+logger "Running post-refresh ${SNAP_NAME} (uuid: ${UUID})"

scripts/hooks/prepare-slot-certs

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+source "${SNAP}/init"
+
+if ! [[ -d "${CERTS_DIR}" ]]; then
+    logger "Creating dir ${CERTS_DIR}"
+    mkdir "${CERTS_DIR}"
+    chmod 0700 "${CERTS_DIR}"
+fi
+
+if ! [[ -d "${SSL_DIR}" ]]; then
+    logger "Creating local cert dir ${SSL_DIR}"
+    mkdir "${SSL_DIR}"
+fi
+
+logger "Creating connection from ${SNAP_NAME} (uuid: ${UUID})"
+
+KEY=`gpg --armor --export "${UUID}"`
+
+if [ -z "${KEY}" ]; then
+    gpg_start_agent
+    logger "Create GPG-key"
+    gpg --batch --no-tty --gen-key <<< "
+    %echo Generating a basic OpenPGP key
+    Key-Type: default
+    Subkey-Type: default
+    Name-Real: ${SNAP_NAME}
+    Name-Email: ${UUID}@${SNAP_NAME}.gpg
+    Name-comment: Generated from ${SNAP_NAME} for certs-slot
+    Expire-Date: 0
+    %no-protection
+    %commit
+    %echo done"
+    gpg_close_agent
+fi
+
+KEY=`gpg --armor --export "${UUID}"`
+if [ $? -ne 0 ]; then
+    echo "Failed to create GPG-key"
+    logger "Failed to create GPG-key for ${UUID}"
+    exit 1
+fi
+
+snapctl set :certs snapname="${SNAP_NAME}"
+snapctl set :certs uuid="${UUID}"
+snapctl set :certs pkey="${KEY}"
+
+logger "${SNAP_NAME}:certs (uuid: ${UUID}) prepared"

snap/hooks/connect-slot-components

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+snapctl restart "${SNAP_NAME}.hass"

snap/hooks/disconnect-slot-certs

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+source "${SNAP}/init"
+logger "Disconnect ${SNAP_NAME}:certs (uuid: ${UUID})"
+
+logger "TODO: Remove certificate?"
+logger "TODO: Remove GPG-key?"
+logger "TODO: Restart HASS?"
+
+rm -rf "${SSL_DIR}"
+snapctl restart "${SNAP_NAME}.hass"

snap/hooks/prepare-slot-certs

@@ -1,43 +0,0 @@
-#!/usr/bin/env bash
-
-CERTS_DIR="${SNAP_DATA}/certs"
-if ! [[ -d "${CERTS_DIR}" ]]; then
-    echo "Creating dir ${CERTS_DIR}"
-    mkdir "${CERTS_DIR}"
-    chmod 0700 "${CERTS_DIR}"
-fi
-
-KEYS_DIR="${SNAP_DATA}/.keys"
-
-if ! [[ "${KEYS_DIR}" ]]; then
-    echo "Creating dir ${KEYS_DIR}"
-    mkdir "${KEYS_DIR}"
-fi
-
-UUID_FILE="${KEYS_DIR}/.install-id"
-if ! [[ -f "${UUID_FILE}" ]]; then
-    echo "Generating UUID"
-    uuid > ${UUID_FILE}
-    chmod 0600 "${UUID_FILE}"
-fi
-
-UUID=`cat "${UUID_FILE}"`
-
-echo "Generating RSA-keypair"
-
-gpg --list-key "${UUID}" 2> /dev/null
-
-if [[ $? -ne 0 ]]; then
-    gpg --batch --gen-key <<< "%no-protection
-    Key-Type: DSA
-    Key-Length: 2048
-    Name-Real: ${UUID}
-    Expire-Date: 0"
-fi
-
-snapctl set :certs snapname="${SNAP_NAME}"
-snapctl set :certs uuid="${UUID}"
-snapctl set :certs pkey="`pgp --armor --export ${UUID}`"
-
-echo "${SNAP_NAME}:certs prepared"
-exit 1

snap/hooks/prepare-slot-components

@@ -1,8 +1,9 @@
 #!/usr/bin/env bash
 
+logger "Connect 'custom_components' (HACS) to ${SNAP_NAME}"
 CC="${SNAP_DATA}/custom_components"
 
 if ! [[ -d "${CC}" ]]; then
-    echo "Creating dir ${CC}"
+    logger "Creating dir ${CC}"
     mkdir "${CC}"
 fi

snap/hooks/unprepare-slot-components

@@ -1,5 +1,6 @@
 #!/urs/bin/env bash
 
+logger "Disconnect 'custom_components' (HACS) from ${SNAP_NAME}"
 CC="${SNAP_DATA}/custom_components"
-echo "Removing ${CC}"
+logger "Removing ${CC}"
 rm -rf "${CC}"

snap/snapcraft.yaml

@@ -5,6 +5,12 @@ description: |
     Home Assistant is a home automation platform running on Python 3. 
     It is able to track and control all devices at home and offer a 
     platform for automating control.
+
+    This version supports integrations with
+    - HACS: see 'home-assistant-hacs' (custom_components)
+    - acme.sh: see 'acme-sh' (SSL-certificates)
+
+    Also see 'ddclient-snap' to easily update your DNS.
 base: core20
 grade: stable
 confinement: strict
@@ -30,6 +36,8 @@ slots:
 apps:
   hass:
     command: bin/hass --config $SNAP_DATA
+    command-chain:
+      - bin/slot-certs
     daemon: simple
     environment:
       PIP_USER: 1
@@ -43,6 +51,19 @@ apps:
       - physical-memory-control
     slots: 
       - components
+  certs-daemon:
+    command: bin/certs-daemon
+    daemon: oneshot
+    restart-condition: always
+    timer: 00:00-24:00/287
+    slots:
+      - certs
+
+hooks:
+  prepare-slot-certs:
+    plugs:
+      - network
+      - network-bind
 
 parts:
   homeassistant:
@@ -95,8 +116,28 @@ parts:
     override-build: |
       snapcraftctl build
       sed -i 's/include-system-site-packages = false/include-system-site-packages = true/g' $SNAPCRAFT_PART_INSTALL/pyvenv.cfg
-  internal:
-    plugin: nil
+  hooks:
+    plugin: dump
+    source: ./scripts/hooks
+    source-type: local
     stage-packages:
       - uuid
+      - libossp-uuid16
+      - libassuan0
       - gpg
+      - gpg-agent
+    organize:
+      configure: snap/hooks/configure
+      post-refresh: snap/hooks/post-refresh
+      prepare-slot-certs: snap/hooks/prepare-slot-certs
+  bins:
+    plugin: dump
+    source: ./scripts/bin
+    source-type: local
+    organize:
+      slot-certs: bin/slot-certs
+      certs-daemon: bin/certs-daemon
+  config:
+    plugin: dump
+    source: ./scripts/config
+    source-type: local