net-ssh-socks 0.0.1 → 0.0.2

data/README.md

@@ -2,17 +2,27 @@
 
 ## Description
 
-Net::SSH::Socks is a library for programmatically creating a SOCKS proxy that tunnels through SSH. Similar to Net::SSH::Service::Forward#local except the host is dynamic (determined by the client application, such as a browser).
+Net::SSH::Socks is a library for programmatically creating a SOCKS proxy server that tunnels through SSH. Similar to Net::SSH::Service::Forward#local except the host is dynamic (determined by the client application, such as a browser).
+
+Useful for securing traffic over SSH or getting in/out of a firewall.
+
+## Use cases
+
+* If your company blocks certain sites/resources but allows SSH, then you can tunnel out to a machine outside the firewall.
+* If you need to access sites/resources inside a firewall, then you can tunnel into a machine inside the firewall.
+* Encrypt your traffic to protect yourself from things like Firesheep on public wifi.
 
 ## Synopsis
 
-    require 'net/ssh'
     require 'net/ssh/socks'
 
     Net::SSH.start('host', 'user') do |ssh|
       ssh.forward.socks(8080)
+      ssh.loop { true }
     end
 
+Now, configure your browser to use a SOCKS proxy at localhost:8080
+
 ## Install
 
     gem install net-ssh-socks

data/lib/net/ssh/socks.rb

@@ -3,9 +3,8 @@ require 'net/ssh'
 module Net
   module SSH
     class Socks
-      VERSION = "0.0.1"
+      VERSION = "0.0.2"
 
-      SOCKS_VERSION  = 5
       METHOD_NO_AUTH = 0
       CMD_CONNECT    = 1
       REP_SUCCESS    = 0
@@ -13,6 +12,9 @@ module Net
       ATYP_IPV4      = 1
       ATYP_DOMAIN    = 3
       ATYP_IPV6      = 4
+      SOCKS4         = 4
+      SOCKS4_SUCCESS = [0, 0x5a, 0, 0, 0, 0, 0, 0].pack("C*")
+      SOCKS5         = 5
 
       # client is an open socket
       def initialize(client)
@@ -20,14 +22,34 @@ module Net
       end
 
       # Communicates with a client application as described by the SOCKS 5
-      # specification: http://tools.ietf.org/html/rfc1928.
-      #
+      # specification: http://tools.ietf.org/html/rfc1928 and
+      # http://en.wikipedia.org/wiki/SOCKS
       # returns the host and port requested by the client
       def client_handshake
-        version, nmethods, *methods = @client.recv(8).unpack("C*")
+        version = @client.recv(1).unpack("C*").first
+        case version
+        when SOCKS4 : client_handshake_v4
+        when SOCKS5 : client_handshake_v5
+        else
+          raise "SOCKS version not supported: #{version.inspect}"
+        end
+      end
+
+      def client_handshake_v4
+        command = @client.recv(1)
+        port = @client.recv(2).unpack("n").first
+        ip_addr = @client.recv(4).unpack("C*").join('.')
+        username = @client.recv(1024) # read the rest of the stream
+
+        @client.send SOCKS4_SUCCESS, 0
+        [ip_addr, port]
+      end
+
+      def client_handshake_v5
+        nmethods, *methods = @client.recv(8).unpack("C*")
 
         if methods.include?(METHOD_NO_AUTH)
-          packet = [SOCKS_VERSION, METHOD_NO_AUTH].pack("C*")
+          packet = [SOCKS5, METHOD_NO_AUTH].pack("C*")
           @client.send packet, 0
         else
           @client.close
@@ -36,7 +58,7 @@ module Net
 
         version, command, reserved, address_type, *destination = @client.recv(256).unpack("C*")
 
-        packet = ([SOCKS_VERSION, REP_SUCCESS, RESERVED, address_type] + destination).pack("C*")
+        packet = ([SOCKS5, REP_SUCCESS, RESERVED, address_type] + destination).pack("C*")
         @client.send packet, 0
 
         remote_host, remote_port = case address_type
@@ -50,15 +72,28 @@ module Net
         when ATYP_IPV6
           @client.close
           raise 'Unsupported address type. Only "IPv4" is supported'
+        else
+          raise "Unknown address_type: #{address_type}"
         end
 
         [remote_host, remote_port]
       end
-
     end
   end
 end
 
+class Net::SSH::Connection::Session
+  def on_close(&block)
+    @on_close = block
+  end
+
+  alias_method :close_without_callbacks, :close
+  def close
+    close_without_callbacks
+    @on_close.call if @on_close
+  end
+end
+
 class Net::SSH::Service::Forward
   # Starts listening for connections on the local host, and forwards them
   # to the specified remote host/port via the SSH connection. This method
@@ -81,23 +116,30 @@ class Net::SSH::Service::Forward
     bind_address = "127.0.0.1"
     bind_address = args.shift if args.first.is_a?(String) && args.first =~ /\D/
     local_port   = args.shift.to_i
+    info { "socks on #{bind_address} port #{local_port}" }
 
-    socket = TCPServer.new(bind_address, local_port)
-    session.listen_to(socket) do |socket|
-      client = socket.accept
+    socks_server = TCPServer.new(bind_address, local_port)
+    session.listen_to(socks_server) do |server|
+      client = server.accept
 
       socks = Net::SSH::Socks.new(client)
       remote_host, remote_port = socks.client_handshake
+      info { "connection requested on #{remote_host} port #{remote_port}" }
 
       channel = session.open_channel("direct-tcpip", :string, remote_host, :long, remote_port, :string, bind_address, :long, local_port) do |channel|
-        channel.info { "direct channel established" }
+        info { "direct channel established" }
         prepare_client(client, channel, :local)
       end
 
       channel.on_open_failed do |ch, code, description|
-        channel.error { "could not establish direct channel: #{description} (#{code})" }
+        error { "could not establish direct channel: #{description} (#{code})" }
         client.close
       end
     end
+
+    session.on_close do
+      debug { "cleaning up socks server" }
+      socks_server.close
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: net-ssh-socks
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Mike Enriquez
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-21 00:00:00 -05:00
+date: 2010-12-22 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency