shadowsocks_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 985b77d98ddedbace62ae1b742491ed21c12b70f
+  data.tar.gz: 910e78c16a44f23a5cf085ef12e9b2f7316edf31
+SHA512:
+  metadata.gz: b7199b0e371ab8f5c75e4f3b6a53dcf97c1f395ddc08b31f677bf0912ab3acdb740f04f8656a01803261759f24ec5344abab3bf346cbd2319a936803c242c15c
+  data.tar.gz: b698d89d4d739a468c1663d160b1783f9b2964dc688960e69f73d43cf9238cf65b90e9fce12e511d1ff7b42cc51bbda42ba0de5e92efd34994a796b99f41fec0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.6

data/.yardopts

@@ -0,0 +1,5 @@
+--no-private
+
+-
+LICENSE.txt
+CODE_OF_CONDUCT.md

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at zhenkyle@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+  "https://github.com/#{repo_name}.git"
+end
+
+gem 'evented-spec', github: 'ruby-amqp/evented-spec'
+# Specify your gem's dependencies in shadowsocks_ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Zhenkyle
+
+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.

data/README.md

@@ -0,0 +1,160 @@
+# ShadowsocksRuby
+
+ShadowsocksRuby is a flexible platform for writing [shadowsocks](https://github.com/shadowsocks/shadowsocks) like tunnel proxy to help you bypass firewalls. With layered protocol strategy, TCP/UDP/(even TLS) connection object and powerful DSL backended by ruby, it make your life easy to develop new tunnel protocols.
+
+Main features include:
+
+* **Popular event-driven I/O model:** utilize very little resource but provding extremely high scalability, performance and stability
+* **Vanilla shadowsocks protocol support:** comes with shadowsocks's original version and OTA version protocol support and [shadowsocksr](https://github.com/shadowsocksr/shadowsocksr) 's "http_simple" and "tls_ticket" obfuscation protocol support
+* **Cipher method support:** all known shadowsocks cipher method, including `table` and `chacha20`
+* **Parallel execution support:** support multi workers by using [Einhorn](https://github.com/stripe/einhorn) socket manager to enable parallelism on multi-core CPU, and extra drb server to exchange data within workers
+* **Easy develop your own protocol:** see "Example SOCKS4 Client Proxy in 35 lines"
+
+## Installation
+
+    $ gem install shadowsocks_ruby
+
+## Usage
+
+### Running
+
+After Installation, ShadowsockRuby install 2 executable files for you:
+
+```
+$ ssserver-ruby -h
+A SOCKS like tunnel proxy that helps you bypass firewalls.
+
+Usage: ssserver-ruby [options]
+
+Proxy options:
+    -c, --config [CONFIG]            path to config file (lazy default: config.json)
+    -s, --server SERVER_ADDR         server address (default: 0.0.0.0)
+    -p, --port SERVER_PORT           server port (default: 8388)
+    -k, --password PASSWORD          password
+    -O, --packet-protocol NAME       packet protocol (default: origin)
+    -G, --packet-param PARAM         packet protocol parameters
+    -m, --cipher-protocol NAME       cipher protocol (default: aes-256-cfb)
+    -o, --obfs-protocol [NAME]       obfuscate protocol (lazy default: http_simple)
+    -g, --obfs-param PARAM           obfuscate protocol parameters
+    -t, --timeout TIMEOUT            timeout in seconds, default: 300
+        --fast-open                  use TCP_FASTOPEN, requires Linux 3.7+
+    -E, --einhorn                    Use Einhorn socket manager
+
+Common options:
+    -h, --help                       display help message
+    -v, --vv                         verbose mode
+    -q, --qq                         quiet mode, only show warnings/errors
+        --version                    show version information
+```
+
+and
+
+```
+$ sslocal-ruby -h
+A SOCKS like tunnel proxy that helps you bypass firewalls.
+
+Usage: sslocal-ruby [options]
+
+Proxy options:
+    -c, --config [CONFIG]            path to config file (lazy default: config.json)
+    -s, --server SERVER_ADDR         server address
+    -p, --port SERVER_PORT           server port (default: 8388)
+    -b, --bind_addr LOCAL_ADDR       local binding address (default: 0.0.0.0)
+    -l, --local_port LOCAL_PORT      local port  (default: default: 1080)
+    -k, --password PASSWORD          password
+    -O, --packet-protocol NAME       packet protocol (default: origin)
+    -G, --packet-param PARAM         packet protocol parameters
+    -m, --cipher-protocol NAME       cipher protocol (default: aes-256-cfb)
+    -o, --obfs-protocol [NAME]       obfuscate protocol (lazy default: http_simple)
+    -g, --obfs-param PARAM           obfuscate protocol parameters
+    -t, --timeout TIMEOUT            timeout in seconds, default: 300
+        --fast-open                  use TCP_FASTOPEN, requires Linux 3.7+
+    -E, --einhorn                    Use Einhorn socket manager
+
+Common options:
+    -h, --help                       display help message
+    -v, --vv                         verbose mode
+    -q, --qq                         quiet mode, only show warnings/errors
+        --version                    show version information
+```
+
+### Signals
+
+    QUIT - Graceful shutdown. Stop accepting connections immediately and
+           wait as long as necessary for all connections to close.
+
+    TERM - Fast shutdown. Stop accepting connections immediately and wait
+           up to 10 seconds for connections to close before forcing
+           termination.
+
+    INT  - Same as TERM
+
+
+### Example to establish a basic tunnel proxy
+
+    # On remote machine (eg IP: 1.2.3.4)
+    ssserver-ruby -k secret
+
+    # Then on local machine
+    sslocal-ruby -k secret -s 1.2.3.4
+
+    #Then using `127.0.0.1:1080` as your local SOCKS5 server.
+
+
+## Development
+To get started, check out [documentation](http://www.rubydoc.info/github/zhenkyle/shadowsocks_ruby) then check out [spec](https://github.com/zhenkyle/shadowsocks_ruby/tree/master/spec) and [features](https://github.com/zhenkyle/shadowsocks_ruby/tree/master/features).
+
+### Example SOCKS4 Client Protocol in 35 lines
+
+Here's a fully-functional protocol to make ShadowsocksRuby support SOCKS4 client:
+
+```ruby
+module ShadowsocksRuby
+  module Protocols
+    class Socks4Protocol
+      attr_accessor :next_protocol
+      def initialize params = {}; end
+
+      def tcp_receive_from_client_first_packet n
+        data = async_recv(8)
+        v, c, port, o1, o2, o3, o4, user = data.unpack("CCnC4a*")
+        data << async_recv_until("\0")
+        if v != 4 or c != 1
+          send_data "\0\x5b\0\0\0\0\0\0" 
+          raise PharseError, "SOCKS version or command not supported: #{v}, #{c}"
+        end
+        send_data "\0\x5a\0\0\0\0\0\0"
+        class << self
+          alias tcp_receive_from_client tcp_receive_from_client_other_packet
+        end
+        "\x01" + [o1, o2, o3, o4, port].pack("C4n") # return address_bin
+      end
+
+      alias tcp_receive_from_client tcp_receive_from_client_first_packet
+
+      def tcp_receive_from_client_other_packet n
+        async_recv(n)
+      end
+
+      def tcp_send_to_client data
+        send_data data
+      end
+
+      def async_recv_until(str) @next_protocol.async_recv_until(str); end
+    end
+  end
+end
+```
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/zhenkyle/shadowsocks_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+If you send pull request to add a new protocol, please include a RSpec spec (for unit and integration test) or a Cucumber feature (for acceptance test). 
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'cucumber/rake/task'
+require "yard"
+RSpec::Core::RakeTask.new(:spec)
+
+Cucumber::Rake::Task.new(:features) do |t|
+t.cucumber_opts = "features --format pretty -x"
+t.fork = false
+end
+
+YARD::Rake::YardocTask.new
+
+task :default => :spec

data/bin/aruba

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'aruba' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("aruba", "aruba")

data/bin/bundler

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'bundler' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("bundler", "bundler")

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "shadowsocks_ruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/cucumber

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'cucumber' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("cucumber", "cucumber")

data/bin/einhorn

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'einhorn' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("einhorn", "einhorn")

data/bin/einhornsh

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'einhornsh' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("einhorn", "einhornsh")

data/bin/htmldiff

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("diff-lcs", "htmldiff")

data/bin/ldiff

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("diff-lcs", "ldiff")

data/bin/lrucache_server

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'drb/drb'
+require 'lrucache'
+
+# The URI for the server to connect to
+URI="druby://localhost:18787"
+
+# The object that handles requests on the server
+FRONT_OBJECT = LRUCache.new(:ttl => 60 * 5)
+
+$SAFE = 1 # disable eval() and friends
+
+DRb.start_service(URI, FRONT_OBJECT)
+# Wait for the drb server thread to finish before exiting.
+DRb.thread.join

data/bin/rake

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/yard

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'yard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("yard", "yard")

data/bin/yardoc

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'yardoc' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("yard", "yardoc")

data/bin/yri

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'yri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("yard", "yri")

data/config.example.json

@@ -0,0 +1,6 @@
+{
+  "server": "127.0.0.1",
+  "server_port": 8388,
+  "password": "secret",
+  "method": "aes-256-cfb"
+}

data/exe/sslocal-ruby

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "shadowsocks_ruby"
+ShadowsocksRuby::Cli::SslocalRunner.new.execute!()

data/exe/ssserver-ruby

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "shadowsocks_ruby"
+ShadowsocksRuby::Cli::SsserverRunner.new.execute!()