mirror of
https://github.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker.git
synced 2025-09-02 18:50:13 +00:00
f67776d8a9
long options for the command line are removed. getopt is replaced with the newer getopts (which is compatible with Debian's DASH Shell) * fixes https://github.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/issues/35 * adds sanity checks for user command line switches * adds -v command line option to print blacklist version
269 lines
7.9 KiB
Bash
Executable file
269 lines
7.9 KiB
Bash
Executable file
#!/bin/sh
|
|
|
|
# Shell Script for Installing the Nginx Bad Bot Blocker
|
|
# Copyright - https://github.com/mitchellkrogza
|
|
# Project Url: https://github.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker
|
|
# Version 2.2017.07
|
|
# Install script & Alpine Linux package by Stuart Cardall: https://github.com/itoffshore
|
|
|
|
# PLEASE READ CONFIGURATION INSTRUCTIONS BEFORE USING THIS - THIS IS ONLY A PARTIAL INSTALLER
|
|
# FOR COPYING THE FILES CORRECTLY TO THE NGINX FOLDERS:
|
|
# https://github.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/blob/master/CONFIGURATION.md
|
|
|
|
# Use this script for a new install or to update to a new release (which has a new configuration
|
|
# file structure) and thereafter use the Auto Update Shell Script update-ngxblocker to update
|
|
# the blacklist in /etc/nginx/conf.d/globalblacklist.conf
|
|
|
|
# THIS INSTALL SCRIPT ONLY COPIES THE NECESSARY FILES FOR NGINX DIRECTLY FROM THE REPO
|
|
|
|
### The installer script does not carry out STEP 6 of the configuration instructions for you.
|
|
### You must manually edit any vhost files with the includes in STEP 6 or it will not actually be protecting any sites.
|
|
### READ: https://github.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/blob/master/CONFIGURATION.md
|
|
|
|
### You can also now use a setup script contributed by Stuart Cardall to automatically insert the includes for you
|
|
### See - https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/setup-ngxblocker
|
|
|
|
# Save this file as /usr/sbin/install-ngxblocker
|
|
# sudo wget https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/install-ngxblocker -O /usr/sbin/install-ngxblocker
|
|
# Make it Executable:
|
|
# chmod 700 /usr/sbin/install-ngxblocker
|
|
# Run it from the command line:
|
|
# sudo /usr/sbin/install-ngxblocker [ --help ]
|
|
|
|
######## LETS INSTALL NOW ###############################
|
|
|
|
CONF_DIR=/etc/nginx/conf.d
|
|
BOTS_DIR=/etc/nginx/bots.d
|
|
REPO=https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master
|
|
|
|
####### end user configuration ##########################
|
|
|
|
usage() {
|
|
local script=$(basename $0)
|
|
cat <<EOF
|
|
$script: INSTALL Nginx Bad Bot Blocker configuration to: [ $CONF_DIR ] [ $BOTS_DIR ]
|
|
|
|
Usage: $script [OPTIONS]
|
|
[ -b ] : Bot rules directory (default: $BOTS_DIR)
|
|
[ -c ] : NGINX conf directory (default: $CONF_DIR)
|
|
[ -r ] : Change repo url (default: $REPO)
|
|
[ -x ] : Actually change the files (default: don't change anything)
|
|
[ -v ] : Print blacklist version
|
|
[ -h ] : this help message
|
|
|
|
Examples:
|
|
$script (Don't change anything: display results on stdout)
|
|
$script -x (Download / update config files)
|
|
EOF
|
|
exit 0
|
|
}
|
|
|
|
check_version() {
|
|
local file=$CONF_DIR/globalblacklist.conf
|
|
|
|
if [ -f $file ]; then
|
|
grep Version $file
|
|
grep 'Updated:' $file
|
|
else
|
|
printf "Missing '$file' (pass -c \$path before -v)\n"
|
|
fi
|
|
|
|
exit 0
|
|
}
|
|
|
|
longest_str() {
|
|
echo $@ | tr " " "\n" | awk '{print length ($0)}' | sort -nr | head -n1
|
|
}
|
|
|
|
check_if_updating() {
|
|
local x= local_file= local_dir=$1
|
|
local file_list=$(echo $@ | awk '{$1=""; print}' | sed -e 's/^[[:space:]]*//')
|
|
|
|
for x in $file_list; do
|
|
local_file=$local_dir/$x
|
|
|
|
if [ ! -f $local_file ]; then
|
|
echo "true"
|
|
break
|
|
fi
|
|
done
|
|
}
|
|
|
|
download_files() {
|
|
local url= x= local_file= remote_dir=$1 local_dir=$2
|
|
local file_list=$(echo $@ | awk '{$1="",$2=""; print}')
|
|
local col_size=$(( $(longest_str $file_list) + $(echo $remote_dir | wc -m) ))
|
|
|
|
if [ -n "$(check_if_updating $local_dir $file_list)" ]; then
|
|
printf "\nREPO = $REPO\n\n"
|
|
|
|
for x in $file_list; do
|
|
local_file=$local_dir/$x
|
|
|
|
if [ ! -f $local_file ]; then
|
|
if [ "$DRY_RUN" = "N" ]; then
|
|
printf "%-21s %-$(( $col_size +8 ))s %s" \
|
|
"Downloading [FROM]=>" \
|
|
"[REPO]/$remote_dir/$x" \
|
|
"[TO]=> $local_file"
|
|
|
|
url=$REPO/$remote_dir/$x
|
|
wget -q $url -O $local_file
|
|
|
|
if [ $? = 0 ]; then
|
|
printf "...OK\n"
|
|
else
|
|
printf "...ERROR downloading: $url\n"
|
|
fi
|
|
else
|
|
printf "%-21s %-$(( $col_size +8 ))s %s\n" \
|
|
"Downloading [FROM]=>" \
|
|
"[REPO]/$remote_dir/$x" \
|
|
"[TO]=> $local_file"
|
|
fi
|
|
fi
|
|
done
|
|
else
|
|
printf "Nothing to update for directory: $local_dir\n"
|
|
fi
|
|
}
|
|
|
|
check_config() {
|
|
local x= dirs=$@
|
|
|
|
for x in $dirs; do
|
|
if [ ! -d $x ]; then
|
|
printf "Creating directory: $x\n"
|
|
if [ "$DRY_RUN" = "N" ]; then
|
|
mkdir -p $x
|
|
fi
|
|
fi
|
|
done
|
|
}
|
|
|
|
sanitize_path() {
|
|
echo $1 |tr -cd '[:alnum:] [=@=] [=.=] [=-=] [=/=] [=_=]' \
|
|
|tr -s '@.-/_' |awk '{print tolower($0)}'
|
|
}
|
|
|
|
sanitize_url() {
|
|
echo $1 |tr -cd '[:alnum:] [=:=] [=.=] [=-=] [=/=]' \
|
|
|tr -s ':.-' |awk '{print tolower($0)}'
|
|
}
|
|
|
|
check_args() {
|
|
local option=$1 type=$2 arg=$3
|
|
local msg="ERROR: option '-$option' argument '$arg' requires:"
|
|
|
|
case "$type" in
|
|
path) if ! echo $arg | grep ^/ 1>/dev/null; then
|
|
printf "$msg absolute path.\n"
|
|
exit 1
|
|
fi
|
|
;;
|
|
url) if ! echo $arg | grep -E ^http[s]?://[0-9a-zA-Z-]+[.]+[/0-9a-zA-Z.]+ 1>/dev/null; then
|
|
printf "$msg url => http[s]://the.url\n"
|
|
exit 1
|
|
fi
|
|
;;
|
|
none) printf "$msg argument.\n"; exit 1;;
|
|
esac
|
|
}
|
|
|
|
get_options() {
|
|
local arg= opts=
|
|
|
|
while getopts :b:c:r:xvh opts "$@"
|
|
do
|
|
if [ -n "${OPTARG}" ]; then
|
|
case "$opts" in
|
|
r) arg=$(sanitize_url ${OPTARG});;
|
|
*) arg=$(sanitize_path ${OPTARG});;
|
|
esac
|
|
fi
|
|
|
|
case "$opts" in
|
|
b) BOTS_DIR=$arg; check_args $opts path $arg ;;
|
|
c) CONF_DIR=$arg; check_args $opts path $arg ;;
|
|
r) REPO=$arg; check_args $opts url $arg ;;
|
|
x) DRY_RUN=N ;;
|
|
v) check_version ;;
|
|
h) usage ;;
|
|
\?) usage ;;
|
|
:) check_args $OPTARG none none ;;
|
|
esac
|
|
done
|
|
}
|
|
|
|
wget_opts() {
|
|
local opts=
|
|
|
|
# GNU wget / Busybox 1.26.2
|
|
if wget --help 2>&1 | grep -q "\--spider"; then
|
|
opts="--spider"
|
|
else # Busybox wget < 1.26.2
|
|
opts="-s"
|
|
fi
|
|
|
|
echo $opts
|
|
}
|
|
|
|
check_online() {
|
|
local url=$1 options=$(wget_opts)
|
|
|
|
if wget $options $url &>/dev/null; then
|
|
echo "true"
|
|
fi
|
|
}
|
|
|
|
main() {
|
|
local include_url=
|
|
|
|
# require root
|
|
if [ "$(id -u)" != "0" ]; then
|
|
echo "This script must be run as root" 1>&2
|
|
exit 1
|
|
fi
|
|
|
|
# parse command line
|
|
get_options $@
|
|
include_url=$REPO/include_filelist.txt
|
|
|
|
# check repo is online & source includes
|
|
printf "Checking url: $include_url\n"
|
|
if [ -n "$(check_online $include_url)" ]; then
|
|
local tmp=$(mktemp)
|
|
wget -q $include_url -O $tmp
|
|
source $tmp 2>/dev/null
|
|
rm -f $tmp
|
|
else
|
|
printf "Repo down or missing: $include_url\n"
|
|
exit 1
|
|
fi
|
|
|
|
# double check we have some files sourced
|
|
if [ -z "$CONF_FILES" ] || [ -z "$BOT_FILES" ]; then
|
|
printf "Error sourcing variables from: $include_url"
|
|
exit 1
|
|
fi
|
|
|
|
# by default do not change any files
|
|
if [ -z "$DRY_RUN" ]; then
|
|
printf "\n** Dry Run ** | -x or --exec to download files\n\n"
|
|
fi
|
|
|
|
check_config $CONF_DIR $BOTS_DIR
|
|
download_files conf.d $CONF_DIR $CONF_FILES
|
|
download_files bots.d $BOTS_DIR $BOT_FILES
|
|
}
|
|
|
|
## START ##
|
|
main $@
|
|
exit $?
|
|
|
|
# PLEASE READ CONFIGURATION INSTRUCTIONS
|
|
# https://github.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/blob/master/CONFIGURATION.md
|
|
|
|
# PLEASE ALSO SEE THE SETUP SCRIPT TO INSERT THE NECESSARY INCLUDES FOR YOU
|
|
### You can now use a setup script contributed by Stuart Cardall to automatically add the includes for you
|
|
### See - https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/setup-ngxblocker
|