Code style and shellcheck

README.md

@@ -18,7 +18,7 @@ Falls `/etc/foodoord.conf` nicht vorhanden ist:
 
 ### Dateiliste
 
-Der Deamon besteht aus folgenden Dateien.
+Der Daemon besteht aus folgenden Dateien.
 
 * foodoor
 * foodoord
@@ -44,7 +44,7 @@ Das IdentityFile ist der Deploy-SSH-Key, der im [Repo](https://git.chaospott.de/
 ### Schlüsselupdate
 
 `foodoor-update-keydb`
-Aktualisiert die die Schlüssel auf der Tür und baut die *Authorized_Keys* für die User *open* und *close*. Keys die nicht dem OpenSSH-Format mit 4096 bit entsprechen, werden ignoriert. Wenn das Script von Hand aufgerufen wird, werden die betroffenen Keys angezeigt. Über einen Cronjob werden die Keys alle **5 Min aktualisiert**.
+Aktualisiert die Schlüssel auf der Tür und baut die *Authorized_Keys* für die User *open* und *close*. Keys die nicht dem OpenSSH-Format mit 4096 bit entsprechen, werden ignoriert. Wenn das Script von Hand aufgerufen wird, werden die betroffenen Keys angezeigt. Über einen Cronjob werden die Keys alle **5 Min aktualisiert**.
 
 ### Schlüsselformate
 
@@ -56,30 +56,30 @@ Der foodoord akzeptiert nur Pub-Keys im *OpenSSH2-Format*. Keys lassen sich unte
 
 * Mit `ssh-keygen -b 4096` lassen sich Keys generieren.
 * `ssh-add $Pfad_zum_Key` fügt den Key dem ssh-Agent hinzu. Die Option `ssh-add -l` zeigt geladene Keys an.
-* `ssh-kegen -l -f $Pfad_zum_Key ` gibt den Fingerprint und andere Informationen zurück.
+* `ssh-kegen -l -f $Pfad_zum_Key` gibt den Fingerprint und andere Informationen zurück.
 
 
-####Keys konvertieren(PuTTy>OpenSSH):####
+#### Keys konvertieren (PuTTy > OpenSSH):
 
-* `ssh-keygen -i $Pfad_zum_Key > $Pfad_neuer_Pfad.pub<` liest ssh2-kompatible Keys(RFC 4716) ein und speichert diese im OpenSSH-Format.
+* `ssh-keygen -i $Pfad_zum_Key > $Pfad_neuer_Pfad.pub<` liest ssh2-kompatible Keys (RFC 4716) ein und speichert diese im OpenSSH-Format.
 
 
-###PuTTy###
+### PuTTy
 
 Da die Tür nur Keys im OpenSSH-Format verträgt, dürfen auch mit Putty nur OpenSSH-Keys genutzt werden.
 
-###Keys generieren (OpenSSH-Format mit PuttyGen):###
+#### Keys generieren (OpenSSH-Format mit PuttyGen):
 
 1. PuTTYgen öffnen
 2. Unten "Number of Bits in a generated Key:" 4096 eintippen
 3. "Generate" klicken um Key zu generieren
-4. Nach dem generieren oben im Menu "Conversions" > "Export OpenSSH-Key"
+4. Nach dem Generieren oben im Menu "Conversions" > "Export OpenSSH-Key"
 5. Speichern
 
 Es ist zu beachten, dass Putty den PrivateKey im Putty-Format benötigt! Das heißt, falls der generierte Key vor dem Export nicht gespeichert wurde, muss der private Key noch konvertiert werden, siehe nächster Punkt!
 
 
-###Keys konvertieren(OpenSSH>PuTTy):###
+#### Keys konvertieren (OpenSSH > PuTTy):
 
 1. PuTTYgen öffnen
 2. "Load" drücken
@@ -88,8 +88,7 @@ Es ist zu beachten, dass Putty den PrivateKey im Putty-Format benötigt! Das hei
 5. Speichern
 
 
-
+## Hardware
-##Hardware
 
 ### Input:
 
@@ -97,7 +96,6 @@ Es ist zu beachten, dass Putty den PrivateKey im Putty-Format benötigt! Das hei
 * Klingel
 * Statustaster
 
-
 ### Output:
 
 * Status LEDs

build-package

@@ -1,3 +1,3 @@
 #!/bin/bash
-VERSION=3.0.4
+VERSION=3.1.0
-dpkg-deb --root-owner-group -b debian foodoord_${VERSION}_all.deb 
+dpkg-deb --root-owner-group -b debian "foodoord_${VERSION}_all.deb"

debian/DEBIAN/postinst

@@ -1,4 +1,5 @@
 #!/bin/bash
+
 echo "Creating group and users.."
 groupadd foodoor
 useradd -M -d /var/lib/foodoor/close -G foodoor -s /bin/sh close
@@ -20,8 +21,8 @@ chown root:foodoor /state
 chmod 664 /state
 
 echo "##################"
-while [ "$prompt" != "oben" -a "$prompt" != "unten" ]; do
+while [ "$prompt" != "oben" ] && [ "$prompt" != "unten" ]; do
- read -p "Sind wir oben oder unten? (oben, unten): " prompt
+    read -r -p "Sind wir oben oder unten? (oben, unten): " prompt
 done
 echo "##################"
 
@@ -30,6 +31,6 @@ pip install pifacecommon pifacedigitalio
 
 echo "Enabling and starting systemd-Services"
 systemctl daemon-reload
-systemctl enable foodoord@$prompt
+systemctl enable "foodoord@$prompt"
-systemctl restart foodoord@$prompt
+systemctl restart "foodoord@$prompt"
-systemctl status foodoord@$prompt
+systemctl status "foodoord@$prompt"

debian/etc/systemd/system/foodoord@.service

@@ -9,7 +9,5 @@ ExecStart=/usr/sbin/foodoord_%i
 Restart=on-failure
 RestartSec=5s
 
-
 [Install]
 WantedBy=multi-user.target
-

debian/usr/sbin/foodoor

@@ -1,37 +1,34 @@
 #!/bin/sh
+
 set -e
 
 PIPE_PATH=/var/run/foodoord.pipe
 
-if [ ! -e $PIPE_PATH ]
+if [ ! -e $PIPE_PATH ]; then
- then
     echo "Pipe missing. Check daemon status."
     exit 1
 fi
 
-action="$1"
+action=$1
-isTriggerActivated="0"
+isTriggerActivated=0
 
-if [ -z "$action" ]
+if [ -z "$action" ]; then
- then
+    action=$SSH_ORIGINAL_COMMAND
-  action="$SSH_ORIGINAL_COMMAND"
+    isTriggerActivated=1
-  isTriggerActivated="1"
 fi
 
 case $action in
-  close|open)
+close | open)
-    echo $action | tee $PIPE_PATH |sed 's/open/UNLOCKED/;s/close/LOCKED/' >  /state
+    echo "$action" | tee "$PIPE_PATH" | sed 's/open/UNLOCKED/;s/close/LOCKED/' > /state
     ;;
-  status)
+status) ;;
-   ;;
+*)
-  *)
+    echo "Usage: $(basename "$0") { close, open, status }"
-    echo "Usage: $(basename $0) { close, open, status }"
     exit 1
     ;;
 esac
 
-if [ $isTriggerActivated -eq 1 ]
+if [ $isTriggerActivated -eq 1 ]; then
-then
     cat /state
     sleep 2
 fi

debian/usr/sbin/foodoor-update-keydb

@@ -4,60 +4,51 @@ set -e
 export PATH="/usr/bin:/bin:/usr/sbin:/sbin"
 
 dest=/var/run/foodoor-keys
-temp_outfile="$dest.tmp"
+temp_outfile=$dest.tmp
 
-
+if [ ! -e "$dest/.git/config" ]; then
-if [ ! -e "${dest}/.git/config" ]
-then
     #echo "Repo does not exist, trying to clone..."
-  ( cd /var/run && git clone --quiet --single-branch --depth=1 ssh://git.chaospott.de/Keyverwaltung/foodoor-keys.git "${dest}" )
+    git -C "$dest" clone --quiet --single-branch --depth=1 ssh://git.chaospott.de/Keyverwaltung/foodoor-keys.git "$dest"
 else
     #echo "Repo exists, updating..."
-  ( cd "${dest}" && git fetch --quiet && git merge --quiet origin/master master )
+    git -C "$dest" fetch --quiet && git -C "$dest" merge --quiet origin/master master
 fi
 
-rm -f ${temp_outfile}
+rm -f "$temp_outfile"
-  find "${dest}/keys" -name '*.pub' | sort | \
+find "$dest/keys" -type f -name '*.pub' | sort |
-    while read keyfile
+    while read -r keyfile; do
-    do
+        if ssh-keygen -l -f "$keyfile" &> /dev/null; then
-      ssh-keygen -l -f ${keyfile} &> /dev/null
+            keyinfo=$(ssh-keygen -l -f "$keyfile")             # The whole key information
-      if [ $? -eq 0 ]; then
+            crypto=$(echo "$keyinfo" | sed 's/.*(\(.*\))/\1/') # Looks like "RSA" or "ED25519"
-        valid=false
+            key_length=$(echo "$keyinfo" | cut -d" " -f1)
-        keyinfo=$(ssh-keygen -l -f ${keyfile}) # The whole key information
-        crypto=$(echo "${keyinfo}" | sed 's/.*(\(.*\))/\1/') # Looks like "RSA" or "ED25519"
-        key_length=$(echo "${keyinfo}" | cut -d" " -f1) 
 
-        if [ "${crypto}" == "RSA" ]; then
+            if [ "$crypto" == "RSA" ]; then
-
+                if [ "$key_length" -lt 4096 ]; then
-          if [ ${key_length} -lt 4096 ]; then
+                    echo "Key size of key $keyfile less than 4096. Not adding it to key database." >&2
-            echo "Key size of key ${keyfile} not equal to 4096. Not adding it to key database." >&2
                     continue
+                fi
+                # valid
+            elif [ "$crypto" == "ED25519" ]; then
+                : # valid
             else
-            valid=true
+                continue
             fi
 
-        elif [ "${crypto}" == "ED25519" ]; then
+            echo "command=\"/usr/sbin/foodoor \$action \",no-port-forwarding,no-X11-forwarding,no-agent-forwarding $(sed 's/\r//g' "$keyfile") $keyfile" >> $temp_outfile
-          valid=true
-        fi
-
-        if [ "$valid" = true ]; then
-          echo "command=\"/usr/sbin/foodoor \$action \",no-port-forwarding,no-X11-forwarding,no-agent-forwarding $(cat ${keyfile} | sed 's/\r//g') ${keyfile}" >> ${temp_outfile}
-        fi
         fi
     done
 
-for appendix in open close door
+for appendix in open close door; do
-do
+    action=$appendix
-    action="$appendix"
     if [ "$appendix" = "door" ]; then
         action=""
     fi
     export action
 
-    outfile="${dest}/authorized_keys.${appendix}"
+    outfile=$dest/authorized_keys.$appendix
-    cat ${temp_outfile} |envsubst > ${outfile}
+    envsubst < "$temp_outfile" > "$outfile"
 
     # Oben und unten
-    install -d -o ${appendix} -g nogroup -m 0700 /var/lib/foodoor/${appendix}/.ssh
+    install -d -o "$appendix" -g nogroup -m 0700 "/var/lib/foodoor/$appendix/.ssh"
-    install -b -S .last -o ${appendix} -g nogroup -m 0600 ${outfile} /var/lib/foodoor/${appendix}/.ssh/authorized_keys
+    install -b -S .last -o "$appendix" -g nogroup -m 0600 "$outfile" "/var/lib/foodoor/$appendix/.ssh/authorized_keys"
 done

debian/usr/sbin/foodoord_oben

@@ -1,105 +1,103 @@
 #!/usr/bin/env python3
 # vim: ts=2 sw=2 et
 
-import os
-import stat
-import time
-import pifacedigitalio
-import signal
-import sys
 import grp
+import json
+import os
+import signal
+import stat
+import subprocess
+import sys
+import time
 from configparser import ConfigParser
 
-#Read config
+import pifacedigitalio
+
+# Definitions for output
+LED_RED = 6
+LED_GREEN = 7
+RELAYS_LOCK = 0
+RELAYS_UNLOCK = 1
+
+# Definitions for input
+DOOR_BELL = 0
+REED_RELAYS = 1  # not implemented yet
+
+# Definitions for LED color
+RED = 1
+GREEN = 2
+ORANGE = 3
+
+# Read config
 parser = ConfigParser()
 parser.read('/etc/foodoord.conf')
 
-doorapi = parser.get('doorstatus', 'status_url')
+DOORAPI = parser.get('doorstatus', 'status_url')
-consumerkey = parser.get('doorstatus', 'key')
+CONSUMERKEY = parser.get('doorstatus', 'key')
-consumersecret = parser.get('doorstatus', 'secret')
+CONSUMERSECRET = parser.get('doorstatus', 'secret')
-
-
-#Definitions for output
-LED_RED=6
-LED_GREEN=7
-RELAYS_LOCK=0
-RELAYS_UNLOCK=1
-
-#Definitions for input
-DOOR_BELL=0
-REED_RELAYS=1 #not implementet yet 
-
-#Definitions for LEDcolor
-RED=1
-GREEN=2
-ORANGE=3
 
 
 def update_api(locked):
     try:
-        os.system("/usr/bin/curl -XPOST --header 'Content-Type: application/json' --data '{ \"consumer_key\": \"" + consumerkey  + "\", \"consumer_secret\": \"" + consumersecret + "\", \"aerie\": " + str(locked).lower() + " }' '" + doorapi  + "' ")
+        subprocess.check_call([
+            "/usr/bin/curl", "-XPOST",
+            "--header", "Content-Type: application/json",
+            "--data",
+            json.dumps({"consumer_key": CONSUMERKEY, "consumer_secret": CONSUMERSECRET, "aerie": locked})
+        ])
     except:
         pass
 
 
-if __name__ == "__main__":
+def set_led(color):
-
+    if color == RED:
-  def doorbell(event):
+        pifacedigital.leds[LED_RED].turn_on()
-    if (STATUS):
+        pifacedigital.leds[LED_GREEN].turn_off()
-      pifacedigital.relays[RELAYS_UNLOCK].toggle()
+    elif color == GREEN:
-      time.sleep(2)
+        pifacedigital.leds[LED_GREEN].turn_on()
-      pifacedigital.relays[RELAYS_UNLOCK].toggle()
+        pifacedigital.leds[LED_RED].turn_off()
-      #print 'got doorbell'
+    elif color == ORANGE:
-
+        pifacedigital.leds[LED_RED].turn_on()
-  def close_button(event):
+        pifacedigital.leds[LED_GREEN].turn_on()
-    global STATUS
-    STATUS = False
-    try:
-      update_api(True)
-    except:
-      pass
-
-    set_led(RED)
 
 
-  listener = pifacedigitalio.InputEventListener()
+class Foodoord:
-  listener.register(0, pifacedigitalio.IODIR_RISING_EDGE, doorbell, settle_time=10)
+    def __init__(self):
-  listener.register(1, pifacedigitalio.IODIR_RISING_EDGE, close_button, settle_time=5)
+        self.status_open = False
-  listener.activate()
 
-  def signal_handler(signal, frame):
+        self.listener = pifacedigitalio.InputEventListener()
-    listener.deactivate()
+        self.listener.register(0, pifacedigitalio.IODIR_RISING_EDGE, self.doorbell, settle_time=10)
+        self.listener.register(1, pifacedigitalio.IODIR_RISING_EDGE, self.close_button, settle_time=5)
+
+    def signal_handler(self, _signal, _frame):
+        self.listener.deactivate()
         os.remove("/var/run/foodoord.pipe")
 
-    try:
         update_api(True)
-    except:
-      pass
-
         set_led(RED)
         sys.exit(0)
 
-  def set_led(color):
+    def doorbell(self, event):
-    if (color==RED):
+        if self.status_open:
-      pifacedigital.leds[LED_RED].turn_on()
+            pifacedigital.relays[RELAYS_UNLOCK].toggle()
-      pifacedigital.leds[LED_GREEN].turn_off()
+            time.sleep(2)
+            pifacedigital.relays[RELAYS_UNLOCK].toggle()
 
-    elif (color==GREEN):
+    def close_button(self, _event):
-      pifacedigital.leds[LED_GREEN].turn_on()
+        self.status_open = False
-      pifacedigital.leds[LED_RED].turn_off()
+        update_api(True)
+        set_led(RED)
 
-    elif (color==ORANGE):
+    def main(self):
-      pifacedigital.leds[LED_RED].turn_on()
+        self.listener.activate()
-      pifacedigital.leds[LED_GREEN].turn_on()
 
         pifacedigital = pifacedigitalio.PiFaceDigital()
-  signal.signal(signal.SIGTERM, signal_handler)
+        signal.signal(signal.SIGTERM, self.signal_handler)
 
-  #Startsettings
+        # Start settings
-  STATUS = False
         pifacedigital.leds[LED_RED].turn_on()
 
-  #Setting up FiFo to get sshd-output
+        # Setting up FiFo to get sshd-output
         try:
             os.mkfifo("/var/run/foodoord.pipe")
             os.chown("/var/run/foodoord.pipe", -1, grp.getgrnam('foodoor')[2])
@@ -107,37 +105,32 @@ if __name__ == "__main__":
         except OSError:
             pass
 
-  with open("/var/run/foodoord.pipe", "r") as ssh_input:
+        ssh_input = open("/var/run/foodoord.pipe", "r")
-    while 1:
+        while True:
-      #Read sshd-output from pipe
+            # Read sshd-output from pipe
-      Pipe = ssh_input.readline()[:-1]
+            pipe_cmd = ssh_input.readline().strip()
 
-      if (Pipe == "close" and STATUS):
+            if pipe_cmd == "close" and self.status_open:
                 pifacedigital.relays[RELAYS_LOCK].toggle()
                 time.sleep(1)
                 pifacedigital.relays[RELAYS_LOCK].toggle()
-        STATUS = False
 
-        try:
+                self.status_open = False
                 update_api(True)
-        except:
-          pass
-
                 set_led(RED)
 
-      elif (Pipe == "open"):
+            elif pipe_cmd == "open":
                 pifacedigital.relays[RELAYS_UNLOCK].toggle()
                 time.sleep(2)
                 pifacedigital.relays[RELAYS_UNLOCK].toggle()
 
-        if (STATUS==False):
+                if not self.status_open:
-
-          try:
                     update_api(False)
-          except:
+                self.status_open = True
-            pass
-
-        STATUS = True
-
                 set_led(GREEN)
+
             time.sleep(0.1)
+
+
+if __name__ == "__main__":
+    Foodoord().main()

debian/usr/sbin/foodoord_unten

@@ -1,64 +1,69 @@
-#! /usr/bin/python3
+#!/usr/bin/env python3
 # vim: ts=2 sw=2 et
 
+import grp
+import json
 import os
 import stat
+import subprocess
 import time
-import signal
-import sys
-import RPi.GPIO as gpio
-import grp
 from configparser import ConfigParser
 
-#Read config
+import RPi.GPIO as gpio
+
+# Definitions for output
+LED_RED = 6
+LED_GREEN = 7
+RELAYS_LOCK = 0
+RELAYS_UNLOCK = 1
+PIN_OPEN = 24
+PIN_CLOSE = 27
+# Definitions for input
+DOOR_BELL = 0
+REED_RELAYS = 1  # not implemented yet
+
+# Definitions for LED color
+RED = 1
+GREEN = 2
+ORANGE = 3
+
+# Read config
 parser = ConfigParser()
 parser.read('/etc/foodoord.conf')
 
-doorapi = parser.get('doorstatus', 'status_url')
+DOORAPI = parser.get('doorstatus', 'status_url')
-consumerkey = parser.get('doorstatus', 'key')
+CONSUMERKEY = parser.get('doorstatus', 'key')
-consumersecret = parser.get('doorstatus', 'secret')
+CONSUMERSECRET = parser.get('doorstatus', 'secret')
-
-#Definitions for output
-LED_RED=6
-LED_GREEN=7
-RELAYS_LOCK=0
-RELAYS_UNLOCK=1
-PIN_OPEN=24
-PIN_CLOSE=27
-#Definitions for input
-DOOR_BELL=0
-REED_RELAYS=1 #not implementet yet
-
-#Definitions for LEDcolor
-RED=1
-GREEN=2
-ORANGE=3
-
 
 
 def write_state(state):
     try:
-    handle = open("/tmp/door_state", "w")
+        with open("/tmp/door_state", "w") as handle:
             handle.write(state)
-    handle.close()
     except:
         pass
 
 
 def update_api(locked):
     try:
-    os.system("/usr/bin/curl -XPOST --header 'Content-Type: application/json' --data '{ \"consumer_key\": \"" + consumerkey  + "\", \"consumer_secret\": \"" + consumersecret + "\", \"cellar\": " + str(locked).lower() + " }' '" + doorapi  + "' ")
+        subprocess.check_call([
+            "/usr/bin/curl", "-XPOST",
+            "--header", "Content-Type: application/json",
+            "--data",
+            json.dumps({"consumer_key": CONSUMERKEY, "consumer_secret": CONSUMERSECRET, "cellar": locked}),
+            DOORAPI
+        ])
     except:
         pass
 
-if __name__ == "__main__":
 
-  #Startsettings
+def main():
-  STATUS=False
+    # Start settings
     gpio.setmode(gpio.BCM)
     gpio.setup(PIN_OPEN, gpio.OUT)
     gpio.setup(PIN_CLOSE, gpio.OUT)
-  #Setting up FiFo to get sshd-output
+
+    # Setting up FiFo to get sshd-output
     try:
         os.mkfifo("/var/run/foodoord.pipe")
         os.chown("/var/run/foodoord.pipe", -1, grp.getgrnam('foodoor')[2])
@@ -66,32 +71,30 @@ if __name__ == "__main__":
     except OSError:
         pass
 
-  with open("/var/run/foodoord.pipe", "r") as ssh_input:
+    ssh_input = open("/var/run/foodoord.pipe", "r")
-    while 1:
+    while True:
-      #Read sshd-output from pipe
+        # Read sshd output from pipe
-      Pipe = ssh_input.readline()[:-1]
+        pipe_cmd = ssh_input.readline().strip()
 
-      if (Pipe == "close"):
+        if pipe_cmd == "close":
-        gpio.output(PIN_CLOSE,1)
+            gpio.output(PIN_CLOSE, 1)
             time.sleep(1)
-        gpio.output(PIN_CLOSE,0)
+            gpio.output(PIN_CLOSE, 0)
 
             write_state("closed")
             update_api(True)
 
-
+        elif pipe_cmd == "open":
-      elif (Pipe == "open"):
+            # Locking
-
+            gpio.output(PIN_OPEN, 1)
-        #Locking
-        gpio.output(PIN_OPEN,1)
             time.sleep(1)
-        gpio.output(PIN_OPEN,0)
+            gpio.output(PIN_OPEN, 0)
 
-        #Save State
+            write_state("open")  # Save State
-        write_state("open")
+            update_api(False)  # Status Update
-
-        #Status Update
-        update_api(False)
 
         time.sleep(0.2)
 
+
+if __name__ == "__main__":
+    main()