#!/usr/bin/env bash
#
# JbTecWiz Support Centre -- generated fix script
#
# Fault : Certificate renewal fails and the site goes to expired HTTPS
# Fix   : Make sure renewal is running and being watched
# Source: https://jbtecwiz.com/support/lnx-web-certbot
#
# Run as     : Root shell
# Expect     : 20 minutes
# Risk       : low
# Reversible : yes
#
# WHEN THIS IS THE RIGHT FIX
#   After fixing it. This is what stops it happening again.
#
# HOW TO UNDO IT
#   Remove the deploy hook script to revert.
#
# Walks the fix one step at a time and asks before each. Steps with no
# command are yours to do -- it prints those and waits. DRYRUN=1 prints
# without executing; UNATTENDED=1 does not ask.
#
# --------------------------------------------------------------------
# NO WARRANTY - USE AT YOUR OWN RISK
#
# This script is provided by JbTecWiz as-is and with no warranty of any
# kind, express or implied. You run it entirely at your own risk.
#
# JbTecWiz accepts no liability for any loss or damage arising from its
# use, including but not limited to data loss, downtime, or configuration
# changes that turn out to be wrong for your system.
#
# You are responsible for reading this script before running it, for
# satisfying yourself that it suits the machine in front of you, and for
# having a working backup first. Some steps cannot be undone.
# --------------------------------------------------------------------

set -uo pipefail
DRYRUN="${DRYRUN:-0}"
UNATTENDED="${UNATTENDED:-0}"
failed=0

# - THIS SCRIPT WILL NOT RUN UNTIL YOU EDIT IT -
cat >&2 <<'EOF'

  This script needs editing before it can run.
  Replace each of these with a real value:
    example.com   (a placeholder domain)

  Then delete this block near the top of the script.

EOF
exit 2

if [ "$(id -u)" -ne 0 ]; then
  echo "  This fix is documented as needing root. Re-run with sudo." >&2
  exit 3
fi

rule() { printf "\n%s\n" "$(printf '-%.0s' $(seq 1 70))"; if [ $# -gt 0 ]; then echo "$1"; fi; }
prose() { echo "$1" | fold -s -w 74 | sed "s/^/  /"; }

# Returns 0 when the caller should run the command, 1 when it should not.
# A manual step always returns 1 -- there is nothing for the caller to run.
step() {  # step <n> <do> <why> <manual|cmd> [command lines...]
  local n="$1" dotext="$2" why="$3" mode="$4"; shift 4
  rule "  Step $n of 4"
  prose "$dotext"
  if [ -n "$why" ]; then echo; prose "$why"; fi
  if [ "$mode" = "manual" ]; then
    echo; echo "  -> Do this yourself, then press Enter to carry on."
    if [ "$UNATTENDED" = "0" ] && [ "$DRYRUN" = "0" ]; then read -r _; fi
    return 1
  fi
  echo; printf "    %s\n" "$@"; echo
  if [ "$DRYRUN" = "1" ]; then echo "  (dry run -- not executed)"; return 1; fi
  if [ "$UNATTENDED" = "0" ]; then
    read -r -p "  Run this step? [Y]es / [S]kip / [Q]uit " a
    case "$a" in
      [Qq]*) echo "  Stopped at your request."; exit 0 ;;
      [Ss]*) echo "  Skipped."; return 1 ;;
    esac
  fi
  return 0
}

rule
echo "  Certificate renewal fails and the site goes to expired HTTPS"
echo "  Make sure renewal is running and being watched"
echo
echo "  Risk: low   Reversible   20 minutes"
echo
prose 'No warranty. Use at your own risk - JbTecWiz accepts no liability. Read it before you run it, and have a backup.'
rule
echo
if [ "$UNATTENDED" = "0" ] && [ "$DRYRUN" = "0" ]; then
  read -r -p "  Ready? [y/N] " go
  case "$go" in [Yy]*) ;; *) echo "  Nothing was changed."; exit 0;; esac
fi

if step 1 'Check the timer is enabled and when it last ran.' '' cmd 'systemctl list-timers certbot* snap.certbot* --all' 'sudo systemctl status certbot.timer --no-pager'; then
  systemctl list-timers certbot* snap.certbot* --all
  sudo systemctl status certbot.timer --no-pager
  if [ $? -ne 0 ]; then
    failed=$((failed+1))
    echo "  Step 1 failed. The rest of the fix may depend on it." >&2
  fi
fi

if step 2 'Add a reload hook so a renewed certificate is actually served -- a renewal that does not reload nginx leaves the old certificate in memory.' 'This is a genuinely common cause of an expired certificate on a machine where renewal has been succeeding for months. The file on disk is current and the running process is serving one from ninety days ago.' cmd 'printf '\''#!/bin/sh\nsystemctl reload nginx\n'\'' | sudo tee /etc/letsencrypt/renewal-hooks/deploy/reload-nginx.sh' 'sudo chmod +x /etc/letsencrypt/renewal-hooks/deploy/reload-nginx.sh'; then
  printf '#!/bin/sh\nsystemctl reload nginx\n' | sudo tee /etc/letsencrypt/renewal-hooks/deploy/reload-nginx.sh
  sudo chmod +x /etc/letsencrypt/renewal-hooks/deploy/reload-nginx.sh
  if [ $? -ne 0 ]; then
    failed=$((failed+1))
    echo "  Step 2 failed. The rest of the fix may depend on it." >&2
  fi
fi

if step 3 'Add monitoring that checks the expiry from outside, so a failure is noticed before the browser notices it.' '' cmd 'echo | openssl s_client -servername example.com -connect example.com:443 2>/dev/null | openssl x509 -noout -enddate'; then
  echo | openssl s_client -servername example.com -connect example.com:443 2>/dev/null | openssl x509 -noout -enddate
  if [ $? -ne 0 ]; then
    failed=$((failed+1))
    echo "  Step 3 failed. The rest of the fix may depend on it." >&2
  fi
fi

if step 4 'Register an email address with the ACME account so expiry warnings arrive.' '' cmd 'sudo certbot update_account --email admin@example.com'; then
  sudo certbot update_account --email admin@example.com
  if [ $? -ne 0 ]; then
    failed=$((failed+1))
    echo "  Step 4 failed. The rest of the fix may depend on it." >&2
  fi
fi

rule "  Confirm it worked"
prose 'The timer is active, and the served certificate'\''s expiry matches the file on disk.'
if [ "$DRYRUN" = "0" ]; then
  sudo certbot certificates | grep -A2 'Certificate Name'
fi

rule
if [ "$failed" -gt 0 ]; then
  echo "  Finished with $failed failed step(s)."
  echo "  Read the full write-up at https://jbtecwiz.com/support/lnx-web-certbot"
else
  echo "  Finished."
fi
echo
prose 'To undo: Remove the deploy hook script to revert.'
rule