#!/bin/bash

# tor-ctrl is a commandline tool for executing commands on a Tor server via
# the controlport.  In order to get this to work, add "ControlPort 9051" and
# "CookieAuthentication 1" to your torrc and reload Tor.  Or - if you want a
# fixed password - leave out "CookieAuthentication 1" and use the following
# line to create the appropriate HashedControlPassword entry for your torrc
# (you need to change yourpassword, of course):
#
# echo "HashedControlPassword $(tor --hash-password yourpassword | tail -n 1)"
#
# tor-ctrl will return 0 if it was successful and 1 if not, 2 will be returned
# if something (telnet, xxd) is missing.  4 will be returned if it executed
# several commands from a file.
#
# For setting the bandwidth for specific times of the day, I suggest calling
# tor-ctrl via cron, e.g.:
#
# 0 22 * * * /path/to/tor-ctrl -c "SETCONF bandwidthrate=1mb"
# 0 7 * * *  /path/to/tor-ctrl -c "SETCONF bandwidthrate=100kb"
#
# This would set the bandwidth to 100kb at 07:00 and to 1mb at 22:00.  You can
# use notations like 1mb, 1kb or the number of bytes.

# Many, many other things are possible, see
#              https://gitweb.torproject.org/torspec.git/tree/control-spec.txt

# Copyright (c) 2007 by Stefan Behte
# Portion Copyright (C) 2013 - 2019 ENCRYPTED SUPPORT LP <adrelanos@riseup.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#
# On Debian systems, the full text of the GNU General Public
# License version 3 can be found in the file
# `/usr/share/common-licenses/GPL-3'.

# tor-ctrl was originally written by Stefan Behte
#
# Please send bugs, comments, wishes, thanks and success stories to:
# Stefan dot Behte at gmx dot net
#
# Also have a look at my page:
# http://ge.mine.nu/

TORCTLIP=127.0.0.1
TORCTLPORT=9051
TOR_COOKIE="/run/tor/control.authcookie"
TOR_CONTROL="/run/tor/control"
SLEEP_AFTER_CMD=1
VERBOSE=0

usage()
{
cat <<EOF

tor-ctrl was originally written by Stefan Behte (http://ge.mine.nu)

You should have a look at
https://gitweb.torproject.org/torspec.git/tree/control-spec.txt

usage: tor-ctrl [-switch] [variable]

       [-c] [command] = command to execute
                        notice: always "quote" your command

       [-f] [file]    = file to execute commands from
                        notice: only one command per line

       [-a] [path]    = path to Tor's control_auth_cookie
                        default: /run/tor/control.authcookie
                        notice: do not forget to adjust your torrc

       [-s] [time]    = sleep [var] seconds after each command sent
                        default: 1 second
                        notice: for GETCONF, you can use smaller pause times
                        than for SETCONF; this is due to telnet's behavior.

       [-p] [pwd]     = Use password [var] instead of Tor's control_auth_cookie
                        default: not used
                        notice: do not forget to adjust your torrc

       [-P] [port]     = Tor ControlPort
                        default: 9051

       [-v]           = verbose
                        default: not set
                        notice: the default output is the return code ;)
                        You probably want to set -v when running manually

       [-w]           = wait instead of exiting after command
                        default: not set
                        notice: implies verbose. Useful with SETEVENTS.

       Examples:      tor-ctrl -c "SETCONF bandwidthrate=1mb"
                      tor-ctrl -v -c "GETINFO version"
                      tor-ctrl -v -s 0 -P 9051 -p foobar -c "GETCONF bandwidthrate"

EOF
exit 2
}

checkprogs()
{
        local programs
        programs="telnet"
        if [ "$PASSWORD" = "" ]; then
                # you only need xxd when using control_auth_cookie
                programs="$programs xxd"
        fi

        for p in $programs ; do
                command -v "$p" &>/dev/null            # are you there?
                if [ "$?" != "0" ]; then
                        echo "$p is missing."
                        exit 2
                fi
        done
}

sendcmd()
{
        echo "$@"
        sleep "${SLEEP_AFTER_CMD}"
}

login()
{
        if [ "$PASSWORD" = "" ]; then
                sendcmd "AUTHENTICATE $(xxd -c 32 -g 0 "${TOR_COOKIE}" | awk '{print $2}')"
        else
                sendcmd "AUTHENTICATE \"${PASSWORD}\""
        fi
}

cmdpipe()
{
        login
        sendcmd "$@"
        if [ -z "$WAIT" ]; then
                sendcmd "QUIT"
        else
                while sleep 3600; do :; done
        fi
}

vecho()
{
        if [ "$VERBOSE" -ge 1 ]; then
                echo "$@"
        fi
}

myecho()
{
        local STR
        if [ -z "$WAIT" ]; then
                STR="$(cat)"
                vecho "$STR"
                echo "$STR" | if [ "$(grep -c ^"250 ")" = 3 ]; then
                        exit 0
                else
                        exit 1
                fi
        else
                cat
        fi
}

filepipe()
{
        login
        cat "$1" | while read line
        do
                sendcmd "$line"
        done
        sendcmd "QUIT"
}

while getopts ":a:c:s:p:P:f:vwh" Option
do
        case $Option in
                a) TOR_COOKIE="${OPTARG}";;
                c) CMD="${OPTARG}";;
                s) SLEEP_AFTER_CMD="${OPTARG}";;
                p) PASSWORD="${OPTARG}";;
                P) TORCTLPORT="${OPTARG}";;
                f) FILE="${OPTARG}";;
                v) VERBOSE=1;;
                w) WAIT=1;;
                h) usage;;
                *) usage;;
        esac
done

if [ -e "$FILE" -o "$FILE" = "-" ]; then
        checkprogs
        #filepipe "$FILE" | telnet "$TORCTLIP" "$TORCTLPORT" 2>/dev/null | myecho
        filepipe "$FILE" | socat - UNIX-CONNECT:"$TOR_CONTROL" | myecho
        exit 4
fi

if [ "$CMD" != "" ]; then
        checkprogs
        #cmdpipe "$CMD" | telnet "$TORCTLIP" "$TORCTLPORT" 2>/dev/null | myecho
        cmdpipe "$CMD" | socat - UNIX-CONNECT:"$TOR_CONTROL" | myecho
else
        usage
fi