SetupPentest.sh

#!/usr/bin/env bash
set -uo pipefail
IFS=$'\n\t'

# =============================================================================
# NAME        : SetupPentest.sh
# DESCRIPTION :
# AUTHOR      : Adam Compton
# DATE CREATED: 2024-12-16 16:51:35
# =============================================================================
# EDIT HISTORY:
# DATE                 | EDITED BY    | DESCRIPTION OF CHANGE
# ---------------------|--------------|----------------------------------------
# 2024-12-16 16:51:35  | Adam Compton | Initial creation.
# =============================================================================

# Minimal placeholders (until more robust functions can be defined later)
function fail() {
    local timestamp
    timestamp=$(date +"[%Y-%m-%d %H:%M:%S]")
    echo "${timestamp} [- FAIL  ] $*" >&2
}
function pass() {
    local timestamp
    timestamp=$(date +"[%Y-%m-%d %H:%M:%S]")
    echo "${timestamp} [+ PASS  ] $*"
}
function info() {
    local timestamp
    timestamp=$(date +"[%Y-%m-%d %H:%M:%S]")
    echo "${timestamp} [* INFO  ] $*"
}
function warn() {
    local timestamp
    timestamp=$(date +"[%Y-%m-%d %H:%M:%S]")
    echo "${timestamp} [! WARN  ] $*"
}
function debug() {
    local timestamp
    timestamp=$(date +"[%Y-%m-%d %H:%M:%S]")
    echo "${timestamp} [! DEBUG ] $*"
}

# Initialize the error flag
ERROR_FLAG=false

# Ensure the script is being run under Bash
if [[ -z "${BASH_VERSION:-}" ]]; then
    fail "Error: This script must be run under Bash."
    ERROR_FLAG=true
fi

# Ensure Bash version is 4.0 or higher
if [[ -n "${BASH_VERSION:-}" && "${BASH_VERSINFO[0]}" -lt 4 ]]; then
    fail "Error: This script requires Bash version 4.0 or higher. Current version: ${BASH_VERSION}"
    ERROR_FLAG=true
else
    info "Detected bash version: ${BASH_VERSION}"
fi

# Ensure the script is run as root (user ID 0)
if [[ ${EUID} -ne 0 ]]; then
    fail "Error: This script must be run as root."
    ERROR_FLAG=true
fi

###############################################################################
# _Pause
#==============================
# Pauses execution until user presses any key (interactive mode only).
#————————————————————
# Usage:
#   _Pause
#
# Arguments:
#   None
#
# Return Values:
#   None (returns immediately if non-interactive)
###############################################################################
function _Pause() {
    if [[ -t 0 ]]; then # check if running interactively
        echo
        echo "-----------------------------------"
        read -n 1 -s -r -p "Press any key to continue..."
        echo # Move to the next line after key press

        # Use ANSI escape codes to move the cursor up and clear lines
        tput cuu 3 # Move the cursor up 3 lines
        tput el    # Clear the current line
        tput el    # Clear the next line
        tput el    # Clear the third line
    fi
}

# If any errors occurred, display a summary and exit
if ${ERROR_FLAG}; then
    echo
    fail "--------------------------------------------------"
    fail "One or more errors occurred:"
    fail "  - Ensure you are using Bash version 4.0 or higher."
    fail "  - Ensure you are running this script as root as"
    fail "    some tools will need to be installed and other"
    fail "    'root' tasks will possibly be performed"
    fail
    fail "-----------------------------------"
    _Pause
    #exit 1  # Exit with a failure status code
fi

# Success message if no errors
pass "All checks passed. Continuing script execution."

# -----------------------------------------------------------------------------
# ---------------------------------- IMPORTS/SOURCES --------------------------
# -----------------------------------------------------------------------------

# Check if the HOME environment variable is set
if [[ -n "${HOME}" ]]; then
    # If HOME is set, use it
    info "HOME environment variable is set. Using HOME: ${HOME}"
elif command -v getent > /dev/null 2>&1; then
    # If getent is available, use it to retrieve the home directory
    HOME_TEMP=$(getent passwd "$(whoami)" | cut -d: -f6)
    export HOME="${HOME_TEMP}"
    if [[ -n "${HOME}" ]]; then
        info "Using getent to determine HOME: ${HOME}"
    else
        fail "Failed to determine HOME using getent."
        exit 1
    fi
else
    # Fallback: Use eval to get the home directory
    HOME_TEMP=$(eval echo ~)
    export HOME="${HOME_TEMP}"
    if [[ -n "${HOME}" ]]; then
        warn "HOME and getent are unavailable. Using fallback with eval: HOME=${HOME}"
    else
        fail "Failed to determine HOME. Unable to proceed."
        exit 1
    fi
fi

# Determine the script's root directory
# The SCRIPT_DIR variable points to the directory containing the script.
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
if [[ -n "${SCRIPT_DIR}" && -d "${SCRIPT_DIR}" ]]; then
    export SCRIPT_DIR
    info "Script directory determined: ${SCRIPT_DIR}"
else
    fail "Failed to determine the script directory. Exiting."
    exit 1
fi

# Define required files in an array
# These files must exist and be sourced for the script to work correctly.
declare -a REQUIRED_FILES=(
    "${SCRIPT_DIR}/config/config.sh"
    "${SCRIPT_DIR}/config/lists.sh"
    "${SCRIPT_DIR}/lib/common_core/lib/utils.sh"
    "${SCRIPT_DIR}/lib/common_core/lib/menu.sh"
    "${SCRIPT_DIR}/menu/init_tasks.sh"
    "${SCRIPT_DIR}/menu/install_tasks.sh"
    "${SCRIPT_DIR}/menu/menu_tasks.sh"
)

# Source required files and verify their existence
for file in "${REQUIRED_FILES[@]}"; do
    if [[ -f "${file}" ]]; then
        # Source the file if it exists
        source "${file}" || {
            echo "Failed to source file: ${file}. Exiting."
            exit 1
        }
    else
        # Log an error if the file is missing
        echo "Required file is missing: ${file}. Exiting."
        exit 1
    fi
done

# -----------------------------------------------------------------------------
# ---------------------------------- GLOBAL VARIABLES/CHECKS ------------------
# -----------------------------------------------------------------------------

# Check if proxychains is required
_check_proxy_needed

# -----------------------------------------------------------------------------
# ---------------------------------- UTILITY ----------------------------------
# -----------------------------------------------------------------------------

###############################################################################
# ensure_command
#==============================
# Checks whether a given command is installed and functional.
# Prompts the user to install it if missing.
#————————————————————
# Usage:
#   ensure_command <command_name>
#
# Arguments:
#   command_name → Name of the binary/command to check and install if missing
#
# Return Values:
#   0 → Command exists or installed successfully
#   non-zero → User declined install or install failed
#————————————————————
# Requirements:
#   check_command
#   _install_package
#   info, warn, fail functions
#   OS_NAME variable
###############################################################################
function ensure_command() {
    local cmd="$1"

    if [[ -z "${cmd}" ]]; then
        fail "No command name provided to ensure_command."
        return "${_FAIL}"
    fi

    if ! check_command "${cmd}"; then
        read -r -p "Command '${cmd}' not found. Do you want to install it? (Y/n): " answer

        # Default to 'Y' if user just hits Enter
        answer="${answer:-Y}"

        case "${answer}" in
            [Yy]*)
                _install_package "${cmd}"
                return $?
                ;;
            [Nn]*)
                warn "${cmd} will not be installed. Exiting."
                exit "${_FAIL}"
                ;;
            *)
                fail "Invalid response. Exiting."
                exit "${_FAIL}"
                ;;
        esac
    else
        info "Command '${cmd}' is already installed."
    fi
}

# -----------------------------------------------------------------------------
# ---------------------------------- MAIN -------------------------------------
# -----------------------------------------------------------------------------

###############################################################################
# main
#==============================
# Main entry point for the SetupPentest script.
#————————————————————
# Usage:
#   main [options]
#
# Arguments:
#   -bash → Bypass menu and run Setup_Dot_Files directly
#
# Return Values:
#   0 → Success
#   1 → Invalid argument
###############################################################################
function main() {
    # Check if any arguments are passed
    if [[ $# -eq 0 ]]; then
        # No arguments, display the menu
        _display_menu "Setup Pentest Environment" "_Process_Start_Menu" false "${SETUP_MENU_ITEMS[@]}"
        return
    fi

    # Process arguments
    while [[ $# -gt 0 ]]; do
        case "$1" in
            -bash)
                # Bypass menu and run Setup_Dot_Files directly
                Setup_Dot_Files
                return
                ;;
            *)
                # Handle invalid arguments
                echo "[ERROR] Invalid argument: $1" >&2
                echo "Usage: $0 [-bash]" >&2
                return 1
                ;;
        esac
    done
}

# Run ensure_command to check if required commands are present
ensure_command "fzf"
ensure_command "proxychains"
ensure_command "proxychains4"

# Call the main function, passing all script arguments
main "$@"