utils/launch.sh

   1 #!/usr/bin/env bash
   2
   3 # Copyright 2016 Joel Martin
   4 # Copyright 2016 Solly Ross
   5 # Licensed under MPL 2.0 or any later version (see LICENSE.txt)
   6
   7 usage() {
   8     if [ "$*" ]; then
   9         echo "$*"
  10         echo
  11     fi
  12     echo "Usage: ${NAME} [--listen PORT] [--vnc VNC_HOST:PORT] [--cert CERT] [--ssl-only]"
  13     echo
  14     echo "Starts the WebSockets proxy and a mini-webserver and "
  15     echo "provides a cut-and-paste URL to go to."
  16     echo
  17     echo "    --listen PORT         Port for proxy/webserver to listen on"
  18     echo "                          Default: 6080"
  19     echo "    --vnc VNC_HOST:PORT   VNC server host:port proxy target"
  20     echo "                          Default: localhost:5900"
  21     echo "    --cert CERT           Path to combined cert/key file"
  22     echo "                          Default: self.pem"
  23     echo "    --web WEB             Path to web files (e.g. vnc.html)"
  24     echo "                          Default: ./"
  25     echo "    --ssl-only            Disable non-https connections."
  26     echo "                                    "
  27     exit 2
  28 }
  29
  30 NAME="$(basename $0)"
  31 REAL_NAME="$(readlink -f $0)"
  32 HERE="$(cd "$(dirname "$REAL_NAME")" && pwd)"
  33 PORT="6080"
  34 VNC_DEST="localhost:5900"
  35 CERT=""
  36 WEB=""
  37 proxy_pid=""
  38 SSLONLY=""
  39
  40 die() {
  41     echo "$*"
  42     exit 1
  43 }
  44
  45 cleanup() {
  46     trap - TERM QUIT INT EXIT
  47     trap "true" CHLD   # Ignore cleanup messages
  48     echo
  49     if [ -n "${proxy_pid}" ]; then
  50         echo "Terminating WebSockets proxy (${proxy_pid})"
  51         kill ${proxy_pid}
  52     fi
  53 }
  54
  55 # Process Arguments
  56
  57 # Arguments that only apply to chrooter itself
  58 while [ "$*" ]; do
  59     param=$1; shift; OPTARG=$1
  60     case $param in
  61     --listen)  PORT="${OPTARG}"; shift            ;;
  62     --vnc)     VNC_DEST="${OPTARG}"; shift        ;;
  63     --cert)    CERT="${OPTARG}"; shift            ;;
  64     --web)     WEB="${OPTARG}"; shift            ;;
  65     --ssl-only) SSLONLY="--ssl-only"             ;;
  66     -h|--help) usage                              ;;
  67     -*) usage "Unknown chrooter option: ${param}" ;;
  68     *) break                                      ;;
  69     esac
  70 done
  71
  72 # Sanity checks
  73 which netstat >/dev/null 2>&1 \
  74     || die "Must have netstat installed"
  75
  76 netstat -ltn | grep -qs ":${PORT} .*LISTEN" \
  77     && die "Port ${PORT} in use. Try --listen PORT"
  78
  79 trap "cleanup" TERM QUIT INT EXIT
  80
  81 # Find vnc.html
  82 if [ -n "${WEB}" ]; then
  83     if [ ! -e "${WEB}/vnc.html" ]; then
  84         die "Could not find ${WEB}/vnc.html"
  85     fi
  86 elif [ -e "$(pwd)/vnc.html" ]; then
  87     WEB=$(pwd)
  88 elif [ -e "${HERE}/../vnc.html" ]; then
  89     WEB=${HERE}/../
  90 elif [ -e "${HERE}/vnc.html" ]; then
  91     WEB=${HERE}
  92 elif [ -e "${HERE}/../share/novnc/vnc.html" ]; then
  93     WEB=${HERE}/../share/novnc/
  94 else
  95     die "Could not find vnc.html"
  96 fi
  97
  98 # Find self.pem
  99 if [ -n "${CERT}" ]; then
 100     if [ ! -e "${CERT}" ]; then
 101         die "Could not find ${CERT}"
 102     fi
 103 elif [ -e "$(pwd)/self.pem" ]; then
 104     CERT="$(pwd)/self.pem"
 105 elif [ -e "${HERE}/../self.pem" ]; then
 106     CERT="${HERE}/../self.pem"
 107 elif [ -e "${HERE}/self.pem" ]; then
 108     CERT="${HERE}/self.pem"
 109 else
 110     echo "Warning: could not find self.pem"
 111 fi
 112
 113 # try to find websockify (prefer local, try global, then download local)
 114 if [[ -e ${HERE}/websockify ]]; then
 115     WEBSOCKIFY=${HERE}/websockify/run
 116
 117     if [[ ! -x $WEBSOCKIFY ]]; then
 118         echo "The path ${HERE}/websockify exists, but $WEBSOCKIFY either does not exist or is not executable."
 119         echo "If you intended to use an installed websockify package, please remove ${HERE}/websockify."
 120         exit 1
 121     fi
 122
 123     echo "Using local websockify at $WEBSOCKIFY"
 124 else
 125     WEBSOCKIFY=$(which websockify 2>/dev/null)
 126
 127     if [[ $? -ne 0 ]]; then
 128         echo "No installed websockify, attempting to clone websockify..."
 129         WEBSOCKIFY=${HERE}/websockify/run
 130         git clone https://github.com/novnc/websockify ${HERE}/websockify
 131
 132         if [[ ! -e $WEBSOCKIFY ]]; then
 133             echo "Unable to locate ${HERE}/websockify/run after downloading"
 134             exit 1
 135         fi
 136
 137         echo "Using local websockify at $WEBSOCKIFY"
 138     else
 139         echo "Using installed websockify at $WEBSOCKIFY"
 140     fi
 141 fi
 142
 143 echo "Starting webserver and WebSockets proxy on port ${PORT}"
 144 #${HERE}/websockify --web ${WEB} ${CERT:+--cert ${CERT}} ${PORT} ${VNC_DEST} &
 145 ${WEBSOCKIFY} ${SSLONLY} --web ${WEB} ${CERT:+--cert ${CERT}} ${PORT} ${VNC_DEST} &
 146 proxy_pid="$!"
 147 sleep 1
 148 if ! ps -p ${proxy_pid} >/dev/null; then
 149     proxy_pid=
 150     echo "Failed to start WebSockets proxy"
 151     exit 1
 152 fi
 153
 154 echo -e "\n\nNavigate to this URL:\n"
 155 if [ "x$SSLONLY" == "x" ]; then
 156     echo -e "    http://$(hostname):${PORT}/vnc.html?host=$(hostname)&port=${PORT}\n"
 157 else
 158     echo -e "    https://$(hostname):${PORT}/vnc.html?host=$(hostname)&port=${PORT}\n"
 159 fi
 160
 161 echo -e "Press Ctrl-C to exit\n\n"
 162
 163 wait ${proxy_pid}