Class: Net::SSH::Service::Forward

Inherits:
Object
  • Object
show all
Includes:
Loggable
Defined in:
lib/net/ssh/service/forward.rb

Overview

This class implements various port forwarding services for use by Net::SSH clients. The Forward class should never need to be instantiated directly; instead, it should be accessed via the singleton instance returned by Connection::Session#forward:

ssh.forward.local(1234, "www.capify.org", 80)

Defined Under Namespace

Classes: Remote

Instance Attribute Summary collapse

Attributes included from Loggable

#logger

Instance Method Summary collapse

Methods included from Loggable

#debug, #error, #fatal, #info, #lwarn

Constructor Details

#initialize(session) ⇒ Forward

Instantiates a new Forward service instance atop the given connection service session. This will register new channel open handlers to handle the specialized channels that the SSH port forwarding protocols employ.



25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/net/ssh/service/forward.rb', line 25

def initialize(session)
  @session = session
  self.logger = session.logger
  @remote_forwarded_ports = {}
  @local_forwarded_ports = {}
  @agent_forwarded = false

  session.on_open_channel('forwarded-tcpip', &method(:forwarded_tcpip))
  session.on_open_channel('auth-agent', &method(:auth_agent_channel))
  session.on_open_channel('[email protected]', &method(:auth_agent_channel))
end

Instance Attribute Details

#session ⇒ Object (readonly)

The underlying connection service instance that the port-forwarding services employ.



17
18
19
 
# File 'lib/net/ssh/service/forward.rb', line 17

def session
  @session
end

Instance Method Details

#active_locals ⇒ Object

Returns a list of all active locally forwarded ports. The returned value is an array of arrays, where each element is a two-element tuple consisting of the local port and bind address corresponding to the forwarding port.



118
119
120
 
# File 'lib/net/ssh/service/forward.rb', line 118

def active_locals
  @local_forwarded_ports.keys
end

#active_remotes ⇒ Object

Returns all active forwarded remote ports. The returned value is an array of two-element tuples, where the first element is the port on the remote host and the second is the bind address.



182
183
184
 
# File 'lib/net/ssh/service/forward.rb', line 182

def active_remotes
  @remote_forwarded_ports.keys
end

#agent(channel) ⇒ Object

Enables SSH agent forwarding on the given channel. The forwarded agent will remain active even after the channel closes–the channel is only used as the transport for enabling the forwarded connection. You should never need to call this directly–it is called automatically the first time a session channel is opened, when the connection was created with :forward_agent set to true:

Net::SSH.start("remote.host", "me", :forward_agent => true) do |ssh|
  ssh.open_channel do |ch|
    # agent will be automatically forwarded by this point
  end
  ssh.loop
end



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/net/ssh/service/forward.rb', line 199

def agent(channel)
  return if @agent_forwarded
  @agent_forwarded = true

  channel.send_channel_request("[email protected]") do |achannel, success|
    if success
      debug { "authentication agent forwarding is active" }
    else
      achannel.send_channel_request("auth-agent-req") do |a2channel, success2|
        if success2
          debug { "authentication agent forwarding is active" }
        else
          error { "could not establish forwarding of authentication agent" }
        end
      end
    end
  end
end

#cancel_local(port, bind_address = "127.0.0.1") ⇒ Object

Terminates an active local forwarded port. If no such forwarded port exists, this will raise an exception. Otherwise, the forwarded connection is terminated.

ssh.forward.cancel_local(1234)
ssh.forward.cancel_local(1234, "0.0.0.0")



107
108
109
110
111
112
 
# File 'lib/net/ssh/service/forward.rb', line 107

def cancel_local(port, bind_address="127.0.0.1")
  socket = @local_forwarded_ports.delete([port, bind_address])
  socket.shutdown rescue nil
  socket.close rescue nil
  session.stop_listening_to(socket)
end

#cancel_remote(port, host = "127.0.0.1") ⇒ Object

Requests that a remote forwarded port be cancelled. The remote forwarded port on the remote host, bound to the given address on the remote host, will be terminated, but not immediately. This method returns immediately after queueing the request to be sent to the server. If for some reason the port cannot be cancelled, an exception will be raised (asynchronously).

If you want to know when the connection has been cancelled, it will no longer be present in the #active_remotes list. If you want to block until the port is no longer active, you could do something like this:

ssh.forward.cancel_remote(1234, "0.0.0.0")
ssh.loop { ssh.forward.active_remotes.include?([1234, "0.0.0.0"]) }



169
170
171
172
173
174
175
176
177
 
# File 'lib/net/ssh/service/forward.rb', line 169

def cancel_remote(port, host="127.0.0.1")
  session.send_global_request("cancel-tcpip-forward", :string, host, :long, port) do |success, response|
    if success
      @remote_forwarded_ports.delete([port, host])
    else
      raise Net::SSH::Exception, "could not cancel remote forward request on #{host}:#{port}"
    end
  end
end

#local(*args) ⇒ Object

Starts listening for connections on the local host, and forwards them to the specified remote host/port via the SSH connection. This method accepts either three or four arguments. When four arguments are given, they are:

  • the local address to bind to

  • the local port to listen on

  • the remote host to forward connections to

  • the port on the remote host to connect to

If three arguments are given, it is as if the local bind address is “127.0.0.1”, and the rest are applied as above.

To request an ephemeral port on the remote server, provide 0 (zero) for the port number. In all cases, this method will return the port that has been assigned.

ssh.forward.local(1234, "www.capify.org", 80)
assigned_port = ssh.forward.local("0.0.0.0", 0, "www.capify.org", 80)



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
 
# File 'lib/net/ssh/service/forward.rb', line 56

def local(*args)
  if args.length < 3 || args.length > 4
    raise ArgumentError, "expected 3 or 4 parameters, got #{args.length}"
  end

  local_port_type = :long

  socket = begin
    if defined?(UNIXServer) and args.first.class == UNIXServer
      local_port_type = :string
      args.shift
    else
      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
      local_port_type = :long
      TCPServer.new(bind_address, local_port)
    end
  end

  local_port = socket.addr[1] if local_port == 0 # ephemeral port was requested
  remote_host = args.shift
  remote_port = args.shift.to_i

  @local_forwarded_ports[[local_port, bind_address]] = socket

  session.listen_to(socket) do |server|
    client = server.accept
    debug { "received connection on #{socket}" }

    channel = session.open_channel("direct-tcpip", :string, remote_host, :long, remote_port, :string, bind_address, local_port_type, local_port) do |achannel|
      achannel.info { "direct channel established" }
    end

    prepare_client(client, channel, :local)
  
    channel.on_open_failed do |ch, code, description|
      channel.error { "could not establish direct channel: #{description} (#{code})" }
      channel[:socket].close
    end
  end
  
  local_port
end

#remote(port, host, remote_port, remote_host = "127.0.0.1") ⇒ Object Also known as: remote_to

Requests that all connections on the given remote-port be forwarded via the local host to the given port/host. The last argument describes the bind address on the remote host, and defaults to 127.0.0.1.

This method will return immediately, but the port will not actually be forwarded immediately. If the remote server is not able to begin the listener for this request, an exception will be raised asynchronously.

To request an ephemeral port on the remote server, provide 0 (zero) for the port number. The assigned port will show up in the # #active_remotes list.

If you want to block until the port is active, you could do something like this:

old_active_remotes = ssh.forward.active_remotes
ssh.forward.remote(80, "www.google.com", 0, "0.0.0.0")
ssh.loop { !(ssh.forward.active_remotes.length > old_active_remotes.length) }
assigned_port = (ssh.forward.active_remotes - old_active_remotes).first[0]



141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/net/ssh/service/forward.rb', line 141

def remote(port, host, remote_port, remote_host="127.0.0.1")
  session.send_global_request("tcpip-forward", :string, remote_host, :long, remote_port) do |success, response|
    if success
      remote_port = response.read_long if remote_port == 0
      debug { "remote forward from remote #{remote_host}:#{remote_port} to #{host}:#{port} established" }
      @remote_forwarded_ports[[remote_port, remote_host]] = Remote.new(host, port)
    else
      error { "remote forwarding request failed" }
      raise Net::SSH::Exception, "remote forwarding request failed"
    end
  end
end