summaryrefslogtreecommitdiff
path: root/nodes/freedombox.yml
blob: 61ba2a7c42587f4e5b06ec7f537f622b6422fc6e (plain)
  1. # Freedombox on LIME2 box
  2. # Targets:  Debian 9 (Stretch) or newer
  3. # Depends: boxer-data (>= 10.5.14)
  4. classes:
  5.   - Console.setup
  6.   - Console.filemanager
  7.   - Admin.etc.functions
  8.   - Admin
  9.   - Service.ssh
  10.   - Service.mail.mta.dma
  11.   - Hardware.motherboard.olimex.lime2
  12.   - Hardware.harden
  13.   - Hardware.net.interfaces.reset
  14.   - Framework.pkg.apt.autoremove-suggests
  15.   - Framework.pkg.apt.avoid-removals
  16.   - Framework.pkg.apt.aptitude.advance-on-action
  17.   - Framework.pkg.apt.aptitude.list-suite
  18.   - Framework.pkg.apt.proxy.reset
  19.   - Framework.pkg.apt.source.reset
  20. parameters:
  21.   bug:
  22.     - 483754
  23.   doc:
  24.     gateway:
  25.       pkg:
  26.         - include freedombox-setup
  27.       tweak:
  28.         - reset root account rcfiles from skeleton
  29.         - limit video buffers (freeing memory for general use)
  30.         - use HDMI (not serial portas initial boot console
  31.         - enable Domain name (DNSservice systemd-resolved
  32.         - use Cloudflare (not Googlefallback DNS resolvers
  33.         - enable multicast DNS
  34.         - enable Network Time (NTPservice systemd-timesyncd
  35.         - use static IPs as fallback with NTP to avoid DNSSEC deadlock
  36.         - grant root access to users in POSIX (and LDAPgroup 'admin'
  37.         - create local systemd service to create SSH host keys if missing
  38.         - clear content of /etc/machine-id
  39.         - remove SSH host keys
  40.   pkg:
  41.     - plinth
  42.   tweak:
  43.     - >
  44.       files=".bash_logout .bashrc .profile";\
  45.        for file in $files; do \
  46.         cp -f "/target/etc/skel/$file" "/target/root/$file";\
  47.        done;\
  48.        echo '' >> /target/root/.profile;\
  49.        echo 'mesg n || true' >> /target/root/.profile
  50.     - >
  51.       _setappendvar /target/etc/default/flash-kernel \
  52.        LINUX_KERNEL_CMDLINE_DEFAULTS \
  53.        '"sunxi_ve_mem_reserve=0 sunxi_g2d_mem_reserve=0 sunxi_fb_mem_reserve=16"'
  54.     - >
  55.       file=/target/etc/flash-kernel/bootscript/bootscr.sunxi;\
  56.        _backup "$file";\
  57.        sed -i -r -e '2asetenv console tty0\''n' "$file"
  58.     - >
  59.       dir=/target/etc/systemd/resolved.conf.d;\
  60.        mkdir -p "$dir";\
  61.         file="$dir/local.conf";\
  62.         echo '[Resolve]' > "$file";\
  63.         echo 'FallbackDNS=1.1.1.1 1.0.0.1 2606:4700:4700::1111,2606:4700:4700::1001' >> "$file";\
  64.         echo 'MulticastDNS=yes' >> "$file"
  65.     - systemctl enable systemd-resolved
  66.     - >
  67.       ln -sfT ../run/systemd/resolve/stub-resolv.conf \
  68.        /target/etc/resolv.conf
  69.     - >
  70.       dir=/target/etc/systemd/timesyncd.conf.d;\
  71.        mkdir -p "$dir";\
  72.         file="$dir/local.conf";\
  73.         echo '[Time]' > "$file";\
  74.         echo '# include static IPs (once expanded from former) to avoid DNSSEC deadlock' >> "$file";\
  75.         echo 'FallbackNTP=2.debian.pool.ntp.org 195.137.195.251 158.248.189.11 193.104.228.123 195.137.195.252 2001:ac8:37::40 2001:67c:28c8:12::123 2a00:1b70:1200:1::123 2001:67c:564::12' >> "$file"
  76.     - systemctl enable systemd-timesyncd
  77.     - >
  78.       _setappendline /target/etc/sudoers.d/local-freedombox \
  79.        '%admin ALL=(root) ALL'
  80.     - >
  81.       _setappendvar /target/etc/sysctl.d/local-freedombox.conf \
  82.        net.ipv6.conf.all.forwarding 1
  83.     - >
  84.       file=/target/usr/local/sbin/gen-sshd-host-keys;\
  85.        echo '#!/bin/sh' "$file";\
  86.        echo '#' >> "$file";\
  87.        echo '# Generate missing ssh host keys' >> "$file";\
  88.        echo '# code copied from openssh-server postinst to address' >> "$file";\
  89.        echo '# https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=594175' >> "$file";\
  90.        echo '' >> "$file";\
  91.        echo '# Copyright: 2018 Purism SPC' >> "$file";\
  92.        echo '# License: BSD-2-clause' >> "$file";\
  93.        echo '#  Redistribution and use in source and binary forms, with or without' >> "$file";\
  94.        echo '#  modification, are permitted provided that the following conditions' >> "$file";\
  95.        echo '#  are met:' >> "$file";\
  96.        echo '#  1. Redistributions of source code must retain the above copyright' >> "$file";\
  97.        echo '#     notice, this list of conditions and the following disclaimer.' >> "$file";\
  98.        echo '#  2. Redistributions in binary form must reproduce the above copyright' >> "$file";\
  99.        echo '#     notice, this list of conditions and the following disclaimer in the' >> "$file";\
  100.        echo '#     documentation and/or other materials provided with the distribution.' >> "$file";\
  101.        echo '#  .' >> "$file";\
  102.        echo '#  THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR' >> "$file";\
  103.        echo '#  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES' >> "$file";\
  104.        echo '#  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.' >> "$file";\
  105.        echo '#  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,' >> "$file";\
  106.        echo '#  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT' >> "$file";\
  107.        echo '#  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,' >> "$file";\
  108.        echo '#  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY' >> "$file";\
  109.        echo '#  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT' >> "$file";\
  110.        echo '#  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF' >> "$file";\
  111.        echo '#  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.' >> "$file";\
  112.        echo '' >> "$file";\
  113.        echo 'set -e' >> "$file";\
  114.        echo '' >> "$file";\
  115.        echo 'export LC_ALL=C.UTF-8' >> "$file";\
  116.        echo '' >> "$file";\
  117.        echo 'get_config_option() {' >> "$file";\
  118.        echo '        option="$1"' >> "$file";\
  119.        echo '' >> "$file";\
  120.        echo '        [ -f /etc/ssh/sshd_config ] || return' >> "$file";\
  121.        echo '' >> "$file";\
  122.        echo '        # TODO: actually only one '"'='"' allowed after option' >> "$file";\
  123.        echo '        perl -lne '"'" >> "$file";\
  124.        echo '                s/[[:space:]]+/ /g; s/[[:space:]]+$//;' >> "$file";\
  125.        echo '                print if s/^[[:space:]]*'"'"'"$option"'"'"'[[:space:]=]+//i'"'"\' >> "$file";\
  126.        echo '           /etc/ssh/sshd_config' >> "$file";\
  127.        echo '}' >> "$file";\
  128.        echo '' >> "$file";\
  129.        echo '' >> "$file";\
  130.        echo 'host_keys_required() {' >> "$file";\
  131.        echo '        hostkeys="$(get_config_option HostKey)"' >> "$file";\
  132.        echo '        if "$hostkeys" ]; then' >> "$file";\
  133.        echo '                echo "$hostkeys"' >> "$file";\
  134.        echo '        else' >> "$file";\
  135.        echo '                # No HostKey directives at all, so the server picks some' >> "$file";\
  136.        echo '                # defaults.' >> "$file";\
  137.        echo '                echo /etc/ssh/ssh_host_rsa_key' >> "$file";\
  138.        echo '                echo /etc/ssh/ssh_host_ecdsa_key' >> "$file";\
  139.        echo '                echo /etc/ssh/ssh_host_ed25519_key' >> "$file";\
  140.        echo '        fi' >> "$file";\
  141.        echo '}' >> "$file";\
  142.        echo '' >> "$file";\
  143.        echo 'create_key() {' >> "$file";\
  144.        echo '   msg="$1"' >> "$file";\
  145.        echo '   shift' >> "$file";\
  146.        echo '   hostkeys="$1"' >> "$file";\
  147.        echo '   shift' >> "$file";\
  148.        echo '   file="$1"' >> "$file";\
  149.        echo '   shift' >> "$file";\
  150.        echo '' >> "$file";\
  151.        echo '   if echo "$hostkeys" | grep -x "$file" >/dev/null && \' >> "$file";\
  152.        echo '      [ ! -f "$file" ; then' >> "$file";\
  153.        echo '       printf "%s" "$msg"' >> "$file";\
  154.        echo '       ssh-keygen -q -f "$file" -N "" "$@"' >> "$file";\
  155.        echo '       echo' >> "$file";\
  156.        echo '       if which restorecon >/dev/null 2>&1; then' >> "$file";\
  157.        echo '           restorecon "$file" "$file.pub"' >> "$file";\
  158.        echo '       fi' >> "$file";\
  159.        echo '       ssh-keygen -l -f "$file.pub"' >> "$file";\
  160.        echo '   fi' >> "$file";\
  161.        echo '}' >> "$file";\
  162.        echo '' >> "$file";\
  163.        echo '' >> "$file";\
  164.        echo 'create_keys() {' >> "$file";\
  165.        echo '   hostkeys="$(host_keys_required)"' >> "$file";\
  166.        echo '' >> "$file";\
  167.        echo '   create_key "Creating SSH2 RSA key; this may take some time ..." \' >> "$file";\
  168.        echo '       "$hostkeys" /etc/ssh/ssh_host_rsa_key -t rsa' >> "$file";\
  169.        echo '   create_key "Creating SSH2 DSA key; this may take some time ..." \' >> "$file";\
  170.        echo '       "$hostkeys" /etc/ssh/ssh_host_dsa_key -t dsa' >> "$file";\
  171.        echo '   create_key "Creating SSH2 ECDSA key; this may take some time ..." \' >> "$file";\
  172.        echo '       "$hostkeys" /etc/ssh/ssh_host_ecdsa_key -t ecdsa' >> "$file";\
  173.        echo '   create_key "Creating SSH2 ED25519 key; this may take some time ..." \' >> "$file";\
  174.        echo '       "$hostkeys" /etc/ssh/ssh_host_ed25519_key -t ed25519' >> "$file";\
  175.        echo '}' >> "$file";\
  176.        echo '' >> "$file";\
  177.        echo 'create_keys' >> "$file";\
  178.        echo 'service ssh force-reload' >> "$file";\
  179.        chmod a+x "$file"
  180.     - >
  181.       file=/target/etc/systemd/system/gen-sshd-host-keys.service;\
  182.        echo '[Unit]' > "$file";\
  183.        echo 'Description=Generate OpenSSH daemon host keys service' >> "$file";\
  184.        echo 'ConditionPathExists=/usr/sbin/sshd' >> "$file";\
  185.        echo 'ConditionPathExists=!/etc/ssh/sshd_not_to_be_run' >> "$file";\
  186.        echo 'Before=ssh.service' >> "$file";\
  187.        echo 'Before=ssh.socket' >> "$file";\
  188.        echo 'Documentation=https://source.puri.sm/Librem5/gen-ssd-host-keys/README.md' >> "$file";\
  189.        echo '' >> "$file";\
  190.        echo '[Service]' >> "$file";\
  191.        echo 'Type=oneshot' >> "$file";\
  192.        echo 'ExecStart=/usr/local/sbin/gen-sshd-host-keys' >> "$file";\
  193.        echo 'ExecStop=/bin/true' >> "$file";\
  194.        echo '' >> "$file";\
  195.        echo '[Install]' >> "$file";\
  196.        echo 'WantedBy=ssh.service' >> "$file";\
  197.        echo 'WantedBy=ssh.socket' >> "$file"
  198.     - systemctl enable gen-sshd-host-keys
  199.     - echo > /target/etc/machine-id
  200.     - ln -sfT ../../../etc/machine-id /target/var/lib/dbus/machine-id
  201.     - find /target/etc/ssh -maxdepth 1 -type f -name "ssh_host_*_key*" -delete