Class: Net::SSH::Buffer

Inherits:
Object
  • Object
show all
Defined in:
lib/net/ssh/buffer.rb

Overview

Net::SSH::Buffer is a flexible class for building and parsing binary data packets. It provides a stream-like interface for sequentially reading data items from the buffer, as well as a useful helper method for building binary packets given a signature.

Writing to a buffer always appends to the end, regardless of where the read cursor is. Reading, on the other hand, always begins at the first byte of the buffer and increments the read cursor, with subsequent reads taking up where the last left off.

As a consumer of the Net::SSH library, you will rarely come into contact with these buffer objects directly, but it could happen. Also, if you are ever implementing a protocol on top of SSH (e.g. SFTP), this buffer class can be quite handy.

Direct Known Subclasses

Packet

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(content = "") ⇒ Buffer

Creates a new buffer, initialized to the given content. The position is initialized to the beginning of the buffer.


74
75
76
77
# File 'lib/net/ssh/buffer.rb', line 74

def initialize(content="")
  @content = content.to_s
  @position = 0
end

Instance Attribute Details

#contentObject (readonly)

exposes the raw content of the buffer


67
68
69
# File 'lib/net/ssh/buffer.rb', line 67

def content
  @content
end

#positionObject

the current position of the pointer in the buffer


70
71
72
# File 'lib/net/ssh/buffer.rb', line 70

def position
  @position
end

Class Method Details

.from(*args) ⇒ Object

This is a convenience method for creating and populating a new buffer from a single command. The arguments must be even in length, with the first of each pair of arguments being a symbol naming the type of the data that follows. If the type is :raw, the value is written directly to the hash.

b = Buffer.from(:byte, 1, :string, "hello", :raw, "\1\2\3\4")
#-> "\1\0\0\0\5hello\1\2\3\4"

The supported data types are:

  • :raw => write the next value verbatim (#write)

  • :int64 => write an 8-byte integer (#write_int64)

  • :long => write a 4-byte integer (#write_long)

  • :byte => write a single byte (#write_byte)

  • :string => write a 4-byte length followed by character data (#write_string)

  • :mstring => same as string, but caller cannot resuse the string, avoids potential duplication (#write_moved)

  • :bool => write a single byte, interpreted as a boolean (#write_bool)

  • :bignum => write an SSH-encoded bignum (#write_bignum)

  • :key => write an SSH-encoded key value (#write_key)

Any of these, except for :raw, accepts an Array argument, to make it easier to write multiple values of the same type in a briefer manner.

Raises:

  • (ArgumentError)

47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# File 'lib/net/ssh/buffer.rb', line 47

def self.from(*args)
  raise ArgumentError, "odd number of arguments given" unless args.length % 2 == 0

  buffer = new
  0.step(args.length - 1, 2) do |index|
    type = args[index]
    value = args[index + 1]
    if type == :raw
      buffer.append(value.to_s)
    elsif Array === value
      buffer.send("write_#{type}", *value)
    else
      buffer.send("write_#{type}", value)
    end
  end

  buffer
end

Instance Method Details

#==(buffer) ⇒ Object

Compares the contents of the two buffers, returning true only if they are identical in size and content.


97
98
99
# File 'lib/net/ssh/buffer.rb', line 97

def ==(buffer)
  to_s == buffer.to_s
end

#append(text) ⇒ Object

Appends the given text to the end of the buffer. Does not alter the read position. Returns the buffer object itself.


146
147
148
149
# File 'lib/net/ssh/buffer.rb', line 146

def append(text)
  @content << text
  self
end

#availableObject

Returns the number of bytes available to be read (e.g., how many bytes remain between the current position and the end of the buffer).


86
87
88
# File 'lib/net/ssh/buffer.rb', line 86

def available
  length - position
end

#clear!Object

Resets the buffer, making it empty. Also, resets the read position to 0.


120
121
122
123
# File 'lib/net/ssh/buffer.rb', line 120

def clear!
  @content = ""
  @position = 0
end

#consume!(n = position) ⇒ Object

Consumes n bytes from the buffer, where n is the current position unless otherwise specified. This is useful for removing data from the buffer that has previously been read, when you are expecting more data to be appended. It helps to keep the size of buffers down when they would otherwise tend to grow without bound.

Returns the buffer object itself.


132
133
134
135
136
137
138
139
140
141
142
# File 'lib/net/ssh/buffer.rb', line 132

def consume!(n=position)
  if n >= length
    # optimize for a fairly common case
    clear!
  elsif n > 0
    @content = @content[n..-1] || ""
    @position -= n
    @position = 0 if @position < 0
  end
  self
end

#empty?Boolean

Returns true if the buffer contains no data (e.g., it is of zero length).

Returns:

  • (Boolean)

102
103
104
# File 'lib/net/ssh/buffer.rb', line 102

def empty?
  @content.empty?
end

#eof?Boolean

Returns true if the pointer is at the end of the buffer. Subsequent reads will return nil, in this case.

Returns:

  • (Boolean)

114
115
116
# File 'lib/net/ssh/buffer.rb', line 114

def eof?
  @position >= length
end

#lengthObject

Returns the length of the buffer's content.


80
81
82
# File 'lib/net/ssh/buffer.rb', line 80

def length
  @content.length
end

#read(count = nil) ⇒ Object

Reads and returns the next count bytes from the buffer, starting from the read position. If count is nil, this will return all remaining text in the buffer. This method will increment the pointer.


175
176
177
178
179
180
# File 'lib/net/ssh/buffer.rb', line 175

def read(count=nil)
  count ||= length
  count = length - @position if @position + count > length
  @position += count
  @content[@position - count, count]
end

#read!(count = nil) ⇒ Object

Reads (as #read) and returns the given number of bytes from the buffer, and then consumes (as #consume!) all data up to the new read position.


184
185
186
187
188
# File 'lib/net/ssh/buffer.rb', line 184

def read!(count=nil)
  data = read(count)
  consume!
  data
end

#read_all(&block) ⇒ Object

Calls block(self) until the buffer is empty, and returns all results.


191
192
193
# File 'lib/net/ssh/buffer.rb', line 191

def read_all(&block)
  Enumerator.new { |e| e << yield(self) until eof? }.to_a
end

#read_bignumObject

Read a bignum (OpenSSL::BN) from the buffer, in SSH2 format. It is essentially just a string, which is reinterpreted to be a bignum in binary format.


237
238
239
240
241
# File 'lib/net/ssh/buffer.rb', line 237

def read_bignum
  data = read_string
  return unless data
  OpenSSL::BN.new(data, 2)
end

#read_boolObject

Read a single byte and convert it into a boolean, using 'C' rules (i.e., zero is false, non-zero is true).


229
230
231
232
# File 'lib/net/ssh/buffer.rb', line 229

def read_bool
  b = read_byte or return nil
  b != 0
end

#read_bufferObject

Reads the next string from the buffer, and returns a new Buffer object that wraps it.


335
336
337
# File 'lib/net/ssh/buffer.rb', line 335

def read_buffer
  Buffer.new(read_string)
end

#read_byteObject

Read and return the next byte in the buffer. Returns nil if called at the end of the buffer.


214
215
216
217
# File 'lib/net/ssh/buffer.rb', line 214

def read_byte
  b = read(1) or return nil
  b.getbyte(0)
end

#read_int64Object

Return the next 8 bytes as a 64-bit integer (in network byte order). Returns nil if there are less than 8 bytes remaining to be read in the buffer.


198
199
200
201
202
# File 'lib/net/ssh/buffer.rb', line 198

def read_int64
  hi = read_long or return nil
  lo = read_long or return nil
  return (hi << 32) + lo
end

#read_keyObject

Read a key from the buffer. The key will start with a string describing its type. The remainder of the key is defined by the type that was read.


246
247
248
249
# File 'lib/net/ssh/buffer.rb', line 246

def read_key
  type = read_string
  return (type ? read_keyblob(type) : nil)
end

#read_keyblob(type) ⇒ Object

Read a keyblob of the given type from the buffer, and return it as a key. Only RSA, DSA, and ECDSA keys are supported.


293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
# File 'lib/net/ssh/buffer.rb', line 293

def read_keyblob(type)
  case type
  when /^(.*)[email protected]\.com$/
    key = Net::SSH::Authentication::Certificate.read_certblob(self, $1)
  when /^ssh-dss$/
    key = OpenSSL::PKey::DSA.new
    if key.respond_to?(:set_pqg)
      key.set_pqg(read_bignum, read_bignum, read_bignum)
    else
      key.p = read_bignum
      key.q = read_bignum
      key.g = read_bignum
    end
    if key.respond_to?(:set_key)
      key.set_key(read_bignum, nil)
    else
      key.pub_key = read_bignum
    end
  when /^ssh-rsa$/
    key = OpenSSL::PKey::RSA.new
    if key.respond_to?(:set_key)
      e = read_bignum
      n = read_bignum
      key.set_key(n, e, nil)
    else
      key.e = read_bignum
      key.n = read_bignum
    end
  when /^ssh-ed25519$/
    Net::SSH::Authentication::ED25519Loader.raiseUnlessLoaded("unsupported key type `#{type}'")
    key = Net::SSH::Authentication::ED25519::PubKey.read_keyblob(self)
  when /^ecdsa\-sha2\-(\w*)$/
    key = OpenSSL::PKey::EC.read_keyblob($1, self)
  else
    raise NotImplementedError, "unsupported key type `#{type}'"
  end

  return key
end

#read_longObject

Return the next four bytes as a long integer (in network byte order). Returns nil if there are less than 4 bytes remaining to be read in the buffer.


207
208
209
210
# File 'lib/net/ssh/buffer.rb', line 207

def read_long
  b = read(4) or return nil
  b.unpack("N").first
end

#read_private_keyblob(type) ⇒ Object


251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
# File 'lib/net/ssh/buffer.rb', line 251

def read_private_keyblob(type)
  case type
  when /^ssh-rsa$/
    key = OpenSSL::PKey::RSA.new
    n = read_bignum
    e = read_bignum
    d = read_bignum
    iqmp = read_bignum
    p = read_bignum
    q = read_bignum
    _unkown1 = read_bignum
    _unkown2 = read_bignum
    dmp1 = d % (p - 1)
    dmq1 = d % (q - 1)
    if key.respond_to?(:set_key)
      key.set_key(n, e, d)
    else
      key.e = e
      key.n = n
      key.d = d
    end
    if key.respond_to?(:set_factors)
      key.set_factors(p, q)
    else
      key.p = p
      key.q = q
    end
    if key.respond_to?(:set_crt_params)
      key.set_crt_params(dmp1, dmq1, iqmp)
    else
      key.dmp1 = dmp1
      key.dmq1 = dmq1
      key.iqmp = iqmp
    end
    key
  else
    raise Exception, "Cannot decode private key of type #{type}"
  end
end

#read_stringObject

Read and return an SSH2-encoded string. The string starts with a long integer that describes the number of bytes remaining in the string. Returns nil if there are not enough bytes to satisfy the request.


222
223
224
225
# File 'lib/net/ssh/buffer.rb', line 222

def read_string
  length = read_long or return nil
  read(length)
end

#read_to(pattern) ⇒ Object

Reads all data up to and including the given pattern, which may be a String, Fixnum, or Regexp and is interpreted exactly as String#index does. Returns nil if nothing matches. Increments the position to point immediately after the pattern, if it does match. Returns all data up to and including the text that matched the pattern.


162
163
164
165
166
167
168
169
170
# File 'lib/net/ssh/buffer.rb', line 162

def read_to(pattern)
  index = @content.index(pattern, @position) or return nil
  length = case pattern
           when String then pattern.length
           when Integer then 1
           when Regexp then $&.length
           end
  index && read(index + length)
end

#remainder_as_bufferObject

Returns all text from the current pointer to the end of the buffer as a new Net::SSH::Buffer object.


153
154
155
# File 'lib/net/ssh/buffer.rb', line 153

def remainder_as_buffer
  Buffer.new(@content[@position..-1])
end

#reset!Object

Resets the pointer to the start of the buffer. Subsequent reads will begin at position 0.


108
109
110
# File 'lib/net/ssh/buffer.rb', line 108

def reset!
  @position = 0
end

#to_sObject

Returns a copy of the buffer's content.


91
92
93
# File 'lib/net/ssh/buffer.rb', line 91

def to_s
  (@content || "").dup
end

#write(*data) ⇒ Object

Writes the given data literally into the string. Does not alter the read position. Returns the buffer object.


341
342
343
344
# File 'lib/net/ssh/buffer.rb', line 341

def write(*data)
  data.each { |datum| @content << datum.dup.force_encoding('BINARY') }
  self
end

#write_bignum(*n) ⇒ Object

Writes each argument to the buffer as a bignum (SSH2-style). No checking is done to ensure that the arguments are, in fact, bignums. Does not alter the read position. Returns the buffer object.


416
417
418
419
# File 'lib/net/ssh/buffer.rb', line 416

def write_bignum(*n)
  @content << n.map { |b| b.to_ssh }.join
  self
end

#write_bool(*b) ⇒ Object

Writes each argument to the buffer as a (C-style) boolean, with 1 meaning true, and 0 meaning false. Does not alter the read position. Returns the buffer object.


408
409
410
411
# File 'lib/net/ssh/buffer.rb', line 408

def write_bool(*b)
  b.each { |v| @content << (v ? "\1" : "\0") }
  self
end

#write_byte(*n) ⇒ Object

Writes each argument to the buffer as a byte. Does not alter the read position. Returns the buffer object.


375
376
377
378
# File 'lib/net/ssh/buffer.rb', line 375

def write_byte(*n)
  n.each { |b| @content << b.chr }
  self
end

#write_int64(*n) ⇒ Object

Writes each argument to the buffer as a network-byte-order-encoded 64-bit integer (8 bytes). Does not alter the read position. Returns the buffer object.


356
357
358
359
360
361
362
363
# File 'lib/net/ssh/buffer.rb', line 356

def write_int64(*n)
  n.each do |i|
    hi = (i >> 32) & 0xFFFFFFFF
    lo = i & 0xFFFFFFFF
    @content << [hi, lo].pack("N2")
  end
  self
end

#write_key(*key) ⇒ Object

Writes the given arguments to the buffer as SSH2-encoded keys. Does not alter the read position. Returns the buffer object.


423
424
425
426
# File 'lib/net/ssh/buffer.rb', line 423

def write_key(*key)
  key.each { |k| append(k.to_blob) }
  self
end

#write_long(*n) ⇒ Object

Writes each argument to the buffer as a network-byte-order-encoded long (4-byte) integer. Does not alter the read position. Returns the buffer object.


368
369
370
371
# File 'lib/net/ssh/buffer.rb', line 368

def write_long(*n)
  @content << n.pack("N*")
  self
end

#write_moved(string) ⇒ Object

Optimized version of write where the caller gives up ownership of string to the method. This way we can mutate the string.


348
349
350
351
# File 'lib/net/ssh/buffer.rb', line 348

def write_moved(string)
  @content << string.force_encoding('BINARY')
  self
end

#write_mstring(*text) ⇒ Object

Writes each argument to the buffer as an SSH2-encoded string. Each string is prefixed by its length, encoded as a 4-byte long integer. Does not alter the read position. Returns the buffer object. Might alter arguments see write_moved


396
397
398
399
400
401
402
403
# File 'lib/net/ssh/buffer.rb', line 396

def write_mstring(*text)
  text.each do |string|
    s = string.to_s
    write_long(s.bytesize)
    write_moved(s)
  end
  self
end

#write_string(*text) ⇒ Object

Writes each argument to the buffer as an SSH2-encoded string. Each string is prefixed by its length, encoded as a 4-byte long integer. Does not alter the read position. Returns the buffer object.


383
384
385
386
387
388
389
390
# File 'lib/net/ssh/buffer.rb', line 383

def write_string(*text)
  text.each do |string|
    s = string.to_s
    write_long(s.bytesize)
    write(s)
  end
  self
end