summaryrefslogtreecommitdiff
path: root/lib/net/ssh/proxy/command.rb
blob: b6723e1f698284ea0184bcc69f86ac8f595f2967 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
require 'socket'
require 'rubygems'
require 'net/ssh/proxy/errors'
require 'net/ssh/ruby_compat'

module Net; module SSH; module Proxy

  # An implementation of a command proxy. To use it, instantiate it,
  # then pass the instantiated object via the :proxy key to
  # Net::SSH.start:
  #
  #   require 'net/ssh/proxy/command'
  #
  #   proxy = Net::SSH::Proxy::Command.new('ssh relay nc %h %p')
  #   Net::SSH.start('host', 'user', :proxy => proxy) do |ssh|
  #     ...
  #   end
  class Command

    # The command line template
    attr_reader :command_line_template

    # The command line for the session
    attr_reader :command_line

    # Create a new socket factory that tunnels via a command executed
    # with the user's shell, which is composed from the given command
    # template.  In the command template, `%h' will be substituted by
    # the host name to connect and `%p' by the port.
    def initialize(command_line_template)
      @command_line_template = command_line_template
      @command_line = nil
    end

    # Return a new socket connected to the given host and port via the
    # proxy that was requested when the socket factory was instantiated.
    def open(host, port, connection_options = nil)
      command_line = @command_line_template.gsub(/%(.)/) {
        case $1
        when 'h'
          host
        when 'p'
          port.to_s
        when 'r'
          remote_user = connection_options && connection_options[:remote_user]
          if remote_user
            remote_user
          else
            raise ArgumentError, "remote user name not available"
          end
        when '%'
          '%'
        else
          raise ArgumentError, "unknown key: #{$1}"
        end
      }
      begin
        io = IO.popen(command_line, "r+")
        if result = Net::SSH::Compat.io_select([io], nil, [io], 60)
          if result.last.any?
            raise "command failed"
          end
        else
          raise "command timed out"
        end
      rescue => e
        raise ConnectError, "#{e}: #{command_line}"
      end
      @command_line = command_line
      if Gem.win_platform?
        # read_nonblock and write_nonblock are not available on Windows
        # pipe. Use sysread and syswrite as a replacement works.
        def io.send(data, flag)
          syswrite(data)
        end

        def io.recv(size)
          sysread(size)
        end
      else
        def io.send(data, flag)
          begin
            result = write_nonblock(data)
          rescue IO::WaitWritable, Errno::EINTR
            IO.select(nil, [self])
            retry
          end
          result
        end

        def io.recv(size)
          begin
            result = read_nonblock(size)
          rescue IO::WaitReadable, Errno::EINTR
            timeout_in_seconds = 20
            if IO.select([self], nil, [self], timeout_in_seconds) == nil
              raise "Unexpected spurious read wakeup"
            end
            retry
          end
          result
        end
      end
      io
    end
  end

end; end; end