forked from EvergreenCrypto/docker-finance
client: plugins: implement Tor plugin (tor.bash)
- Creates, prepares and manages containerized Tor instance - Prepares a running docker-finance container to proxy (`proxychains-ng`) through the containerized Tor instance
This commit is contained in:
161
client/plugins/docker/tor.bash
Executable file
161
client/plugins/docker/tor.bash
Executable file
@@ -0,0 +1,161 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
# docker-finance | modern accounting for the power-user
|
||||
#
|
||||
# Copyright (C) 2024 Aaron Fiore (Founder, Evergreen Crypto LLC)
|
||||
#
|
||||
# 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/>.
|
||||
|
||||
#
|
||||
# "Libraries"
|
||||
#
|
||||
|
||||
[ -z "$DOCKER_FINANCE_CLIENT_REPO" ] && exit 1
|
||||
source "${DOCKER_FINANCE_CLIENT_REPO}/client/src/docker/lib/lib_docker.bash"
|
||||
|
||||
[[ -z "$global_platform" || -z "$global_arg_delim_1" || -z "$global_user" || -z "$global_tag" ]] && lib_utils::die_fatal
|
||||
instance="${global_platform}${global_arg_delim_1}${global_user}:${global_tag}"
|
||||
lib_docker::docker "$instance" # NOTE: "constructor" only needed if calling library directly
|
||||
|
||||
#
|
||||
# Implementation
|
||||
#
|
||||
|
||||
declare -g tor_container="docker-finance_tor"
|
||||
|
||||
# TODO: current implementation will clobber any other proxychains usage (i.e., other SOCKS proxy or overlay network (I2P, etc.))
|
||||
function tor::start()
|
||||
{
|
||||
[[ -z "$global_container" || -z "$global_network" ]] && lib_utils::die_fatal
|
||||
|
||||
# NOTE: proxychains.conf's [ProxyList] won't allow hostnames (or Docker network container name).
|
||||
# So, to avoid conflicting IP address spaces, docker-finance will not hardcode address space.
|
||||
# Ergo, a already-running container will be needed (sorry, lib_docker::run())
|
||||
if ! docker container inspect -f '{{.State.Running}}' "$global_container" &>/dev/null; then
|
||||
lib_utils::die_fatal "docker-finance not running! Bring \`up\` container and try again."
|
||||
fi
|
||||
|
||||
local -r _torrc="/etc/tor/torrc"
|
||||
|
||||
if docker container inspect -f '{{.State.Running}}' "$tor_container" &>/dev/null; then
|
||||
lib_utils::print_error "${tor_container}: instance already running (consider \`restart\`)"
|
||||
return 1
|
||||
else
|
||||
docker run -it --rm --detach \
|
||||
--network "$global_network" \
|
||||
--name="${tor_container}" \
|
||||
--entrypoint=/bin/sh alpine:latest -c "
|
||||
apk update \
|
||||
&& apk add tor \
|
||||
&& cp ${_torrc}.sample ${_torrc} \
|
||||
&& su -s /usr/bin/tor tor" 1>/dev/null || lib_utils::die_fatal
|
||||
fi && lib_utils::print_info "${tor_container}: container started"
|
||||
|
||||
# Get Tor container's local IP
|
||||
local _ip
|
||||
_ip="$(docker inspect -f '{{range.NetworkSettings.Networks}}{{.IPAddress}}{{end}}' $tor_container)"
|
||||
lib_utils::print_info "${tor_container}: container IP '${_ip}'"
|
||||
|
||||
# Need to wait for a working installation
|
||||
lib_utils::print_warning "${tor_container}: waiting for Tor installation"
|
||||
while ! docker exec "$tor_container" /bin/sh -c 'apk info -e tor' 1>/dev/null; do
|
||||
sleep 1s
|
||||
done && lib_utils::print_info "${tor_container}: Tor installation ready"
|
||||
|
||||
# Update torrc with container's local IP (to avoid 0.0.0.0)
|
||||
lib_utils::print_info "${tor_container}: updating $_torrc"
|
||||
docker exec "$tor_container" \
|
||||
/bin/sh -c "
|
||||
sed -i '/^SOCKSPort /d' ${_torrc} \
|
||||
&& echo 'SOCKSPort ${_ip}:9050' >>${_torrc}" || lib_utils::die_fatal
|
||||
|
||||
# Have Tor pickup changes
|
||||
lib_utils::print_info "${tor_container}: restarting Tor with updated ${_torrc}"
|
||||
docker exec "$tor_container" /bin/sh -c "pkill -HUP tor" || lib_utils::die_fatal
|
||||
|
||||
# Set docker-finance's proxychains to point to Tor instance
|
||||
local -r _proxychains="/etc/proxychains.conf"
|
||||
lib_utils::print_info "${global_container}: updating $_proxychains"
|
||||
docker exec -it --user root "$global_container" \
|
||||
/bin/bash -i -c "
|
||||
sed -i \
|
||||
-e 's:^#quiet_mode:quiet_mode:' \
|
||||
-e 's:^# localnet 127.0.0.0/255.0.0.0:localnet 127.0.0.0/255.0.0.0:' \
|
||||
-e '/^socks/d' $_proxychains \
|
||||
&& echo 'socks5 $_ip 9050' >>$_proxychains" || lib_utils::die_fatal
|
||||
|
||||
# Test Tor connection
|
||||
local -r _sleep="15s"
|
||||
lib_utils::print_warning "${global_container}: testing connection (bootstrapping ~${_sleep})"
|
||||
sleep "$_sleep" # Give time to bootstrap
|
||||
# TODO: run timer to verify response (and fail if N times if no response)
|
||||
docker exec -it "$global_container" \
|
||||
/bin/bash -i -c "
|
||||
proxychains curl -s https://check.torproject.org 2>/dev/null \
|
||||
| grep -B3 'Your IP address appears to be' \
|
||||
| sed -e 's/^ //g' -e '\$ s/[^\\.0-9]//g' -e '/^\$/d' -e '2,3d'" || lib_utils::die_fatal
|
||||
}
|
||||
|
||||
function tor::stop()
|
||||
{
|
||||
if ! docker container inspect -f '{{.State.Running}}' "$tor_container" &>/dev/null; then
|
||||
lib_utils::print_error "${tor_container}: container not running"
|
||||
return 1
|
||||
fi
|
||||
lib_utils::print_warning "${tor_container}: stopping container"
|
||||
docker container stop "$tor_container" &>/dev/null \
|
||||
&& lib_utils::print_info "${tor_container}: container stopped"
|
||||
}
|
||||
|
||||
function tor::restart()
|
||||
{
|
||||
tor::stop
|
||||
tor::start
|
||||
}
|
||||
|
||||
function main()
|
||||
{
|
||||
local -r _usage="
|
||||
\e[32mDescription:\e[0m
|
||||
|
||||
Connect docker-finance container's \`fetch\` to The Onion Router.
|
||||
|
||||
\e[32mUsage:\e[0m
|
||||
|
||||
\e[37;2m# Client (host) command\e[0m
|
||||
$ dfi $instance plugins repo${global_arg_delim_1}$(basename $0) <{start|up}|restart|{stop|down}>
|
||||
|
||||
\e[37;2m# Container command (see \`fetch\` help for usage)\e[0m
|
||||
$ dfi <profile${global_arg_delim_1}subprofile> fetch help
|
||||
"
|
||||
|
||||
case "$1" in
|
||||
start | up)
|
||||
tor::start
|
||||
;;
|
||||
stop | down)
|
||||
tor::stop
|
||||
;;
|
||||
restart)
|
||||
tor::restart
|
||||
;;
|
||||
*)
|
||||
lib_utils::die_usage "$_usage"
|
||||
;;
|
||||
esac
|
||||
}
|
||||
|
||||
main "$@"
|
||||
|
||||
# vim: sw=2 sts=2 si ai et
|
||||
Reference in New Issue
Block a user