moesocks: A functional firewall killer

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

A SOCKS5 proxy using the client / server architecture.

[Skip to Readme]

Properties

Versions	0.1.0.0, 0.1.0.1, 0.1.0.2, 0.1.0.3, 0.1.0.4, 0.1.0.5, 0.1.0.6, 0.1.0.7, 0.1.0.8, 0.1.0.9, 0.1.0.10, 0.1.0.11, 0.1.0.12, 0.1.0.13, 0.1.0.14, 0.1.0.15, 0.1.0.16, 0.1.0.17, 0.1.0.18, 0.1.0.19, 0.1.0.20, 0.1.0.21, 0.1.0.22, 0.1.0.23, 0.1.0.24, 0.1.0.25, 0.1.0.26, 0.1.0.27, 0.1.1.0, 0.1.1.10, 0.1.1.20, 0.1.1.30, 0.1.1.31, 0.1.1.32, 0.1.2.0, 0.1.2.10, 0.1.2.20, 0.1.2.30, 1.0.0.0, 1.0.0.1, 1.0.0.10, 1.0.0.20, 1.0.0.30, 1.0.0.40, 1.0.0.41, 1.0.0.42, 1.0.0.43, 1.0.0.44, 1.0.0.44, 1.0.1.0
Change log	CHANGELOG.md
Dependencies	aeson, async, attoparsec, base (>4 && <=5), binary, bytestring, containers, cryptohash, hslogger, HsOpenSSL, iproute, lens, lens-aeson, mtl, network, optparse-applicative, random, stm, strict, text, time, transformers, unordered-containers [details]
License	Apache-2.0
Copyright	Copyright (C) 2015 Jinjing Wang
Author	Jinjing Wang
Maintainer	Jinjing Wang <nfjinjing@gmail.com>
Category	Network
Home page	https://github.com/nfjinjing/moesocks
Source repo	head: git clone git://github.com/nfjinjing/moesocks.git
Uploaded	by JinjingWang at 2018-02-09T17:19:55Z

Downloads

moesocks-1.0.0.44.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

JinjingWang

For package maintainers and hackage trustees

edit package information

Readme for moesocks-1.0.0.44

[back to package description]

MoeSocks

A SOCKS5 proxy using the client / server architecture.

MoeSocks is mostly compatible with shadowsocks.

Installation

From binary

Install Nix

curl https://nixos.org/nix/install | sh

Install moesocks

nix-env -i -A nixpkgs.haskellPackages.moesocks

Run

moesocks

From source

Install GHC and cabal-install

Download moesocks

git clone https://github.com/nfjinjing/moesocks

Sandbox!

cd moesocks
cabal sandbox init

Install

cabal install

Run

.cabal-sandbox/bin/moesocks

Usage

Start a remote node outside a firewall:
```
  moesocks -r remote -k birthday!
```
Start a local node inside a firewall:
```
  moesocks -s $REMOTE_IP -k birthday!
```
Now you have a SOCKS5 proxy running inside a firewall on port 1080.
See more options:
```
  moesocks --help
```

Features

SOCKS5 proxy service, tested with GFW.
TCP port forwarding.
UDP port forwarding, for example to tunnel DNS request: -U 5300:8.8.8.8:53.
SOCKS5 service on local can be turned off.
Understand shadowsocks' json configuration file.

Known issues

UDP over SOCKS5 is not implemented.
TCP bind over SOCKS5 is not implemented.
A bit slower then the Python implementation.
Only works on Unix.

Tips

TCP Fast Open (TFO)

Benefit of using TFO

TFO can bypass the TCP three-way handshake in successive connections, thus reducing latency.

Enable TFO in your OS runtime.

On Linux 3.7+, to check the availability of TFO:

cat /proc/sys/net/ipv4/tcp_fastopen

On Linux 3.7+, to enable TFO (as root):

echo 3 > /proc/sys/net/ipv4/tcp_fastopen

Enable TFO in MoeSocks

TFO can be turned on by adding a "fastOpen":true field in config.json or adding a --fast-open argument in the command line.

Verify

Use tcpdump on the remotePort, check for that SYN should start to carry payload. An example command is:

tcpdump port 8388 -i any -X -v

TCP BBR

Using tcp-bbr as the congestion control algorithm should dramatically increase your bandwith in most cases.

Credits

shadowsocks greatly inspired MoeSocks.
shadowsocks-haskell another implementation of shadowsocks in Haskell, also greatly inspired MoeSocks. Much of the understanding of the internal of shadowsocks was gained by reading shadowsocks-haskell.

License

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.