rsocks5patch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cf1d99bc0cb455cbe4de6e7bf8d89c1ae4050ccdae12c02783d5352dad7c05db
+  data.tar.gz: 45c799e546887483174c50d4bc73b8ad7f9bf89e718bdf039eb73ec05fdaf74f
+SHA512:
+  metadata.gz: 1125085b0c643e920e2282aaac260b8bfb68e9f9b5dd3c9d865bfd4df5fb5a4a62a606896a95de974c02d5a0386a156511489443e1bc474c447ba1900640ff65
+  data.tar.gz: 632fbd71e14f025ab75ba9667a572c6f5c90864a86246cbf3612d656d13ed06088bf7a224ea183c9dba9edf33232167675ad4fa897caa58e2dad4dd3917e4c56

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-06-08
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rsocks5patch.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 TODO: Write your name
+
+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,23 @@
+# Rsocks5patch
+
+When including `rsocks5patch` the Ruby `Socket` class function `tcp`
+will be replaced with one that will first establish a connection
+through a SOCKS proxy.
+
+The new `Socket.tcp` function also adds two options, `socks_host`
+and `socks_port` in situations where the `tcp` function is used directly.
+
+An example use.
+
+```ruby
+
+require "rsocks5patch"
+Socket.socks_host = "localhost"
+Socket.socks_port = 9050
+
+resp = Net::HTTP.get_response(URI("https://gitlab.com/basking2/rsocks5patch/-/tree/main"))
+```
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/rsocks5patch/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Rsocks5patch
+  VERSION = "0.1.0"
+end

data/lib/rsocks5patch.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+# vim: set et sw=2:
+
+require "net/http"
+require "uri"
+require "socket"
+
+require_relative "rsocks5patch/version"
+
+# When this module is evaluated it will patch the Ruby Socket class.
+module Rsocks5patch
+  class Error < StandardError; end
+
+  Socket.class_eval do
+    # alias :orig_func :self.tcp
+    #
+    class << self
+      alias_method :orig_func, :tcp
+
+      attr_accessor :socks_host, :socks_port
+    end
+
+    def self.mustread(socket, num)
+      data = ""
+      loop do
+        tmp = socket.read(num - data.length)
+        return null if tmp.nil?
+
+        data += tmp
+        return data if data.length == num
+      end
+    end
+
+    def self.tcp(
+      host,
+      port,
+      local_host = nil,
+      local_port = nil,
+      connect_timeout: nil,
+      resolv_timeout: nil,
+      socks_host: nil,
+      socks_port: nil
+    )
+      socks_host ||= self.socks_host
+      socks_port ||= self.socks_port
+
+      unless socks_host
+        return orig_func(host, port, local_host, local_port, connect_timeout: connect_timeout,
+                                                             resolv_timeout: resolv_timeout)
+      end
+
+      socket = orig_func(socks_host, socks_port, local_host, local_port, connect_timeout: nil, resolv_timeout: nil)
+
+      socket.write([0x5, 0x1, 0x0].pack("CCC"))
+      ver, auth = mustread(socket, 2).unpack("CC")
+
+      raise StandardError, "Unexpected version #{ver}." if ver != 0x5
+      raise StandardError, "No available auth method." if auth == 0xff
+
+      # Version, CMD=1, RSV=0, ADDRTYPE=3, LEN, HOST, PORT
+      socket.write([0x5, 0x01, 0x00, 0x3, host.length, host, port].pack("CCCCCa*n"))
+
+      ver, status, _resv, addrtype = mustread(socket, 4).unpack("CCCC")
+      raise StandardError, "Unexpected version #{ver}." if ver != 0x5
+
+      case status
+      when 0x00
+        ""
+      when 0x01
+        raise StandardError, "general failure"
+      when 0x02
+        raise StandardError, "connection not allowed by ruleset"
+      when 0x03
+        raise StandardError, "network unreachable"
+      when 0x04
+        raise StandardError, "host unreachable"
+      when 0x05
+        raise StandardError, "connection refused by destination host"
+      when 0x06
+        raise StandardError, "TTL expired"
+      when 0x07
+        raise StandardError, "command not supported / protocol error"
+      when 0x08
+        raise StandardError, "address type not supported"
+      else
+        raise StandardError, "unexpected error status #{status}"
+      end
+
+      case addrtype
+      when 0x1
+        _ipv4addr = mustread(socket, 4)
+      when 0x3
+        _len = mustread(socket, 1)
+        _host = mustread(socket, len)
+      when 0x4
+        _ipv6addr = mustread(socket, 16)
+      else
+        raise StandardError, "No available auth method." if auth == 0xff
+      end
+      _port = mustread(socket, 2)
+
+      socket
+    end
+  end
+end

data/sig/rsocks5patch.rbs

@@ -0,0 +1,4 @@
+module Rsocks5patch
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: rsocks5patch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sam Baskinger
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-08 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- basking2@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rsocks5patch.rb
+- lib/rsocks5patch/version.rb
+- sig/rsocks5patch.rbs
+homepage: https://gitlab.com/basking2/rsocks5patch
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://gitlab.com/basking2/rsocks5patch
+  source_code_uri: https://gitlab.com/basking2/rsocks5patch
+  changelog_uri: https://gitlab.com/basking2/rsocks5patch/-/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Patch SOCKS5 capabilities into Ruby's Socket class.
+test_files: []