#!/usr/bin/python3 # SPDX-License-Identifier: AGPL-3.0-or-later """ Helper script for configuring Shadowsocks. """ import argparse import json import os import pathlib import random import string import sys from shutil import move from plinth import action_utils from plinth.modules import shadowsocks SHADOWSOCKS_CONFIG_SYMLINK = '/etc/shadowsocks-libev/freedombox.json' SHADOWSOCKS_CONFIG_ACTUAL = \ '/var/lib/private/shadowsocks-libev/freedombox/freedombox.json' def parse_arguments(): """Return parsed command line arguments as dictionary.""" parser = argparse.ArgumentParser() subparsers = parser.add_subparsers(dest='subcommand', help='Sub command') subparsers.add_parser('setup', help='Perform initial setup steps') subparsers.add_parser('get-config', help='Read and print JSON config to stdout') subparsers.add_parser('merge-config', help='Merge JSON config from stdin with existing') subparsers.required = True return parser.parse_args() def subcommand_setup(_): """Perform initial setup steps.""" # Only client socks5 proxy is supported for now. Disable the # server component. action_utils.service_disable('shadowsocks-libev') os.makedirs('/var/lib/private/shadowsocks-libev/freedombox/', exist_ok=True) # if existing configuration from version 1 which is normal file # move it to new location. if (not os.path.islink(SHADOWSOCKS_CONFIG_SYMLINK) and os.path.isfile(SHADOWSOCKS_CONFIG_SYMLINK)): move(SHADOWSOCKS_CONFIG_SYMLINK, SHADOWSOCKS_CONFIG_ACTUAL) if not os.path.islink(SHADOWSOCKS_CONFIG_SYMLINK): os.symlink(SHADOWSOCKS_CONFIG_ACTUAL, SHADOWSOCKS_CONFIG_SYMLINK) if not os.path.isfile(SHADOWSOCKS_CONFIG_ACTUAL): password = ''.join( random.choice(string.ascii_letters) for _ in range(12)) initial_config = { 'server': '127.0.0.1', 'server_port': 8388, 'local_port': 1080, 'password': password, 'method': 'chacha20-ietf-poly1305' } _merge_config(initial_config) # Commit 50e5608331330b37c0b9cce846e34ccc193d1b0d incorrectly sets the # StateDirectory without setting DynamicUser. Buster's shadowsocks will # then create directory /var/lib/shadowsocks-libev/freedombox/ and refuse # to delete is in later versions when DynamicUser=yes needs it to be a # symlink. action_utils.service_daemon_reload() wrong_state_dir = pathlib.Path('/var/lib/shadowsocks-libev/freedombox/') if not wrong_state_dir.is_symlink() and wrong_state_dir.is_dir(): wrong_state_dir.rmdir() if action_utils.service_is_enabled(shadowsocks.managed_services[0]): action_utils.service_restart(shadowsocks.managed_services[0]) def subcommand_get_config(_): """Read and print Shadowsocks configuration.""" try: print(open(SHADOWSOCKS_CONFIG_SYMLINK, 'r').read()) except Exception: sys.exit(1) def _merge_config(config): """Write merged configuration into file.""" try: current_config = open(SHADOWSOCKS_CONFIG_SYMLINK, 'r').read() current_config = json.loads(current_config) except (OSError, json.JSONDecodeError): current_config = {} new_config = current_config new_config.update(config) new_config = json.dumps(new_config, indent=4, sort_keys=True) open(SHADOWSOCKS_CONFIG_SYMLINK, 'w').write(new_config) def subcommand_merge_config(_): """Configure Shadowsocks.""" config = sys.stdin.read() config = json.loads(config) _merge_config(config) # Don't try_restart because initial configuration may not be valid so # shadowsocks will not be running even when enabled. if action_utils.service_is_enabled(shadowsocks.managed_services[0]): action_utils.service_restart(shadowsocks.managed_services[0]) def main(): """Parse arguments and perform all duties.""" arguments = parse_arguments() subcommand = arguments.subcommand.replace('-', '_') subcommand_method = globals()['subcommand_' + subcommand] subcommand_method(arguments) if __name__ == '__main__': main()