dress_socks 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5b123ce6c20f6502e2d9113a4776a23460b0decdd1aa47becebccc4aa682ed85
+  data.tar.gz: d866a719eae28e9841f2969ebe9873a5bff63cb85044f2e8253632cf4f8c86a8
+SHA512:
+  metadata.gz: eb343ce13ca2a3974703538709958e7dc974e630d7caa7c928a3494cdaf473d2f156f195becb274f2d7286d93aa770a992696c11730fedef31d0e3d6bc2c8f27
+  data.tar.gz: e989aa22f362ac3f7f74290866a86b52b06bd48d219852bc4573770c64e6696abb62b35c2b23b94b8cb60310bfe114d121424fb52eb174a2074cfdb49979cb82

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+.rspec_status

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Changelog.md

@@ -0,0 +1,3 @@
+# Changelog
+
+11-30-2019: Project created

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in dress_socks.gemspec
+gemspec
+
+gem "pry", "~> 0.12.2"

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    dress_socks (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  dress_socks!
+  pry (~> 0.12.2)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Justin McNally
+
+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,41 @@
+# DressSocks
+
+A pure ruby implementation of SOCKSSocket, allowing tunneling a socket through a SOCKS proxy.
+
+Based heavily on Socksify, we needed more flexibility in how we setup the tcp connection and only setting it up for certain pieces of code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dress_socks'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dress_socks
+
+## Usage
+
+DressSocks::Socket.new(remote_host, remote_port, socks_username: nil, socks_password: nil, socks_server: nil, socks_port: nil, socks_ignore: [], socks_version: '5')
+
+Creates a new TCP Socket that tunnels through the socks configuration passed.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/chowly/dress_socks.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dress_socks"
+
+# 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(__FILE__)

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/dress_socks.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dress_socks/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dress_socks"
+  spec.version       = DressSocks::VERSION
+  spec.authors       = ["Justin McNally"]
+  spec.email         = ["justin@chowlyinc.com"]
+
+  spec.summary       = 'A pure ruby implementation of SOCKSSocket'
+  spec.description   = 'SOCKSSocket is great but require a lot of C gymnastics. This aims to do the same thing in all Ruby code.'
+  spec.homepage      = 'https://github.com/chowly/dress_socks'
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/chowly/dress_socks"
+    spec.metadata["changelog_uri"] = "https://github.com/Chowly/dress_socks/blob/master/Changelog.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/dress_socks.rb

@@ -0,0 +1,10 @@
+require "socket"
+require "resolv"
+
+require "dress_socks/version"
+require "dress_socks/socket"
+require 'dress_socks/errors'
+
+module DressSocks
+
+end

data/lib/dress_socks/errors.rb

@@ -0,0 +1,71 @@
+module DressSocks
+  class SOCKSError < RuntimeError
+    def initialize(msg)
+      super
+    end
+
+    class ServerFailure < SOCKSError
+      def initialize
+        super("general SOCKS server failure")
+      end
+    end
+    class NotAllowed < SOCKSError
+      def initialize
+        super("connection not allowed by ruleset")
+      end
+    end
+    class NetworkUnreachable < SOCKSError
+      def initialize
+        super("Network unreachable")
+      end
+    end
+    class HostUnreachable < SOCKSError
+      def initialize
+        super("Host unreachable")
+      end
+    end
+    class ConnectionRefused < SOCKSError
+      def initialize
+        super("Connection refused")
+      end
+    end
+    class TTLExpired < SOCKSError
+      def initialize
+        super("TTL expired")
+      end
+    end
+    class CommandNotSupported < SOCKSError
+      def initialize
+        super("Command not supported")
+      end
+    end
+    class AddressTypeNotSupported < SOCKSError
+      def initialize
+        super("Address type not supported")
+      end
+    end
+
+    def self.for_response_code(code)
+      case code
+      when 1
+        ServerFailure
+      when 2
+        NotAllowed
+      when 3
+        NetworkUnreachable
+      when 4
+        HostUnreachable
+      when 5
+        ConnectionRefused
+      when 6
+        TTLExpired
+      when 7
+        CommandNotSupported
+      when 8
+        AddressTypeNotSupported
+      else
+        self
+      end
+    end
+  end
+end

data/lib/dress_socks/socket.rb

@@ -0,0 +1,164 @@
+module DressSocks
+  class Socket < ::TCPSocket
+    attr_accessor :socks_server, :socks_port, :socks_version, :socks_ignores, :socks_username, :socks_password
+  
+    alias :initialize_tcp :initialize
+  
+
+    def encoded_socks_version
+      (self.socks_version == "4a" or self.socks_version == "4") ? "\004" : "\005"
+    end
+
+    # See http://tools.ietf.org/html/rfc1928
+    def initialize(remote_host=nil, remote_port=0, local_host=nil, local_port=nil, 
+                   socks_username: nil, socks_password: nil, socks_server: nil, socks_port: nil, 
+                   socks_ignores: [], socks_version: '5')
+
+      self.socks_server = socks_server
+      self.socks_port = socks_port
+      self.socks_username = socks_username
+      self.socks_password = socks_password
+      self.socks_ignores = socks_ignores
+      self.socks_version = socks_version
+
+
+      if socks_server and socks_port and not socks_ignores.include?(remote_host)
+        initialize_tcp socks_server, socks_port
+  
+        socks_authenticate unless socks_version =~ /^4/
+  
+        if remote_host
+          socks_connect(remote_host, remote_port)
+        end
+      else
+        initialize_tcp remote_host, remote_port, local_host, local_port
+      end
+    end
+  
+    # Authentication
+    def socks_authenticate
+      if self.socks_username || self.socks_password
+                write "\005\001\002"
+      else
+                write "\005\001\000"
+      end
+      auth_reply = recv(2)
+      if auth_reply.empty?
+        raise DressSocks::SOCKSError.new("Server doesn't reply authentication")
+      end
+      if auth_reply[0..0] != "\004" and auth_reply[0..0] != "\005"
+        raise DressSocks::SOCKSError.new("SOCKS version #{auth_reply[0..0]} not supported")
+      end
+      if self.socks_username || self.socks_password
+        if auth_reply[1..1] != "\002"
+          raise DressSocks::SOCKSError.new("SOCKS authentication method #{auth_reply[1..1]} neither requested nor supported")
+        end
+        auth = "\001"
+        auth += self.socks_username.to_s.length.chr
+        auth += self.socks_username.to_s
+        auth += self.socks_password.to_s.length.chr
+        auth += self.socks_password.to_s
+        write auth
+        auth_reply = recv(2)
+        if auth_reply[1..1] != "\000"
+          raise DressSocks::SOCKSError.new("SOCKS authentication failed")
+        end
+      else
+        if auth_reply[1..1] != "\000"
+          raise DressSocks::SOCKSError.new("SOCKS authentication method #{auth_reply[1..1]} neither requested nor supported")
+        end
+      end
+    end
+  
+    # Connect
+    def socks_connect(host, port)
+      port = ::Socket.getservbyname(port) if port.is_a?(String)
+      req = String.new
+      req << self.encoded_socks_version
+      req << "\001"
+      req << "\000" if self.socks_version == "5"
+      req << [port].pack('n') if self.socks_version =~ /^4/
+  
+      if self.socks_version == "4"
+        host = Resolv::DNS.new.getaddress(host).to_s
+      end
+      if host =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/  # to IPv4 address
+        req << "\001" if self.socks_version == "5"
+        _ip = [$1.to_i,
+               $2.to_i,
+               $3.to_i,
+               $4.to_i
+              ].pack('CCCC')
+        req << _ip
+      elsif host =~ /^[:0-9a-f]+$/  # to IPv6 address
+        raise "TCP/IPv6 over SOCKS is not yet supported (inet_pton missing in Ruby & not supported by Tor"
+        req << "\004"
+      else                          # to hostname
+        if self.socks_version == "5"
+          req << "\003" + [host.size].pack('C') + host
+        else
+          req << "\000\000\000\001"
+          req << "\007\000"
+          req << host
+          req << "\000"
+        end
+      end
+      req << [port].pack('n') if self.socks_version == "5"
+
+      write req
+  
+      socks_receive_reply
+    end
+  
+    # returns [bind_addr: String, bind_port: Fixnum]
+    def socks_receive_reply
+      if self.socks_version == "5"
+        connect_reply = recv(4)
+        if connect_reply.empty?
+          raise DressSocks::SOCKSError.new("Server doesn't reply")
+        end
+        if connect_reply[0..0] != "\005"
+          raise DressSocks::SOCKSError.new("SOCKS version #{connect_reply[0..0]} is not 5")
+        end
+        if connect_reply[1..1] != "\000"
+          raise DressSocks::SOCKSError.for_response_code(connect_reply.bytes.to_a[1])
+        end
+        bind_addr_len = case connect_reply[3..3]
+                when "\001"
+                  4
+                when "\003"
+                  recv(1).bytes.first
+                when "\004"
+                  16
+                else
+                  raise DressSocks::SOCKSError.for_response_code(connect_reply.bytes.to_a[3])
+                end
+        bind_addr_s = recv(bind_addr_len)
+        bind_addr = case connect_reply[3..3]
+                    when "\001"
+                      bind_addr_s.bytes.to_a.join('.')
+                    when "\003"
+                      bind_addr_s
+                    when "\004"  # Untested!
+                      i = 0
+                      ip6 = ""
+                      bind_addr_s.each_byte do |b|
+                        if i > 0 and i % 2 == 0
+                          ip6 += ":"
+                        end
+                        i += 1
+  
+                        ip6 += b.to_s(16).rjust(2, '0')
+                      end
+                    end
+        bind_port = recv(bind_addr_len + 2)
+        [bind_addr, bind_port.unpack('n')]
+      else
+        connect_reply = recv(8)
+        unless connect_reply[0] == "\000" and connect_reply[1] == "\x5A"
+          raise DressSocks::SOCKSError.new("Failed while connecting througth socks")
+        end
+      end
+    end
+  end
+end

data/lib/dress_socks/version.rb

@@ -0,0 +1,3 @@
+module DressSocks
+  VERSION = "0.1.2"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: dress_socks
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Justin McNally
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: SOCKSSocket is great but require a lot of C gymnastics. This aims to
+  do the same thing in all Ruby code.
+email:
+- justin@chowlyinc.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rspec_status"
+- Changelog.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dress_socks.gemspec
+- lib/dress_socks.rb
+- lib/dress_socks/errors.rb
+- lib/dress_socks/socket.rb
+- lib/dress_socks/version.rb
+homepage: https://github.com/chowly/dress_socks
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/chowly/dress_socks
+  source_code_uri: https://github.com/chowly/dress_socks
+  changelog_uri: https://github.com/Chowly/dress_socks/blob/master/Changelog.md
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: A pure ruby implementation of SOCKSSocket
+test_files: []