#!/bin/bash
# SPDX-Version: 3.0
# SPDX-CreationInfo: 2025-06-25; WEIDNER, Marc S.; <msw@coresecret.dev>
# SPDX-ExternalRef: GIT https://git.coresecret.dev/msw/CISS.debian.live.builder.git
# SPDX-FileContributor: WEIDNER, Marc S.; Centurion Intelligence Consulting Agency
# SPDX-FileCopyrightText: 2024-2025; WEIDNER, Marc S.; <msw@coresecret.dev>
# SPDX-FileType: SOURCE
# SPDX-License-Identifier: EUPL-1.2 OR LicenseRef-CCLA-1.0
# SPDX-LicenseComment: This file is part of the CISS.debian.installer.secure framework.
# SPDX-PackageName: CISS.debian.live.builder
# SPDX-Security-Contact: security@coresecret.eu

#######################################
# Usage Wrapper CISS.debian.live.builder
# Arguments:
#   $0: Script name
#######################################
usage() {
  # shellcheck disable=SC2155
  declare var_cols=$(tput cols 2>/dev/null || echo 80)

  #######################################
  # Header, Footer wrapper for dynamical output.
  # Arguments:
  #   $1: Text.
  #   $2: Width of Terminal.
  #######################################
  center() {
    declare var_text="$1"
    declare var_width="$2"
    declare var_padding=$(( (var_width - ${#var_text}) / 2 ))
    printf "%*s%s%*s\n" "${var_padding}" "" "${var_text}" "${var_padding}" ""
  }

  # shellcheck disable=SC2155
  declare var_header=$(center "CLB(1)                        CISS.debian.live.builder                        CLB(1)" "${var_cols}")
  # shellcheck disable=SC2155
  declare var_footer=$(center "V8.13.016.2025.09.28                        2025-08-11                        CLB(1)" "${var_cols}")

  {
    echo -e "\e[1;97m${var_header}\e[0m"
    echo
    echo -e "\e[92mCISS.debian.live.builder from https://git.coresecret.dev/msw \e[0m"
    echo -e "\e[92mMaster V8.13.016.2025.09.28\e[0m"
    echo -e "\e[92mA lightweight Shell Wrapper for building a hardened Debian Live ISO Image.\e[0m"
    echo
    echo -e "\e[97m(c) Marc S. Weidner, 2018 - 2025 \e[0m"
    echo -e "\e[97m(p) Centurion Press, 2024 - 2025 \e[0m"
    echo
    echo -e "\e[97m${0} <option>, where <option> is one or more of: \e[0m"
    echo
    echo -e "\e[97m  --help, -h \e[0m"
    echo "    What you're looking at."
    echo
    echo -e "\e[97m  --autobuild=*, -a=* \e[0m"
    echo "    Headless mode. Skip the dialog wrapper, provider note screen and interactive kernel"
    echo "    selector dialog. Change '*' to your desired Linux kernel and trim the"
    echo "    'linux-image-' string to select a specific kernel, e.g. '--autobuild=6.12.30+bpo-amd64'."
    echo
    echo -e "\e[97m  --architecture <STRING> one of <amd64 | arm64> \e[0m"
    echo "    A string reflecting the architecture of the Live System."
    echo "    MUST be provided."
    echo
    echo -e "\e[97m  --build-directory </path/to/build_directory> \e[0m"
    echo "    Where the Debian Live Build Image should be generated."
    echo "    MUST be provided."
    echo
    echo -e "\e[97m  --change-splash <STRING> one of <club | hexagon>\e[0m"
    echo "    A string reflecting the Grub Boot Screen Splash you want to use."
    echo "    If omitted defaults to './.archive/background/club.png'."
    echo
    echo -e "\e[97m  --cdi (Experimental Feature)\e[0m"
    echo "    This option generates a boot menu entry to start the forthcoming"
    echo "    'CISS.debian.installer', which will be executed after"
    echo "    the system has successfully booted up."
    echo
    echo -e "\e[97m  --contact, -c\ e[0m"
    echo "    Show author contact information."
    echo
    echo -e "\e[97m  --control <INTEGER>\e[0m"
    echo "    An integer that reflects the version of your Live ISO Image."
    echo "    MUST be provided."
    echo
    echo -e "\e[97m  --debug, -d \e[0m"
    echo "    Enables debug logging for the main program routine. Detailed logging"
    echo "    information are written to '/tmp/ciss_live_builder_$$.log'."
    echo
    echo -e "\e[97m  --dhcp-centurion \e[0m"
    echo "    If a DHCP lease is provided, the provider's nameserver will be overridden,"
    echo "    and only the hardened, privacy-focused Centurion DNS servers will be used:"
    echo "      - https://dns01.eddns.eu/"
    echo "      - https://dns02.eddns.de/"
    echo "      - https://dns03.eddns.eu/"
    echo
    echo -e "\e[97m  --jump-host <IP | IP | ... > \e[0m"
    echo "    Provide up to 10 IPs for /etc/host.allow whitelisting of SSH access."
    echo "    Could be either IPv4 and / or IPv6 addresses and / or CCDIR notation."
    echo "    If provided, than it MUST be a <SPACE> separated list."
    echo "    IPv6 addresses MUST be encapsulated with [], e.g., [1234::abcd]/64."
    echo
    echo -e "\e[97m  --log-statistics-only\e[0m"
    echo "    Provides statistic only after successful building a"
    echo "    CISS.debian.live-ISO. While enabling '--log-statistics-only'"
    echo "    the argument '--build-directory' MUST be provided while"
    echo "    all further options MUST be omitted."
    echo
    echo -e "\e[97m  --provider-netcup-ipv6 \e[0m"
    echo "    Activates IPv6 support for Netcup Root Server. One unique"
    echo "    IPv6 address MUST be provided in this case and MUST be encapsulated"
    echo "    with [], e.g., [1234::abcd]."
    echo
    echo -e "\e[97m  --renice-priority <PRIORITY> \e[0m"
    echo "    Reset the nice priority value of the script and all its children"
    echo "    to the desired <PRIORITY>. MUST be an integer (between '-19' and 19)."
    echo "    Negative (higher) values MUST be enclosed in double quotes '\"'."
    echo
    echo -e "\e[97m  --reionice-priority <CLASS> <PRIORITY> \e[0m"
    echo "    Reset the ionice priority value of the script and all its children"
    echo "    to the desired <CLASS>. MUST be an integer:"
    echo "      1: realtime"
    echo "      2: best-effort"
    echo "      3: idle"
    echo "    Defaults to '2'."
    echo "    Whereas <PRIORITY> MUST be an integer as well between:"
    echo "      0: highest priority and"
    echo "      7: lowest priority."
    echo "    Defaults to '4'."
    echo "    A real-time I/O process can significantly slow down other processes"
    echo "    or even cause them to starve if it continuously requests I/O."
    echo
    echo -e "\e[97m  --root-password-file </path/to/password.txt> \e[0m"
    echo "    Password file for 'root', if given, MUST be a string of 20 to 64 characters,"
    echo "    and MUST NOT contain the special character '\"'."
    echo "    If the argument is omitted, no further login authentication is required for"
    echo "    the local console. The root password is hashed with an 16 Byte '/dev/random'"
    echo "    generated SALT and SHA512 Hashing function and 8,388,608 rounds. Immediately"
    echo "    after Hash generation all Variables containing plain password fragments are"
    echo "    deleted. Password file SHOULD be '0400' and 'root:root' and is deleted without"
    echo "    further prompt after password hash has been successfully generated via:"
    echo "    'shred -vfzu 5 -f'."
    echo "    'No tracing of any plain text password fragment in any debug log."
    echo
    echo -e "\e[97m  --ssh-port <INTEGER> \e[0m"
    echo "    The desired Port SSH should listen to."
    echo "    If not provided defaults to Port '22'."
    echo
    echo -e "\e[97m  --ssh-pubkey </path/to/.ssh/> \e[0m"
    echo "    Imports the SSH Public Key from the FILE 'authorized_keys' of the"
    echo "    specified PATH into the Live ISO. MUST be provided."
    echo
    echo -e "\e[97m  --trixie \e[0m"
    echo "    Create a Debian Trixie Live ISO."
    echo
    echo -e "\e[97m  --version, -v \e[0m"
    echo "    Show version of ${0}."
    echo
    echo -e "\e[93m💡 Notes:\e[0m"
    echo -e "\e[93m🔵 You MUST be 'root' to run this script.\e[0m"
    echo
    echo -e "\e[95m💷 Please consider donating to my work at: \e[0m"
    echo -e "\e[95m🌐 https://coresecret.eu/spenden/ \e[0m"
    echo
    echo -e "\e[1;97m${var_footer}\e[0m"
  } | less -R
}
# vim: number et ts=2 sw=2 sts=2 ai tw=128 ft=sh