pry-remote-em 0.5.0 → 0.6.0

data/README.md

@@ -312,11 +312,65 @@ process.
 
 Message will not be displayed by the clients until the presses enter.
 
+## Authentication Event Callbacks
+Available events are:
+
+ - auth_attempt - called each time authentication is attempted
+ - auth_fail    - called each time authentication fails
+ - auth_ok      - called each time authentication succeeds
+
+```ruby
+log         = ::Logger.new('/var/log/auth.pry.log')
+obj.new.remote_pry_em('0.0.0.0', :auto, :tls => true, :auth => auth_hash) do |pry|
+  pry.auth_attempt do |user, ip|
+    log.info("got an authentication attempt for #{user} from #{ip}")
+  end
+  pry.auth_fail do |user, ip|
+    log.fatal("failed authentication attempt for #{user} from #{ip}")
+  end
+  pry.auth_ok do |user, ip|
+    log.info("successful authentication for #{user} from #{ip}")
+  end
+end
+```
+
+## Shell Commands
+If the pry-remote-em service is started with the ``:allow_shell_cmds =>
+true`` option set it will spawn sub processes for any command prefixed
+with a '.'.
+
+```
+[1] pry(#<#<Class:0x007fe0be072618>>)> .uname -a
+Darwin kiff.local 11.3.0 Darwin Kernel Version 11.3.0: Thu Jan 12 18:47:41 PST 2012; root:xnu-1699.24.23~1/RELEASE_X86_64 x86_64
+```
+
+Interactive commands like ``vim`` will probably not behave
+appropriately.
+
+
+If the server was not started with the ``allow_shell_cmds`` option then
+all shell commands will be met with a rejection notice.
+
+```
+[1] pry(#<#<Class:0x007fe0be072618>>)> .ls
+shell commands are not allowed by this server
+```
+
+The server will also log whenever a user attempts to execute a shell
+command.
+
+```
+W, [2012-02-11T19:21:27.663941 #36471]  WARN -- : executing shell command 'ls -al' for  (127.0.0.1:63878)
+```
+
+```
+E, [2012-02-11T19:23:40.770380 #36471] ERROR -- : refused to execute shell command 'ls' for caleb (127.0.0.1:63891)
+```
+
 # Missing Features
 
   - AutoDiscovery/Broker [ticket](https://github.com/simulacre/pry-remote-em/issues/11)
   - HTTP Transport [ticket](https://github.com/simulacre/pry-remote-em/issues/12)
-  - Shell Commands [ticket](https://github.com/simulacre/pry-remote-em/issues/15)
   - Vi mode editing - RbReadline doesn't support vi edit mode. I'm looking into contributing it. PryRemoteEm uses rb-readline because the STLIB version doesn't play nice with Fibers.
   - Ssh key based authentication
 

data/lib/pry-remote-em.rb

@@ -18,8 +18,44 @@ end
 
 
 class Object
-  def remote_pry_em(host = PryRemoteEm::DEFHOST, port = PryRemoteEm::DEFPORT, opts = {:tls => false})
+  def remote_pry_em(host = PryRemoteEm::DEFHOST, port = PryRemoteEm::DEFPORT, opts = {:tls => false}, &blk)
     opts = {:target => self}.merge(opts)
-    PryRemoteEm::Server.run(opts[:target], host, port, opts)
+    PryRemoteEm::Server.run(opts[:target], host, port, opts, &blk)
   end
 end
+
+
+unless defined?(EventMachine.popen3)
+  module EventMachine
+    # @see http://eventmachine.rubyforge.org/EventMachine.html#M000491
+    # @see https://gist.github.com/535644/4d5b645b96764e07ccb53539529bea9270741e1a
+    def self.popen3(cmd, handler=nil, *args)
+      klass = klass_from_handler(Connection, handler, *args)
+      w     = Shellwords::shellwords(cmd)
+      w.unshift(w.first) if w.first
+
+      new_stderr = $stderr.dup
+      rd, wr     = IO::pipe
+
+      $stderr.reopen wr
+      s = invoke_popen(w)
+      $stderr.reopen new_stderr
+
+      klass.new(s, *args).tap do |c|
+        EM.attach(rd, Popen3StderrHandler, c)
+        @conns[s] = c
+        yield(c) if block_given?
+      end
+    end
+
+    class Popen3StderrHandler < EventMachine::Connection
+      def initialize(connection)
+        @connection = connection
+      end
+
+      def receive_data(data)
+        @connection.receive_stderr(data)
+      end
+    end  # class::Popen3StderrHandler
+  end # module::EventMachine
+end # defined?(EventMachine.popen3)

data/lib/pry-remote-em/client.rb

@@ -1,5 +1,6 @@
 require 'uri'
 require 'pry-remote-em'
+require 'pry-remote-em/client/keyboard'
 require 'pry/helpers/base_helpers'
 #require "readline"   # doesn't work with Fiber.yield
         #  - /Users/caleb/src/pry-remote-em/lib/pry-remote-em/client.rb:45:in `yield': fiber called across stack rewinding barrier (FiberError)
@@ -69,6 +70,15 @@ module PryRemoteEm
       elsif j['mb']
         Kernel.puts "\033[1m!! msg: " + j['mb'] + "\033[0m"
 
+      elsif j['s'] # shell command output
+        Kernel.puts j['s']
+
+      elsif j.include?('sc') # command completed
+        if @keyboard
+          @keyboard.bufferio(true)
+          @keyboard.close_connection
+        end
+
       elsif j['g'] # server banner
         Kernel.puts "[pry-remote-em] remote is #{j['g']}"
         name, version, scheme = j['g'].split(" ", 3)
@@ -133,6 +143,13 @@ module PryRemoteEm
             send_data({:b => l[2..-1]})
           elsif '!' == l[0]
             send_data({:m => l[1..-1]})
+          elsif '.' == l[0]
+            send_data({:s => l[1..-1]})
+            if Gem.loaded_specs["eventmachine"].version < Gem::Version.new("1.0.0.beta4")
+              Kernel.puts "\033[1minteractive shell commands are not well supported when running on EventMachine prior 1.0.0.beta4\033[0m"
+            else
+              @keyboard = EM.open_keyboard(Keyboard, self)
+            end
           else
             send_data(l)
           end # "!!" == l[0..1]

data/lib/pry-remote-em/client/keyboard.rb

@@ -0,0 +1,46 @@
+require "termios"
+module PryRemoteEm
+  module Client
+    module Keyboard
+
+      def initialize(c)
+        @con            = c
+        # TODO check actual current values to determine if it's enabled or not
+        @buff_enabled   = true
+        # On EM < 1.0.0.beta.4 the keyboard handler and Termios don't work well together
+        # readline will complain that STDIN isn't a tty after Termios manipulation, so
+        # just don't let it happen
+        @manip_buff     = Gem.loaded_specs["eventmachine"].version >= Gem::Version.new("1.0.0.beta.4")
+        bufferio(false)
+        # TODO retain the old SIGINT handler and reset it later
+        trap :SIGINT do
+          @con.send_data({:ssc => true})
+        end
+      end
+
+      def receive_data(d)
+        @con.send_data({:sd => d})
+      end
+
+      def unbind
+        bufferio(true)
+        trap :SIGINT do
+          Process.exit
+        end
+      end
+
+      # Makes stdin buffered or unbuffered.
+      # In unbuffered mode read and select will not wait for "\n"; also will not echo characters.
+      # This probably does not work on Windows.
+      # On EventMachine < 1.0.0.beta.4 this method doesn't do anything
+      def bufferio(enable)
+        return if !@manip_buff || (enable && @buff_enabled) || (!enable && !@buff_enabled)
+        attr = Termios.getattr($stdin)
+        enable ? (attr.c_lflag |= Termios::ICANON | Termios::ECHO) : (attr.c_lflag &= ~(Termios::ICANON|Termios::ECHO))
+        Termios.setattr($stdin, Termios::TCSANOW, attr)
+        @buff_enabled = enable
+      end
+    end # module::Keyboard
+  end # module::Client
+end # module PryRemoteEm
+

data/lib/pry-remote-em/server.rb

@@ -1,5 +1,7 @@
 require 'pry'
+require 'logger'
 require 'pry-remote-em'
+require 'pry-remote-em/server/shell_cmd'
 # How it works with Pry
 #
 # When PryRemoteEm.run is called it registers with EventMachine for a given ip
@@ -34,6 +36,15 @@ module PryRemoteEm
     include JsonProto
 
     class << self
+      # Start a pry-remote-em server
+      # @param [Object] obj the object to bind pry to
+      # @param [String] ip the ip address to listen on
+      # @param [Fixnum, Symbol] port the port to listen on - if :auto the next available port will be taken
+      # @param [Hash] opts
+      # @option opts [Boolean] :tls require SSL encryption
+      # @option opts [Logger] :logger
+      # @option opts [Proc, Object] :auth require user authentication - see README
+      # @option opts [Boolean] :allow_shell_cmds
       def run(obj, host = DEFHOST, port = DEFPORT, opts = {:tls => false})
         tries = :auto == port ? 100.tap{ port = DEFPORT } : 1
         # TODO raise a useful exception not RuntimeError
@@ -42,6 +53,7 @@ module PryRemoteEm
           EM.start_server(host, port, PryRemoteEm::Server, obj, opts) do |pre|
             Fiber.new {
               begin
+                yield pre if block_given?
                 Pry.start(obj, :input => pre, :output => pre)
               ensure
                 pre.close_connection
@@ -58,7 +70,7 @@ module PryRemoteEm
           raise e
         end
         scheme = opts[:tls] ? 'pryems' : 'pryem'
-        Kernel.puts "[pry-remote-em] listening for connections on #{scheme}://#{host}:#{port}/"
+        (opts[:logger] || ::Logger.new(STDERR)).info("[pry-remote-em] listening for connections on #{scheme}://#{host}:#{port}/")
       end # run(obj, host = DEFHOST, port = DEFPORT)
 
       # The list of pry-remote-em connections for a given object, or the list of all pry-remote-em
@@ -81,9 +93,27 @@ module PryRemoteEm
     end # class << self
 
     def initialize(obj, opts = {:tls => false})
-      @obj        = obj
-      @after_auth = []
-      @opts       = opts
+      @obj              = obj
+      @opts             = opts
+      @allow_shell_cmds = opts[:allow_shell_cmds]
+      @log              = opts[:logger] || ::Logger.new(STDERR)
+      # Blocks that will be called on each authentication attempt, prior checking the credentials
+      @auth_attempt_cbs = []
+      # All authentication attempts that occured before an auth callback was registered
+      @auth_attempts    = []
+      # Blocks that will be called on each failed authentication attempt
+      @auth_fail_cbs    = []
+      # All failed authentication attempts that occured before an auth callback was reigstered
+      @auth_fails       = []
+      # Blocks that will be called on successful authentication attempt
+      @auth_ok_cbs      = []
+      # All successful authentication attemps that occured before the auth ok callbacks were registered
+      @auth_oks         = []
+
+      # The number maximum number of authentication attempts that are permitted
+      @auth_tries       = 5
+      # Data to be sent after the user successfully authenticates if authentication is required
+      @after_auth       = []
       return unless (a = opts[:auth])
       if a.is_a?(Proc)
         return fail("auth handler Procs must take two arguments not (#{a.arity})") unless a.arity == 2
@@ -95,28 +125,26 @@ module PryRemoteEm
         return error("auth handler objects must respond to :call, or :[]") unless a.respond_to?(:[])
         @auth = lambda {|u,p| a[u] && a[u] == p }
       end
-      @auth_tries = 5
     end
 
     def post_init
       @lines = []
       Pry.config.pager, @old_pager = false, Pry.config.pager
-      Pry.config.system, @old_system = PryRemoteEm::Server::System, Pry.config.system
       @auth_required  = @auth
       port, ip        = Socket.unpack_sockaddr_in(get_peername)
-      Kernel.puts "[pry-remote-em] received client connection from #{ip}:#{port}"
+      @log.info("[pry-remote-em] received client connection from #{ip}:#{port}")
       send_data({:g => "PryRemoteEm #{VERSION} #{@opts[:tls] ? 'pryems' : 'pryem'}"})
       @opts[:tls] ? start_tls : (@auth_required && send_data({:a => false}))
       PryRemoteEm::Server.register(@obj, self)
     end
 
     def start_tls
-      Kernel.puts "[pry-remote-em] starting TLS (#{peer_ip}:#{peer_port})"
+      @log.debug("[pry-remote-em] starting TLS (#{peer_ip}:#{peer_port})")
       super(@opts[:tls].is_a?(Hash) ? @opts[:tls] : {})
     end
 
     def ssl_handshake_completed
-      Kernel.puts "[pry-remote-em] TLS connection established (#{peer_ip}:#{peer_port})"
+      @log.info("[pry-remote-em] TLS connection established (#{peer_ip}:#{peer_port})")
       send_data({:a => false}) if @auth_required
     end
 
@@ -150,13 +178,17 @@ module PryRemoteEm
       elsif j['a'] # authentication response
         return send_data({:a => true}) if !@auth || !@auth_required
         return send_data({:a => 'auth data must be a two element array'}) unless j['a'].is_a?(Array) && j['a'].length == 2
+        auth_attempt(j['a'][0], peer_ip)
         unless (@auth_required = !@auth.call(*j['a']))
+          @user = j['a'][0]
+          auth_ok(j['a'][0], peer_ip)
           authenticated!
         else
+         auth_fail(j['a'][0], peer_ip)
           if @auth_tries <= 0
             msg = "max authentication attempts reached"
             send_data({:a => msg})
-            Kernel.puts "[pry-remote-em] #{msg} (#{peer_ip}:#{peer_port})"
+            @log.debug("[pry-remote-em] #{msg} (#{peer_ip}:#{peer_port})")
             return close_connection_after_writing
           end
           @auth_tries -= 1
@@ -171,6 +203,24 @@ module PryRemoteEm
         peers(:all).each { |peer| peer.send_bmessage(j['b']) }
         send_last_prompt
 
+      elsif j['s'] # shell command
+        # TODO confirm shell command's are allowed
+        unless @allow_shell_cmds
+          puts "\033[1mshell commands are not allowed by this server\033[0m"
+          @log.error("refused to execute shell command '#{j['s']}' for #{@user} (#{peer_ip}:#{peer_port})")
+          send_data({:sc => -1})
+          send_last_prompt
+        else
+          @log.warn("executing shell command '#{j['s']}' for #{@user} (#{peer_ip}:#{peer_port})")
+          @shell_cmd = EM.popen3(j['s'], ShellCmd, self)
+        end
+
+      elsif j['sd'] # shell data
+        @shell_cmd.send_data(j['sd'])
+
+      elsif j['ssc'] # shell ctrl-c
+        @shell_cmd.close_connection
+
       else
         warn "received unexpected data: #{j.inspect}"
       end # j['d']
@@ -185,9 +235,8 @@ module PryRemoteEm
 
     def unbind
       Pry.config.pager  = @old_pager
-      Pry.config.system = @old_system
       PryRemoteEm::Server.unregister(@obj, self)
-      Kernel.puts "[pry-remote-em] remote session terminated (#{peer_ip}:#{peer_port})"
+      @log.debug("[pry-remote-em] remote session terminated (#{peer_ip}:#{peer_port})")
     end
 
     def peers(all = false)
@@ -210,6 +259,45 @@ module PryRemoteEm
       @auth_required ?  @after_auth.push({:mb => msg}) : send_data({:mb => msg})
     end
 
+    # Callbacks for events on the server
+
+    # Registers a block to call when authentication is attempted.
+    # @overload auth_attempt(&blk)
+    #   @yield [user, ip] a block to call on each authentication attempt
+    #   @yieldparam [String] user
+    #   @yieldparam [String] ip
+    def auth_attempt(*args, &blk)
+      block_given? ? @auth_attempt_cbs << blk : @auth_attempts.push(args)
+      while (auth_data = @auth_attempts.shift)
+        @auth_attempt_cbs.each { |cb| cb.call(*auth_data) }
+      end
+    end # auth_attempt(*args, &blk)
+
+    # Registers a block to call when authentication fails.
+    # @overload auth_fail(&blk)
+    #   @yield [user, ip] a block to call after each failed authentication attempt
+    #   @yieldparam [String] user
+    #   @yieldparam [String] ip
+    def auth_fail(*args, &blk)
+      block_given? ? @auth_fail_cbs << blk : @auth_fails.push(args)
+      while (fail_data = @auth_fails.shift)
+        @auth_fail_cbs.each { |cb| cb.call(*fail_data) }
+      end
+    end # auth_fail(*args, &blk)
+
+    # Registers a block to call when authentication succeeds.
+    # @overload auth_ok(&blk)
+    #   @yield [user, ip] a block to call after each successful authentication attempt
+    #   @yieldparam [String] user
+    #   @yieldparam [String] ip
+    def auth_ok(*args, &blk)
+      block_given? ? @auth_ok_cbs << blk : @auth_oks.push(args)
+      while (ok_data = @auth_oks.shift)
+        @auth_ok_cbs.each { |cb| cb.call(*ok_data) }
+      end
+    end # auth_fail(*args, &blk)
+
+
     # Methods that make Server compatible with Pry
 
     def readline(prompt)
@@ -241,9 +329,5 @@ module PryRemoteEm
     def flush
       true
     end
-
-    System = proc do |output, cmd, _|
-      output.puts("shell commands are not yet supported")
-    end
   end # module::Server
 end # module::PryRemoteEm

data/lib/pry-remote-em/server/shell_cmd.rb

@@ -0,0 +1,20 @@
+module PryRemoteEm
+  module Server
+    module ShellCmd
+      def initialize(pryem)
+        @pryem = pryem
+      end
+
+      def receive_data(d)
+        @pryem.send_data({:s => d.force_encoding("utf-8") })
+      end
+
+      alias :receive_stderr :receive_data
+
+      def unbind
+        @pryem.send_data({:sc => get_status.exitstatus })
+        @pryem.send_last_prompt
+      end
+    end # module::ShellCmd
+  end # module::Server
+end # module::PryRemoteEm

data/lib/pry-remote-em/version.rb

@@ -1,3 +1,3 @@
 module PryRemoteEm
-  VERSION   = '0.5.0'
+  VERSION   = '0.6.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pry-remote-em
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-06 00:00:00.000000000Z
+date: 2012-02-11 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70256102479660 !ruby/object:Gem::Requirement
+  requirement: &70351121077580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70256102479660
+  version_requirements: *70351121077580
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70256102473680 !ruby/object:Gem::Requirement
+  requirement: &70351121077080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.9.6
   type: :runtime
   prerelease: false
-  version_requirements: *70256102473680
+  version_requirements: *70351121077080
 - !ruby/object:Gem::Dependency
   name: rb-readline
-  requirement: &70256102473100 !ruby/object:Gem::Requirement
+  requirement: &70351121076660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70256102473100
+  version_requirements: *70351121076660
+- !ruby/object:Gem::Dependency
+  name: ruby-termios
+  requirement: &70351121076120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *70351121076120
 - !ruby/object:Gem::Dependency
   name: highline
-  requirement: &70256102471840 !ruby/object:Gem::Requirement
+  requirement: &70351121109480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +65,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70256102471840
+  version_requirements: *70351121109480
 description: Connect to Pry remotely using EventMachine with tab-completion, paging,
   user auth and SSL
 email: pry-remote-em@simulacre.org
@@ -63,8 +74,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/pry-remote-em/client/keyboard.rb
 - lib/pry-remote-em/client.rb
 - lib/pry-remote-em/json-proto.rb
+- lib/pry-remote-em/server/shell_cmd.rb
 - lib/pry-remote-em/server.rb
 - lib/pry-remote-em/version.rb
 - lib/pry-remote-em.rb
@@ -95,4 +108,3 @@ signing_key:
 specification_version: 3
 summary: Connect to Pry remotely using EventMachine
 test_files: []
-has_rdoc: