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 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 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 217 218 219 220 221 222 223 224 225 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 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 290 291 292 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 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 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 424
|
-- This module implements the socket level functionality needed for an HTTP 1 connection
local cqueues = require "cqueues"
local monotime = cqueues.monotime
local ca = require "cqueues.auxlib"
local cc = require "cqueues.condition"
local ce = require "cqueues.errno"
local connection_common = require "http.connection_common"
local onerror = connection_common.onerror
local h1_stream = require "http.h1_stream"
local new_fifo = require "fifo"
local connection_methods = {}
for k,v in pairs(connection_common.methods) do
connection_methods[k] = v
end
local connection_mt = {
__name = "http.h1_connection";
__index = connection_methods;
}
function connection_mt:__tostring()
return string.format("http.h1_connection{type=%q;version=%.1f}",
self.type, self.version)
end
-- assumes ownership of the socket
local function new_connection(socket, conn_type, version)
assert(socket, "must provide a socket")
if conn_type ~= "client" and conn_type ~= "server" then
error('invalid connection type. must be "client" or "server"')
end
assert(version == 1 or version == 1.1, "unsupported version")
local self = setmetatable({
socket = socket;
type = conn_type;
version = version;
-- for server: streams waiting to go out
-- for client: streams waiting for a response
pipeline = new_fifo();
-- pipeline condition is stored in stream itself
-- for server: held while request being read
-- for client: held while writing request
req_locked = nil;
-- signaled when unlocked
req_cond = cc.new();
-- A function that will be called if the connection becomes idle
onidle_ = nil;
}, connection_mt)
socket:setvbuf("full", math.huge) -- 'infinite' buffering; no write locks needed
socket:setmode("b", "bf")
socket:onerror(onerror)
return self
end
function connection_methods:setmaxline(read_length)
if self.socket == nil then
return nil
end
self.socket:setmaxline(read_length)
return true
end
function connection_methods:clearerr(...)
if self.socket == nil then
return nil
end
return self.socket:clearerr(...)
end
function connection_methods:error(...)
if self.socket == nil then
return nil
end
return self.socket:error(...)
end
function connection_methods:take_socket()
local s = self.socket
if s == nil then
-- already taken
return nil
end
self.socket = nil
-- Shutdown *after* taking away socket so shutdown handlers can't effect the socket
self:shutdown()
-- Reset socket to some defaults
s:onerror(nil)
return s
end
function connection_methods:shutdown(dir)
if dir == nil or dir:match("w") then
while self.pipeline:length() > 0 do
local stream = self.pipeline:peek()
stream:shutdown()
end
end
if self.socket then
return ca.fileresult(self.socket:shutdown(dir))
else
return true
end
end
function connection_methods:new_stream()
assert(self.type == "client")
if self.socket == nil or self.socket:eof("w") then
return nil
end
local stream = h1_stream.new(self)
return stream
end
-- this function *should never throw*
function connection_methods:get_next_incoming_stream(timeout)
assert(self.type == "server")
-- Make sure we don't try and read before the previous request has been fully read
if self.req_locked then
local deadline = timeout and monotime()+timeout
assert(cqueues.running(), "cannot wait for condition if not within a cqueues coroutine")
if cqueues.poll(self.req_cond, timeout) == timeout then
return nil, ce.strerror(ce.ETIMEDOUT), ce.ETIMEDOUT
end
timeout = deadline and deadline-monotime()
assert(self.req_locked == nil)
end
if self.socket == nil then
return nil
end
-- Wait for at least one byte
local ok, err, errno = self.socket:fill(1, 0)
if not ok then
if errno == ce.ETIMEDOUT then
local deadline = timeout and monotime()+timeout
if cqueues.poll(self.socket, timeout) ~= timeout then
return self:get_next_incoming_stream(deadline and deadline-monotime())
end
end
return nil, err, errno
end
local stream = h1_stream.new(self)
self.pipeline:push(stream)
self.req_locked = stream
return stream
end
function connection_methods:read_request_line(timeout)
local deadline = timeout and (monotime()+timeout)
local preline
local line, err, errno = self.socket:xread("*L", timeout)
if line == "\r\n" then
-- RFC 7230 3.5: a server that is expecting to receive and parse a request-line
-- SHOULD ignore at least one empty line (CRLF) received prior to the request-line.
preline = line
line, err, errno = self.socket:xread("*L", deadline and (deadline-monotime()))
end
if line == nil then
if preline then
local ok, errno2 = self.socket:unget(preline)
if not ok then
return nil, onerror(self.socket, "unget", errno2)
end
end
return nil, err, errno
end
local method, target, httpversion = line:match("^(%w+) (%S+) HTTP/(1%.[01])\r\n$")
if not method then
self.socket:seterror("r", ce.EILSEQ)
local ok, errno2 = self.socket:unget(line)
if not ok then
return nil, onerror(self.socket, "unget", errno2)
end
if preline then
ok, errno2 = self.socket:unget(preline)
if not ok then
return nil, onerror(self.socket, "unget", errno2)
end
end
return nil, onerror(self.socket, "read_request_line", ce.EILSEQ)
end
httpversion = httpversion == "1.0" and 1.0 or 1.1 -- Avoid tonumber() due to locale issues
return method, target, httpversion
end
function connection_methods:read_status_line(timeout)
local line, err, errno = self.socket:xread("*L", timeout)
if line == nil then
return nil, err, errno
end
local httpversion, status_code, reason_phrase = line:match("^HTTP/(1%.[01]) (%d%d%d) (.*)\r\n$")
if not httpversion then
self.socket:seterror("r", ce.EILSEQ)
local ok, errno2 = self.socket:unget(line)
if not ok then
return nil, onerror(self.socket, "unget", errno2)
end
return nil, onerror(self.socket, "read_status_line", ce.EILSEQ)
end
httpversion = httpversion == "1.0" and 1.0 or 1.1 -- Avoid tonumber() due to locale issues
return httpversion, status_code, reason_phrase
end
function connection_methods:read_header(timeout)
local line, err, errno = self.socket:xread("*h", timeout)
if line == nil then
-- Note: the *h read returns *just* nil when data is a non-mime compliant header
if err == nil then
local pending_bytes = self.socket:pending()
-- check if we're at end of headers
if pending_bytes >= 2 then
local peek = assert(self.socket:xread(2, "b", 0))
local ok, errno2 = self.socket:unget(peek)
if not ok then
return nil, onerror(self.socket, "unget", errno2)
end
if peek == "\r\n" then
return nil
end
end
if pending_bytes > 0 then
self.socket:seterror("r", ce.EILSEQ)
return nil, onerror(self.socket, "read_header", ce.EILSEQ)
end
end
return nil, err, errno
end
-- header fields can have optional surrounding whitespace
--[[ RFC 7230 3.2.4: No whitespace is allowed between the header field-name
and colon. In the past, differences in the handling of such whitespace have
led to security vulnerabilities in request routing and response handling.
A server MUST reject any received request message that contains whitespace
between a header field-name and colon with a response code of
400 (Bad Request). A proxy MUST remove any such whitespace from a response
message before forwarding the message downstream.]]
local key, val = line:match("^([^%s:]+):[ \t]*(.-)[ \t]*$")
if not key then
self.socket:seterror("r", ce.EILSEQ)
local ok, errno2 = self.socket:unget(line)
if not ok then
return nil, onerror(self.socket, "unget", errno2)
end
return nil, onerror(self.socket, "read_header", ce.EILSEQ)
end
return key, val
end
function connection_methods:read_headers_done(timeout)
local crlf, err, errno = self.socket:xread(2, timeout)
if crlf == "\r\n" then
return true
elseif crlf ~= nil or (err == nil and self.socket:pending() > 0) then
self.socket:seterror("r", ce.EILSEQ)
if crlf then
local ok, errno2 = self.socket:unget(crlf)
if not ok then
return nil, onerror(self.socket, "unget", errno2)
end
end
return nil, onerror(self.socket, "read_headers_done", ce.EILSEQ)
else
return nil, err, errno
end
end
-- pass a negative length for *up to* that number of bytes
function connection_methods:read_body_by_length(len, timeout)
assert(type(len) == "number")
return self.socket:xread(len, timeout)
end
function connection_methods:read_body_till_close(timeout)
return self.socket:xread("*a", timeout)
end
function connection_methods:read_body_chunk(timeout)
local deadline = timeout and (monotime()+timeout)
local chunk_header, err, errno = self.socket:xread("*L", timeout)
if chunk_header == nil then
return nil, err, errno
end
local chunk_size, chunk_ext = chunk_header:match("^(%x+) *(.-)\r\n")
if chunk_size == nil then
self.socket:seterror("r", ce.EILSEQ)
local unget_ok1, unget_errno1 = self.socket:unget(chunk_header)
if not unget_ok1 then
return nil, onerror(self.socket, "unget", unget_errno1)
end
return nil, onerror(self.socket, "read_body_chunk", ce.EILSEQ)
elseif #chunk_size > 8 then
self.socket:seterror("r", ce.E2BIG)
return nil, onerror(self.socket, "read_body_chunk", ce.E2BIG)
end
chunk_size = tonumber(chunk_size, 16)
if chunk_ext == "" then
chunk_ext = nil
end
if chunk_size == 0 then
-- you MUST read trailers after this!
return false, chunk_ext
else
local ok, err2, errno2 = self.socket:fill(chunk_size+2, 0)
if not ok then
local unget_ok1, unget_errno1 = self.socket:unget(chunk_header)
if not unget_ok1 then
return nil, onerror(self.socket, "unget", unget_errno1)
end
if errno2 == ce.ETIMEDOUT then
timeout = deadline and deadline-monotime()
if cqueues.poll(self.socket, timeout) ~= timeout then
-- retry
return self:read_body_chunk(deadline and deadline-monotime())
end
elseif err2 == nil then
self.socket:seterror("r", ce.EILSEQ)
return nil, onerror(self.socket, "read_body_chunk", ce.EILSEQ)
end
return nil, err2, errno2
end
-- if `fill` succeeded these shouldn't be able to fail
local chunk_data = assert(self.socket:xread(chunk_size, "b", 0))
local crlf = assert(self.socket:xread(2, "b", 0))
if crlf ~= "\r\n" then
self.socket:seterror("r", ce.EILSEQ)
local unget_ok3, unget_errno3 = self.socket:unget(crlf)
if not unget_ok3 then
return nil, onerror(self.socket, "unget", unget_errno3)
end
local unget_ok2, unget_errno2 = self.socket:unget(chunk_data)
if not unget_ok2 then
return nil, onerror(self.socket, "unget", unget_errno2)
end
local unget_ok1, unget_errno1 = self.socket:unget(chunk_header)
if not unget_ok1 then
return nil, onerror(self.socket, "unget", unget_errno1)
end
return nil, onerror(self.socket, "read_body_chunk", ce.EILSEQ)
end
-- Success!
return chunk_data, chunk_ext
end
end
function connection_methods:write_request_line(method, target, httpversion, timeout)
assert(method:match("^[^ \r\n]+$"))
assert(target:match("^[^ \r\n]+$"))
assert(httpversion == 1.0 or httpversion == 1.1)
local line = string.format("%s %s HTTP/%s\r\n", method, target, httpversion == 1.0 and "1.0" or "1.1")
local ok, err, errno = self.socket:xwrite(line, "f", timeout)
if not ok then
return nil, err, errno
end
return true
end
function connection_methods:write_status_line(httpversion, status_code, reason_phrase, timeout)
assert(httpversion == 1.0 or httpversion == 1.1)
assert(status_code:match("^[1-9]%d%d$"), "invalid status code")
assert(type(reason_phrase) == "string" and reason_phrase:match("^[^\r\n]*$"), "invalid reason phrase")
local line = string.format("HTTP/%s %s %s\r\n", httpversion == 1.0 and "1.0" or "1.1", status_code, reason_phrase)
local ok, err, errno = self.socket:xwrite(line, "f", timeout)
if not ok then
return nil, err, errno
end
return true
end
function connection_methods:write_header(k, v, timeout)
assert(type(k) == "string" and k:match("^[^:\r\n]+$"), "field name invalid")
assert(type(v) == "string" and v:sub(-1, -1) ~= "\n" and not v:match("\n[^ ]"), "field value invalid")
local ok, err, errno = self.socket:xwrite(k..": "..v.."\r\n", "f", timeout)
if not ok then
return nil, err, errno
end
return true
end
function connection_methods:write_headers_done(timeout)
-- flushes write buffer
local ok, err, errno = self.socket:xwrite("\r\n", "n", timeout)
if not ok then
return nil, err, errno
end
return true
end
function connection_methods:write_body_chunk(chunk, chunk_ext, timeout)
assert(chunk_ext == nil, "chunk extensions not supported")
local data = string.format("%x\r\n", #chunk) .. chunk .. "\r\n"
-- flushes write buffer
local ok, err, errno = self.socket:xwrite(data, "n", timeout)
if not ok then
return nil, err, errno
end
return true
end
function connection_methods:write_body_last_chunk(chunk_ext, timeout)
assert(chunk_ext == nil, "chunk extensions not supported")
-- no flush; writing trailers (via write_headers_done) will do that
local ok, err, errno = self.socket:xwrite("0\r\n", "f", timeout)
if not ok then
return nil, err, errno
end
return true
end
function connection_methods:write_body_plain(body, timeout)
-- flushes write buffer
local ok, err, errno = self.socket:xwrite(body, "n", timeout)
if not ok then
return nil, err, errno
end
return true
end
return {
new = new_connection;
methods = connection_methods;
mt = connection_mt;
}
|