Improving WebGoat Developer Bootstrap Script
Improved the Developer Bootstratp script to perform some checking for tools and pull the git repo if directory already exists Signed-off-by: Doug Morato <dm@corp.io>
This commit is contained in:
Doug Morato
parent
b937e5936c
commit
6826d0eeba
@ -1,44 +1,186 @@
|
||||
#!/bin/bash
|
||||
# Bootstrap the setup of WebGoat for developer use in Linux/Mac machines
|
||||
#!/bin/sh
|
||||
|
||||
# Bootstrap the setup of WebGoat for developer use in Linux and Mac machines
|
||||
# This script will clone the necessary git repositories, call the maven goals
|
||||
# in the order the are needed and launch tomcat listening on localhost:8080
|
||||
# Happy hacking !
|
||||
|
||||
# Clone WebGoat and WebGoat-lessons from GitHub if they don't exist
|
||||
if [ ! -d "WebGoat" ]; then
|
||||
git clone https://github.com/WebGoat/WebGoat.git
|
||||
fi
|
||||
if [ ! -d "WebGoat-Lessons" ]; then
|
||||
git clone https://github.com/WebGoat/WebGoat-Lessons.git
|
||||
# Find out what is our terminal size
|
||||
COLS="$(tput cols)"
|
||||
if (( COLS <= 0 )) ; then
|
||||
COLS="${COLUMNS:-80}"
|
||||
fi
|
||||
|
||||
# Compile and Install the WebGoat lesson server
|
||||
mvn -file WebGoat/pom.xml clean compile install
|
||||
# Colors
|
||||
ESC_SEQ="\x1b["
|
||||
COL_RESET=$ESC_SEQ"39;49;00m"
|
||||
COL_RED=$ESC_SEQ"31;01m"
|
||||
COL_GREEN=$ESC_SEQ"32;01m"
|
||||
COL_YELLOW=$ESC_SEQ"33;01m"
|
||||
COL_BLUE=$ESC_SEQ"34;01m"
|
||||
COL_MAGENTA=$ESC_SEQ"35;01m"
|
||||
COL_CYAN=$ESC_SEQ"36;01m"
|
||||
|
||||
# Compile and package the WebGoat Lessons
|
||||
mvn -file WebGoat-Lessons/pom.xml package
|
||||
# Horizontal Rule function
|
||||
horizontal_rule() {
|
||||
local WORD
|
||||
|
||||
# Copy the Lessons into the WebGoat-Container
|
||||
cp -fa ./WebGoat-Lessons/target/plugins/*.jar ./WebGoat/webgoat-container/src/main/webapp/plugin_lessons/
|
||||
for WORD in "#"
|
||||
do
|
||||
hr "$WORD"
|
||||
done
|
||||
}
|
||||
|
||||
# Start WebGoat using the maven tomcat7:run-war goal
|
||||
printf "\n"
|
||||
printf "\n"
|
||||
printf "\n"
|
||||
printf "\n"
|
||||
printf "\n"
|
||||
echo "-----------------------------------------------------------------------------------"
|
||||
echo "____________________ Starting WebGoat using the embedded Tomcat ___________________"
|
||||
echo "###################################################################################"
|
||||
echo "### Open a web browser and navigate to http://localhost:8080/WebGoat/"
|
||||
echo "### STDOUT and STDERR logs are captured in ./webgoat_developer_bootstrap.log"
|
||||
echo "### To stop the Tomcat execution, press CTRL + C"
|
||||
echo "### If you close this terminal window, Tomcat and WebGoat will stop running"
|
||||
echo "##################################### HAPPY HACKING! ##############################"
|
||||
echo "-----------------------------------------------------------------------------------"
|
||||
printf "\n"
|
||||
printf "\n"
|
||||
printf "\n"
|
||||
printf "\n"
|
||||
printf "\n"
|
||||
mvn -file WebGoat/pom.xml -pl webgoat-container tomcat7:run-war &> webgoat_developer_bootstrap.log
|
||||
hr() {
|
||||
local WORD="$1"
|
||||
if [[ -n "$WORD" ]] ; then
|
||||
local LINE=''
|
||||
while (( ${#LINE} < COLS ))
|
||||
do
|
||||
LINE="$LINE$WORD"
|
||||
done
|
||||
|
||||
echo "${LINE:0:$COLS}"
|
||||
fi
|
||||
}
|
||||
|
||||
## test if command exists
|
||||
ftest() {
|
||||
echo "$COL_CYAN info: Checking if ${1} is installed $COL_RESET"
|
||||
if ! type -f "${1}" > /dev/null 2>&1; then
|
||||
return 1
|
||||
else
|
||||
return 0
|
||||
fi
|
||||
}
|
||||
|
||||
|
||||
## feature tests
|
||||
features() {
|
||||
for f in "${@}"; do
|
||||
ftest "${f}" || {
|
||||
echo >&2 "***$COL_RED ERROR: Missing \`${f}'! Make sure it exists and try again. $COL_RESET"
|
||||
return 1
|
||||
}
|
||||
done
|
||||
return 0
|
||||
}
|
||||
|
||||
tomcat_started () {
|
||||
STAT=`netstat -na | grep 8080 | awk '{print $6}'`
|
||||
if [ "$STAT" = "LISTEN" ]; then
|
||||
echo "$COL_GREEN WebGoat has started successfully! Browse to the following address. $COL_RESET"
|
||||
echo "$COL_CYAN Happy Hacking! $COL_RESET"
|
||||
return 0
|
||||
|
||||
elif [ "$STAT" = "" ]; then
|
||||
echo "$COL_RED WebGoat failed to start up.... please wait run the following command for debugging : $COL_RESET"
|
||||
echo "$COL_MAGENTA mvn -q -file WebGoat/pom.xml -pl webgoat-container tomcat7:run-war"
|
||||
fi
|
||||
return 1
|
||||
}
|
||||
|
||||
|
||||
## main setup
|
||||
developer_bootstrap() {
|
||||
horizontal_rule
|
||||
echo "$COL_RED
|
||||
██╗ ██╗███████╗██████╗ ██████╗ ██████╗ █████╗ ████████╗
|
||||
██║ ██║██╔════╝██╔══██╗██╔════╝ ██╔═══██╗██╔══██╗╚══██╔══╝
|
||||
██║ █╗ ██║█████╗ ██████╔╝██║ ███╗██║ ██║███████║ ██║
|
||||
██║███╗██║██╔══╝ ██╔══██╗██║ ██║██║ ██║██╔══██║ ██║
|
||||
╚███╔███╔╝███████╗██████╔╝╚██████╔╝╚██████╔╝██║ ██║ ██║
|
||||
╚══╝╚══╝ ╚══════╝╚═════╝ ╚═════╝ ╚═════╝ ╚═╝ ╚═╝ ╚═╝
|
||||
$COL_RESET"
|
||||
horizontal_rule
|
||||
echo "Welcome to the WebGoat Developer Bootstrap script for Linux/Mac."
|
||||
echo "Now checking if all the required software to run WebGoat is already installed."
|
||||
echo "FYI: This Developer Bootstrap Script for WebGoat requires: Git, Java JDK and Maven accessible on the path"
|
||||
|
||||
## test for require features
|
||||
features git mvn java || return $?
|
||||
|
||||
# Clone WebGoat from github
|
||||
if [ ! -d "WebGoat" ]; then
|
||||
echo "Cloning the WebGoat container repository"
|
||||
git clone https://github.com/WebGoat/WebGoat.git
|
||||
else
|
||||
horizontal_rule
|
||||
(
|
||||
echo "$COL_YELLOW The WebGoat container repo has already been clonned before, pulling upstream changes. $COL_RESET"
|
||||
cd WebGoat || {
|
||||
echo >&2 "$COL_RED *** ERROR: Could not cd into the WebGoat Directory. $COL_RESET"
|
||||
return 1
|
||||
}
|
||||
git pull origin master
|
||||
)
|
||||
fi
|
||||
|
||||
# Clone WebGoat-lessons from GitHub if they don't exist
|
||||
if [ ! -d "WebGoat-Lessons" ]; then
|
||||
horizontal_rule
|
||||
echo -e "$COL_CYAN Cloning the WebGoat Lessons repository $COL_RESET"
|
||||
git clone https://github.com/WebGoat/WebGoat-Lessons.git
|
||||
else
|
||||
horizontal_rule
|
||||
(
|
||||
echo "$COL_YELLOW The WebGoat Lesson repo has already been cloned before, pulling upstream changes. $COL_RESET"
|
||||
cd WebGoat-Lessons || {
|
||||
echo >&2 "$COL_RED *** ERROR: Could not cd into the WebGoat-Lessons Directory $COL_RESET"
|
||||
return 1
|
||||
}
|
||||
git pull origin master
|
||||
)
|
||||
fi
|
||||
|
||||
# Compile and Install the WebGoat lesson server
|
||||
horizontal_rule
|
||||
echo "$COL_BLUE Compiling and installing the WebGoat Container lesson server..... $COL_RESET"
|
||||
mvn -q -DskipTests -file WebGoat/pom.xml clean compile install || {
|
||||
echo >&2 "$COL_RED *** ERROR: Could not compile the WebGoat Container. $COL_RESET"
|
||||
return 1
|
||||
}
|
||||
echo "$COL_GREEN SUCCESS: Compiled the WebGoat Container successfully! $COL_RESET"
|
||||
|
||||
# Compile and package the WebGoat Lessons
|
||||
horizontal_rule
|
||||
echo "$COL_BLUE Compiling and installing the WebGoat Lessons $COL_RESET"
|
||||
mvn -q -DskipTests -file WebGoat-Lessons/pom.xml package || {
|
||||
echo >&2 "$COL_RED *** ERROR: Could not compile the WebGoat Container. $COL_RESET"
|
||||
return 1
|
||||
}
|
||||
echo "$COL_GREEN SUCCESS: Compiled the WebGoat Lessons successfully! $COL_RESET"
|
||||
|
||||
# Copy the Lessons into the WebGoat-Container
|
||||
horizontal_rule
|
||||
echo "$COL_BLUE Copying the compiled lessons jars into the container so we can start the lesson server with some base lessons, $COL_RESET"
|
||||
cp -fa ./WebGoat-Lessons/target/plugins/*.jar ./WebGoat/webgoat-container/src/main/webapp/plugin_lessons/
|
||||
|
||||
# Start the embedded Tomcat server
|
||||
echo "$COL_MAGENTA"
|
||||
horizontal_rule
|
||||
horizontal_rule
|
||||
horizontal_rule
|
||||
horizontal_rule
|
||||
echo "$COL_MAGENTA"
|
||||
echo "$COL_CYAN ***** Starting WebGoat using the embedded Tomcat ***** $COL_RESET"
|
||||
echo " Please be patient.... The startup of the server can take from 30s to 3 minutes."
|
||||
echo " WebGoat will be ready for you when you see the following message on the command prompt:"
|
||||
echo "$COL_YELLOW INFO: Starting ProtocolHandler ["http-bio-8080"] $COL_RESET"
|
||||
echo "$COL_CYAN When you see the message above, open a web browser and navigate to http://localhost:8080/WebGoat/ $COL_RESET"
|
||||
echo " To stop the WebGoat and Tomcat Execution execution, press CTRL + C"
|
||||
echo "$COL_RED If you close this terminal window, Tomcat and WebGoat will stop running $COL_RESET"
|
||||
echo "$COL_MAGENTA"
|
||||
horizontal_rule
|
||||
horizontal_rule
|
||||
horizontal_rule
|
||||
horizontal_rule
|
||||
echo "$COL_RESET"
|
||||
sleep 5
|
||||
|
||||
# Starting WebGoat
|
||||
mvn -q -DskipTests -file WebGoat/pom.xml -pl webgoat-container tomcat7:run-war
|
||||
}
|
||||
|
||||
# Start main script
|
||||
developer_bootstrap
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user