#!/bin/sh
BACKEND="${BACKEND:-/usr/sbin/owrt-full-backup}"
KEY_FILE="${KEY_FILE:-/etc/owrt-full-backup/web.key}"
PARAMS_FILE="${TMPDIR:-/tmp}/owrt-full-backup-cgi.$$"
RESULT_FILE=""
RESULT_TITLE=""
RESULT_CODE=""
PROJECT_URL="${PROJECT_URL:-https://github.com/kzolotarev95/openwrt-full-backup}"
RAW_URL="${RAW_URL:-https://raw.githubusercontent.com/kzolotarev95/openwrt-full-backup/main}"
cleanup() {
rm -f "$PARAMS_FILE"
if [ -n "$RESULT_FILE" ]; then
rm -f "$RESULT_FILE"
fi
}
trap cleanup EXIT INT TERM
html_escape() {
sed 's/&/\&/g; s/\</g; s/>/\>/g; s/"/\"/g'
}
h() {
printf '%s' "$1" | html_escape
}
url_decode() {
local data
data="$(printf '%s' "$1" | sed 's/+/ /g; s/%/\\x/g')"
printf '%b' "$data"
}
parse_params() {
local data old_ifs pair key value
data="$1"
old_ifs="$IFS"
IFS='&'
for pair in $data; do
key="${pair%%=*}"
value="${pair#*=}"
[ "$pair" = "$key" ] && value=""
key="$(url_decode "$key" | tr -d '\r\n\t')"
value="$(url_decode "$value" | tr '\r\n\t' ' ')"
[ -n "$key" ] && printf '%s\t%s\n' "$key" "$value" >>"$PARAMS_FILE"
done
IFS="$old_ifs"
}
param() {
awk -F ' ' -v k="$1" '$1 == k { print $2; exit }' "$PARAMS_FILE"
}
has_param() {
awk -F ' ' -v k="$1" '$1 == k { found = 1 } END { exit(found ? 0 : 1) }' "$PARAMS_FILE"
}
read_request() {
local post_data
: >"$PARAMS_FILE"
parse_params "${QUERY_STRING:-}"
if [ "${REQUEST_METHOD:-GET}" = "POST" ] && [ -n "${CONTENT_LENGTH:-}" ]; then
post_data="$(dd bs=1 count="$CONTENT_LENGTH" 2>/dev/null)"
parse_params "$post_data"
fi
}
config_get() {
local key default value
key="$1"
default="$2"
if command -v uci >/dev/null 2>&1; then
value="$(uci -q get "fullbackup.main.$key" 2>/dev/null || true)"
[ -n "$value" ] && {
printf '%s' "$value"
return
}
fi
printf '%s' "$default"
}
web_key() {
cat "$KEY_FILE" 2>/dev/null
}
self_url() {
printf '%s' "${SCRIPT_NAME:-/cgi-bin/owrt-full-backup}"
}
authorized() {
local expected supplied
expected="$(web_key)"
supplied="$(param key)"
[ -n "$expected" ] && [ "$supplied" = "$expected" ]
}
http_html() {
printf 'Content-Type: text/html; charset=utf-8\r\n\r\n'
}
http_unauthorized() {
http_html
cat <<'EOF'
OpenWrt Full Backup
Access denied
Open the panel with the secret key printed by install.sh.
EOF
}
valid_abs_path() {
case "$1" in
/*) ;;
*) return 1 ;;
esac
printf '%s' "$1" | grep -Eq '^/[A-Za-z0-9._/-]+$'
}
download_file() {
local file base
file="$(param file)"
valid_abs_path "$file" || {
http_html
printf 'Bad file path.
'
exit 0
}
case "$file" in
*.tar.gz|*.tar.gz.sha256) ;;
*) http_html; printf 'Only backup archives and checksums can be downloaded.
'; exit 0 ;;
esac
[ -f "$file" ] || {
http_html
printf 'File not found.
'
exit 0
}
base="$(basename "$file")"
case "$file" in
*.sha256) printf 'Content-Type: text/plain\r\n' ;;
*) printf 'Content-Type: application/gzip\r\n' ;;
esac
printf 'Content-Disposition: attachment; filename="%s"\r\n\r\n' "$base"
cat "$file"
exit 0
}
run_backend() {
RESULT_TITLE="$1"
shift
RESULT_FILE="${TMPDIR:-/tmp}/owrt-full-backup-result.$$"
if [ ! -x "$BACKEND" ]; then
RESULT_CODE=127
printf 'Backend is not installed: %s\n' "$BACKEND" >"$RESULT_FILE"
return
fi
"$BACKEND" "$@" >"$RESULT_FILE" 2>&1
RESULT_CODE="$?"
}
handle_create() {
local output_dir name firmware
output_dir="$(param output_dir)"
name="$(param name)"
firmware="$(param firmware_image)"
[ -n "$output_dir" ] || output_dir="$(config_get output_dir /tmp)"
valid_abs_path "$output_dir" || {
RESULT_TITLE="Create backup"
RESULT_CODE=2
RESULT_FILE="${TMPDIR:-/tmp}/owrt-full-backup-result.$$"
printf 'Bad output directory. Use an absolute path, for example /mnt/usb.\n' >"$RESULT_FILE"
return
}
set -- create -o "$output_dir"
[ -n "$name" ] && set -- "$@" -n "$name"
has_param include_overlay || set -- "$@" --no-overlay
has_param include_rom && set -- "$@" --include-rom
has_param include_raw_mtd && set -- "$@" --include-raw-mtd
[ -n "$firmware" ] && set -- "$@" --firmware-image "$firmware"
run_backend "Create backup" "$@"
}
handle_inspect() {
local archive
archive="$(param archive)"
valid_abs_path "$archive" || {
RESULT_TITLE="Inspect backup"
RESULT_CODE=2
RESULT_FILE="${TMPDIR:-/tmp}/owrt-full-backup-result.$$"
printf 'Bad archive path.\n' >"$RESULT_FILE"
return
}
run_backend "Inspect backup" inspect "$archive"
}
handle_restore() {
local archive confirm
archive="$(param archive)"
confirm="$(param confirm)"
if [ "$confirm" != "RESTORE" ]; then
RESULT_TITLE="Restore backup"
RESULT_CODE=2
RESULT_FILE="${TMPDIR:-/tmp}/owrt-full-backup-result.$$"
printf 'Type RESTORE to confirm restore.\n' >"$RESULT_FILE"
return
fi
valid_abs_path "$archive" || {
RESULT_TITLE="Restore backup"
RESULT_CODE=2
RESULT_FILE="${TMPDIR:-/tmp}/owrt-full-backup-result.$$"
printf 'Bad archive path.\n' >"$RESULT_FILE"
return
}
set -- restore "$archive" --yes
has_param restore_configs || set -- "$@" --no-configs
has_param restore_packages || set -- "$@" --no-packages
has_param restore_overlay && set -- "$@" --overlay
has_param flash_firmware && set -- "$@" --flash-firmware
run_backend "Restore backup" "$@"
}
handle_save_defaults() {
local output_dir include_overlay include_rom include_raw_mtd keep_days
RESULT_TITLE="Save defaults"
RESULT_CODE=0
RESULT_FILE="${TMPDIR:-/tmp}/owrt-full-backup-result.$$"
output_dir="$(param default_output_dir)"
keep_days="$(param keep_days)"
valid_abs_path "$output_dir" || {
RESULT_CODE=2
printf 'Bad output directory.\n' >"$RESULT_FILE"
return
}
case "$keep_days" in ''|*[!0-9]*) keep_days=0 ;; esac
has_param default_include_overlay && include_overlay=1 || include_overlay=0
has_param default_include_rom && include_rom=1 || include_rom=0
has_param default_include_raw_mtd && include_raw_mtd=1 || include_raw_mtd=0
if command -v uci >/dev/null 2>&1; then
uci -q batch <"$RESULT_FILE" 2>&1
set fullbackup.main=backup
set fullbackup.main.output_dir='$output_dir'
set fullbackup.main.include_overlay='$include_overlay'
set fullbackup.main.include_rom='$include_rom'
set fullbackup.main.include_raw_mtd='$include_raw_mtd'
set fullbackup.main.keep_days='$keep_days'
commit fullbackup
EOF
RESULT_CODE="$?"
[ "$RESULT_CODE" = "0" ] && printf 'Defaults saved.\n' >>"$RESULT_FILE"
else
RESULT_CODE=127
printf 'uci command not found.\n' >"$RESULT_FILE"
fi
}
handle_action() {
local action
action="$(param action)"
case "$action" in
create) handle_create ;;
inspect) handle_inspect ;;
restore) handle_restore ;;
save_defaults) handle_save_defaults ;;
esac
}
system_value() {
case "$1" in
host) hostname 2>/dev/null || printf 'openwrt' ;;
release)
if [ -r /etc/openwrt_release ]; then
. /etc/openwrt_release 2>/dev/null
printf '%s %s' "${DISTRIB_ID:-OpenWrt}" "${DISTRIB_RELEASE:-unknown}"
else
printf 'OpenWrt unknown'
fi
;;
board)
if [ -r /tmp/sysinfo/board_name ]; then
cat /tmp/sysinfo/board_name
else
printf 'unknown'
fi
;;
esac
}
checkbox_attr() {
[ "$1" = "1" ] && printf ' checked'
}
backup_rows() {
local dir key file base size mtime
dir="$(config_get output_dir /tmp)"
key="$(h "$(param key)")"
[ -d "$dir" ] || {
printf '| Output directory does not exist. |
'
return
}
for file in "$dir"/*-owrt-full-backup.tar.gz; do
[ -f "$file" ] || continue
base="$(basename "$file")"
size="$(ls -lh "$file" 2>/dev/null | awk '{print $5}')"
mtime="$(ls -l "$file" 2>/dev/null | awk '{print $6" "$7" "$8}')"
printf '%s | %s | %s | download |
' \
"$(h "$base")" "$(h "$size")" "$(h "$mtime")" "$(self_url)" "$key" "$(h "$file")"
done
}
page() {
local key output_dir include_overlay include_rom include_raw_mtd keep_days
key="$(h "$(param key)")"
output_dir="$(config_get output_dir /tmp)"
include_overlay="$(config_get include_overlay 1)"
include_rom="$(config_get include_rom 0)"
include_raw_mtd="$(config_get include_raw_mtd 0)"
keep_days="$(config_get keep_days 0)"
http_html
cat <
OpenWrt Full Backup
EOF
if [ -n "$RESULT_FILE" ]; then
printf '%s
Exit code: %s
' "$(h "$RESULT_TITLE")" "$(h "$RESULT_CODE")"
html_escape <"$RESULT_FILE"
printf '
'
fi
cat <
Device
Host: $(h "$(system_value host)")
Release: $(h "$(system_value release)")
Board: $(h "$(system_value board)")
$(df -h 2>/dev/null | html_escape)
Backups in $(h "$output_dir")
| File | Size | Date | Action |
$(backup_rows)
Git install / remove
Clone install:
git clone $(h "$PROJECT_URL").git
cd openwrt-full-backup
sh install.sh
One-line install:
wget -O - $(h "$RAW_URL")/install.sh | sh
Remove:
wget -O - $(h "$RAW_URL")/uninstall.sh | sh
EOF
}
read_request
if ! authorized; then
http_unauthorized
exit 0
fi
if [ "$(param action)" = "download" ]; then
download_file
fi
if [ "${REQUEST_METHOD:-GET}" = "POST" ]; then
handle_action
fi
page