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 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176
|
local cqueues = require "cqueues"
local monotime = cqueues.monotime
local cc = require "cqueues.condition"
local ce = require "cqueues.errno"
local new_fifo = require "fifo"
local band = require "http.bit".band
local bor = require "http.bit".bor
local h2_errors = require "http.h2_error".errors
local stream_common = require "http.stream_common"
local spack = string.pack or require "compat53.string".pack
local sunpack = string.unpack or require "compat53.string".unpack
local unpack = table.unpack or unpack -- luacheck: ignore 113
local assert = assert
if _VERSION:match("%d+%.?%d*") < "5.3" then
assert = require "compat53.module".assert
end
local MAX_HEADER_BUFFER_SIZE = 400*1024 -- 400 KB is max size in h2o
local frame_handlers = {}
local stream_methods = {}
for k, v in pairs(stream_common.methods) do
stream_methods[k] = v
end
local stream_mt = {
__name = "http.h2_stream";
__index = stream_methods;
}
function stream_mt:__tostring()
local dependee_list = {}
for s in pairs(self.dependees) do
dependee_list[#dependee_list+1] = string.format("%d", s.id)
end
table.sort(dependee_list)
dependee_list = table.concat(dependee_list, ",")
return string.format("http.h2_stream{connection=%s;id=%d;state=%q;parent=%s;dependees={%s}}",
tostring(self.connection), self.id, self.state,
(self.parent and tostring(self.parent.id) or "nil"), dependee_list)
end
local function new_stream(connection, id)
assert(type(id) == "number" and id >= 0 and id <= 0x7fffffff, "invalid stream id")
local self = setmetatable({
connection = connection;
type = connection.type;
state = "idle";
id = id;
peer_flow_credits = id ~= 0 and connection.peer_settings[0x4];
peer_flow_credits_increase = cc.new();
parent = nil;
dependees = setmetatable({}, {__mode="kv"});
weight = 16; -- http2 spec, section 5.3.5
rst_stream_error = nil;
stats_sent_headers = 0; -- number of header blocks sent
stats_recv_headers = 0; -- number of header blocks received
stats_sent = 0; -- #bytes sent in DATA blocks
stats_recv = 0; -- #bytes received in DATA blocks
recv_headers_fifo = new_fifo();
recv_headers_cond = cc.new();
chunk_fifo = new_fifo();
chunk_cond = cc.new();
}, stream_mt)
return self
end
local valid_states = {
["idle"] = 1; -- initial
["open"] = 2; -- have sent or received headers; haven't sent body yet
["reserved (local)"] = 2; -- have sent a PUSH_PROMISE
["reserved (remote)"] = 2; -- have received a PUSH_PROMISE
["half closed (local)"] = 3; -- have sent whole body
["half closed (remote)"] = 3; -- have received whole body
["closed"] = 4; -- complete
}
function stream_methods:set_state(new)
local new_order = assert(valid_states[new])
local old = self.state
if new_order <= valid_states[old] then
error("invalid state progression ('"..old.."' to '"..new.."')")
end
self.state = new
if old == "idle" and new ~= "closed" then
self.connection.n_active_streams = self.connection.n_active_streams + 1
elseif old ~= "idle" and new == "closed" then
local n_active_streams = self.connection.n_active_streams - 1
self.connection.n_active_streams = n_active_streams
if n_active_streams == 0 then
self.connection:onidle()(self.connection)
end
end
end
function stream_methods:write_http2_frame(typ, flags, payload, timeout)
return self.connection:write_http2_frame(typ, flags, self.id, payload, timeout)
end
function stream_methods:reprioritise(child, exclusive)
assert(child)
assert(child.id ~= 0) -- cannot reprioritise stream 0
if self == child then
-- http2 spec, section 5.3.1
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("A stream cannot depend on itself", true), ce.EILSEQ
end
do -- Check if the child is an ancestor
local ancestor = self.parent
while ancestor do
if ancestor == child then
-- Break the loop. http spec, section 5.3.3
local ok, err, errno = child.parent:reprioritise(self, false)
if not ok then
return nil, err, errno
end
break
end
ancestor = ancestor.parent
end
end
-- Remove old parent
if child.parent then
child.parent.dependees[child] = nil
end
-- We are now the parent
child.parent = self
if exclusive then
-- All the parent's deps are now the child's
for s, v in pairs(self.dependees) do
s.parent = child
child.dependees[s] = v
self.dependees[s] = nil
end
else
self.dependees[child] = true
end
return true
end
local chunk_methods = {}
local chunk_mt = {
__name = "http.h2_stream.chunk";
__index = chunk_methods;
}
local function new_chunk(stream, original_length, data)
return setmetatable({
stream = stream;
original_length = original_length;
data = data;
acked = false;
}, chunk_mt)
end
function chunk_methods:ack(no_window_update)
if self.acked then
return
end
self.acked = true
local len = self.original_length
if len > 0 and not no_window_update then
-- ignore errors
self.stream:write_window_update(len, 0)
self.stream.connection:write_window_update(len, 0)
end
end
-- DATA
frame_handlers[0x0] = function(stream, flags, payload, deadline) -- luacheck: ignore 212
if stream.id == 0 then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("'DATA' framess MUST be associated with a stream"), ce.EILSEQ
end
if stream.state == "idle" or stream.state == "reserved (remote)" then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("'DATA' frames not allowed in 'idle' state"), ce.EILSEQ
elseif stream.state ~= "open" and stream.state ~= "half closed (local)" then
return nil, h2_errors.STREAM_CLOSED:new_traceback("'DATA' frames not allowed in '" .. stream.state .. "' state", true), ce.EILSEQ
end
local end_stream = band(flags, 0x1) ~= 0
local padded = band(flags, 0x8) ~= 0
local original_length = #payload
if padded then
local pad_len = sunpack("> B", payload)
if pad_len >= #payload then -- >= will take care of the pad_len itself
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("length of the padding is the length of the frame payload or greater"), ce.EILSEQ
elseif payload:match("[^%z]", -pad_len) then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("padding not null bytes"), ce.EILSEQ
end
payload = payload:sub(2, -pad_len-1)
end
local chunk = new_chunk(stream, original_length, payload)
stream.chunk_fifo:push(chunk)
stream.stats_recv = stream.stats_recv + #payload
if end_stream then
stream.chunk_fifo:push(nil)
end
stream.chunk_cond:signal()
if end_stream then
if stream.state == "half closed (local)" then
stream:set_state("closed")
else
stream:set_state("half closed (remote)")
end
end
return true
end
function stream_methods:write_data_frame(payload, end_stream, padded, timeout)
if self.id == 0 then
h2_errors.PROTOCOL_ERROR("'DATA' frames MUST be associated with a stream")
end
if self.state ~= "open" and self.state ~= "half closed (remote)" then
h2_errors.STREAM_CLOSED("'DATA' frame not allowed in '" .. self.state .. "' state", true)
end
local pad_len, padding = "", ""
local flags = 0
if end_stream then
flags = bor(flags, 0x1)
end
if padded then
flags = bor(flags, 0x8)
pad_len = spack("> B", padded)
padding = ("\0"):rep(padded)
end
payload = pad_len .. payload .. padding
-- The entire DATA frame payload is included in flow control,
-- including Pad Length and Padding fields if present
local new_stream_peer_flow_credits = self.peer_flow_credits - #payload
local new_connection_peer_flow_credits = self.connection.peer_flow_credits - #payload
if new_stream_peer_flow_credits < 0 or new_connection_peer_flow_credits < 0 then
h2_errors.FLOW_CONTROL_ERROR("not enough flow credits")
end
local ok, err, errno = self:write_http2_frame(0x0, flags, payload, timeout)
if not ok then return nil, err, errno end
self.peer_flow_credits = new_stream_peer_flow_credits
self.connection.peer_flow_credits = new_connection_peer_flow_credits
self.stats_sent = self.stats_sent + #payload
if end_stream then
if self.state == "half closed (remote)" then
self:set_state("closed")
else
self:set_state("half closed (local)")
end
end
return ok
end
-- Map from header name to whether it belongs in a request (vs a response)
local valid_pseudo_headers = {
[":method"] = true;
[":scheme"] = true;
[":path"] = true;
[":authority"] = true;
[":status"] = false;
}
local function validate_headers(headers, is_request, nth_header, ended_stream)
do -- Validate that all colon fields are before other ones (section 8.1.2.1)
local seen_non_colon = false
for name, value in headers:each() do
if name:sub(1,1) == ":" then
--[[ Pseudo-header fields are only valid in the context in
which they are defined. Pseudo-header fields defined for
requests MUST NOT appear in responses; pseudo-header fields
defined for responses MUST NOT appear in requests.
Pseudo-header fields MUST NOT appear in trailers.
Endpoints MUST treat a request or response that contains
undefined or invalid pseudo-header fields as malformed
(Section 8.1.2.6)]]
if (is_request and nth_header ~= 1) or valid_pseudo_headers[name] ~= is_request then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("Pseudo-header fields are only valid in the context in which they are defined", true), ce.EILSEQ
end
if seen_non_colon then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("All pseudo-header fields MUST appear in the header block before regular header fields", true), ce.EILSEQ
end
else
seen_non_colon = true
end
if type(value) ~= "string" then
return nil, "invalid header field", ce.EINVAL
end
end
end
if headers:has("connection") then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("An endpoint MUST NOT generate an HTTP/2 message containing connection-specific header fields", true), ce.EILSEQ
end
local te = headers:get_as_sequence("te")
if te.n > 0 and (te[1] ~= "trailers" or te.n ~= 1) then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback([[The TE header field, which MAY be present in an HTTP/2 request; when it is, it MUST NOT contain any value other than "trailers"]], true), ce.EILSEQ
end
if is_request then
if nth_header == 1 then
--[[ All HTTP/2 requests MUST include exactly one valid value for the :method, :scheme,
and :path pseudo-header fields, unless it is a CONNECT request (Section 8.3).
An HTTP request that omits mandatory pseudo-header fields is malformed (Section 8.1.2.6).]]
local methods = headers:get_as_sequence(":method")
if methods.n ~= 1 then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("requests MUST include exactly one valid value for the :method, :scheme, and :path pseudo-header fields, unless it is a CONNECT request", true), ce.EILSEQ
elseif methods[1] ~= "CONNECT" then
local scheme = headers:get_as_sequence(":scheme")
local path = headers:get_as_sequence(":path")
if scheme.n ~= 1 or path.n ~= 1 then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("requests MUST include exactly one valid value for the :method, :scheme, and :path pseudo-header fields, unless it is a CONNECT request", true), ce.EILSEQ
end
if path[1] == "" and (scheme[1] == "http" or scheme[1] == "https") then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("The :path pseudo-header field MUST NOT be empty for http or https URIs", true), ce.EILSEQ
end
else -- is CONNECT method
-- Section 8.3
if headers:has(":scheme") or headers:has(":path") then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("For a CONNECT request, the :scheme and :path pseudo-header fields MUST be omitted", true), ce.EILSEQ
end
end
elseif nth_header == 2 then
if not ended_stream then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("Trailers MUST be at end of stream", true), ce.EILSEQ
end
elseif nth_header > 2 then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("An HTTP request consists of maximum 2 HEADER blocks", true), ce.EILSEQ
end
else
--[[ For HTTP/2 responses, a single :status pseudo-header field is
defined that carries the HTTP status code field (RFC7231, Section 6).
This pseudo-header field MUST be included in all responses; otherwise,
the response is malformed (Section 8.1.2.6)]]
if not headers:has(":status") then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback(":status pseudo-header field MUST be included in all responses", true), ce.EILSEQ
end
end
return true
end
local function process_end_headers(stream, end_stream, pad_len, pos, promised_stream_id, payload)
if pad_len > 0 then
if pad_len + pos - 1 > #payload then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("length of the padding is the length of the frame payload or greater"), ce.EILSEQ
elseif payload:match("[^%z]", -pad_len) then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("padding not null bytes"), ce.EILSEQ
end
payload = payload:sub(1, -pad_len-1)
end
local headers, newpos, errno = stream.connection.decoding_context:decode_headers(payload, nil, pos)
if not headers then
return nil, newpos, errno
end
if newpos ~= #payload + 1 then
return nil, h2_errors.COMPRESSION_ERROR:new_traceback("incomplete header fragment"), ce.EILSEQ
end
if not promised_stream_id then
stream.stats_recv_headers = stream.stats_recv_headers + 1
local validate_ok, validate_err, errno2 = validate_headers(headers, stream.type ~= "client", stream.stats_recv_headers, stream.state == "half closed (remote)" or stream.state == "closed")
if not validate_ok then
return nil, validate_err, errno2
end
stream.recv_headers_fifo:push(headers)
stream.recv_headers_cond:signal()
if end_stream then
stream.chunk_fifo:push(nil)
stream.chunk_cond:signal()
if stream.state == "half closed (local)" then
stream:set_state("closed")
else
stream:set_state("half closed (remote)")
end
else
if stream.state == "idle" then
stream:set_state("open")
end
end
else
local validate_ok, validate_err, errno2 = validate_headers(headers, true, 1, false)
if not validate_ok then
return nil, validate_err, errno2
end
local promised_stream = stream.connection:new_stream(promised_stream_id)
stream:reprioritise(promised_stream)
promised_stream:set_state("reserved (remote)")
promised_stream.recv_headers_fifo:push(headers)
stream.connection.new_streams:push(promised_stream)
stream.connection.new_streams_cond:signal(1)
end
return true
end
-- HEADERS
frame_handlers[0x1] = function(stream, flags, payload, deadline) -- luacheck: ignore 212
if stream.id == 0 then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("'HEADERS' frames MUST be associated with a stream"), ce.EILSEQ
end
if stream.state ~= "idle" and stream.state ~= "open" and stream.state ~= "half closed (local)" and stream.state ~= "reserved (remote)" then
return nil, h2_errors.STREAM_CLOSED:new_traceback("'HEADERS' frame not allowed in '" .. stream.state .. "' state", true), ce.EILSEQ
end
local end_stream = band(flags, 0x1) ~= 0
local end_headers = band(flags, 0x04) ~= 0
local padded = band(flags, 0x8) ~= 0
local priority = band(flags, 0x20) ~= 0
-- index where payload body starts
local pos = 1
local pad_len
if padded then
pad_len = sunpack("> B", payload, pos)
pos = 2
else
pad_len = 0
end
if priority then
local exclusive, stream_dep, weight
local tmp
tmp, weight = sunpack(">I4 B", payload, pos)
exclusive = band(tmp, 0x80000000) ~= 0
stream_dep = band(tmp, 0x7fffffff)
weight = weight + 1
pos = pos + 5
local new_parent = stream.connection.streams[stream_dep]
-- 5.3.1. Stream Dependencies
-- A dependency on a stream that is not currently in the tree
-- results in that stream being given a default priority
if new_parent then
local ok, err, errno = new_parent:reprioritise(stream, exclusive)
if not ok then
return nil, err, errno
end
stream.weight = weight
end
end
local len = #payload - pos + 1 -- TODO: minus pad_len?
if len > MAX_HEADER_BUFFER_SIZE then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("headers too large"), ce.E2BIG
end
if end_headers then
return process_end_headers(stream, end_stream, pad_len, pos, nil, payload)
else
stream.connection.need_continuation = stream
stream.connection.recv_headers_buffer = { payload }
stream.connection.recv_headers_buffer_pos = pos
stream.connection.recv_headers_buffer_pad_len = pad_len
stream.connection.recv_headers_buffer_items = 1
stream.connection.recv_headers_buffer_length = len
return true
end
end
function stream_methods:write_headers_frame(payload, end_stream, end_headers, padded, exclusive, stream_dep, weight, timeout)
assert(self.state ~= "closed" and self.state ~= "half closed (local)")
local pad_len, pri, padding = "", "", ""
local flags = 0
if end_stream then
flags = bor(flags, 0x1)
end
if end_headers then
flags = bor(flags, 0x4)
end
if padded then
flags = bor(flags, 0x8)
pad_len = spack("> B", padded)
padding = ("\0"):rep(padded)
end
if weight or stream_dep then
flags = bor(flags, 0x20)
assert(stream_dep < 0x80000000)
local tmp = stream_dep
if exclusive then
tmp = bor(tmp, 0x80000000)
end
weight = weight and weight - 1 or 0
pri = spack("> I4 B", tmp, weight)
end
payload = pad_len .. pri .. payload .. padding
local ok, err, errno = self:write_http2_frame(0x1, flags, payload, timeout)
if ok == nil then return nil, err, errno end
self.stats_sent_headers = self.stats_sent_headers + 1
if end_stream then
if self.state == "half closed (remote)" then
self:set_state("closed")
else
self:set_state("half closed (local)")
end
else
if self.state == "reserved (local)" then
self:set_state("half closed (remote)")
elseif self.state == "idle" then
self:set_state("open")
end
end
return ok
end
-- PRIORITY
frame_handlers[0x2] = function(stream, flags, payload) -- luacheck: ignore 212
if stream.id == 0 then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("'PRIORITY' frames MUST be associated with a stream"), ce.EILSEQ
end
if #payload ~= 5 then
return nil, h2_errors.FRAME_SIZE_ERROR:new_traceback("'PRIORITY' frames must be 5 bytes", true), ce.EILSEQ
end
local exclusive, stream_dep, weight
local tmp
tmp, weight = sunpack(">I4 B", payload)
weight = weight + 1
exclusive = band(tmp, 0x80000000) ~= 0
stream_dep = band(tmp, 0x7fffffff)
local new_parent = stream.connection.streams[stream_dep]
local ok, err, errno = new_parent:reprioritise(stream, exclusive)
if not ok then
return nil, err, errno
end
stream.weight = weight
return true
end
function stream_methods:write_priority_frame(exclusive, stream_dep, weight, timeout)
assert(stream_dep < 0x80000000)
local tmp = stream_dep
if exclusive then
tmp = bor(tmp, 0x80000000)
end
weight = weight and weight - 1 or 0
local payload = spack("> I4 B", tmp, weight)
return self:write_http2_frame(0x2, 0, payload, timeout)
end
-- RST_STREAM
frame_handlers[0x3] = function(stream, flags, payload, deadline) -- luacheck: ignore 212
if stream.id == 0 then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("'RST_STREAM' frames MUST be associated with a stream"), ce.EILSEQ
end
if #payload ~= 4 then
return nil, h2_errors.FRAME_SIZE_ERROR:new_traceback("'RST_STREAM' frames must be 4 bytes"), ce.EILSEQ
end
if stream.state == "idle" then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("'RST_STREAM' frames MUST NOT be sent for a stream in the 'idle' state"), ce.EILSEQ
end
local err_code = sunpack(">I4", payload)
stream.rst_stream_error = (h2_errors[err_code] or h2_errors.INTERNAL_ERROR):new {
message = string.format("'RST_STREAM' on stream #%d (code=0x%x)", stream.id, err_code);
}
stream:set_state("closed")
stream.recv_headers_cond:signal()
stream.chunk_cond:signal()
return true
end
function stream_methods:write_rst_stream(err_code, timeout)
if self.id == 0 then
h2_errors.PROTOCOL_ERROR("'RST_STREAM' frames MUST be associated with a stream")
end
if self.state == "idle" then
h2_errors.PROTOCOL_ERROR([['RST_STREAM' frames MUST NOT be sent for a stream in the "idle" state]])
end
local flags = 0
local payload = spack(">I4", err_code)
local ok, err, errno = self:write_http2_frame(0x3, flags, payload, timeout)
if not ok then return nil, err, errno end
if self.state ~= "closed" then
self:set_state("closed")
end
self:shutdown()
return ok
end
-- SETTING
frame_handlers[0x4] = function(stream, flags, payload, deadline)
if stream.id ~= 0 then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("stream identifier for a 'SETTINGS' frame MUST be zero"), ce.EILSEQ
end
local ack = band(flags, 0x1) ~= 0
if ack then -- server is ACK-ing our settings
if #payload ~= 0 then
return nil, h2_errors.FRAME_SIZE_ERROR:new_traceback("Receipt of a 'SETTINGS' frame with the ACK flag set and a length field value other than 0"), ce.EILSEQ
end
stream.connection:ack_settings()
return true
else -- settings from server
if #payload % 6 ~= 0 then
return nil, h2_errors.FRAME_SIZE_ERROR:new_traceback("'SETTINGS' frame with a length other than a multiple of 6 octets"), ce.EILSEQ
end
local peer_settings = {}
for i=1, #payload, 6 do
local id, val = sunpack(">I2 I4", payload, i)
if id == 0x1 then
stream.connection.encoding_context:set_max_dynamic_table_size(val)
-- Add a 'max size' element to the next outgoing header
stream.connection.encoding_context:encode_max_size(val)
elseif id == 0x2 then
-- Convert to boolean
if val == 0 then
val = false
elseif val == 1 then
val = true
else
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("invalid value for boolean"), ce.EILSEQ
end
if val and stream.type == "client" then
-- Clients MUST reject any attempt to change the SETTINGS_ENABLE_PUSH
-- setting to a value other than 0 by treating the message as a connection
-- error of type PROTOCOL_ERROR.
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("SETTINGS_ENABLE_PUSH not allowed for clients"), ce.EILSEQ
end
elseif id == 0x4 then
if val >= 2^31 then
return nil, h2_errors.FLOW_CONTROL_ERROR:new_traceback("SETTINGS_INITIAL_WINDOW_SIZE must be less than 2^31"), ce.EILSEQ
end
elseif id == 0x5 then
if val < 16384 then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("SETTINGS_MAX_FRAME_SIZE must be greater than or equal to 16384"), ce.EILSEQ
elseif val >= 2^24 then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("SETTINGS_MAX_FRAME_SIZE must be less than 2^24"), ce.EILSEQ
end
end
peer_settings[id] = val
end
stream.connection:set_peer_settings(peer_settings)
-- Ack server's settings
-- XXX: This shouldn't ignore all errors (it probably should not flush)
stream:write_settings_frame(true, nil, deadline and deadline-monotime())
return true
end
end
local function pack_settings_payload(settings)
local i = 0
local a = {}
local function append(k, v)
a[i*2+1] = k
a[i*2+2] = v
i = i + 1
end
local HEADER_TABLE_SIZE = settings[0x1]
if HEADER_TABLE_SIZE ~= nil then
append(0x1, HEADER_TABLE_SIZE)
end
local ENABLE_PUSH = settings[0x2]
if ENABLE_PUSH ~= nil then
if type(ENABLE_PUSH) == "boolean" then
ENABLE_PUSH = ENABLE_PUSH and 1 or 0
end
append(0x2, ENABLE_PUSH)
end
local MAX_CONCURRENT_STREAMS = settings[0x3]
if MAX_CONCURRENT_STREAMS ~= nil then
append(0x3, MAX_CONCURRENT_STREAMS)
end
local INITIAL_WINDOW_SIZE = settings[0x4]
if INITIAL_WINDOW_SIZE ~= nil then
if INITIAL_WINDOW_SIZE >= 2^31 then
h2_errors.FLOW_CONTROL_ERROR("SETTINGS_INITIAL_WINDOW_SIZE must be less than 2^31")
end
append(0x4, INITIAL_WINDOW_SIZE)
end
local MAX_FRAME_SIZE = settings[0x5]
if MAX_FRAME_SIZE ~= nil then
if MAX_FRAME_SIZE < 16384 then
h2_errors.PROTOCOL_ERROR("SETTINGS_MAX_FRAME_SIZE must be greater than or equal to 16384")
elseif MAX_FRAME_SIZE >= 2^24 then
h2_errors.PROTOCOL_ERROR("SETTINGS_MAX_FRAME_SIZE must be less than 2^24")
end
append(0x5, MAX_FRAME_SIZE)
end
local MAX_HEADER_LIST_SIZE = settings[0x6]
if MAX_HEADER_LIST_SIZE ~= nil then
append(0x6, MAX_HEADER_LIST_SIZE)
end
return spack(">" .. ("I2 I4"):rep(i), unpack(a, 1, i*2))
end
function stream_methods:write_settings_frame(ACK, settings, timeout)
if self.id ~= 0 then
h2_errors.PROTOCOL_ERROR("'SETTINGS' frames must be on stream id 0")
end
local flags, payload
if ACK then
if settings ~= nil then
h2_errors.PROTOCOL_ERROR("'SETTINGS' ACK cannot have new settings")
end
flags = 0x1
payload = ""
else
flags = 0
payload = pack_settings_payload(settings)
end
local ok, err, errno = self:write_http2_frame(0x4, flags, payload, timeout)
if ok and not ACK then
local n = self.connection.send_settings.n + 1
self.connection.send_settings.n = n
self.connection.send_settings[n] = settings
ok = n
end
return ok, err, errno
end
-- PUSH_PROMISE
frame_handlers[0x5] = function(stream, flags, payload, deadline) -- luacheck: ignore 212
if not stream.connection.acked_settings[0x2] then
-- An endpoint that has both set this parameter to 0 and had it acknowledged MUST
-- treat the receipt of a PUSH_PROMISE frame as a connection error of type PROTOCOL_ERROR.
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("SETTINGS_ENABLE_PUSH is 0"), ce.EILSEQ
elseif stream.type == "server" then
-- A client cannot push. Thus, servers MUST treat the receipt of a PUSH_PROMISE
-- frame as a connection error of type PROTOCOL_ERROR.
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("A client cannot push"), ce.EILSEQ
end
if stream.id == 0 then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("'PUSH_PROMISE' frames MUST be associated with a stream"), ce.EILSEQ
end
local end_headers = band(flags, 0x04) ~= 0
local padded = band(flags, 0x8) ~= 0
-- index where payload body starts
local pos = 1
local pad_len
if padded then
pad_len = sunpack("> B", payload, pos)
pos = 2
else
pad_len = 0
end
local tmp = sunpack(">I4", payload, pos)
local promised_stream_id = band(tmp, 0x7fffffff)
pos = pos + 4
local len = #payload - pos + 1 -- TODO: minus pad_len?
if len > MAX_HEADER_BUFFER_SIZE then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("headers too large"), ce.EILSEQ
end
if end_headers then
return process_end_headers(stream, false, pad_len, pos, promised_stream_id, payload)
else
stream.connection.recv_headers_buffer = { payload }
stream.connection.recv_headers_buffer_pos = pos
stream.connection.recv_headers_buffer_pad_len = pad_len
stream.connection.recv_headers_buffer_items = 1
stream.connection.recv_headers_buffer_length = len
stream.connection.promised_steam_id = promised_stream_id
return true
end
end
function stream_methods:write_push_promise_frame(promised_stream_id, payload, end_headers, padded, timeout)
assert(self.state == "open" or self.state == "half closed (remote)")
assert(self.id ~= 0)
local pad_len, padding = "", ""
local flags = 0
if end_headers then
flags = bor(flags, 0x4)
end
if padded then
flags = bor(flags, 0x8)
pad_len = spack("> B", padded)
padding = ("\0"):rep(padded)
end
assert(promised_stream_id > 0)
assert(promised_stream_id < 0x80000000)
assert(promised_stream_id % 2 == 0)
-- TODO: promised_stream_id must be valid for sender
promised_stream_id = spack(">I4", promised_stream_id)
payload = pad_len .. promised_stream_id .. payload .. padding
return self:write_http2_frame(0x5, flags, payload, timeout)
end
-- PING
frame_handlers[0x6] = function(stream, flags, payload, deadline)
if stream.id ~= 0 then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("'PING' must be on stream id 0"), ce.EILSEQ
end
if #payload ~= 8 then
return nil, h2_errors.FRAME_SIZE_ERROR:new_traceback("'PING' frames must be 8 bytes"), ce.EILSEQ
end
local ack = band(flags, 0x1) ~= 0
if ack then
local cond = stream.connection.pongs[payload]
if cond then
cond:signal()
stream.connection.pongs[payload] = nil
end
return true
else
return stream:write_ping_frame(true, payload, deadline and deadline-monotime())
end
end
function stream_methods:write_ping_frame(ACK, payload, timeout)
if self.id ~= 0 then
h2_errors.PROTOCOL_ERROR("'PING' frames must be on stream id 0")
end
if #payload ~= 8 then
h2_errors.FRAME_SIZE_ERROR("'PING' frames must have 8 byte payload")
end
local flags = ACK and 0x1 or 0
return self:write_http2_frame(0x6, flags, payload, timeout)
end
-- GOAWAY
frame_handlers[0x7] = function(stream, flags, payload, deadline) -- luacheck: ignore 212
if stream.id ~= 0 then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("'GOAWAY' frames must be on stream id 0"), ce.EILSEQ
end
if #payload < 8 then
return nil, h2_errors.FRAME_SIZE_ERROR:new_traceback("'GOAWAY' frames must be at least 8 bytes"), ce.EILSEQ
end
local last_streamid = sunpack(">I4 I4", payload)
if stream.connection.recv_goaway_lowest == nil or last_streamid < stream.connection.recv_goaway_lowest then
stream.connection.recv_goaway_lowest = last_streamid
stream.connection.recv_goaway:signal()
end
return true
end
function stream_methods:write_goaway_frame(last_streamid, err_code, debug_msg, timeout)
if self.id ~= 0 then
h2_errors.PROTOCOL_ERROR("'GOAWAY' frames MUST be on stream 0")
end
assert(last_streamid)
local flags = 0
local payload = spack(">I4 I4", last_streamid, err_code)
if debug_msg then
payload = payload .. debug_msg
end
local ok, err, errno = self:write_http2_frame(0x7, flags, payload, timeout)
if not ok then
return nil, err, errno
end
self.connection.send_goaway_lowest = math.min(last_streamid, self.connection.send_goaway_lowest or math.huge)
return true
end
-- WINDOW_UPDATE
frame_handlers[0x8] = function(stream, flags, payload, deadline) -- luacheck: ignore 212
if #payload ~= 4 then
return nil, h2_errors.FRAME_SIZE_ERROR:new_traceback("'WINDOW_UPDATE' frames must be 4 bytes"), ce.EILSEQ
end
if stream.id ~= 0 and stream.state == "idle" then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback([['WINDOW_UPDATE' frames not allowed in "idle" state]]), ce.EILSEQ
end
local tmp = sunpack(">I4", payload)
if band(tmp, 0x80000000) ~= 0 then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("'WINDOW_UPDATE' reserved bit set"), ce.EILSEQ
end
local increment = band(tmp, 0x7fffffff)
if increment == 0 then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("'WINDOW_UPDATE' MUST not have an increment of 0", stream.id ~= 0), ce.EILSEQ
end
local ob
if stream.id == 0 then -- for connection
ob = stream.connection
else
ob = stream
end
local newval = ob.peer_flow_credits + increment
if newval > 2^31-1 then
return nil, h2_errors.FLOW_CONTROL_ERROR:new_traceback("A sender MUST NOT allow a flow-control window to exceed 2^31-1 octets", stream.id ~= 0), ce.EILSEQ
end
ob.peer_flow_credits = newval
ob.peer_flow_credits_increase:signal()
return true
end
function stream_methods:write_window_update_frame(inc, timeout)
local flags = 0
if self.id ~= 0 and self.state == "idle" then
h2_errors.PROTOCOL_ERROR([['WINDOW_UPDATE' frames not allowed in "idle" state]])
end
if inc >= 0x80000000 or inc <= 0 then
h2_errors.PROTOCOL_ERROR("invalid window update increment", true)
end
local payload = spack(">I4", inc)
return self:write_http2_frame(0x8, flags, payload, timeout)
end
function stream_methods:write_window_update(inc, timeout)
while inc >= 0x80000000 do
local ok, err, errno = self:write_window_update_frame(0x7fffffff, 0)
if not ok then
return nil, err, errno
end
inc = inc - 0x7fffffff
end
return self:write_window_update_frame(inc, timeout)
end
-- CONTINUATION
frame_handlers[0x9] = function(stream, flags, payload, deadline) -- luacheck: ignore 212
if stream.id == 0 then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("'CONTINUATION' frames MUST be associated with a stream"), ce.EILSEQ
end
if not stream.connection.need_continuation then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("'CONTINUATION' frames MUST be preceded by a 'HEADERS', 'PUSH_PROMISE' or 'CONTINUATION' frame without the 'END_HEADERS' flag set"), ce.EILSEQ
end
local end_headers = band(flags, 0x04) ~= 0
local len = stream.connection.recv_headers_buffer_length + #payload
if len > MAX_HEADER_BUFFER_SIZE then
return nil, h2_errors.PROTOCOL_ERROR:new_traceback("headers too large"), ce.E2BIG
end
table.insert(stream.connection.recv_headers_buffer, payload)
stream.connection.recv_headers_buffer_items = stream.connection.recv_headers_buffer_items + 1
stream.connection.recv_headers_buffer_length = len
if end_headers then
local pad_len = stream.connection.recv_headers_buffer_pad_len
local pos = stream.connection.recv_headers_buffer_pos
payload = table.concat(stream.connection.recv_headers_buffer, "", 1, stream.connection.recv_headers_buffer_items)
local promised_steam_id = stream.connection.promised_steam_id
stream.connection.recv_headers_buffer = nil
stream.connection.recv_headers_buffer_pos = nil
stream.connection.recv_headers_buffer_pad_len = nil
stream.connection.recv_headers_buffer_items = nil
stream.connection.recv_headers_buffer_length = nil
stream.connection.promised_steam_id = nil
stream.connection.need_continuation = nil
return process_end_headers(stream, false, pad_len, pos, promised_steam_id, payload)
else
return true
end
end
function stream_methods:write_continuation_frame(payload, end_headers, timeout)
assert(self.state == "open" or self.state == "half closed (remote)")
local flags = 0
if end_headers then
flags = bor(flags, 0x4)
end
return self:write_http2_frame(0x9, flags, payload, timeout)
end
-------------------------------------------
function stream_methods:shutdown()
if self.state ~= "idle" and self.state ~= "closed" and self.id ~= 0 then
self:write_rst_stream(0, 0) -- ignore result
end
local len = 0
for i=1, self.chunk_fifo:length() do
local chunk = self.chunk_fifo:peek(i)
if chunk ~= nil then
chunk:ack(true)
len = len + #chunk.data
end
end
if len > 0 then
self.connection:write_window_update(len, 0)
end
return true
end
-- this function *should never throw*
function stream_methods:get_headers(timeout)
local deadline = timeout and (monotime()+timeout)
while self.recv_headers_fifo:length() < 1 do
if self.state == "closed" then
return nil, self.rst_stream_error
end
local which = cqueues.poll(self.recv_headers_cond, self.connection, timeout)
if which == self.connection then
local ok, err, errno = self.connection:step(0)
if not ok then
return nil, err, errno
end
elseif which == timeout then
return nil, ce.strerror(ce.ETIMEDOUT), ce.ETIMEDOUT
end
timeout = deadline and (deadline-monotime())
end
local headers = self.recv_headers_fifo:pop()
return headers
end
function stream_methods:get_next_chunk(timeout)
local deadline = timeout and (monotime()+timeout)
while self.chunk_fifo:length() == 0 do
if self.state == "closed" or self.state == "half closed (remote)" then
return nil, self.rst_stream_error
end
local which = cqueues.poll(self.chunk_cond, self.connection, timeout)
if which == self.connection then
local ok, err, errno = self.connection:step(0)
if not ok then
return nil, err, errno
end
elseif which == timeout then
return nil, ce.strerror(ce.ETIMEDOUT), ce.ETIMEDOUT
end
timeout = deadline and (deadline-monotime())
end
local chunk = self.chunk_fifo:pop()
if chunk == nil then
return nil
else
local data = chunk.data
chunk:ack(false)
return data
end
end
function stream_methods:unget(str)
local chunk = new_chunk(self, 0, str) -- 0 means :ack does nothing
self.chunk_fifo:insert(1, chunk)
return true
end
local function write_headers(self, func, headers, timeout)
local deadline = timeout and (monotime()+timeout)
local encoding_context = self.connection.encoding_context
encoding_context:encode_headers(headers)
local payload = encoding_context:render_data()
encoding_context:clear_data()
local SETTINGS_MAX_FRAME_SIZE = self.connection.peer_settings[0x5]
if #payload <= SETTINGS_MAX_FRAME_SIZE then
local ok, err, errno = func(payload, true, deadline)
if not ok then
return ok, err, errno
end
else
do
local partial = payload:sub(1, SETTINGS_MAX_FRAME_SIZE)
local ok, err, errno = func(partial, false, deadline)
if not ok then
return ok, err, errno
end
end
local sent = SETTINGS_MAX_FRAME_SIZE
local max = #payload-SETTINGS_MAX_FRAME_SIZE
while sent < max do
local partial = payload:sub(sent+1, sent+SETTINGS_MAX_FRAME_SIZE)
local ok, err, errno = self:write_continuation_frame(partial, false, deadline and deadline-monotime())
if not ok then
return ok, err, errno
end
sent = sent + SETTINGS_MAX_FRAME_SIZE
end
do
local partial = payload:sub(sent+1)
local ok, err, errno = self:write_continuation_frame(partial, true, deadline and deadline-monotime())
if not ok then
return ok, err, errno
end
end
end
return true
end
function stream_methods:write_headers(headers, end_stream, timeout)
assert(headers, "missing argument: headers")
assert(validate_headers(headers, self.type == "client", self.stats_sent_headers+1, end_stream))
assert(type(end_stream) == "boolean", "'end_stream' MUST be a boolean")
local padded, exclusive, stream_dep, weight = nil, nil, nil, nil
return write_headers(self, function(payload, end_headers, deadline)
return self:write_headers_frame(payload, end_stream, end_headers, padded, exclusive, stream_dep, weight, deadline and deadline-monotime())
end, headers, timeout)
end
function stream_methods:push_promise(headers, timeout)
assert(self.type == "server")
assert(headers, "missing argument: headers")
assert(validate_headers(headers, true, 1, false))
assert(headers:has(":authority"))
local promised_stream = self.connection:new_stream()
self:reprioritise(promised_stream)
local promised_stream_id = promised_stream.id
local padded = nil
local ok, err, errno = write_headers(self, function(payload, end_headers, deadline)
return self:write_push_promise_frame(promised_stream_id, payload, end_headers, padded, deadline)
end, headers, timeout)
if not ok then
return nil, err, errno
end
promised_stream:set_state("reserved (local)")
return promised_stream
end
function stream_methods:write_chunk(payload, end_stream, timeout)
local deadline = timeout and (monotime()+timeout)
local sent = 0
while true do
while self.peer_flow_credits == 0 do
local which = cqueues.poll(self.peer_flow_credits_increase, self.connection, timeout)
if which == self.connection then
local ok, err, errno = self.connection:step(0)
if not ok then
return nil, err, errno
end
elseif which == timeout then
return nil, ce.strerror(ce.ETIMEDOUT), ce.ETIMEDOUT
end
timeout = deadline and (deadline-monotime())
end
while self.connection.peer_flow_credits == 0 do
local which = cqueues.poll(self.connection.peer_flow_credits_increase, self.connection, timeout)
if which == self.connection then
local ok, err, errno = self.connection:step(0)
if not ok then
return nil, err, errno
end
elseif which == timeout then
return nil, ce.strerror(ce.ETIMEDOUT), ce.ETIMEDOUT
end
timeout = deadline and (deadline-monotime())
end
local SETTINGS_MAX_FRAME_SIZE = self.connection.peer_settings[0x5]
local max_available = math.min(self.peer_flow_credits, self.connection.peer_flow_credits, SETTINGS_MAX_FRAME_SIZE)
if max_available < (#payload - sent) then
if max_available > 0 then
-- send partial payload
local ok, err, errno = self:write_data_frame(payload:sub(sent+1, sent+max_available), false, timeout)
if not ok then
return nil, err, errno
end
sent = sent + max_available
end
else
break
end
timeout = deadline and (deadline-monotime())
end
local ok, err, errno = self:write_data_frame(payload:sub(sent+1), end_stream, false, timeout)
if not ok then
return nil, err, errno
end
return true
end
return {
new = new_stream;
methods = stream_methods;
mt = stream_mt;
frame_handlers = frame_handlers;
pack_settings_payload = pack_settings_payload;
}
|