socks_tunnel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dddadc3f63d978799189f6fa955e3f810ad77a2e
+  data.tar.gz: ef0d4d891892564a69d559d791d436274a488708
+SHA512:
+  metadata.gz: 0bc01a03e50e7b585a7b9a6756df027b9589d4c29c1d3a18f370c0149d3f94d9959ba5d62983b25196b711135c917627907a00bfea61979112705f18f250cd2f
+  data.tar.gz: 02e8978e9b80d7d04c67dee7769bfad33e2dee49843e6bbd43cb4f62fb992852a1baf5c6a706963a0077d4b2ee85240c154cd51353c503e24a7b61c680a93b47

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in socks_tunnel.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Weihu Chen
+
+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,75 @@
+# SocksTunnel
+
+Establish secure tunnel via Socks 5.
+
+## Installation
+
+    $ gem install socks_tunnel
+
+## Usage
+
+Start local server
+
+    socks_tunnel local --password=PASSWORD --port=PORT --remote-addr=REMOTE_ADDR
+
+Options
+
+<table>
+  <tr>
+    <td>--port</td><td>The port number to listen.</td><td>Required</td>
+  </tr>
+  <tr>
+    <td>--password</td><td>The password for generating encryption key and iv.</td><td>Required</td>
+  </tr>
+  <tr>
+    <td>--remote-addr</td><td>The address of remote server. (host:port)</td><td>Required</td>
+  </tr>
+  <tr>
+    <td>--host</td><td>When running local server on a different machine, use this to set the IP.</td><td>Optional</td>
+  </tr>
+  <tr>
+    <td>--salt</td><td>The salt for generating encryption key and iv.</td><td>Optional</td>
+  </tr>
+</table>
+
+Start remote server
+
+    socks_tunnel remote --password=PASSWORD --port=PORT
+
+Options
+
+<table>
+  <tr>
+    <td>--port</td><td>The port number to listen.</td><td>Required</td>
+  </tr>
+  <tr>
+    <td>--password</td><td>The password for generating encryption key and iv.</td><td>Required</td>
+  </tr>
+  <tr>
+    <td>--salt</td><td>The salt for generating encryption key and iv.</td><td>Optional</td>
+  </tr>
+</table>
+
+*Password* and *Salt* used in both local and remote server should be the same.
+
+## Example
+
+Test on local machine
+
+    # Start local server
+    socks_tunnel local --password=mypassword --port=8081 --remote-addr=127.0.0.1:8082
+    # Start remote server
+    socks_tunnel remote --password=mypassword --port=8082
+
+    # Use curl to test
+    curl --socks5 localhost:8081 https://github.com/
+
+Run *Remote server* on a real server
+
+    # Start local server
+    socks_tunnel local --password=mypassword --port=8081 --remote-addr=[SERVER_IP]:8082
+    # Start remote server
+    socks_tunnel remote --password=mypassword --port=8082
+
+    # Use curl to test
+    curl --socks5 localhost:8081 https://github.com/

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/socks_tunnel

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "socks_tunnel/cli"
+
+SocksTunnel::CLI.start(ARGV)

data/lib/socks_tunnel.rb

@@ -0,0 +1,10 @@
+require "eventmachine"
+require "socks_tunnel/version"
+require "socks_tunnel/buffer"
+require "socks_tunnel/coder"
+require "socks_tunnel/config"
+
+module SocksTunnel
+  autoload :Local,  "socks_tunnel/local"
+  autoload :Remote, "socks_tunnel/remote"
+end

data/lib/socks_tunnel/buffer.rb

@@ -0,0 +1,33 @@
+module SocksTunnel
+  class Buffer
+    def initialize
+      @buffer_data = ''
+    end
+
+    def <<(data)
+      @buffer_data << data
+    end
+
+    def each
+      loop do
+        fore, rest = @buffer_data.split(Config.delimiter, 2)
+        break unless rest
+        yield fore
+        @buffer_data = rest
+      end
+    end
+
+    def shift
+      fore, rest = @buffer_data.split(Config.delimiter, 2)
+      if rest
+        @buffer_data = rest
+        return fore
+      end
+      nil
+    end
+
+    def clear
+      @buffer_data = ''
+    end
+  end
+end

data/lib/socks_tunnel/cli.rb

@@ -0,0 +1,24 @@
+require "thor"
+require "socks_tunnel"
+
+module SocksTunnel
+  class CLI < Thor
+    desc "local", "Start local server"
+    option :port,        required: true
+    option :password,    required: true
+    option :remote_addr, required: true
+    option :host
+    def local
+      Config.from(options)
+      Local.run
+    end
+
+    desc "remote", "Start remote server"
+    option :port,     required: true
+    option :password, required: true
+    def remote
+      Config.from(options)
+      Remote.run
+    end
+  end
+end

data/lib/socks_tunnel/coder.rb

@@ -0,0 +1,30 @@
+require "openssl"
+
+module SocksTunnel
+  class Coder
+    def initialize
+      cipher = OpenSSL::Cipher.new(Config.cipher)
+      key_iv = OpenSSL::PKCS5.pbkdf2_hmac_sha1(Config.password, Config.salt, 2000, cipher.key_len + cipher.iv_len)
+      @key = key_iv[0, cipher.key_len]
+      @iv = key_iv[cipher.key_len, cipher.iv_len]
+
+      @encoder = OpenSSL::Cipher.new(Config.cipher)
+      @encoder.encrypt
+      @encoder.key = @key
+
+      @decoder = OpenSSL::Cipher.new(Config.cipher)
+      @decoder.decrypt
+      @decoder.key = @key
+    end
+
+    def encode(data)
+      @encoder.iv = @iv
+      @encoder.update(data) + @encoder.final
+    end
+
+    def decode(data)
+      @decoder.iv = @iv
+      @decoder.update(data) + @decoder.final
+    end
+  end
+end

data/lib/socks_tunnel/config.rb

@@ -0,0 +1,36 @@
+module SocksTunnel
+  class Config
+    class << self
+      attr_accessor :local_server_host, :local_server_port,
+        :remote_server_host, :remote_server_port, :password, :salt
+
+      def from(options)
+        if options[:remote_addr]
+          @local_server_port = options[:port]
+          @local_server_host = options[:host] if options[:host]
+          @remote_server_host, @remote_server_port = options[:remote_addr].split(':')
+        else
+          @remote_server_port = options[:port]
+        end
+        @password = options[:password]
+        @salt = options[:salt] if options[:salt]
+      end
+
+      def local_server_host
+        @local_server_host ||= '127.0.0.1'
+      end
+
+      def salt
+        @salt ||= "V\x11\x97\xA6r\xEF[\xFE"
+      end
+
+      def delimiter
+        @delimiter ||= '===SOCKSTUNNEL==='
+      end
+
+      def cipher
+        @cipher ||= 'AES-256-CBC'
+      end
+    end
+  end
+end

data/lib/socks_tunnel/local.rb

@@ -0,0 +1,155 @@
+require "ipaddr"
+
+module SocksTunnel
+  class Local
+    def self.run
+      EventMachine.run do
+        puts "Start local server at #{Config.local_server_host}:#{Config.local_server_port}"
+        EventMachine.start_server(Config.local_server_host, Config.local_server_port, Server)
+      end
+    end
+
+    class Connection < EventMachine::Connection
+      attr_accessor :server
+
+      def post_init
+        @coder = Coder.new
+        @buffer = Buffer.new
+      end
+
+      def send_encoded_data(data)
+        return if data.nil? || data.empty?
+        send_data(@coder.encode(data))
+        send_data(Config.delimiter)
+      end
+
+      def receive_data(data)
+        return if data.nil? || data.empty?
+        @buffer << data
+        @buffer.each do |segment|
+          server.send_data(@coder.decode(segment))
+        end
+      end
+
+      def unbind
+        server.close_connection_after_writing
+      end
+    end
+
+    module Server
+      def post_init
+        @fiber = Fiber.new do
+          greeting
+          loop { do_command }
+        end
+      end
+
+      def receive_data(data)
+        if @connection
+          @connection.send_encoded_data(data.to_s)
+        else
+          @data = data
+          @fiber = nil if @fiber.resume
+        end
+      end
+
+      def unbind
+        @connection.close_connection if @connection
+      end
+
+      private
+
+        # IN
+        # +----+----------+----------+
+        # |VER | NMETHODS | METHODS  |
+        # +----+----------+----------+
+        # | 1  |    1     | 1 to 255 |
+        # +----+----------+----------+
+        #
+        # OUT
+        # +----+--------+
+        # |VER | METHOD |
+        # +----+--------+
+        # | 1  |   1    |
+        # +----+--------+
+        def greeting
+          ver = @data.unpack("C").first
+          clear_data
+          if ver == 5
+            send_data "\x05\x00"  # NO AUTHENTICATION REQUIRED
+          else
+            send_data "\x05\xFF"  # NO ACCEPTABLE METHODS
+          end
+          Fiber.yield
+        end
+
+        # IN
+        # +----+-----+-------+------+----------+----------+
+        # |VER | CMD |  RSV  | ATYP | DST.ADDR | DST.PORT |
+        # +----+-----+-------+------+----------+----------+
+        # | 1  |  1  | X'00' |  1   | Variable |    2     |
+        # +----+-----+-------+------+----------+----------+
+        #
+        # OUT
+        # see the defination of reply_data
+        def do_command
+          _, cmd, _, atype, addr_length = @data.unpack("C5")
+          header_length = 0
+
+          case atype
+          when 1, 4  # 1: ipv4, 4 bytes / 4: ipv6, 16 bytes
+            ip_length = 4 * atype
+            host = IPAddr.ntop @data[4, ip_length]
+            port = @data[4 + ip_length, 2].unpack('S>').first
+            header_length = ip_length + 6
+          when 3     # domain name
+            host = @data[5, addr_length]
+            port = @data[5 + addr_length, 2].unpack('S>').first
+            header_length = addr_length + 7
+          else
+            panic :address_type_not_supported
+          end
+
+          case cmd
+          when 1
+            send_data reply_data(:success)
+            @connection = EventMachine.connect(Config.remote_server_host, Config.remote_server_port, Connection)
+            @connection.server = self
+            @connection.send_encoded_data("#{host}:#{port}")
+            @connection.send_encoded_data(@data[header_length, -1])
+            clear_data
+            Fiber.yield
+          when 2, 3  # bind, udp
+            panic :command_not_supported
+          else
+            panic :command_not_supported
+          end
+        end
+
+        # +----+-----+-------+------+----------+----------+
+        # |VER | REP |  RSV  | ATYP | BND.ADDR | BND.PORT |
+        # +----+-----+-------+------+----------+----------+
+        # | 1  |  1  | X'00' |  1   | Variable |    2     |
+        # +----+-----+-------+------+----------+----------+
+        def reply_data(type)
+          @replies_hash ||= begin
+            {
+              success:                    0,
+              command_not_supported:      7,
+              address_type_not_supported: 8,
+            }.map { |k, v| [k, ("\x05#{[v].pack('C')}\x00\x01\x00\x00\x00\x00\x00\x00")] }.to_h
+          end
+          @replies_hash[type]
+        end
+
+        def clear_data
+          @data = nil
+        end
+
+        def panic(reply_type)
+          send_data reply_data(reply_type)
+          Fiber.yield true
+        end
+    end
+  end
+end

data/lib/socks_tunnel/remote.rb

@@ -0,0 +1,64 @@
+module SocksTunnel
+  class Remote
+    def self.run
+      EventMachine.run do
+        puts "Start remote server at 0.0.0.0:#{Config.remote_server_port}"
+        EventMachine.start_server('0.0.0.0', Config.remote_server_port, Server)
+      end
+    end
+
+    class Connection < EventMachine::Connection
+      attr_accessor :server
+
+      def receive_data(data)
+        @server.send_encoded_data(data)
+      end
+
+      def unbind
+        @server.close_connection_after_writing
+      end
+    end
+
+    class Server < EventMachine::Connection
+      def post_init
+        @coder = Coder.new
+        @buffer = Buffer.new
+      end
+
+      def send_encoded_data(data)
+        return if data.nil? || data.empty?
+        send_data(@coder.encode(data))
+        send_data(Config.delimiter)
+      end
+
+      def receive_data(data)
+        if @connection
+          @buffer << data
+          @buffer.each do |segment|
+            @connection.send_data(@coder.decode(segment))
+          end
+        else
+          @buffer << data
+          addr = @buffer.shift
+          if addr
+            addr = @coder.decode(addr)
+            host, port = addr.split(':')
+            port = (port.nil? || port.empty?) ? 80 : port.to_i
+            @connection = EventMachine.connect(host, port, Connection)
+            @connection.server = self
+            @buffer.each do |segment|
+              @connection.send_data(@coder.decode(segment))
+            end
+          end
+        end
+      rescue
+        @connection.close_connection if @connection
+        close_connection
+      end
+
+      def unbind
+        @connection.close_connection if @connection
+      end
+    end
+  end
+end

data/lib/socks_tunnel/version.rb

@@ -0,0 +1,3 @@
+module SocksTunnel
+  VERSION = "0.1.0"
+end

data/socks_tunnel.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'socks_tunnel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "socks_tunnel"
+  spec.version       = SocksTunnel::VERSION
+  spec.authors       = ["Weihu Chen"]
+  spec.email         = ["cctiger36@gmail.com"]
+
+  spec.summary       = %q{Establish secure tunnel via Socks 5.}
+  spec.description   = %q{Establish secure tunnel via Socks 5.}
+  spec.homepage      = "https://github.com/cctiger36/socks_tunnel"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "eventmachine", "> 1.2"
+  spec.add_dependency "thor", "> 0.19"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: socks_tunnel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Weihu Chen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Establish secure tunnel via Socks 5.
+email:
+- cctiger36@gmail.com
+executables:
+- socks_tunnel
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/socks_tunnel
+- lib/socks_tunnel.rb
+- lib/socks_tunnel/buffer.rb
+- lib/socks_tunnel/cli.rb
+- lib/socks_tunnel/coder.rb
+- lib/socks_tunnel/config.rb
+- lib/socks_tunnel/local.rb
+- lib/socks_tunnel/remote.rb
+- lib/socks_tunnel/version.rb
+- socks_tunnel.gemspec
+homepage: https://github.com/cctiger36/socks_tunnel
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Establish secure tunnel via Socks 5.
+test_files: []