Class: Net::SSH::Transport::Session

Inherits:
Object
  • Object
show all
Includes:
Loggable, Constants
Defined in:
lib/net/ssh/transport/session.rb

Overview

The transport layer represents the lowest level of the SSH protocol, and implements basic message exchanging and protocol initialization. It will never be instantiated directly (unless you really know what you’re about), but will instead be created for you automatically when you create a new SSH session via Net::SSH.start.

Constant Summary collapse

DEFAULT_PORT =

The standard port for the SSH protocol.

22

Constants included from Constants

Constants::DEBUG, Constants::DISCONNECT, Constants::IGNORE, Constants::KEXDH_INIT, Constants::KEXDH_REPLY, Constants::KEXECDH_INIT, Constants::KEXECDH_REPLY, Constants::KEXINIT, Constants::NEWKEYS, Constants::SERVICE_ACCEPT, Constants::SERVICE_REQUEST, Constants::UNIMPLEMENTED

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(host, options = {}) ⇒ Session

Instantiates a new transport layer abstraction. This will block until the initial key exchange completes, leaving you with a ready-to-use transport session.



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

def initialize(host, options={})
  self.logger = options[:logger]

  @host = host
  @port = options[:port] || DEFAULT_PORT
  @bind_address = options[:bind_address] || nil
  @options = options

  debug { "establishing connection to #{@host}:#{@port}" }

  @socket =
    if (factory = options[:proxy])
      factory.open(@host, @port, options)
    else
      Socket.tcp(@host, @port, @bind_address, nil,
                 connect_timeout: options[:timeout])
    end

  @socket.extend(PacketStream)
  @socket.logger = @logger

  debug { "connection established" }

  @queue = []

  @host_key_verifier = select_host_key_verifier(options[:paranoid])


  @server_version = ServerVersion.new(socket, logger, options[:timeout])

  @algorithms = Algorithms.new(self, options)
  wait { algorithms.initialized? }
rescue Errno::ETIMEDOUT
  raise Net::SSH::ConnectionTimeout
end

Instance Attribute Details

#algorithms ⇒ Object (readonly)

The Algorithms instance used to perform key exchanges.



44
45
46
 
# File 'lib/net/ssh/transport/session.rb', line 44

def algorithms
  @algorithms
end

#host ⇒ Object (readonly)

The host to connect to, as given to the constructor.



29
30
31
 
# File 'lib/net/ssh/transport/session.rb', line 29

def host
  @host
end

#host_key_verifier ⇒ Object (readonly)

The host-key verifier object used to verify host keys, to ensure that the connection is not being spoofed.



48
49
50
 
# File 'lib/net/ssh/transport/session.rb', line 48

def host_key_verifier
  @host_key_verifier
end

#options ⇒ Object (readonly)

The hash of options that were given to the object at initialization.



51
52
53
 
# File 'lib/net/ssh/transport/session.rb', line 51

def options
  @options
end

#port ⇒ Object (readonly)

The port number to connect to, as given in the options to the constructor. If no port number was given, this will default to DEFAULT_PORT.



33
34
35
 
# File 'lib/net/ssh/transport/session.rb', line 33

def port
  @port
end

#queue ⇒ Object (readonly)

this method is primarily for use in tests



272
273
274
 
# File 'lib/net/ssh/transport/session.rb', line 272

def queue
  @queue
end

#server_version ⇒ Object (readonly)

The ServerVersion instance that encapsulates the negotiated protocol version.



41
42
43
 
# File 'lib/net/ssh/transport/session.rb', line 41

def server_version
  @server_version
end

#socket ⇒ Object (readonly)

The underlying socket object being used to communicate with the remote host.



37
38
39
 
# File 'lib/net/ssh/transport/session.rb', line 37

def socket
  @socket
end

Instance Method Details

#close ⇒ Object

Cleans up (see PacketStream#cleanup) and closes the underlying socket.



125
126
127
128
 
# File 'lib/net/ssh/transport/session.rb', line 125

def close
  socket.cleanup
  socket.close
end

#closed? ⇒ Boolean

Returns true if the underlying socket has been closed.

Returns:

  • (Boolean) 


120
121
122
 
# File 'lib/net/ssh/transport/session.rb', line 120

def closed?
  socket.closed?
end

#configure_client(options = {}) ⇒ Object

Configure’s the packet stream’s client state with the given set of options. This is typically used to define the cipher, compression, and hmac algorithms to use when sending packets to the server.



252
253
254
 
# File 'lib/net/ssh/transport/session.rb', line 252

def configure_client(options={})
  socket.client.set(options)
end

#configure_server(options = {}) ⇒ Object

Configure’s the packet stream’s server state with the given set of options. This is typically used to define the cipher, compression, and hmac algorithms to use when reading packets from the server.



259
260
261
 
# File 'lib/net/ssh/transport/session.rb', line 259

def configure_server(options={})
  socket.server.set(options)
end

#enqueue_message(message) ⇒ Object

Enqueues the given message, such that it will be sent at the earliest opportunity. This does not block, but returns immediately.



245
246
247
 
# File 'lib/net/ssh/transport/session.rb', line 245

def enqueue_message(message)
  socket.enqueue_packet(message)
end

#hint(which, value = true) ⇒ Object

Sets a new hint for the packet stream, which the packet stream may use to change its behavior. (See PacketStream#hints).



265
266
267
 
# File 'lib/net/ssh/transport/session.rb', line 265

def hint(which, value=true)
  socket.hints[which] = value
end

#host_as_string ⇒ Object

Returns the host (and possibly IP address) in a format compatible with SSH known-host files.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/net/ssh/transport/session.rb', line 101

def host_as_string
  @host_as_string ||= begin
    string = "#{host}"
    string = "[#{string}]:#{port}" if port != DEFAULT_PORT

    peer_ip = socket.peer_ip

    if peer_ip != Net::SSH::Transport::PacketStream::PROXY_COMMAND_HOST_IP &&
       peer_ip != host
      string2 = peer_ip
      string2 = "[#{string2}]:#{port}" if port != DEFAULT_PORT
      string << "," << string2
    end

    string
  end
end

#host_keys ⇒ Object 



92
93
94
95
96
97
 
# File 'lib/net/ssh/transport/session.rb', line 92

def host_keys
  @host_keys ||= begin
    known_hosts = options.fetch(:known_hosts, KnownHosts)
    known_hosts.search_for(options[:host_key_alias] || host_as_string, options)
  end
end

#next_message ⇒ Object

Blocks until a new packet is available to be read, and returns that packet. See #poll_message.



171
172
173
 
# File 'lib/net/ssh/transport/session.rb', line 171

def next_message
  poll_message(:block)
end

#peer ⇒ Object

Returns a hash of information about the peer (remote) side of the socket, including :ip, :port, :host, and :canonized (see #host_as_string).



165
166
167
 
# File 'lib/net/ssh/transport/session.rb', line 165

def peer
  @peer ||= { :ip => socket.peer_ip, :port => @port.to_i, :host => @host, :canonized => host_as_string }
end

#poll_message(mode = :nonblock, consume_queue = true) ⇒ Object

Tries to read the next packet from the socket. If mode is :nonblock (the default), this will not block and will return nil if there are no packets waiting to be read. Otherwise, this will block until a packet is available. Note that some packet types (DISCONNECT, IGNORE, UNIMPLEMENTED, DEBUG, and KEXINIT) are handled silently by this method, and will never be returned.

If a key-exchange is in process and a disallowed packet type is received, it will be enqueued and otherwise ignored. When a key-exchange is not in process, and consume_queue is true, packets will be first read from the queue before the socket is queried.



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/net/ssh/transport/session.rb', line 186

def poll_message(mode=:nonblock, consume_queue=true)
  loop do
    if consume_queue && @queue.any? && algorithms.allow?(@queue.first)
      return @queue.shift
    end

    packet = socket.next_packet(mode)
    return nil if packet.nil?

    case packet.type
    when DISCONNECT
      raise Net::SSH::Disconnect, "disconnected: #{packet[:description]} (#{packet[:reason_code]})"

    when IGNORE
      debug { "IGNORE packet recieved: #{packet[:data].inspect}" }

    when UNIMPLEMENTED
      lwarn { "UNIMPLEMENTED: #{packet[:number]}" }

    when DEBUG
      send(packet[:always_display] ? :fatal : :debug) { packet[:message] }

    when KEXINIT
      algorithms.accept_kexinit(packet)

    else
      return packet if algorithms.allow?(packet)
      push(packet)
    end
  end
end

#push(packet) ⇒ Object

Adds the given packet to the packet queue. If the queue is non-empty, #poll_message will return packets from the queue in the order they were received.



233
234
235
 
# File 'lib/net/ssh/transport/session.rb', line 233

def push(packet)
  @queue.push(packet)
end

#rekey! ⇒ Object

Requests a rekey operation, and blocks until the operation completes. If a rekey is already pending, this returns immediately, having no effect.



148
149
150
151
152
153
 
# File 'lib/net/ssh/transport/session.rb', line 148

def rekey!
  if !algorithms.pending?
    algorithms.rekey!
    wait { algorithms.initialized? }
  end
end

#rekey_as_needed ⇒ Object

Returns immediately if a rekey is already in process. Otherwise, if a rekey is needed (as indicated by the socket, see PacketStream#if_needs_rekey?) one is performed, causing this method to block until it completes.



158
159
160
161
 
# File 'lib/net/ssh/transport/session.rb', line 158

def rekey_as_needed
  return if algorithms.pending?
  socket.if_needs_rekey? { rekey! }
end

#send_message(message) ⇒ Object

Sends the given message via the packet stream, blocking until the entire message has been sent.



239
240
241
 
# File 'lib/net/ssh/transport/session.rb', line 239

def send_message(message)
  socket.send_packet(message)
end

#service_request(service) ⇒ Object

Returns a new service_request packet for the given service name, ready for sending to the server.



141
142
143
 
# File 'lib/net/ssh/transport/session.rb', line 141

def service_request(service)
  Net::SSH::Buffer.from(:byte, SERVICE_REQUEST, :string, service)
end

#shutdown! ⇒ Object

Performs a “hard” shutdown of the connection. In general, this should never be done, but it might be necessary (in a rescue clause, for instance, when the connection needs to close but you don’t know the status of the underlying protocol’s state).



134
135
136
137
 
# File 'lib/net/ssh/transport/session.rb', line 134

def shutdown!
  error { "forcing connection closed" }
  socket.close
end

#wait ⇒ Object

Waits (blocks) until the given block returns true. If no block is given, this just waits long enough to see if there are any pending packets. Any packets read are enqueued (see #push).



221
222
223
224
225
226
227
228
 
# File 'lib/net/ssh/transport/session.rb', line 221

def wait
  loop do
    break if block_given? && yield
    message = poll_message(:nonblock, false)
    push(message) if message
    break if !block_given?
  end
end