hsume2-localtunnel 0.3.beta

data/Manifest

@@ -0,0 +1,9 @@
+Manifest
+README.rdoc
+Rakefile
+bin/localtunnel
+lib/localtunnel.rb
+lib/localtunnel/net_ssh_gateway_patch.rb
+lib/localtunnel/tunnel.rb
+lib/localtunnel/tunnel_app.rb
+server.py

data/README.rdoc

@@ -0,0 +1,60 @@
+= localtunnel -- instant public tunnel to your local web server
+
+== Install 
+
+To get the dependencies if you don't have them, type:
+
+    sudo apt-get install ruby ruby1.8-dev rubygems1.8 libopenssl-ruby
+
+Now you can install localtunnel with RubyGems:
+
+    sudo gem install localtunnel 
+
+or to get the source:
+
+    git clone http://github.com/progrium/localtunnel.git
+
+== Usage
+
+    localtunnel [options] <localport>
+      -k, --key FILE    upload a public key for authentication
+
+Localtunnel is a client to a free and open source reverse tunneling
+service made specifically for web traffic. It's intended to be used to
+temporarily expose local web servers to the greater Internet for
+debugging, unit tests, demos, etc.   
+
+This is how you make your local port 8080 public:
+
+    $ localtunnel 8080
+    Port 8080 is now publicly accessible from http://8bv2.localtunnel.com ...
+
+Using localtunnel is comparable to using SSH reverse/remote port
+forwarding on a remote host that has GatewayPorts enabled, but without
+all the configuration or the need of a host. The localtunnel command
+works with a server component that is running on localtunnel.com,
+which is provided as a free service.
+
+If you have never run localtunnel before, you'll need to upload a public
+key to authenticate. You do this once:
+
+    $ localtunnel -k ~/.ssh/id_rsa.pub 8080
+
+After that, you shouldn't have to use -k again.
+
+Localtunnel can be started before or after the local web server.   It
+tunnels through to the url given in that status message "publicly
+accessible from..." for as long as the command is running.  The tunnel
+is closed if the command exits.
+
+== Contributors
+
+    andyl (andy@r210.com) 
+    Charles Merriam (charles.merriam@gmail.com) 
+    Hunter Gillane (hunter.gillane@gmail.com) 
+    Michael Sofaer (msofaer@pivotallabs.com) 
+    Jeff Lindsay (progrium@gmail.com)
+
+== License
+
+MIT

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('hsume2-localtunnel', '0.3.beta') do |p|
+  p.description    = "instant public tunnel to your local web server"
+  p.url            = "http://github.com/hsume2/localtunnel"
+  p.author         = "Jeff Lindsay"
+  p.email          = "jeff.lindsay@twilio.com"
+  p.has_rdoc       = false
+  p.rdoc_pattern   = //
+  p.rdoc_options   = []
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.executable_pattern = ["bin/*"]
+  p.runtime_dependencies = ["json >=1.2.4", "net-ssh >=2.0.22", "net-ssh-gateway >=1.0.1", "sinatra >=1.3.2", "POpen4 >=0.1.4"]
+  p.development_dependencies = []
+end

data/bin/localtunnel

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+# Copyright (c) 2010 Jeff Lindsay
+#
+# 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.
+
+require 'rubygems'
+require 'optparse'
+require 'localtunnel'
+
+key = nil
+options = OptionParser.new do |o|
+  o.banner = "Usage: localtunnel [options] <localport>"
+  o.on("-k", "--key FILE", "upload a public key for authentication") do |k|
+    key = File.exist?(k.to_s) ? File.open(k).read : nil
+  end
+  o.on('-h', "--help", "show this help") { puts o; exit }
+end
+
+args = options.parse!
+local_port = args[0]
+unless local_port.to_i.between?(1, 65535)
+  puts options
+  exit
+end
+
+t = LocalTunnel::Tunnel.new(local_port, key)
+t.register_tunnel
+t.start_tunnel

data/hsume2-localtunnel.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{hsume2-localtunnel}
+  s.version = "0.3.beta"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeff Lindsay"]
+  s.date = %q{2012-01-25}
+  s.default_executable = %q{localtunnel}
+  s.description = %q{instant public tunnel to your local web server}
+  s.email = %q{jeff.lindsay@twilio.com}
+  s.executables = ["localtunnel"]
+  s.extra_rdoc_files = ["README.rdoc", "Rakefile", "bin/localtunnel", "lib/localtunnel.rb", "lib/localtunnel/net_ssh_gateway_patch.rb", "lib/localtunnel/tunnel.rb", "lib/localtunnel/tunnel_app.rb", "server.py", "hsume2-localtunnel.gemspec"]
+  s.files = ["Manifest", "README.rdoc", "Rakefile", "bin/localtunnel", "lib/localtunnel.rb", "lib/localtunnel/net_ssh_gateway_patch.rb", "lib/localtunnel/tunnel.rb", "lib/localtunnel/tunnel_app.rb", "server.py", "hsume2-localtunnel.gemspec"]
+  s.homepage = %q{http://github.com/hsume2/localtunnel}
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{hsume2-localtunnel}
+  s.rubygems_version = %q{1.5.3}
+  s.summary = %q{instant public tunnel to your local web server}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, [">= 1.2.4"])
+      s.add_runtime_dependency(%q<net-ssh>, [">= 2.0.22"])
+      s.add_runtime_dependency(%q<net-ssh-gateway>, [">= 1.0.1"])
+      s.add_runtime_dependency(%q<sinatra>, [">= 1.3.2"])
+      s.add_runtime_dependency(%q<POpen4>, [">= 0.1.4"])
+    else
+      s.add_dependency(%q<json>, [">= 1.2.4"])
+      s.add_dependency(%q<net-ssh>, [">= 2.0.22"])
+      s.add_dependency(%q<net-ssh-gateway>, [">= 1.0.1"])
+      s.add_dependency(%q<sinatra>, [">= 1.3.2"])
+      s.add_dependency(%q<POpen4>, [">= 0.1.4"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 1.2.4"])
+    s.add_dependency(%q<net-ssh>, [">= 2.0.22"])
+    s.add_dependency(%q<net-ssh-gateway>, [">= 1.0.1"])
+    s.add_dependency(%q<sinatra>, [">= 1.3.2"])
+    s.add_dependency(%q<POpen4>, [">= 0.1.4"])
+  end
+end

data/lib/localtunnel/net_ssh_gateway_patch.rb

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'net/ssh'
+require 'net/ssh/gateway'
+
+# http://groups.google.com/group/capistrano/browse_thread/thread/455c0c8a6faa9cc8?pli=1
+class Net::SSH::Gateway
+  # Opens a SSH tunnel from a port on a remote host to a given host and port
+  # on the local side
+  # (equivalent to openssh -R parameter)
+  def open_remote(port, host, remote_port, remote_host = "127.0.0.1")
+    ensure_open!
+
+    @session_mutex.synchronize do
+      @session.forward.remote(port, host, remote_port, remote_host)
+    end
+
+    if block_given?
+      begin
+        yield [remote_port, remote_host]
+      ensure
+        close_remote(remote_port, remote_host)
+      end
+    else
+      return [remote_port, remote_host]
+    end
+  rescue Errno::EADDRINUSE
+    retry
+  end
+
+  # Cancels port-forwarding over an open port that was previously opened via
+  # #open_remote.
+  def close_remote(port, host = "127.0.0.1")
+    ensure_open!
+
+    @session_mutex.synchronize do
+      @session.forward.cancel_remote(port, host)
+    end
+  end
+end

data/lib/localtunnel/tunnel.rb

@@ -0,0 +1,89 @@
+require 'rubygems'
+require 'net/ssh'
+require 'net/ssh/gateway'
+require 'net/http'
+require 'uri'
+require 'json'
+require 'open4'
+
+require 'localtunnel/net_ssh_gateway_patch'
+
+module LocalTunnel; end
+
+require 'localtunnel/tunnel_app'
+
+class LocalTunnel::Tunnel
+
+  SHELL_HOOK_FILE = "./.localtunnel_callback"
+
+  attr_accessor :port, :key, :host
+
+  def initialize(port, key)
+    @port = port
+    @key  = key
+    @host = ""
+  end
+
+  def register_tunnel(key=@key)
+    url = URI.parse("http://open.localtunnel.com/")
+    if key
+      resp = JSON.parse(Net::HTTP.post_form(url, {"key" => key}).body)
+    else
+      resp = JSON.parse(Net::HTTP.get(url))
+    end
+    if resp.has_key? 'error'
+      puts "   [Error] #{resp['error']}"
+      exit
+    end
+    @host = resp['host'].split(':').first
+    @tunnel = resp
+    return resp
+  rescue
+    puts "   [Error] Unable to register tunnel. Perhaps service is down?"
+    exit
+  end
+
+  def start_tunnel
+    port = @port
+    tunnel = @tunnel
+
+    TunnelApp.tunnel = tunnel['host']
+    tunnel_pid = fork { TunnelApp.run! }
+
+    at_exit do
+      Process.kill('KILL', tunnel_pid)
+      Process.waitpid(tunnel_pid)
+    end
+
+    error = ''
+
+    status = Open4::popen4("ssh -nNT -g -R *:#{tunnel['through_port']}:0.0.0.0:#{port} #{tunnel['user']}@#{@host} -o PasswordAuthentication=no") do |pid, i, o, e|
+      puts "   " << tunnel['banner'] if tunnel.has_key? 'banner'
+      if File.exists?(File.expand_path(SHELL_HOOK_FILE))
+        system "#{SHELL_HOOK_FILE} ""#{tunnel['host']}""" if File.exists?(File.expand_path(SHELL_HOOK_FILE))
+        if !$?.success?
+          puts "   An error occurred executing the callback hook #{SHELL_HOOK_FILE}"
+          puts "   (Make sure it is executable)"
+        end
+      end
+      puts "   Port #{port} is now publicly accessible from http://#{tunnel['host']} ..."
+
+      begin
+        while str = e.gets
+          error += str
+          puts str
+        end
+      rescue Interrupt
+        exit
+      end
+    end
+
+    if error =~ /Permission denied/
+      possible_key = Dir[File.expand_path('~/.ssh/*.pub')].first
+      puts "   Failed to authenticate. If this is your first tunnel, you need to"
+      puts "   upload a public key using the -k option. Try this:\n\n"
+      puts "   localtunnel -k #{possible_key ? possible_key : '~/path/to/key'} #{port}"
+      exit
+    end
+  end
+end

data/lib/localtunnel/tunnel_app.rb

@@ -0,0 +1,15 @@
+require 'sinatra/base'
+
+class LocalTunnel::Tunnel
+  class TunnelApp < Sinatra::Base
+    class << self
+      attr_accessor :tunnel
+    end
+
+    set :port, (ENV['LOCAL_TUNNEL_PORT'] || 9000)
+
+    get '/' do
+      TunnelApp.tunnel
+    end
+  end
+end

data/lib/localtunnel.rb

@@ -0,0 +1,2 @@
+$: << File.expand_path(File.dirname(__FILE__))
+require 'localtunnel/tunnel'

data/server.py

@@ -0,0 +1,106 @@
+try:
+    from twisted.internet import pollreactor
+    pollreactor.install()
+except: pass
+from twisted.internet import protocol, reactor, defer, task
+from twisted.web import http, proxy, resource, server
+from twisted.python import log
+import sys, time
+import urlparse
+import socket
+import simplejson
+import re
+
+SSH_USER = 'localtunnel'
+AUTHORIZED_KEYS = '/home/localtunnel/.ssh/authorized_keys'
+PORT_RANGE = [32000, 64000]
+BANNER = "This localtunnel service is brought to you by Twilio."
+SSH_OPTIONS = 'command="/bin/echo Shell access denied",no-agent-forwarding,no-pty,no-user-rc,no-X11-forwarding '
+KEY_REGEX = re.compile(r'^ssh-(\w{3}) [^\n]+$')
+
+def port_available(port):
+    try:
+        socket.create_connection(['127.0.0.1', port]).close()
+        return False
+    except socket.error:
+        return True
+    
+def baseN(num,b=32,numerals="23456789abcdefghijkmnpqrstuvwxyz"): 
+    return ((num == 0) and  "0" ) or (baseN(num // b, b).lstrip("0") + numerals[num % b])
+
+class LocalTunnelReverseProxy(proxy.ReverseProxyResource):
+    isLeaf = True
+    
+    def __init__(self, user, host='127.0.0.1'):
+        self.user = user
+        self.tunnels = {}
+        proxy.ReverseProxyResource.__init__(self, host, None, None)
+    
+    def find_tunnel_name(self):
+        name = baseN(abs(hash(time.time())))[0:4]
+        if (name in self.tunnels and not port_available(self.tunnels[name])) or name == 'open':
+            time.sleep(0.1)
+            return self.find_tunnel_name()
+        return name
+        
+    def find_tunnel_port(self):
+        port = PORT_RANGE[0]
+        start_time = time.time()
+        while not port_available(port):
+            if time.time()-start_time > 3:
+                raise Exception("No port available")
+            port += 1
+            if port >= PORT_RANGE[1]: port = PORT_RANGE[0]
+        return port
+    
+    def garbage_collect(self):
+        for name in self.tunnels:
+            if port_available(self.tunnels[name]):
+                del self.tunnels[name]
+    
+    def install_key(self, key):
+        if not KEY_REGEX.match(key.strip()):
+            return False
+        key = ''.join([SSH_OPTIONS, key.strip(), "\n"])
+        fr = open(AUTHORIZED_KEYS, 'r')
+        if not key in fr.readlines():
+            fa = open(AUTHORIZED_KEYS, 'a')
+            fa.write(key)
+            fa.close()
+        fr.close()
+        return True
+    
+    def register_tunnel(self, superhost, key=None):
+        if key and not self.install_key(key): return simplejson.dumps(dict(error="Invalid key."))
+        name = self.find_tunnel_name()
+        port = self.find_tunnel_port()
+        self.tunnels[name] = port
+        return simplejson.dumps(
+            dict(through_port=port, user=self.user, host='%s.%s' % (name, superhost), banner=BANNER))
+    
+    def render(self, request):
+        host = request.getHeader('host')
+        name, superhost = host.split('.', 1)
+        if host.startswith('open.'):
+            request.setHeader('Content-Type', 'application/json')
+            return self.register_tunnel(superhost, request.args.get('key', [None])[0])
+        else:
+            if not name in self.tunnels: return "Not found"
+        
+            request.content.seek(0, 0)
+            clientFactory = self.proxyClientFactoryClass(
+                request.method, request.uri, request.clientproto,
+                request.getAllHeaders(), request.content.read(), request)
+            self.reactor.connectTCP(self.host, self.tunnels[name], clientFactory)
+            return server.NOT_DONE_YET
+
+#if 'location' in request.responseHeaders and host in request.responseHeaders['location']:
+#    # Strip out the port they think they need
+#    p = re.compile(r'%s\:\d+' % host)
+#    location = p.sub(host, request.responseHeaders['location'])
+#    request.responseHeaders['location'] = location
+
+        
+log.startLogging(sys.stdout)
+reactor.listenTCP(80, server.Site(LocalTunnelReverseProxy(SSH_USER)))
+reactor.run()

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification 
+name: hsume2-localtunnel
+version: !ruby/object:Gem::Version 
+  hash: 31098141
+  prerelease: 4
+  segments: 
+  - 0
+  - 3
+  - beta
+  version: 0.3.beta
+platform: ruby
+authors: 
+- Jeff Lindsay
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-25 00:00:00 -08:00
+default_executable: localtunnel
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 2
+        - 4
+        version: 1.2.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: net-ssh
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 2
+        - 0
+        - 22
+        version: 2.0.22
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: net-ssh-gateway
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 0
+        - 1
+        version: 1.0.1
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 3
+        - 2
+        version: 1.3.2
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: POpen4
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 1
+        - 4
+        version: 0.1.4
+  type: :runtime
+  version_requirements: *id005
+description: instant public tunnel to your local web server
+email: jeff.lindsay@twilio.com
+executables: 
+- localtunnel
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- Rakefile
+- bin/localtunnel
+- lib/localtunnel.rb
+- lib/localtunnel/net_ssh_gateway_patch.rb
+- lib/localtunnel/tunnel.rb
+- lib/localtunnel/tunnel_app.rb
+- server.py
+- hsume2-localtunnel.gemspec
+files: 
+- Manifest
+- README.rdoc
+- Rakefile
+- bin/localtunnel
+- lib/localtunnel.rb
+- lib/localtunnel/net_ssh_gateway_patch.rb
+- lib/localtunnel/tunnel.rb
+- lib/localtunnel/tunnel_app.rb
+- server.py
+- hsume2-localtunnel.gemspec
+has_rdoc: true
+homepage: http://github.com/hsume2/localtunnel
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: hsume2-localtunnel
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: instant public tunnel to your local web server
+test_files: []
+