Class: Protocol::HTTP1::Connection

Inherits:
Object
  • Object
show all
Defined in:
lib/protocol/http1/connection.rb

Constant Summary collapse

CRLF = 
"\r\n".freeze
HTTP10 = 
"HTTP/1.0".freeze
HTTP11 = 
"HTTP/1.1".freeze
HEAD = 
"HEAD".freeze
CONNECT = 
"CONNECT".freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(stream, persistent = true) ⇒ Connection

Returns a new instance of Connection.



55
56
57
58
59
60
61
 
# File 'lib/protocol/http1/connection.rb', line 55

def initialize(stream, persistent = true)
  @stream = stream
  
  @persistent = persistent
  
  @count = 0
end

Instance Attribute Details

#count ⇒ Object (readonly)

The number of requests processed.



69
70
71
 
# File 'lib/protocol/http1/connection.rb', line 69

def count
  @count
end

#persistent ⇒ Object (readonly)

Whether the connection is persistent.



66
67
68
 
# File 'lib/protocol/http1/connection.rb', line 66

def persistent
  @persistent
end

#stream ⇒ Object (readonly)

Returns the value of attribute stream.



63
64
65
 
# File 'lib/protocol/http1/connection.rb', line 63

def stream
  @stream
end

Instance Method Details

#close ⇒ Object

Close the connection and underlying stream.



119
120
121
 
# File 'lib/protocol/http1/connection.rb', line 119

def close
  @stream&.close
end

#hijack! ⇒ IO

Effectively close the connection and return the underlying IO.

Returns:

  • (IO) —

    the underlying non-blocking IO.



108
109
110
111
112
113
114
115
116
 
# File 'lib/protocol/http1/connection.rb', line 108

def hijack!
  @persistent = false
  stream = @stream
  
  @stream.flush
  @stream = nil
  
  return stream
end

#persistent?(version, headers) ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/protocol/http1/connection.rb', line 77

def persistent?(version, headers)
  if version == HTTP10
    if connection = headers[CONNECTION]
      return connection.include?(KEEP_ALIVE)
    else
      return false
    end
  else
    if connection = headers[CONNECTION]
      return !connection.include?(CLOSE)
    else
      return true
    end
  end
end

#read_body(headers, remainder = false) ⇒ Object 



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/protocol/http1/connection.rb', line 366

def read_body(headers, remainder = false)
  # 3.  If a Transfer-Encoding header field is present and the chunked
  # transfer coding (Section 4.1) is the final encoding, the message
  # body length is determined by reading and decoding the chunked
  # data until the transfer coding indicates the data is complete.
  if transfer_encoding = headers.delete(TRANSFER_ENCODING)
    # If a message is received with both a Transfer-Encoding and a
    # Content-Length header field, the Transfer-Encoding overrides the
    # Content-Length.  Such a message might indicate an attempt to
    # perform request smuggling (Section 9.5) or response splitting
    # (Section 9.4) and ought to be handled as an error.  A sender MUST
    # remove the received Content-Length field prior to forwarding such
    # a message downstream.
    if headers[CONTENT_LENGTH]
      raise BadRequest, "Message contains both transfer encoding and content length!"
    end
    
    if transfer_encoding.last == CHUNKED
      return read_chunked_body
    else
      # If a Transfer-Encoding header field is present in a response and
      # the chunked transfer coding is not the final encoding, the
      # message body length is determined by reading the connection until
      # it is closed by the server.  If a Transfer-Encoding header field
      # is present in a request and the chunked transfer coding is not
      # the final encoding, the message body length cannot be determined
      # reliably; the server MUST respond with the 400 (Bad Request)
      # status code and then close the connection.
      return read_remainder_body
    end
  end

  # 5.  If a valid Content-Length header field is present without
  # Transfer-Encoding, its decimal value defines the expected message
  # body length in octets.  If the sender closes the connection or
  # the recipient times out before the indicated number of octets are
  # received, the recipient MUST consider the message to be
  # incomplete and close the connection.
  if content_length = headers.delete(CONTENT_LENGTH)
    length = Integer(content_length)
    if length > 0
      return read_fixed_body(length)
    elsif length == 0
      return nil
    else
      raise BadRequest, "Invalid content length: #{content_length}"
    end
  end
  
  # http://tools.ietf.org/html/rfc2068#section-19.7.1.1
  if remainder
    # 7.  Otherwise, this is a response message without a declared message
    # body length, so the message body length is determined by the
    # number of octets received prior to the server closing the
    # connection.
    return read_remainder_body
  end
end

#read_chunked_body ⇒ Object 



314
315
316
 
# File 'lib/protocol/http1/connection.rb', line 314

def read_chunked_body
  Body::Chunked.new(self)
end

#read_fixed_body(length) ⇒ Object 



318
319
320
 
# File 'lib/protocol/http1/connection.rb', line 318

def read_fixed_body(length)
  Body::Fixed.new(@stream, length)
end

#read_headers ⇒ Object 



187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/protocol/http1/connection.rb', line 187

def read_headers
  fields = []
  
  while line = read_line
    if line =~ /^([a-zA-Z\-\d]+):\s*(.+?)\s*$/
      fields << [$1, $2]
    else
      break
    end
  end
  
  return HTTP::Headers.new(fields)
end

#read_line ⇒ Object 



147
148
149
 
# File 'lib/protocol/http1/connection.rb', line 147

def read_line
  read_line? or raise EOFError
end

#read_line? ⇒ Boolean

Returns:

  • (Boolean) 


143
144
145
 
# File 'lib/protocol/http1/connection.rb', line 143

def read_line?
  @stream.gets(CRLF, chomp: true)
end

#read_remainder_body ⇒ Object 



322
323
324
 
# File 'lib/protocol/http1/connection.rb', line 322

def read_remainder_body
  Body::Remainder.new(@stream)
end

#read_request ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/protocol/http1/connection.rb', line 151

def read_request
  return unless line = read_line?
  
  if match = line.match(REQUEST_LINE)
    _, method, path, version = *match
  else
    raise InvalidRequest, line.inspect
  end
  
  headers = read_headers
  
  @persistent = persistent?(version, headers)
  
  body = read_request_body(headers)
  
  @count += 1
  
  return headers.delete(HOST), method, path, version, headers, body
end

#read_request_body(headers) ⇒ Object 



360
361
362
363
364
 
# File 'lib/protocol/http1/connection.rb', line 360

def read_request_body(headers)
  # 6.  If this is a request message and none of the above are true, then
  # the message body length is zero (no message body is present).
  return read_body(headers)
end

#read_response(method) ⇒ Object 



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/protocol/http1/connection.rb', line 171

def read_response(method)
  version, status, reason = read_line.split(/\s+/, 3)
  
  status = Integer(status)
  
  headers = read_headers
  
  @persistent = persistent?(version, headers)
  
  body = read_response_body(method, status, headers)
  
  @count += 1
  
  return version, status, reason, headers, body
end

#read_response_body(method, status, headers) ⇒ Object 



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/protocol/http1/connection.rb', line 337

def read_response_body(method, status, headers)
  # RFC 7230 3.3.3
  # 1.  Any response to a HEAD request and any response with a 1xx
  # (Informational), 204 (No Content), or 304 (Not Modified) status
  # code is always terminated by the first empty line after the
  # header fields, regardless of the header fields present in the
  # message, and thus cannot contain a message body.
  if method == "HEAD" or (status >= 100 and status < 200) or status == 204 or status == 304
    return nil
  end
  
  # 2.  Any 2xx (Successful) response to a CONNECT request implies that
  # the connection will become a tunnel immediately after the empty
  # line that concludes the header fields.  A client MUST ignore any
  # Content-Length or Transfer-Encoding header fields received in
  # such a message.
  if method == "CONNECT" and status == 200
    return read_tunnel_body
  end
  
  return read_body(headers, true)
end

#read_tunnel_body ⇒ Object 



326
327
328
 
# File 'lib/protocol/http1/connection.rb', line 326

def read_tunnel_body
  read_remainder_body
end

#read_upgrade_body(protocol) ⇒ Object 



330
331
332
 
# File 'lib/protocol/http1/connection.rb', line 330

def read_upgrade_body(protocol)
  read_remainder_body
end

#upgrade?(headers) ⇒ Boolean

Returns:

  • (Boolean) 


71
72
73
74
75
 
# File 'lib/protocol/http1/connection.rb', line 71

def upgrade?(headers)
  if upgrade = headers[UPGRADE]
    return upgrade
  end
end

#write_body(version, body, head = false) ⇒ Object 



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/protocol/http1/connection.rb', line 296

def write_body(version, body, head = false)
  if body.nil? or body.empty?
    write_connection_header(version)
    write_empty_body(body)
  elsif length = body.length
    write_connection_header(version)
    write_fixed_length_body(body, length, head)
  elsif @persistent and version == HTTP11
    write_connection_header(version)
    # We specifically ensure that non-persistent connections do not use chunked response, so that hijacking works as expected.
    write_chunked_body(body, head)
  else
    @persistent = false
    write_connection_header(version)
    write_body_and_close(body, head)
  end
end

#write_body_and_close(body, head) ⇒ Object 



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/protocol/http1/connection.rb', line 277

def write_body_and_close(body, head)
  # We can't be persistent because we don't know the data length:
  @persistent = false
  
  @stream.write("\r\n")
  @stream.flush
  
  if head
    body.close
  else
    body.each do |chunk|
      @stream.write(chunk)
      @stream.flush
    end
  end
  
  @stream.close_write
end

#write_chunked_body(body, head) ⇒ Object 



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/protocol/http1/connection.rb', line 254

def write_chunked_body(body, head)
  @stream.write("transfer-encoding: chunked\r\n\r\n")
  @stream.flush
  
  if head
    body.close
    
    return
  end
  
  body.each do |chunk|
    next if chunk.size == 0
    
    @stream.write("#{chunk.bytesize.to_s(16).upcase}\r\n")
    @stream.write(chunk)
    @stream.write(CRLF)
    @stream.flush
  end
  
  @stream.write("0\r\n\r\n")
  @stream.flush
end

#write_connection_header(version) ⇒ Object

Write the appropriate header for connection persistence.



94
95
96
97
98
99
100
 
# File 'lib/protocol/http1/connection.rb', line 94

def write_connection_header(version)
  if version == HTTP10
    @stream.write("connection: keep-alive\r\n") if @persistent
  else
    @stream.write("connection: close\r\n") unless @persistent
  end
end

#write_empty_body(body) ⇒ Object 



219
220
221
222
223
224
 
# File 'lib/protocol/http1/connection.rb', line 219

def write_empty_body(body)
  @stream.write("content-length: 0\r\n\r\n")
  @stream.flush
  
  body&.close
end

#write_fixed_length_body(body, length, head) ⇒ Object 



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/protocol/http1/connection.rb', line 226

def write_fixed_length_body(body, length, head)
  @stream.write("content-length: #{length}\r\n\r\n")
  @stream.flush
  
  if head
    body.close
    
    return
  end
  
  chunk_length = 0
  body.each do |chunk|
    chunk_length += chunk.bytesize
    
    if chunk_length > length
      raise Error, "Trying to write #{chunk_length} bytes, but content length was #{length} bytes!"
    end
    
    @stream.write(chunk)
  end
  
  @stream.flush
  
  if chunk_length != length
    raise Error, "Wrote #{chunk_length} bytes, but content length was #{length} bytes!"
  end
end

#write_headers(headers) ⇒ Object 



137
138
139
140
141
 
# File 'lib/protocol/http1/connection.rb', line 137

def write_headers(headers)
  headers.each do |name, value|
    @stream.write("#{name}: #{value}\r\n")
  end
end

#write_request(authority, method, path, version, headers) ⇒ Object 



123
124
125
126
127
128
 
# File 'lib/protocol/http1/connection.rb', line 123

def write_request(authority, method, path, version, headers)
  @stream.write("#{method} #{path} #{version}\r\n")
  @stream.write("host: #{authority}\r\n")
  
  write_headers(headers)
end

#write_response(version, status, headers, reason = Reason::DESCRIPTIONS[status]) ⇒ Object 



130
131
132
133
134
135
 
# File 'lib/protocol/http1/connection.rb', line 130

def write_response(version, status, headers, reason = Reason::DESCRIPTIONS[status])
  # Safari WebSockets break if no reason is given.
  @stream.write("#{version} #{status} #{reason}\r\n")
  
  write_headers(headers)
end

#write_upgrade_body(protocol, body = nil) ⇒ Object

Parameters:

  • protocol (String) —

    the protocol to upgrade to.



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/protocol/http1/connection.rb', line 202

def write_upgrade_body(protocol, body = nil)
  # Once we upgrade the connection, it can no longer handle other requests:
  @persistent = false
  
  write_upgrade_header(protocol)
  
  @stream.write("\r\n")
  @stream.flush # Don't remove me!
  
  body&.each do |chunk|
    @stream.write(chunk)
    @stream.flush
  end
  
  return @stream
end

#write_upgrade_header(upgrade) ⇒ Object 



102
103
104
 
# File 'lib/protocol/http1/connection.rb', line 102

def write_upgrade_header(upgrade)
  @stream.write("connection: upgrade\r\nupgrade: #{upgrade}\r\n")
end