1 # Copyright (C) 2016-2019 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
3 # note: our HTTP server should be standalone and capable of running
4 # generic PSGI/Plack apps.
8 use Time::HiRes qw(gettimeofday tv_interval);
10 foreach my $mod (qw(Plack::Util Plack::Builder
11 HTTP::Date HTTP::Status IPC::Run)) {
13 plan skip_all => "$mod missing for httpd-corner.t" if $@;
16 use Digest::SHA qw(sha1_hex);
17 use File::Temp qw/tempdir/;
21 use Socket qw(IPPROTO_TCP TCP_NODELAY SOL_SOCKET);
23 require './t/common.perl';
24 my $tmpdir = tempdir('httpd-corner-XXXXXX', TMPDIR => 1, CLEANUP => 1);
25 my $fifo = "$tmpdir/fifo";
26 ok(defined mkfifo($fifo, 0777), 'created FIFO');
27 my $err = "$tmpdir/stderr.log";
28 my $out = "$tmpdir/stdout.log";
29 my $httpd = 'blib/script/public-inbox-httpd';
30 my $psgi = "./t/httpd-corner.psgi";
31 my $sock = tcp_server();
33 # Make sure we don't clobber socket options set by systemd or similar
34 # using socket activation:
35 my ($defer_accept_val, $accf_arg);
37 setsockopt($sock, IPPROTO_TCP, Socket::TCP_DEFER_ACCEPT(), 5) or die;
38 my $x = getsockopt($sock, IPPROTO_TCP, Socket::TCP_DEFER_ACCEPT());
39 defined $x or die "getsockopt: $!";
40 $defer_accept_val = unpack('i', $x);
41 if ($defer_accept_val <= 0) {
42 die "unexpected TCP_DEFER_ACCEPT value: $defer_accept_val";
44 } elsif ($^O eq 'freebsd' && system('kldstat -m accf_data >/dev/null') == 0) {
45 require PublicInbox::Daemon;
46 my $var = PublicInbox::Daemon::SO_ACCEPTFILTER();
47 $accf_arg = pack('a16a240', 'dataready', '');
48 setsockopt($sock, SOL_SOCKET, $var, $accf_arg) or die "setsockopt: $!";
51 my $upath = "$tmpdir/s";
52 my $unix = unix_server($upath);
53 ok($unix, 'UNIX socket created');
55 END { kill 'TERM', $pid if defined $pid };
56 my $spawn_httpd = sub {
58 my $cmd = [ $httpd, @args, "--stdout=$out", "--stderr=$err", $psgi ];
59 $pid = spawn_listener(undef, $cmd, [ $sock, $unix ]);
60 ok(defined $pid, 'forked httpd process successfully');
64 ok($sock, 'sock created');
65 $spawn_httpd->('-W0');
69 my $conn = conn_for($sock, 'streaming callback');
70 $conn->write("GET /callback HTTP/1.0\r\n\r\n");
71 ok($conn->read(my $buf, 8192), 'read response');
72 my ($head, $body) = split(/\r\n\r\n/, $buf);
73 is($body, "hello world\n", 'callback body matches expected');
77 my $conn = conn_for($sock, 'getline-die');
78 $conn->write("GET /getline-die HTTP/1.1\r\nHost: example.com\r\n\r\n");
79 ok($conn->read(my $buf, 8192), 'read some response');
80 like($buf, qr!HTTP/1\.1 200\b[^\r]*\r\n!, 'got some sort of header');
81 is($conn->read(my $nil, 8192), 0, 'read EOF');
83 my $after = capture($err);
84 is(scalar(grep(/GETLINE FAIL/, @$after)), 1, 'failure logged');
85 is(scalar(grep(/CLOSE FAIL/, @$after)), 1, 'body->close not called');
89 my $conn = conn_for($sock, 'close-die');
90 $conn->write("GET /close-die HTTP/1.1\r\nHost: example.com\r\n\r\n");
91 ok($conn->read(my $buf, 8192), 'read some response');
92 like($buf, qr!HTTP/1\.1 200\b[^\r]*\r\n!, 'got some sort of header');
93 is($conn->read(my $nil, 8192), 0, 'read EOF');
95 my $after = capture($err);
96 is(scalar(grep(/GETLINE FAIL/, @$after)), 0, 'getline not failed');
97 is(scalar(grep(/CLOSE FAIL/, @$after)), 1, 'body->close not called');
101 my $conn = conn_for($sock, 'excessive header');
102 $SIG{PIPE} = 'IGNORE';
103 $conn->write("GET /callback HTTP/1.0\r\n");
104 foreach my $i (1..500000) {
105 last unless $conn->write("X-xxxxxJunk-$i: omg\r\n");
107 ok(!$conn->write("\r\n"), 'broken request');
108 ok($conn->read(my $buf, 8192), 'read response');
109 my ($head, $body) = split(/\r\n\r\n/, $buf);
110 like($head, qr/\b400\b/, 'got 400 response');
114 my $conn = conn_for($sock, 'excessive body Content-Length');
115 $SIG{PIPE} = 'IGNORE';
116 my $n = (10 * 1024 * 1024) + 1;
117 $conn->write("PUT /sha1 HTTP/1.0\r\nContent-Length: $n\r\n\r\n");
118 ok($conn->read(my $buf, 8192), 'read response');
119 my ($head, $body) = split(/\r\n\r\n/, $buf);
120 like($head, qr/\b413\b/, 'got 413 response');
124 my $conn = conn_for($sock, 'excessive body chunked');
125 $SIG{PIPE} = 'IGNORE';
126 my $n = (10 * 1024 * 1024) + 1;
127 $conn->write("PUT /sha1 HTTP/1.1\r\nTransfer-Encoding: chunked\r\n");
128 $conn->write("\r\n".sprintf("%x\r\n", $n));
129 ok($conn->read(my $buf, 8192), 'read response');
130 my ($head, $body) = split(/\r\n\r\n/, $buf);
131 like($head, qr/\b413\b/, 'got 413 response');
135 my $conn = conn_for($sock, 'chunk with pipeline');
137 my $payload = 'b'x$n;
138 $conn->write("PUT /sha1 HTTP/1.1\r\nTransfer-Encoding: chunked\r\n");
139 $conn->write("\r\n".sprintf("%x\r\n", $n));
140 $conn->write($payload . "\r\n0\r\n\r\nGET /empty HTTP/1.0\r\n\r\n");
141 $conn->read(my $buf, 4096);
143 $lim++ while ($conn->read($buf, 4096, bytes::length($buf)) && $lim < 9);
144 my $exp = sha1_hex($payload);
145 like($buf, qr!\r\n\r\n${exp}HTTP/1\.0 200 OK\r\n!s,
146 'chunk parser can handled pipelined requests');
149 # Unix domain sockets
151 my $u = IO::Socket::UNIX->new(Type => SOCK_STREAM, Peer => $upath);
152 ok($u, 'unix socket connected');
153 $u->write("GET /host-port HTTP/1.0\r\n\r\n");
154 $u->read(my $buf, 4096);
155 like($buf, qr!\r\n\r\n127\.0\.0\.1:0\z!,
156 'set REMOTE_ADDR and REMOTE_PORT for Unix socket');
160 my ($dest, $msg) = @_;
161 my $conn = tcp_connect($dest);
162 ok($conn, "connected for $msg");
163 setsockopt($conn, IPPROTO_TCP, TCP_NODELAY, 1);
168 my $conn = conn_for($sock, 'host-port');
169 $conn->write("GET /host-port HTTP/1.0\r\n\r\n");
170 $conn->read(my $buf, 4096);
171 my ($head, $body) = split(/\r\n\r\n/, $buf);
172 my ($addr, $port) = split(/:/, $body);
173 is($addr, $conn->sockhost, 'host matches addr');
174 is($port, $conn->sockport, 'port matches');
177 # graceful termination
179 my $conn = conn_for($sock, 'graceful termination via slow header');
180 $conn->write("GET /slow-header HTTP/1.0\r\n" .
181 "X-Check-Fifo: $fifo\r\n\r\n");
182 open my $f, '>', $fifo or die "open $fifo: $!\n";
184 ok(print($f "hello\n"), 'wrote something to fifo');
187 is(kill('TERM', $kpid), 1, 'started graceful shutdown');
188 ok(print($f "world\n"), 'wrote else to fifo');
189 close $f or die "close fifo: $!\n";
190 $conn->read(my $buf, 8192);
191 my ($head, $body) = split(/\r\n\r\n/, $buf, 2);
192 like($head, qr!\AHTTP/1\.[01] 200 OK!, 'got 200 for slow-header');
193 is($body, "hello\nworld\n", 'read expected body');
194 is(waitpid($kpid, 0), $kpid, 'reaped httpd');
195 is($?, 0, 'no error');
196 $spawn_httpd->('-W0');
200 my $conn = conn_for($sock, 'graceful termination via slow-body');
201 $conn->write("GET /slow-body HTTP/1.0\r\n" .
202 "X-Check-Fifo: $fifo\r\n\r\n");
203 open my $f, '>', $fifo or die "open $fifo: $!\n";
206 $conn->sysread($buf, 8192);
207 like($buf, qr!\AHTTP/1\.[01] 200 OK!, 'got 200 for slow-body');
208 like($buf, qr!\r\n\r\n!, 'finished HTTP response header');
210 foreach my $c ('a'..'c') {
212 ok(print($f $c), 'wrote line to fifo');
213 $conn->sysread($buf, 8192);
214 is($buf, $c, 'got trickle for reading');
218 is(kill('TERM', $kpid), 1, 'started graceful shutdown');
219 ok(print($f "world\n"), 'wrote else to fifo');
220 close $f or die "close fifo: $!\n";
221 $conn->sysread($buf, 8192);
222 is($buf, "world\n", 'read expected body');
223 is($conn->sysread($buf, 8192), 0, 'got EOF from server');
224 is(waitpid($kpid, 0), $kpid, 'reaped httpd');
225 is($?, 0, 'no error');
226 $spawn_httpd->('-W0');
229 sub delay { select(undef, undef, undef, shift || rand(0.02)) }
231 my $str = 'abcdefghijklmnopqrstuvwxyz';
232 my $len = length $str;
233 is($len, 26, 'got the alphabet');
234 my $check_self = sub {
236 $conn->read(my $buf, 4096);
237 my ($head, $body) = split(/\r\n\r\n/, $buf, 2);
238 like($head, qr/\r\nContent-Length: 40\r\n/s, 'got expected length');
239 is($body, sha1_hex($str), 'read expected body');
244 foreach my $p (split(':', $ENV{PATH})) {
245 -x "$p/curl" or next;
250 $have_curl or skip('curl(1) missing', $ntest);
251 my $base = 'http://' . $sock->sockhost . ':' . $sock->sockport;
252 my $url = "$base/sha1";
254 pipe($r, $w) or die "pipe: $!";
255 my $cmd = [qw(curl --tcp-nodelay --no-buffer -T- -HExpect: -sS), $url];
256 my ($out, $err) = ('', '');
257 my $h = IPC::Run::start($cmd, $r, \$out, \$err);
259 foreach my $c ('a'..'z') {
260 print $w $c or die "failed to write to curl: $!";
263 close $w or die "close write pipe: $!";
264 close $r or die "close read pipe: $!";
265 IPC::Run::finish($h);
266 is($?, 0, 'curl exited successfully');
267 is($err, '', 'no errors from curl');
268 is($out, sha1_hex($str), 'read expected body');
270 open my $fh, '-|', qw(curl -sS), "$base/async-big" or die $!;
274 my $r = sysread($fh, my $buf, 4096) or last;
276 $buf =~ /\A\0+\z/ or $non_zero++;
278 is($n, 30 * 1024 * 1024, 'got expected output from curl');
279 is($non_zero, 0, 'read all zeros');
283 my $conn = conn_for($sock, '1.1 pipeline together');
284 $conn->write("PUT /sha1 HTTP/1.1\r\nUser-agent: hello\r\n\r\n" .
285 "PUT /sha1 HTTP/1.1\r\n\r\n");
288 until (scalar(@r) >= 2) {
289 my $r = $conn->sysread(my $tmp, 4096);
290 die $! unless defined $r;
291 die "EOF <$buf>" unless $r;
293 @r = ($buf =~ /\r\n\r\n([a-f0-9]{40})/g);
295 is(2, scalar @r, 'got 2 responses');
297 foreach my $hex (@r) {
298 is($hex, sha1_hex(''), "read expected body $i");
304 my $conn = conn_for($sock, 'no TCP_CORK on empty body');
305 $conn->write("GET /empty HTTP/1.1\r\nHost:example.com\r\n\r\n");
307 my $t0 = [ gettimeofday ];
308 until ($buf =~ /\r\n\r\n/s) {
309 $conn->sysread($buf, 4096, length($buf));
311 my $elapsed = tv_interval($t0, [ gettimeofday ]);
312 ok($elapsed < 0.190, 'no 200ms TCP cork delay on empty body');
316 my $conn = conn_for($sock, 'graceful termination during slow request');
317 $conn->write("PUT /sha1 HTTP/1.0\r\n");
319 $conn->write("Content-Length: $len\r\n");
321 $conn->write("\r\n");
324 is(kill('TERM', $kpid), 1, 'started graceful shutdown');
327 foreach my $c ('a'..'z') {
328 $n += $conn->write($c);
330 is($n, $len, 'wrote alphabet');
331 $check_self->($conn);
332 is(waitpid($kpid, 0), $kpid, 'reaped httpd');
333 is($?, 0, 'no error');
334 $spawn_httpd->('-W0');
337 # various DoS attacks against the chunk parser:
339 local $SIG{PIPE} = 'IGNORE';
340 my $conn = conn_for($sock, '1.1 chunk header excessive');
341 $conn->write("PUT /sha1 HTTP/1.1\r\nTransfer-Encoding:chunked\r\n\r\n");
344 while ($w = $conn->write('ffffffff')) {
347 ok($!, 'got error set in $!');
348 is($w, undef, 'write error happened');
349 ok($n > 0, 'was able to write');
350 my $r = $conn->read(my $buf, 66666);
351 ok($r > 0, 'got non-empty response');
352 like($buf, qr!HTTP/1\.\d 400 !, 'got 400 response');
354 $conn = conn_for($sock, '1.1 chunk trailer excessive');
355 $conn->write("PUT /sha1 HTTP/1.1\r\nTransfer-Encoding:chunked\r\n\r\n");
356 is($conn->syswrite("1\r\na"), 4, 'wrote first header + chunk');
359 while ($w = $conn->write("\r")) {
362 ok($!, 'got error set in $!');
363 ok($n > 0, 'wrote part of chunk end (\r)');
364 $r = $conn->read($buf, 66666);
365 ok($r > 0, 'got non-empty response');
366 like($buf, qr!HTTP/1\.\d 400 !, 'got 400 response');
370 my $conn = conn_for($sock, '1.1 chunked close trickle');
371 $conn->write("PUT /sha1 HTTP/1.1\r\nConnection:close\r\n");
372 $conn->write("Transfer-encoding: chunked\r\n\r\n");
373 foreach my $x ('a'..'z') {
397 $check_self->($conn);
401 my $conn = conn_for($sock, '1.1 chunked close');
402 $conn->write("PUT /sha1 HTTP/1.1\r\nConnection:close\r\n");
403 my $xlen = sprintf('%x', $len);
404 $conn->write("Transfer-Encoding: chunked\r\n\r\n$xlen\r\n" .
405 "$str\r\n0\r\n\r\n");
406 $check_self->($conn);
410 my $conn = conn_for($sock, 'chunked body + pipeline');
411 $conn->write("PUT /sha1 HTTP/1.1\r\n" .
412 "Transfer-Encoding: chunked\r\n");
414 $conn->write("\r\n1\r\n");
418 $conn->write("\r\n0\r\n\r\nPUT /sha1 HTTP/1.1\r\n");
422 until ($buf =~ /\r\n\r\n[a-f0-9]{40}\z/) {
423 $conn->sysread(my $tmp, 4096);
426 my ($head, $body) = split(/\r\n\r\n/, $buf, 2);
427 like($head, qr/\r\nContent-Length: 40\r\n/s, 'got expected length');
428 is($body, sha1_hex('a'), 'read expected body');
430 $conn->write("Connection: close\r\n");
431 $conn->write("Content-Length: $len\r\n\r\n$str");
432 $check_self->($conn);
436 my $conn = conn_for($sock, 'trickle header, one-shot body + pipeline');
437 $conn->write("PUT /sha1 HTTP/1.0\r\n" .
438 "Connection: keep-alive\r\n");
440 $conn->write("Content-Length: $len\r\n\r\n${str}PUT");
442 until ($buf =~ /\r\n\r\n[a-f0-9]{40}\z/) {
443 $conn->sysread(my $tmp, 4096);
446 my ($head, $body) = split(/\r\n\r\n/, $buf, 2);
447 like($head, qr/\r\nContent-Length: 40\r\n/s, 'got expected length');
448 is($body, sha1_hex($str), 'read expected body');
450 $conn->write(" /sha1 HTTP/1.0\r\nContent-Length: $len\r\n\r\n$str");
451 $check_self->($conn);
455 my $conn = conn_for($sock, 'trickle body');
456 $conn->write("PUT /sha1 HTTP/1.0\r\n");
457 $conn->write("Content-Length: $len\r\n\r\n");
458 my $beg = substr($str, 0, 10);
459 my $end = substr($str, 10);
460 is($beg . $end, $str, 'substr setup correct');
465 $check_self->($conn);
469 my $conn = conn_for($sock, 'one-shot write');
470 $conn->write("PUT /sha1 HTTP/1.0\r\n" .
471 "Content-Length: $len\r\n\r\n$str");
472 $check_self->($conn);
476 my $conn = conn_for($sock, 'trickle header, one-shot body');
477 $conn->write("PUT /sha1 HTTP/1.0\r\n");
479 $conn->write("Content-Length: $len\r\n\r\n$str");
480 $check_self->($conn);
484 my $conn = conn_for($sock, '1.1 Connnection: close');
485 $conn->write("PUT /sha1 HTTP/1.1\r\nConnection:close\r\n");
487 $conn->write("Content-Length: $len\r\n\r\n$str");
488 $check_self->($conn);
492 my $conn = conn_for($sock, '1.1 pipeline start');
493 $conn->write("PUT /sha1 HTTP/1.1\r\n\r\nPUT");
495 until ($buf =~ /\r\n\r\n[a-f0-9]{40}\z/) {
496 $conn->sysread(my $tmp, 4096);
499 my ($head, $body) = split(/\r\n\r\n/, $buf, 2);
500 like($head, qr/\r\nContent-Length: 40\r\n/s, 'got expected length');
501 is($body, sha1_hex(''), 'read expected body');
504 $conn->write(" /sha1 HTTP/1.1\r\n\r\n");
506 until ($buf =~ /\r\n\r\n[a-f0-9]{40}\z/) {
507 $conn->sysread(my $tmp, 4096);
510 ($head, $body) = split(/\r\n\r\n/, $buf, 2);
511 like($head, qr/\r\nContent-Length: 40\r\n/s, 'got expected length');
512 is($body, sha1_hex(''), 'read expected body #2');
516 skip 'TCP_DEFER_ACCEPT is Linux-only', 1 if $^O ne 'linux';
517 my $var = Socket::TCP_DEFER_ACCEPT();
518 defined(my $x = getsockopt($sock, IPPROTO_TCP, $var)) or die;
519 is(unpack('i', $x), $defer_accept_val,
520 'TCP_DEFER_ACCEPT unchanged if previously set');
523 skip 'SO_ACCEPTFILTER is FreeBSD-only', 1 if $^O ne 'freebsd';
524 skip 'accf_data not loaded: kldload accf_data' if !defined $accf_arg;
525 my $var = PublicInbox::Daemon::SO_ACCEPTFILTER();
526 defined(my $x = getsockopt($sock, SOL_SOCKET, $var)) or die;
527 is($x, $accf_arg, 'SO_ACCEPTFILTER unchanged if previously set');
530 use PublicInbox::Spawn qw(which);
531 skip 'only testing lsof(8) output on Linux', 1 if $^O ne 'linux';
532 skip 'no lsof in PATH', 1 unless which('lsof');
533 my @lsof = `lsof -p $pid`;
534 is_deeply([grep(/\bdeleted\b/, @lsof)], [], 'no lingering deleted inputs');
535 is_deeply([grep(/\bpipe\b/, @lsof)], [], 'no extra pipes with -W0');
542 open my $fh, '+<', $f or die "failed to open $f: $!\n";
545 truncate($fh, 0) or die "truncate failed on $f: $!\n";