mengskysama · dous03009 · May 18, 2016 · May 18, 2016 · May 18, 2016 · May 18, 2016
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,18 @@
+- Firstly, you are suggested to try the latest released version **OR** the latest commit.
+- Secondly, before you submit an issue, please first search existing issues (including the open and closed ones).
+- Lastly, if the above two did not help, please submit an issue following this template.
+- **PLEASE MAKE SURE THAT THE PROBLEM IS WITH THIS REPO. WE DO NOT ANSWER ANY PROBLEM RELATED TO YOUR PANEL/WEB SERVER**
+- You are free to delete this and the above lines (total 5 lines)
+
+# Version
+(tell us the version you are using, including the commit hash if you are not using a released version)
+
+# Your Problem
+(describe: what you have done, what you expect to see, what you actually see)
+
+(you can paste your log here. Please enable VERBOSE in the configuration file and run the server again to get detailed log)
+
+(suggestion is also welcomed)
+
+# Your Configuration File
+(i.e. config.py. Please use proper markdown to quote it. Remember to delete all sensitive info such as domain name & api key)
diff --git a/.gitignore b/.gitignore
@@ -29,3 +29,20 @@ htmlcov
 
 .DS_Store
 .idea
+tags
+shadowsocks/config.py
+*.log
+*.pyc
+
+#Emacs
+.#*
+venv/
+
+# VS-code
+.vscode/
+
+# Pycharm
+.idea
+
+#ss
+config.json
diff --git a/.travis.yml b/.travis.yml
@@ -10,12 +10,14 @@ cache:
 before_install:
   - sudo apt-get update -qq
   - sudo apt-get install -qq build-essential dnsutils iproute nginx bc
-  - sudo dd if=/dev/urandom of=/usr/share/nginx/www/file bs=1M count=10
+  - sudo dd if=/dev/urandom of=/usr/share/nginx/html/file bs=1M count=10
   - sudo sh -c "echo '127.0.0.1    localhost' > /etc/hosts"
   - sudo service nginx restart
   - pip install pep8 pyflakes nose coverage PySocks
   - sudo tests/socksify/install.sh
   - sudo tests/libsodium/install.sh
+  - sudo tests/libmbedtls/install.sh
+  - sudo tests/libopenssl/install.sh
   - sudo tests/setup_tc.sh
 script:
   - tests/jenkins.sh
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,7 @@
+FROM python:2.7-alpine
+MAINTAINER coderfox<[email protected]>
+RUN apk update && apk add libsodium git
+COPY . /shadowsocks
+WORKDIR /shadowsocks/shadowsocks
+RUN pip install cymysql
+CMD python servers.py
diff --git a/README.md b/README.md
@@ -1,66 +1,103 @@
-About manyuser
-----------------
-
-Install
--------
-
-install MySQL 5.x.x
-
-`pip install cymysql`
-
-create a database named `shadowsocks`
-
-import `shadowsocks.sql` into `shadowsocks`
-
-if you upgrade from old version make sure:
-
-  `pass` is varchar(32) NOT NULL,
-  `passwd` is varchar(32) NOT NULL,
-  `last_get_gift_time` not `last_get_gitf_time`
-
-
-edit config.py
-
-Example:
-
-    #Config
-    MYSQL_HOST = 'mengsky.net'
-    MYSQL_PORT = 3306
-    MYSQL_USER = 'root'
-    MYSQL_PASS = 'root'
-    MYSQL_DB = 'shadowsocks'
-
-    MANAGE_PASS = 'passwd'
-    #if you want manage in other server you should set this value to global ip
-    MANAGE_BIND_IP = '127.0.0.1'
-    #make sure this port is idle
-    MANAGE_PORT = 23333
-    #BIND IP
-    #if you want bind ipv4 and ipv6 '[::]'
-    #if you want bind all of ipv4 if '0.0.0.0'
-    #if you want bind all of if only '4.4.4.4'
-    SS_BIND_IP = '0.0.0.0'
-
-
-TestRun `cd shadowsocks` ` python servers.py` not server.py
-
-if no exception server will startup. you will see such like
-Example:
-
-    add: {"server_port": XXXXX, "password":"XXXXX"}
-
+About Shadowsocks-python Manyuser
+=================================
+This is a multi-user version of shadowsocks-python. Requires a mysql database or a panel which supports SS MU API.
+
+Requirement
+-----------
+1. Python >= 2.5 (python=2.5 need to install extra library: `pip install simplejson`)
+2. MySQL >= 5 (if using database)
+3. A Panel with [MU API](https://github.com/fsgmhoward/shadowsocks-py-mu/wiki/MultiUser-(MU)-API-Reference), such as [SS-Panel V3](https://github.com/orvice/ss-panel). (if using MU API)
+
+Install Instructions for Database User
+--------------------------------------
+1. install `cymysql` library by `pip install cymysql`
+2. create a database named `shadowsocks`
+3. import `shadowsocks.sql` into the `shadowsocks` database
+4. copy `config_example.py` to `config.py` and edit it following the notes inside (but DO NOT delete the example file). You *DO NOT* need to edit the API section.
+5. TestRun `cd shadowsocks && python servers.py` (not server.py)
+
+Install Instructions for MU API User
+-----------------------------------
+1. copy `config_example.py` to `config.py` and edit it following the notes inside (but DO NOT delete the example file). You *DO NOT* need to edit the Database section.
+2. TestRun `cd shadowsocks && python servers.py` (not server.py)
+
+Install Instructions for Docker User
+------------------------------------
+
+1. build the docker: `docker build -t shadowsocks-mu .`
+2. create a config file as above
+3. run the docker (random free ports will be allocated):
+
+   ```
+   docker run -it \
+       -v /PATH/TO/CONFIG/FILE:/shadowsocks/shadowsocks/config.py \
+       -v /PATH/TO/LOG/FILE:/shadowsocks/shadowsocks/shadowsocks.log \
+       -p PORT_START-PORT_END \
+       shadowsocks-mu
+   ```
+
+   If you want to use fixed ports (e.g. port 443 of the host being matched with 443 of the docker), use `-p PORT_START-PORT_END:PORT_START-PORT_END` instead.
+
+   Note: `/PATH/TO/CONFIG/FILE` & `/PATH/TO/LOG/FILE` should be **absolute** paths
+
+Reminders for Windows User
+--------------------------
+1. install `pyuv` library by `pip install pyuv`
+2. if git is not configured in your `%PATH%` environmental variable, you can create a file named `.nogit` to avoid using `git describe`
+
+If no exceptions are thrown, the server will startup. By default, logging is enabled.
+You should be able to see this kind of thing in `shadowsocks.log`(default log file name)
+```
+Jun 24 01:06:08 INFO -----------------------------------------
+Jun 24 01:06:08 INFO Multi-User Shadowsocks Server Starting...
+Jun 24 01:06:08 INFO Current Server Version: 3.1.0-1-gc2ac618
+
+Jun 24 01:10:11 INFO api downloaded
+Jun 24 01:10:13 INFO api skipped port 443
+Jun 24 01:10:13 INFO Server Added:   P[XXXXX], M[rc4-md5], E[[email protected]]
+Jun 24 01:10:13 INFO Server Added:   P[XXXXX], M[rc4-md5], E[[email protected]]
+```
+
+Explanation of the log output
+-----------------------------
+When adding server:
+
+`P[XXX]` client port (assigned by database)
+
+`M[XXX]` client encryption method
+
+`E[XXX]` client email address
+
+When data connection being established/blocked
+
+`U[XXX]` client port (assigned by database)
+
+`RP[XXX]` remote port (the port the client wants to connect)
+
+`A[XXX-->XXX]` from the client address to the remote address
 
 Database user table column
-------------------
+--------------------------
 `passwd` server pass
 
 `port` server port
 
-`t` last keepalive time
+`t` last connecting time
+
+`u` no usage for this shadowsocks server (kept unchanged) but essential for some panels
+
+`d` accumulated upload + download data transfer
+
+`method` custom encryption method
 
-`u` upload transfer
+`enable`/`switch` indicating whether the user is enabled
 
-`d` download transfer (upload & download in here now)
+`transfer_enable` maximum accumulated data transfer allowed - if `u` + `d` > `transfer_enable`, service for this client will be stopped (other clients are not affected)
 
-`transfer_enable` if u + d > transfer_enable this server will be stop (db_transfer.py del_server_out_of_bound_safe)
+Compatibility with frontend UIs
+-------------------------------
+It is fully compatible (through [MU API](https://github.com/fsgmhoward/shadowsocks-py-mu/wiki/MultiUser-(MU)-API-Reference)) with [ss-panel V3](https://github.com/orvice/ss-panel) .
 
+Open source license
+-------------------
+This program is licensed under [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)
diff --git a/config.json.example b/config.json.example
@@ -0,0 +1,17 @@
+{
+    "server":"127.0.0.1",
+    "server_port":8388,
+    "local_port":1080,
+    "password":"password",
+    "timeout":600,
+    "method":"aes-256-cfb",
+    "local_address":"127.0.0.1",
+    "fast_open":false,
+    "tunnel_remote":"8.8.8.8",
+    "dns_server":["8.8.8.8", "8.8.4.4"],
+    "tunnel_remote_port":53,
+    "tunnel_port":53,
+    "libopenssl":"C:\\Program Files\\Git\\mingw64\\bin\\libeay32.dll",
+    "libsodium":"/usr/local/lib/libsodium.so",
+    "libmbedtls":"/usr/local/lib/libmbedcrypto.2.4.0.dylib"
+}
diff --git a/debian/changelog b/debian/changelog
@@ -1,3 +1,26 @@
+shadowsocks (2.9.0-2) unstable; urgency=medium
+
+  [ Shell.Xu ]
+  * Fix compatible issue (Closes: #845016)
+
+ -- Shell.Xu <[email protected]>  Sun, 20 Nov 2016 14:33:31 +0800
+
+shadowsocks (2.9.0-1) unstable; urgency=medium
+
+  [ Shell Xu ]
+  * Upstream update (Closes: #824640)
+  * Remove reference not exists (Closes: #810688)
+
+  [ Thomas Goirand ]
+  * Added lsb-base as Depends:.
+  * Removed Pre-Depends: dpkg (>= 1.15.6~).
+  * Ran wrap-and-sort -t -a.
+  * Fixed VCS URLs to use https.
+  * Removed useless obsolete version of python-all build-depends.
+  * Fixed debian/copyright ordering.
+
+ -- Shell.Xu <[email protected]>  Sat, 01 Oct 2016 16:14:47 +0800
+
 shadowsocks (2.1.0-1) unstable; urgency=low
 
   * Initial release (Closes: #758900)

diff --git a/debian/config.json b/debian/config.json
@@ -7,5 +7,6 @@
     "timeout":300,
     "method":"aes-256-cfb",
     "fast_open": false,
-    "workers": 1
+    "workers": 1,
+    "prefer_ipv6": false
 }
diff --git a/debian/control b/debian/control
@@ -2,18 +2,23 @@ Source: shadowsocks
 Section: python
 Priority: extra
 Maintainer: Shell.Xu <[email protected]>
-Build-Depends: debhelper (>= 8), python-all (>= 2.6.6-3~), python-setuptools
-Standards-Version: 3.9.5
-Homepage: https://github.com/clowwindy/shadowsocks
-Vcs-Git: git://github.com/shell909090/shadowsocks.git
-Vcs-Browser: http://github.com/shell909090/shadowsocks
+Build-Depends: debhelper (>= 8),
+               python-all,
+               python-setuptools,
+Standards-Version: 3.9.8
+Homepage: https://github.com/shadowsocks/shadowsocks
+Vcs-Git: https://github.com/shell909090/shadowsocks.git
+Vcs-Browser: https://github.com/shell909090/shadowsocks
 
 Package: shadowsocks
 Architecture: all
-Pre-Depends: dpkg (>= 1.15.6~)
-Depends: ${misc:Depends}, ${python:Depends}, python-pkg-resources, python-m2crypto
+Depends: lsb-base (>= 3.0-6),
+         python-m2crypto,
+         python-pkg-resources,
+         ${misc:Depends},
+         ${python:Depends},
 Description: Fast tunnel proxy that helps you bypass firewalls
  A secure socks5 proxy, designed to protect your Internet traffic.
  .
  This package contain local and server part of shadowsocks, a fast,
- powerful tunnel proxy to bypass firewalls.
+ powerful tunnel proxy to bypass firewalls.
diff --git a/debian/copyright b/debian/copyright
@@ -1,30 +1,27 @@
 Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
 Upstream-Name: shadowsocks
-Source: https://github.com/clowwindy/shadowsocks
-
-Files: debian/*
-Copyright: 2014 Shell.Xu <[email protected]>
-License: Expat
+Source: https://github.com/shadowsocks/shadowsocks
 
 Files: *
 Copyright: 2014 clowwindy <[email protected]>
-License: Expat
+License: Apache-2.0
+
+Files: debian/*
+Copyright: 2016 Shell.Xu <[email protected]>
+License: Apache-2.0
 
-License: Expat
- 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.
+License: Apache-2.0
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+ .
+     http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
  .
- 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.
+ On Debian systems, the complete text of the Apache License 2.0 can
+ be found in "/usr/share/common-licenses/Apache-2.0"
diff --git a/debian/install b/debian/install
@@ -1 +1 @@
-debian/config.json etc/shadowsocks/
+debian/config.json etc/shadowsocks/
diff --git a/debian/shadowsocks.manpages b/debian/shadowsocks.manpages
@@ -1,2 +1,2 @@
 debian/sslocal.1
-debian/ssserver.1
+debian/ssserver.1
diff --git a/debian/sslocal.1 b/debian/sslocal.1
@@ -55,5 +55,5 @@ Quiet mode, only show warnings/errors.
 The programs are documented fully by
 .IR "Shell Xu <[email protected]>"
 and 
-.IR "Clowwindy <[email protected]>",
-available via the Info system.
+.IR "Clowwindy <[email protected]>"
+.
diff --git a/debian/ssserver.1 b/debian/ssserver.1
@@ -55,5 +55,5 @@ Quiet mode, only show warnings/errors.
 The programs are documented fully by
 .IR "Shell Xu <[email protected]>"
 and 
-.IR "Clowwindy <[email protected]>",
-available via the Info system.
+.IR "Clowwindy <[email protected]>"
+.