From ea663145e21ef4b76dd2a0897399e69adf1c4907 Mon Sep 17 00:00:00 2001 From: clowwindy Date: Mon, 7 Apr 2014 17:03:35 +0800 Subject: [PATCH] add help --- CHANGES | 4 +++ README.md | 2 +- setup.py | 2 +- shadowsocks/encrypt.py | 2 +- shadowsocks/local.py | 68 ++++++++++++++++++++++-------------------- shadowsocks/server.py | 60 ++++++++++++++++++++----------------- shadowsocks/utils.py | 48 +++++++++++++++++++++++++++++ 7 files changed, 123 insertions(+), 63 deletions(-) diff --git a/CHANGES b/CHANGES index f387f43..6aef45b 100644 --- a/CHANGES +++ b/CHANGES @@ -1,3 +1,7 @@ +1.3.5 2014-04-07 +- Add help +- Change default local binding address into 127.0.0.1 + 1.3.4 2014-02-17 - Fix a bug when no config file exists - Client now support multiple server ports and multiple server/port pairs diff --git a/README.md b/README.md index f13a0b0..4408b8c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ shadowsocks =========== -Current version: 1.3.4 [![Build Status](https://travis-ci.org/clowwindy/shadowsocks.png?branch=master)](https://travis-ci.org/clowwindy/shadowsocks) +Current version: 1.3.5 [![Build Status](https://travis-ci.org/clowwindy/shadowsocks.png?branch=master)](https://travis-ci.org/clowwindy/shadowsocks) shadowsocks is a lightweight tunnel proxy which can help you get through firewalls. diff --git a/setup.py b/setup.py index adf13ac..1fdf95c 100644 --- a/setup.py +++ b/setup.py @@ -6,7 +6,7 @@ with open('README.rst') as f: setup( name = "shadowsocks", - version = "1.3.4", + version = "1.3.5", license = 'MIT', description = "a lightweight tunnel proxy", author = 'clowwindy', diff --git a/shadowsocks/encrypt.py b/shadowsocks/encrypt.py index 09a6db6..ee28575 100644 --- a/shadowsocks/encrypt.py +++ b/shadowsocks/encrypt.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Copyright (c) 2012 clowwindy +# Copyright (c) 2014 clowwindy # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal diff --git a/shadowsocks/local.py b/shadowsocks/local.py index b3061e6..11394c9 100755 --- a/shadowsocks/local.py +++ b/shadowsocks/local.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Copyright (c) 2013 clowwindy +# Copyright (c) 2014 clowwindy # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal @@ -190,45 +190,49 @@ def main(): IPv6 = False config_path = utils.find_config() - optlist, args = getopt.getopt(sys.argv[1:], 's:b:p:k:l:m:c:6') - for key, value in optlist: - if key == '-c': - config_path = value + try: + optlist, args = getopt.getopt(sys.argv[1:], 's:b:p:k:l:m:c:6') + for key, value in optlist: + if key == '-c': + config_path = value - if config_path: - logging.info('loading config from %s' % config_path) - with open(config_path, 'rb') as f: - try: - config = json.load(f) - except ValueError as e: - logging.error('found an error in config.json: %s', e.message) - sys.exit(1) - else: - config = {} + if config_path: + logging.info('loading config from %s' % config_path) + with open(config_path, 'rb') as f: + try: + config = json.load(f) + except ValueError as e: + logging.error('found an error in config.json: %s', e.message) + sys.exit(1) + else: + config = {} - optlist, args = getopt.getopt(sys.argv[1:], 's:b:p:k:l:m:c:6') - for key, value in optlist: - if key == '-p': - config['server_port'] = int(value) - elif key == '-k': - config['password'] = value - elif key == '-l': - config['local_port'] = int(value) - elif key == '-s': - config['server'] = value - elif key == '-m': - config['method'] = value - elif key == '-b': - config['local'] = value - elif key == '-6': - IPv6 = True + optlist, args = getopt.getopt(sys.argv[1:], 's:b:p:k:l:m:c:6') + for key, value in optlist: + if key == '-p': + config['server_port'] = int(value) + elif key == '-k': + config['password'] = value + elif key == '-l': + config['local_port'] = int(value) + elif key == '-s': + config['server'] = value + elif key == '-m': + config['method'] = value + elif key == '-b': + config['local'] = value + elif key == '-6': + IPv6 = True + except getopt.GetoptError: + utils.print_local_help() + sys.exit(2) SERVER = config['server'] REMOTE_PORT = config['server_port'] PORT = config['local_port'] KEY = config['password'] METHOD = config.get('method', None) - LOCAL = config.get('local', '') + LOCAL = config.get('local', '127.0.0.1') if not KEY and not config_path: sys.exit('config not specified, please read https://github.com/clowwindy/shadowsocks') diff --git a/shadowsocks/server.py b/shadowsocks/server.py index d045d5e..ba161fd 100755 --- a/shadowsocks/server.py +++ b/shadowsocks/server.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Copyright (c) 2013 clowwindy +# Copyright (c) 2014 clowwindy # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal @@ -144,35 +144,39 @@ def main(): IPv6 = False config_path = utils.find_config() - optlist, args = getopt.getopt(sys.argv[1:], 's:p:k:m:c:6') - for key, value in optlist: - if key == '-c': - config_path = value + try: + optlist, args = getopt.getopt(sys.argv[1:], 's:p:k:m:c:6') + for key, value in optlist: + if key == '-c': + config_path = value - if config_path: - logging.info('loading config from %s' % config_path) - with open(config_path, 'rb') as f: - try: - config = json.load(f) - except ValueError as e: - logging.error('found an error in config.json: %s', e.message) - sys.exit(1) - logging.info('loading config from %s' % config_path) - else: - config = {} + if config_path: + logging.info('loading config from %s' % config_path) + with open(config_path, 'rb') as f: + try: + config = json.load(f) + except ValueError as e: + logging.error('found an error in config.json: %s', e.message) + sys.exit(1) + logging.info('loading config from %s' % config_path) + else: + config = {} - optlist, args = getopt.getopt(sys.argv[1:], 's:p:k:m:c:6') - for key, value in optlist: - if key == '-p': - config['server_port'] = int(value) - elif key == '-k': - config['password'] = value - elif key == '-s': - config['server'] = value - elif key == '-m': - config['method'] = value - elif key == '-6': - IPv6 = True + optlist, args = getopt.getopt(sys.argv[1:], 's:p:k:m:c:6') + for key, value in optlist: + if key == '-p': + config['server_port'] = int(value) + elif key == '-k': + config['password'] = value + elif key == '-s': + config['server'] = value + elif key == '-m': + config['method'] = value + elif key == '-6': + IPv6 = True + except getopt.GetoptError: + utils.print_server_help() + sys.exit(2) SERVER = config['server'] PORT = config['server_port'] diff --git a/shadowsocks/utils.py b/shadowsocks/utils.py index 237ad88..4ad6356 100644 --- a/shadowsocks/utils.py +++ b/shadowsocks/utils.py @@ -1,6 +1,26 @@ #!/usr/bin/python # -*- coding: utf-8 -*- +# Copyright (c) 2014 clowwindy +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +# SOFTWARE. + import os import logging @@ -14,9 +34,37 @@ def find_config(): return config_path return None + def check_config(config): if config.get('server', '') in ['127.0.0.1', 'localhost']: logging.warn('Server is set to "%s", maybe it\'s not correct' % config['server']) logging.warn('Notice server will listen at %s:%s' % (config['server'], config['server_port'])) if (config.get('method', '') or '').lower() == 'rc4': logging.warn('RC4 is not safe; please use a safer cipher, like AES-256-CFB') + + +def print_local_help(): + print '''usage: sslocal [-h] -s SERVER_ADDR -p SERVER_PORT [-b LOCAL_ADDR] -l LOCAL_PORT -k PASSWORD -m METHOD [-c config] + +optional arguments: + -h, --help show this help message and exit + -s SERVER_ADDR server address + -p SERVER_PORT server port + -b LOCAL_ADDR local binding address, default is 127.0.0.1 + -s LOCAL_PORT local port + -k PASSWORD password + -s METHOD encryption method, for example, aes-256-cfb + -c CONFIG path to config file +''' + +def print_server_help(): + print '''usage: ssserver [-h] -s SERVER_ADDR -p SERVER_PORT -k PASSWORD -m METHOD [-c config] + +optional arguments: + -h, --help show this help message and exit + -s SERVER_ADDR server address + -p SERVER_PORT server port + -k PASSWORD password + -s METHOD encryption method, for example, aes-256-cfb + -c CONFIG path to config file +''' \ No newline at end of file