Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bestoa/shadowsocks-vertx
Java port of shadowsocks with vertx.
https://github.com/bestoa/shadowsocks-vertx
bouncy-castle java java-8 shadowsocks shadowsocks-java vertx
Last synced: 26 days ago
JSON representation
Java port of shadowsocks with vertx.
- Host: GitHub
- URL: https://github.com/bestoa/shadowsocks-vertx
- Owner: Bestoa
- License: apache-2.0
- Created: 2016-03-24T10:29:52.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-05-29T03:20:12.000Z (over 1 year ago)
- Last Synced: 2024-08-03T17:12:21.988Z (4 months ago)
- Topics: bouncy-castle, java, java-8, shadowsocks, shadowsocks-java, vertx
- Language: Java
- Homepage:
- Size: 18.6 MB
- Stars: 27
- Watchers: 4
- Forks: 23
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-network-stuff - **29**星
README
shadowsocks-vertx
================
DO NOT USE IT ANYMORE!!!
========================
Only support SS-V1
[](https://app.codacy.com/gh/Bestoa/shadowsocks-vertx/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[](https://codecov.io/gh/Bestoa/shadowsocks-vertx)
[](http://www.apache.org/licenses/LICENSE-2.0.html)
## Intro
shadowsocks-vertx is a lightweight tunnel proxy which can help you get through firewalls. It is a java port of shadowsocks. This project is based on vert.x.
The protocol is compatible with the origin shadowsocks (if both have been upgraded to the latest version).
JDK 8 is needed.
Current version 0.8.4
It is **unstable**! If you encounter any problems, please open an issue.
About shadowsocks, please refer to [shadowsocks](https://shadowsocks.org/)
About vert.x, please refer to [vertx](http://vertx.io/)
## Features
Supported argument:
1. -m/--method crypto method
2. -k/--password password
3. -p/--server_port bind port(server)/remote port(client)
4. -a/--auth OTA enforcing mode
5. -l/--local_port local port
6. -s/--server server
7. -S/--server_mode server mode(default is client mode)
8. -c/--config config file
9. -t/--timeout timeout(unit is second, currently unused)
10. -h/--help show help.
Supported encrypt method:
1. aes-128-cfb
2. aes-192-cfb
3. aes-256-cfb
4. chacha20/chacha20-ietf
Supported one-time auth.
Support JSON config file. Please refer to [shadowsocks config](https://github.com/shadowsocks/shadowsocks/wiki/Configuration-via-Config-File).
Note:
1. Not support: local_address, client will bind 0.0.0.0 not 127.0.0.1
2. Not support: fast_open. Java doesn't have such feature.
3. Not support: workers. Vertx will set work thread number automatically.
4. Additional: server_mode, set the running mode, true for the server.
You could refer to demo config etc/demo.json.
### How to run
#### (1) Before you start
You must have 'gradle' installed first, or use gradle wrapper ./gradlew.
#### (2) generate distributable zip
```shell
$ gradle distZip
```
or
```shell
$ ./gradlew distZip
```
Then you will get shadowsocks-ver.zip in build/distributions.
Unzip it, the folder should contain bin and lib.
#### Run
```shell
//Server
$ bin/shadowsocks -S ...
$ bin/shadowsocks --server_mode ...
//Local
$ bin/shadowsocks ...
```
### (3) generate all-in-one jar
```shell
$ gradle fatJar
```
or
```shell
$ ./gradlew fatJar
```
Then you will get shadowsocks-fat-ver.jar in build/libs.
#### How to run
```shell
//Server
$ java -jar shadowsocks-fat-xx.jar -S ...
$ java -jar shadowsocks-fat-xx.jar --server_mode ...
//Local
$ java -jar shadowsocks-fat-xx.jar ...
```