#!/bin/sh
# Shared helpers for the SnapOtter container entrypoint. Sourced by
# docker/entrypoint.sh and kept in its own file so the permission logic can be
# unit-tested directly (tests/unit/security/entrypoint-permissions.test.ts)
# rather than mirrored. Sourcing has no side effects -- only function defs.
#
# Functions use _-prefixed variables (sh has no portable `local`) to avoid
# clobbering the caller's variables.
# dir_writable
# Creates (best-effort, recursive) and returns 0 if the current user can
# write inside it, 1 otherwise. Probes by creating then removing a temp file:
# an actual write is the only reliable check across ACLs, NFS root-squash, and
# read-only mounts, which ownership/mode arithmetic alone would miss.
dir_writable() {
_dw_dir="$1"
mkdir -p "$_dw_dir" 2>/dev/null || true
_dw_probe="$_dw_dir/.snapotter-write-probe.$$"
if touch "$_dw_probe" 2>/dev/null; then
rm -f "$_dw_probe" 2>/dev/null || true
return 0
fi
return 1
}
# print_storage_permission_error
# Emits an actionable remediation message to stderr. Mirrors the wording of
# storagePermissionMessage() in apps/api/src/lib/storage-writable.ts.
print_storage_permission_error() {
_pe_dir="$1"
_pe_uid="$(id -u 2>/dev/null || echo '?')"
_pe_gid="$(id -g 2>/dev/null || echo '?')"
{
echo "FATAL: Storage directory \"$_pe_dir\" is not writable by the current user (uid=$_pe_uid gid=$_pe_gid)."
echo "SnapOtter cannot upload, process, or store files until this is fixed. Common fixes:"
echo " - Host volume owned by another user: on the host run \"chown -R $_pe_uid:$_pe_gid \""
echo " (or set the container user to match the volume's owner)."
echo " - Running as a non-root user (TrueNAS, Kubernetes runAsUser, OpenShift): run the container as"
echo " root (the default entrypoint self-corrects), set PUID/PGID to match the volume, or grant the"
echo " process supplementary group 0 (Kubernetes fsGroup: 0)."
echo " See https://docs.snapotter.com/guide/deployment#storage-permissions"
} >&2
}
# ensure_writable ...
# Verifies every directory is writable, printing an actionable error for each
# that is not. Returns 0 only when all are writable, 1 otherwise.
ensure_writable() {
_ew_failed=0
for _ew_dir in "$@"; do
if ! dir_writable "$_ew_dir"; then
print_storage_permission_error "$_ew_dir"
_ew_failed=1
fi
done
return "$_ew_failed"
}