]> git.proxmox.com Git - pve-http-server.git/blame - src/PVE/APIServer/AnyEvent.pm
proxy request: forward json content type and parameters
[pve-http-server.git] / src / PVE / APIServer / AnyEvent.pm
CommitLineData
d08808bc 1package PVE::APIServer::AnyEvent;
d8218001 2
8d88baec
DM
3# Note 1: interactions with Crypt::OpenSSL::RSA
4#
5# Some handlers (auth_handler) use Crypt::OpenSSL::RSA, which seems to
6# set the openssl error variable. We need to clear that here, else
7# AnyEvent::TLS aborts the connection.
8# Net::SSLeay::ERR_clear_error();
9
d8218001
DM
10use strict;
11use warnings;
5cef57de
TL
12
13use AnyEvent::HTTP;
d8218001 14use AnyEvent::Handle;
d8218001 15use AnyEvent::IO;
5cef57de
TL
16use AnyEvent::Socket;
17# use AnyEvent::Strict; # only use this for debugging
18use AnyEvent::TLS;
19use AnyEvent::Util qw(guard fh_nonblocking WSAEWOULDBLOCK WSAEINPROGRESS);
20
d8218001 21use Compress::Zlib;
5cef57de
TL
22use Digest::MD5;
23use Digest::SHA;
256da581 24use Encode;
5cef57de
TL
25use Fcntl ();
26use Fcntl;
27use File::Find;
28use File::stat qw();
29use IO::File;
30use MIME::Base64;
31use Net::SSLeay;
32use POSIX qw(strftime EINTR EAGAIN);
33use Socket qw(IPPROTO_TCP TCP_NODELAY SOMAXCONN);
34use Time::HiRes qw(usleep ualarm gettimeofday tv_interval);
d8218001 35
5cef57de 36#use Data::Dumper; # FIXME: remove, just use: print to_json([$var], {pretty => 1}) ."\n";
d8218001
DM
37use HTTP::Date;
38use HTTP::Headers;
39use HTTP::Request;
40use HTTP::Response;
5cef57de 41use HTTP::Status qw(:constants);
3e05f166 42use JSON;
5cef57de
TL
43use Net::IP;
44use URI::Escape;
45use URI;
46
47use PVE::INotify;
48use PVE::SafeSyslog;
a66b77d8 49use PVE::Tools qw(trim);
5cef57de
TL
50
51use PVE::APIServer::Formatter;
52use PVE::APIServer::Utils;
d8218001 53
e7ee5e3f 54my $limit_max_headers = 64;
d8218001 55my $limit_max_header_size = 8*1024;
967dcb76 56my $limit_max_post = 64*1024;
d8218001 57
d8218001
DM
58my $known_methods = {
59 GET => 1,
60 POST => 1,
61 PUT => 1,
62 DELETE => 1,
63};
64
65my $split_abs_uri = sub {
66 my ($abs_uri, $base_uri) = @_;
67
68 my ($format, $rel_uri) = $abs_uri =~ m/^\Q$base_uri\E\/+([a-z][a-z0-9]+)(\/.*)?$/;
69 $rel_uri = '/' if !$rel_uri;
70
71 return wantarray ? ($rel_uri, $format) : $rel_uri;
72};
73
26e73e6b
SI
74sub dprint {
75 my ($self, $message) = @_;
76
77 return if !$self->{debug};
78
79 my ($pkg, $pkgfile, $line, $sub) = caller(1);
80 $sub =~ s/^(?:.+::)+//;
81 print "worker[$$]: $pkg +$line: $sub: $message\n";
82}
83
d8218001
DM
84sub log_request {
85 my ($self, $reqstate) = @_;
86
87 my $loginfo = $reqstate->{log};
88
89 # like apache2 common log format
90 # LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\""
91
92 return if $loginfo->{written}; # avoid duplicate logs
93 $loginfo->{written} = 1;
94
95 my $peerip = $reqstate->{peer_host} || '-';
96 my $userid = $loginfo->{userid} || '-';
97 my $content_length = defined($loginfo->{content_length}) ? $loginfo->{content_length} : '-';
98 my $code = $loginfo->{code} || 500;
99 my $requestline = $loginfo->{requestline} || '-';
2fd728c9 100 my $timestr = strftime("%d/%m/%Y:%H:%M:%S %z", localtime());
d8218001
DM
101
102 my $msg = "$peerip - $userid [$timestr] \"$requestline\" $code $content_length\n";
103
104 $self->write_log($msg);
105}
106
107sub log_aborted_request {
108 my ($self, $reqstate, $error) = @_;
109
110 my $r = $reqstate->{request};
111 return if !$r; # no active request
112
113 if ($error) {
114 syslog("err", "problem with client $reqstate->{peer_host}; $error");
115 }
116
117 $self->log_request($reqstate);
118}
119
d8218001 120sub cleanup_reqstate {
7fb356b7 121 my ($reqstate, $deletetmpfile) = @_;
d8218001
DM
122
123 delete $reqstate->{log};
124 delete $reqstate->{request};
125 delete $reqstate->{proto};
126 delete $reqstate->{accept_gzip};
127 delete $reqstate->{starttime};
128
129 if ($reqstate->{tmpfilename}) {
7fb356b7 130 unlink $reqstate->{tmpfilename} if $deletetmpfile;
d8218001
DM
131 delete $reqstate->{tmpfilename};
132 }
133}
134
135sub client_do_disconnect {
136 my ($self, $reqstate) = @_;
137
7fb356b7 138 cleanup_reqstate($reqstate, 1);
d8218001
DM
139
140 my $shutdown_hdl = sub {
141 my $hdl = shift;
142
143 shutdown($hdl->{fh}, 1);
144 # clear all handlers
145 $hdl->on_drain(undef);
146 $hdl->on_read(undef);
147 $hdl->on_eof(undef);
148 };
149
150 if (my $proxyhdl = delete $reqstate->{proxyhdl}) {
b1364a3c
FG
151 &$shutdown_hdl($proxyhdl)
152 if !$proxyhdl->{block_disconnect};
d8218001
DM
153 }
154
155 my $hdl = delete $reqstate->{hdl};
156
157 if (!$hdl) {
158 syslog('err', "detected empty handle");
159 return;
160 }
161
26e73e6b 162 $self->dprint("close connection $hdl");
d8218001
DM
163
164 &$shutdown_hdl($hdl);
165
c82d1707
SI
166 warn "connection count <= 0!\n" if $self->{conn_count} <= 0;
167
d8218001
DM
168 $self->{conn_count}--;
169
26e73e6b 170 $self->dprint("CLOSE FH" . $hdl->{fh}->fileno() . " CONN$self->{conn_count}");
d8218001
DM
171}
172
173sub finish_response {
174 my ($self, $reqstate) = @_;
175
7fb356b7 176 cleanup_reqstate($reqstate, 0);
d8218001 177
133e0586
DM
178 my $hdl = $reqstate->{hdl};
179 return if !$hdl; # already disconnected
180
d8218001
DM
181 if (!$self->{end_loop} && $reqstate->{keep_alive} > 0) {
182 # print "KEEPALIVE $reqstate->{keep_alive}\n" if $self->{debug};
183 $hdl->on_read(sub {
184 eval { $self->push_request_header($reqstate); };
185 warn $@ if $@;
186 });
187 } else {
188 $hdl->on_drain (sub {
189 eval {
190 $self->client_do_disconnect($reqstate);
191 };
192 warn $@ if $@;
193 });
194 }
195}
196
389ad881
SR
197sub response_stream {
198 my ($self, $reqstate, $stream_fh) = @_;
199
200 # disable timeout, we don't know how big the data is
201 $reqstate->{hdl}->timeout(0);
202
203 my $buf_size = 4*1024*1024;
204
205 my $on_read;
206 $on_read = sub {
207 my ($hdl) = @_;
208 my $reqhdl = $reqstate->{hdl};
209 return if !$reqhdl;
210
211 my $wbuf_len = length($reqhdl->{wbuf});
212 my $rbuf_len = length($hdl->{rbuf});
213 # TODO: Take into account $reqhdl->{wbuf_max} ? Right now
214 # that's unbounded, so just assume $buf_size
215 my $to_read = $buf_size - $wbuf_len;
216 $to_read = $rbuf_len if $rbuf_len < $to_read;
217 if ($to_read > 0) {
218 my $data = substr($hdl->{rbuf}, 0, $to_read, '');
219 $reqhdl->push_write($data);
220 $rbuf_len -= $to_read;
221 } elsif ($hdl->{_eof}) {
222 # workaround: AnyEvent gives us a fake EPIPE if we don't consume
223 # any data when called at EOF, so unregister ourselves - data is
224 # flushed by on_eof anyway
225 # see: https://sources.debian.org/src/libanyevent-perl/7.170-2/lib/AnyEvent/Handle.pm/#L1329
226 $hdl->on_read();
227 return;
228 }
229
230 # apply backpressure so we don't accept any more data into
231 # buffer if the client isn't downloading fast enough
232 # note: read_size can double upon read, and we also need to
233 # account for one more read after start_read, so *4
234 if ($rbuf_len + $hdl->{read_size}*4 > $buf_size) {
235 # stop reading until write buffer is empty
236 $hdl->on_read();
237 my $prev_on_drain = $reqhdl->{on_drain};
238 $reqhdl->on_drain(sub {
239 my ($wrhdl) = @_;
240 # on_drain called because write buffer is empty, continue reading
241 $hdl->on_read($on_read);
242 if ($prev_on_drain) {
243 $wrhdl->on_drain($prev_on_drain);
244 $prev_on_drain->($wrhdl);
245 }
246 });
247 }
248 };
249
250 $reqstate->{proxyhdl} = AnyEvent::Handle->new(
251 fh => $stream_fh,
252 rbuf_max => $buf_size,
253 timeout => 0,
254 on_read => $on_read,
255 on_eof => sub {
256 my ($hdl) = @_;
257 eval {
258 if (my $reqhdl = $reqstate->{hdl}) {
259 $self->log_aborted_request($reqstate);
260 # write out any remaining data
261 $reqhdl->push_write($hdl->{rbuf}) if length($hdl->{rbuf}) > 0;
262 $hdl->{rbuf} = "";
263 $reqhdl->push_shutdown();
264 $self->finish_response($reqstate);
265 }
266 };
267 if (my $err = $@) { syslog('err', "$err"); }
268 $on_read = undef;
269 },
270 on_error => sub {
271 my ($hdl, $fatal, $message) = @_;
272 eval {
273 $self->log_aborted_request($reqstate, $message);
274 $self->client_do_disconnect($reqstate);
275 };
276 if (my $err = $@) { syslog('err', "$err"); }
277 $on_read = undef;
278 },
279 );
280}
281
d8218001 282sub response {
389ad881 283 my ($self, $reqstate, $resp, $mtime, $nocomp, $delay, $stream_fh) = @_;
d8218001
DM
284
285 #print "$$: send response: " . Dumper($resp);
286
287 # activate timeout
288 $reqstate->{hdl}->timeout_reset();
289 $reqstate->{hdl}->timeout($self->{timeout});
290
025b3038 291 $nocomp = 1 if !$self->{compression};
d8218001
DM
292 $nocomp = 1 if !$reqstate->{accept_gzip};
293
294 my $code = $resp->code;
295 my $msg = $resp->message || HTTP::Status::status_message($code);
d8218001
DM
296 my $content = $resp->content;
297
936007ae
TL
298 # multiline mode only checks \n for $, so explicitly check for any \n or \r afterwards
299 ($msg) = $msg =~ m/^(.*)$/m;
300 if ($msg =~ /[\r\n]/) {
301 $code = 400; # bad request from user
302 $msg = HTTP::Status::status_message($code);
303 $content = '';
304 }
305
d8218001 306 if ($code =~ /^(1\d\d|[23]04)$/) {
b9a7fd54 307 # make sure informational, no content and not modified response send no content
d8218001
DM
308 $content = "";
309 }
310
311 $reqstate->{keep_alive} = 0 if ($code >= 400) || $self->{end_loop};
312
313 $reqstate->{log}->{code} = $code;
314
315 my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.0';
316 my $res = "$proto $code $msg\015\012";
317
318 my $ctime = time();
319 my $date = HTTP::Date::time2str($ctime);
320 $resp->header('Date' => $date);
321 if ($mtime) {
322 $resp->header('Last-Modified' => HTTP::Date::time2str($mtime));
323 } else {
324 $resp->header('Expires' => $date);
325 $resp->header('Cache-Control' => "max-age=0");
326 $resp->header("Pragma", "no-cache");
327 }
328
329 $resp->header('Server' => "pve-api-daemon/3.0");
330
331 my $content_length;
389ad881 332 if ($content && !$stream_fh) {
d8218001
DM
333
334 $content_length = length($content);
335
336 if (!$nocomp && ($content_length > 1024)) {
337 my $comp = Compress::Zlib::memGzip($content);
338 $resp->header('Content-Encoding', 'gzip');
339 $content = $comp;
340 $content_length = length($content);
341 }
342 $resp->header("Content-Length" => $content_length);
343 $reqstate->{log}->{content_length} = $content_length;
344
345 } else {
346 $resp->remove_header("Content-Length");
347 }
348
349 if ($reqstate->{keep_alive} > 0) {
350 $resp->push_header('Connection' => 'Keep-Alive');
351 } else {
352 $resp->header('Connection' => 'close');
353 }
354
355 $res .= $resp->headers_as_string("\015\012");
356 #print "SEND(without content) $res\n" if $self->{debug};
357
358 $res .= "\015\012";
389ad881 359 $res .= $content if $content && !$stream_fh;
d8218001
DM
360
361 $self->log_request($reqstate, $reqstate->{request});
5f14e56e 362
389ad881
SR
363 if ($stream_fh) {
364 # write headers and preamble...
365 $reqstate->{hdl}->push_write($res);
366 # ...then stream data via an AnyEvent::Handle
367 $self->response_stream($reqstate, $stream_fh);
368 } elsif ($delay && $delay > 0) {
d8218001
DM
369 my $w; $w = AnyEvent->timer(after => $delay, cb => sub {
370 undef $w; # delete reference
e12e46c9 371 return if !$reqstate->{hdl}; # already disconnected
d8218001
DM
372 $reqstate->{hdl}->push_write($res);
373 $self->finish_response($reqstate);
374 });
375 } else {
376 $reqstate->{hdl}->push_write($res);
377 $self->finish_response($reqstate);
378 }
379}
380
381sub error {
382 my ($self, $reqstate, $code, $msg, $hdr, $content) = @_;
383
384 eval {
385 my $resp = HTTP::Response->new($code, $msg, $hdr, $content);
386 $self->response($reqstate, $resp);
387 };
388 warn $@ if $@;
389}
390
391my $file_extension_info = {
392 css => { ct => 'text/css' },
393 html => { ct => 'text/html' },
394 js => { ct => 'application/javascript' },
3d12de14 395 json => { ct => 'application/json' },
b1e84aa3 396 map => { ct => 'application/json' },
d8218001
DM
397 png => { ct => 'image/png' , nocomp => 1 },
398 ico => { ct => 'image/x-icon', nocomp => 1},
399 gif => { ct => 'image/gif', nocomp => 1},
3d12de14 400 svg => { ct => 'image/svg+xml' },
d8218001
DM
401 jar => { ct => 'application/java-archive', nocomp => 1},
402 woff => { ct => 'application/font-woff', nocomp => 1},
403 woff2 => { ct => 'application/font-woff2', nocomp => 1},
404 ttf => { ct => 'application/font-snft', nocomp => 1},
405 pdf => { ct => 'application/pdf', nocomp => 1},
406 epub => { ct => 'application/epub+zip', nocomp => 1},
3d12de14
DC
407 mp3 => { ct => 'audio/mpeg', nocomp => 1},
408 oga => { ct => 'audio/ogg', nocomp => 1},
80d61dd6 409 tgz => { ct => 'application/x-compressed-tar', nocomp => 1},
d8218001
DM
410};
411
412sub send_file_start {
05e777bc 413 my ($self, $reqstate, $download) = @_;
d8218001
DM
414
415 eval {
416 # print "SEND FILE $filename\n";
417 # Note: aio_load() this is not really async unless we use IO::AIO!
418 eval {
419
420 my $r = $reqstate->{request};
421
05e777bc
DC
422 my $fh;
423 my $nocomp;
424 my $mime;
425
426 if (ref($download) eq 'HASH') {
05e777bc 427 $mime = $download->{'content-type'};
127dbe7c 428 my $encoding = $download->{'content-encoding'};
9c1388da 429 my $disposition = $download->{'content-disposition'};
389ad881 430
51841e98
SR
431 if ($download->{path} && $download->{stream} &&
432 $reqstate->{request}->header('PVEDisableProxy'))
433 {
434 # avoid double stream from a file, let the proxy handle it
435 die "internal error: file proxy streaming only available for pvedaemon\n"
436 if !$self->{trusted_env};
437 my $header = HTTP::Headers->new(
438 pvestreamfile => $download->{path},
439 Content_Type => $mime,
440 );
127dbe7c 441 $header->header('Content-Encoding' => $encoding) if defined($encoding);
9c1388da 442 $header->header('Content-Disposition' => $disposition) if defined($disposition);
51841e98
SR
443 # we need some data so Content-Length gets set correctly and
444 # the proxy doesn't wait for more data - place a canary
445 my $resp = HTTP::Response->new(200, "OK", $header, "error canary");
446 $self->response($reqstate, $resp);
447 return;
448 }
449
450 if (!($fh = $download->{fh})) {
451 my $path = $download->{path};
452 die "internal error: {download} returned but neither fh not path given\n"
453 if !$path;
454 sysopen($fh, "$path", O_NONBLOCK | O_RDONLY)
455 or die "open stream path '$path' for reading failed: $!\n";
456 }
457
389ad881
SR
458 if ($download->{stream}) {
459 my $header = HTTP::Headers->new(Content_Type => $mime);
127dbe7c 460 $header->header('Content-Encoding' => $encoding) if defined($encoding);
9c1388da 461 $header->header('Content-Disposition' => $disposition) if defined($disposition);
389ad881
SR
462 my $resp = HTTP::Response->new(200, "OK", $header);
463 $self->response($reqstate, $resp, undef, 1, 0, $fh);
464 return;
465 }
05e777bc
DC
466 } else {
467 my $filename = $download;
468 $fh = IO::File->new($filename, '<') ||
469 die "unable to open file '$filename' - $!\n";
470
471 my ($ext) = $filename =~ m/\.([^.]*)$/;
472 my $ext_info = $file_extension_info->{$ext};
473
474 die "unable to detect content type" if !$ext_info;
475 $mime = $ext_info->{ct};
476 $nocomp = $ext_info->{nocomp};
477 }
478
d8218001
DM
479 my $stat = File::stat::stat($fh) ||
480 die "$!\n";
5f14e56e 481
d8218001
DM
482 my $mtime = $stat->mtime;
483
484 if (my $ifmod = $r->header('if-modified-since')) {
485 my $iftime = HTTP::Date::str2time($ifmod);
486 if ($mtime <= $iftime) {
487 my $resp = HTTP::Response->new(304, "NOT MODIFIED");
488 $self->response($reqstate, $resp, $mtime);
489 return;
490 }
491 }
492
493 my $data;
494 my $len = sysread($fh, $data, $stat->size);
495 die "got short file\n" if !defined($len) || $len != $stat->size;
496
05e777bc 497 my $header = HTTP::Headers->new(Content_Type => $mime);
d8218001 498 my $resp = HTTP::Response->new(200, "OK", $header, $data);
05e777bc 499 $self->response($reqstate, $resp, $mtime, $nocomp);
d8218001
DM
500 };
501 if (my $err = $@) {
502 $self->error($reqstate, 501, $err);
503 }
504 };
505
506 warn $@ if $@;
507}
508
509sub websocket_proxy {
510 my ($self, $reqstate, $wsaccept, $wsproto, $param) = @_;
511
512 eval {
513 my $remhost;
514 my $remport;
515
ed8d2557 516 my $max_payload_size = 128*1024;
d8218001 517
d8218001
DM
518 if ($param->{port}) {
519 $remhost = 'localhost';
520 $remport = $param->{port};
521 } elsif ($param->{socket}) {
522 $remhost = 'unix/';
523 $remport = $param->{socket};
524 } else {
525 die "websocket_proxy: missing port or socket\n";
526 }
527
c3bd22ec
FG
528 my $encode = sub {
529 my ($data, $opcode) = @_;
530
531 my $string;
532 my $payload;
12014359
DC
533
534 $string = $opcode ? $opcode : "\x82"; # binary frame
535 $payload = $$data;
c3bd22ec
FG
536
537 my $payload_len = length($payload);
538 if ($payload_len <= 125) {
539 $string .= pack 'C', $payload_len;
540 } elsif ($payload_len <= 0xffff) {
541 $string .= pack 'C', 126;
542 $string .= pack 'n', $payload_len;
543 } else {
544 $string .= pack 'C', 127;
545 $string .= pack 'Q>', $payload_len;
546 }
547 $string .= $payload;
548 return $string;
549 };
550
d8218001 551 tcp_connect $remhost, $remport, sub {
5f14e56e 552 my ($fh) = @_
d8218001 553 or die "connect to '$remhost:$remport' failed: $!";
5f14e56e 554
26e73e6b 555 $self->dprint("CONNECTed to '$remhost:$remport'");
d8218001
DM
556
557 $reqstate->{proxyhdl} = AnyEvent::Handle->new(
558 fh => $fh,
cdb69327 559 rbuf_max => $max_payload_size,
ed8d2557 560 wbuf_max => $max_payload_size*5,
d8218001
DM
561 timeout => 5,
562 on_eof => sub {
563 my ($hdl) = @_;
564 eval {
565 $self->log_aborted_request($reqstate);
566 $self->client_do_disconnect($reqstate);
567 };
568 if (my $err = $@) { syslog('err', $err); }
569 },
570 on_error => sub {
571 my ($hdl, $fatal, $message) = @_;
572 eval {
573 $self->log_aborted_request($reqstate, $message);
574 $self->client_do_disconnect($reqstate);
575 };
576 if (my $err = $@) { syslog('err', "$err"); }
577 });
578
579 my $proxyhdlreader = sub {
580 my ($hdl) = @_;
5f14e56e 581
d8218001 582 my $len = length($hdl->{rbuf});
cdb69327 583 my $data = substr($hdl->{rbuf}, 0, $len > $max_payload_size ? $max_payload_size : $len, '');
d8218001 584
c3bd22ec 585 my $string = $encode->(\$data);
d8218001
DM
586
587 $reqstate->{hdl}->push_write($string) if $reqstate->{hdl};
588 };
589
590 my $hdlreader = sub {
591 my ($hdl) = @_;
592
ed979f7a
RJ
593 while (my $len = length($hdl->{rbuf})) {
594 return if $len < 2;
d8218001 595
ed979f7a
RJ
596 my $hdr = unpack('C', substr($hdl->{rbuf}, 0, 1));
597 my $opcode = $hdr & 0b00001111;
598 my $fin = $hdr & 0b10000000;
d8218001 599
ed979f7a 600 die "received fragmented websocket frame\n" if !$fin;
d8218001 601
ed979f7a
RJ
602 my $rsv = $hdr & 0b01110000;
603 die "received websocket frame with RSV flags\n" if $rsv;
d8218001 604
ed979f7a 605 my $payload_len = unpack 'C', substr($hdl->{rbuf}, 1, 1);
d8218001 606
ed979f7a
RJ
607 my $masked = $payload_len & 0b10000000;
608 die "received unmasked websocket frame from client\n" if !$masked;
d8218001 609
ed979f7a
RJ
610 my $offset = 2;
611 $payload_len = $payload_len & 0b01111111;
612 if ($payload_len == 126) {
613 return if $len < 4;
614 $payload_len = unpack('n', substr($hdl->{rbuf}, $offset, 2));
615 $offset += 2;
616 } elsif ($payload_len == 127) {
617 return if $len < 10;
618 $payload_len = unpack('Q>', substr($hdl->{rbuf}, $offset, 8));
619 $offset += 8;
620 }
d8218001 621
ed979f7a
RJ
622 die "received too large websocket frame (len = $payload_len)\n"
623 if ($payload_len > $max_payload_size) || ($payload_len < 0);
d8218001 624
ed979f7a 625 return if $len < ($offset + 4 + $payload_len);
d8218001 626
ed979f7a 627 my $data = substr($hdl->{rbuf}, 0, $offset + 4 + $payload_len, ''); # now consume data
5f14e56e 628
c55702c3 629 my $mask = substr($data, $offset, 4);
ed979f7a 630 $offset += 4;
d8218001 631
ed979f7a 632 my $payload = substr($data, $offset, $payload_len);
d8218001 633
c55702c3
FG
634 # NULL-mask might be used over TLS, skip to increase performance
635 if ($mask ne pack('N', 0)) {
636 # repeat 4 byte mask to payload length + up to 4 byte
637 $mask = $mask x (int($payload_len / 4) + 1);
638 # truncate mask to payload length
639 substr($mask, $payload_len) = "";
640 # (un-)apply mask
641 $payload ^= $mask;
ed979f7a 642 }
d8218001 643
ed979f7a
RJ
644 if ($opcode == 1 || $opcode == 2) {
645 $reqstate->{proxyhdl}->push_write($payload) if $reqstate->{proxyhdl};
646 } elsif ($opcode == 8) {
647 my $statuscode = unpack ("n", $payload);
26e73e6b 648 $self->dprint("websocket received close. status code: '$statuscode'");
b1364a3c 649 if (my $proxyhdl = $reqstate->{proxyhdl}) {
6277311e
FG
650 $proxyhdl->{block_disconnect} = 1 if length $proxyhdl->{wbuf};
651
b1364a3c 652 $proxyhdl->push_shutdown();
d8898f5e 653 }
ed979f7a 654 $hdl->push_shutdown();
e6cb79b5
FG
655 } elsif ($opcode == 9) {
656 # ping received, schedule pong
657 $reqstate->{hdl}->push_write($encode->(\$payload, "\x8A")) if $reqstate->{hdl};
658 } elsif ($opcode == 0xA) {
659 # pong received, continue
ed979f7a
RJ
660 } else {
661 die "received unhandled websocket opcode $opcode\n";
d8218001 662 }
d8218001
DM
663 }
664 };
665
666 my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.1';
667
668 $reqstate->{proxyhdl}->timeout(0);
669 $reqstate->{proxyhdl}->on_read($proxyhdlreader);
670 $reqstate->{hdl}->on_read($hdlreader);
671
672 # todo: use stop_read/start_read if write buffer grows to much
673
1d7da936
FG
674 # FIXME: remove protocol in PVE/PMG 8.x
675 #
e7eb7165
DC
676 # for backwards, compatibility, we have to reply with the websocket
677 # subprotocol from the request
d8218001
DM
678 my $res = "$proto 101 Switching Protocols\015\012" .
679 "Upgrade: websocket\015\012" .
680 "Connection: upgrade\015\012" .
681 "Sec-WebSocket-Accept: $wsaccept\015\012" .
e7eb7165 682 ($wsproto ne "" ? "Sec-WebSocket-Protocol: $wsproto\015\012" : "") .
d8218001
DM
683 "\015\012";
684
26e73e6b 685 $self->dprint($res);
d8218001
DM
686
687 $reqstate->{hdl}->push_write($res);
688
689 # log early
690 $reqstate->{log}->{code} = 101;
691 $self->log_request($reqstate);
692 };
693
694 };
695 if (my $err = $@) {
696 warn $err;
697 $self->log_aborted_request($reqstate, $err);
698 $self->client_do_disconnect($reqstate);
699 }
700}
701
702sub proxy_request {
362dd8eb 703 my ($self, $reqstate, $clientip, $host, $node, $method, $uri, $auth, $params) = @_;
d8218001
DM
704
705 eval {
706 my $target;
707 my $keep_alive = 1;
580d540e
TL
708
709 # stringify URI object and verify it starts with a slash
710 $uri = "$uri";
711 if ($uri !~ m@^/@) {
712 $self->error($reqstate, 400, "invalid proxy uri");
713 return;
714 }
715
e9df8a6e 716 my $may_stream_file;
d8218001
DM
717 if ($host eq 'localhost') {
718 $target = "http://$host:85$uri";
719 # keep alive for localhost is not worth (connection setup is about 0.2ms)
720 $keep_alive = 0;
e9df8a6e 721 $may_stream_file = 1;
d8218001
DM
722 } elsif (Net::IP::ip_is_ipv6($host)) {
723 $target = "https://[$host]:8006$uri";
724 } else {
725 $target = "https://$host:8006$uri";
726 }
727
728 my $headers = {
729 PVEDisableProxy => 'true',
730 PVEClientIP => $clientip,
731 };
732
362dd8eb
FG
733 $headers->{'cookie'} = PVE::APIServer::Formatter::create_auth_cookie($auth->{ticket}, $self->{cookie_name})
734 if $auth->{ticket};
735 $headers->{'Authorization'} = PVE::APIServer::Formatter::create_auth_header($auth->{api_token}, $self->{apitoken_name})
736 if $auth->{api_token};
737 $headers->{'CSRFPreventionToken'} = $auth->{token}
738 if $auth->{token};
23dfd1b7 739 $headers->{'Accept-Encoding'} = 'gzip' if ($reqstate->{accept_gzip} && $self->{compression});
d8218001 740
090019fa
WB
741 if (defined(my $host = $reqstate->{request}->header('Host'))) {
742 $headers->{Host} = $host;
743 }
744
d8218001
DM
745 my $content;
746
747 if ($method eq 'POST' || $method eq 'PUT') {
f398a3d9
DC
748 if ($reqstate->{request}->header('Content-Type') =~ 'application/json') {
749 $headers->{'Content-Type'} = 'application/json';
750 $content = encode_json($params);
751 } else {
752 $headers->{'Content-Type'} = 'application/x-www-form-urlencoded';
753 # use URI object to format application/x-www-form-urlencoded content.
754 my $url = URI->new('http:');
755 $url->query_form(%$params);
756 $content = $url->query;
757 }
d8218001
DM
758 if (defined($content)) {
759 $headers->{'Content-Length'} = length($content);
760 }
761 }
762
763 my $tls = {
764 # TLS 1.x only, with certificate pinning
765 method => 'any',
766 sslv2 => 0,
767 sslv3 => 0,
768 verify => 1,
769 verify_cb => sub {
770 my (undef, undef, undef, $depth, undef, undef, $cert) = @_;
771 # we don't care about intermediate or root certificates
772 return 1 if $depth != 0;
773 # check server certificate against cache of pinned FPs
774 return $self->check_cert_fingerprint($cert);
775 },
776 };
777
778 # load and cache cert fingerprint if first time we proxy to this node
779 $self->initialize_cert_cache($node);
780
781 my $w; $w = http_request(
782 $method => $target,
783 headers => $headers,
784 timeout => 30,
785 recurse => 0,
786 proxy => undef, # avoid use of $ENV{HTTP_PROXY}
787 keepalive => $keep_alive,
788 body => $content,
789 tls_ctx => AnyEvent::TLS->new(%{$tls}),
790 sub {
791 my ($body, $hdr) = @_;
792
793 undef $w;
794
795 if (!$reqstate->{hdl}) {
796 warn "proxy detected vanished client connection\n";
797 return;
798 }
799
800 eval {
801 my $code = delete $hdr->{Status};
802 my $msg = delete $hdr->{Reason};
51841e98 803 my $stream = delete $hdr->{pvestreamfile};
d8218001
DM
804 delete $hdr->{URL};
805 delete $hdr->{HTTPVersion};
806 my $header = HTTP::Headers->new(%$hdr);
807 if (my $location = $header->header('Location')) {
808 $location =~ s|^http://localhost:85||;
809 $header->header(Location => $location);
810 }
51841e98 811 if ($stream) {
e9df8a6e
TL
812 if (!$may_stream_file) {
813 $self->error($reqstate, 403, 'streaming denied');
814 return;
815 }
51841e98
SR
816 sysopen(my $fh, "$stream", O_NONBLOCK | O_RDONLY)
817 or die "open stream path '$stream' for forwarding failed: $!\n";
818 my $resp = HTTP::Response->new($code, $msg, $header, undef);
819 $self->response($reqstate, $resp, undef, 1, 0, $fh);
820 } else {
821 my $resp = HTTP::Response->new($code, $msg, $header, $body);
822 # Note: disable compression, because body is already compressed
823 $self->response($reqstate, $resp, undef, 1);
824 }
d8218001
DM
825 };
826 warn $@ if $@;
827 });
828 };
829 warn $@ if $@;
830}
831
832# return arrays as \0 separated strings (like CGI.pm)
256da581 833# assume data is UTF8 encoded
d8218001
DM
834sub decode_urlencoded {
835 my ($data) = @_;
836
837 my $res = {};
838
839 return $res if !$data;
840
841 foreach my $kv (split(/[\&\;]/, $data)) {
842 my ($k, $v) = split(/=/, $kv);
843 $k =~s/\+/ /g;
844 $k =~ s/%([0-9a-fA-F][0-9a-fA-F])/chr(hex($1))/eg;
d8218001 845
4a09623b
TL
846 if (defined($v)) {
847 $v =~s/\+/ /g;
848 $v =~ s/%([0-9a-fA-F][0-9a-fA-F])/chr(hex($1))/eg;
256da581 849
4a09623b
TL
850 $v = Encode::decode('utf8', $v);
851
852 if (defined(my $old = $res->{$k})) {
853 $v = "$old\0$v";
854 }
5f14e56e 855 }
4a09623b
TL
856
857 $res->{$k} = $v;
d8218001
DM
858 }
859 return $res;
860}
861
862sub extract_params {
863 my ($r, $method) = @_;
864
865 my $params = {};
866
867 if ($method eq 'PUT' || $method eq 'POST') {
3e05f166
DC
868 my $ct;
869 if (my $ctype = $r->header('Content-Type')) {
870 $ct = parse_content_type($ctype);
871 }
872 if (defined($ct) && $ct eq 'application/json') {
873 $params = decode_json($r->content);
874 } else {
875 $params = decode_urlencoded($r->content);
876 }
d8218001
DM
877 }
878
879 my $query_params = decode_urlencoded($r->url->query());
880
881 foreach my $k (keys %{$query_params}) {
882 $params->{$k} = $query_params->{$k};
883 }
884
256da581 885 return $params;
d8218001
DM
886}
887
888sub handle_api2_request {
889 my ($self, $reqstate, $auth, $method, $path, $upload_state) = @_;
890
891 eval {
892 my $r = $reqstate->{request};
893
894 my ($rel_uri, $format) = &$split_abs_uri($path, $self->{base_uri});
895
c7154375 896 my $formatter = PVE::APIServer::Formatter::get_formatter($format, $method, $rel_uri);
d8218001
DM
897
898 if (!defined($formatter)) {
555a5ab3 899 $self->error($reqstate, HTTP_NOT_IMPLEMENTED, "no formatter for uri $rel_uri, $format");
d8218001
DM
900 return;
901 }
902
903 #print Dumper($upload_state) if $upload_state;
904
d8218001
DM
905 my $params;
906
907 if ($upload_state) {
908 $params = $upload_state->{params};
909 } else {
910 $params = extract_params($r, $method);
911 }
912
d9b3838f 913 delete $params->{_dc} if $params; # remove disable cache parameter
d8218001
DM
914
915 my $clientip = $reqstate->{peer_host};
916
66a7a3a3 917 my $res = $self->rest_handler($clientip, $method, $rel_uri, $auth, $params, $format);
d8218001 918
8d88baec
DM
919 # HACK: see Note 1
920 Net::SSLeay::ERR_clear_error();
921
d8218001
DM
922 AnyEvent->now_update(); # in case somebody called sleep()
923
d8218001
DM
924 my $upgrade = $r->header('upgrade');
925 $upgrade = lc($upgrade) if $upgrade;
926
927 if (my $host = $res->{proxy}) {
928
929 if ($self->{trusted_env}) {
930 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy not allowed");
931 return;
932 }
933
934 if ($host ne 'localhost' && $r->header('PVEDisableProxy')) {
935 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy loop detected");
936 return;
937 }
938
939 $res->{proxy_params}->{tmpfilename} = $reqstate->{tmpfilename} if $upload_state;
940
1e9befeb
TL
941 $self->proxy_request(
942 $reqstate, $clientip, $host, $res->{proxynode}, $method, $r->uri, $auth, $res->{proxy_params});
d8218001
DM
943 return;
944
945 } elsif ($upgrade && ($method eq 'GET') && ($path =~ m|websocket$|)) {
946 die "unable to upgrade to protocol '$upgrade'\n" if !$upgrade || ($upgrade ne 'websocket');
947 my $wsver = $r->header('sec-websocket-version');
948 die "unsupported websocket-version '$wsver'\n" if !$wsver || ($wsver ne '13');
e7eb7165 949 my $wsproto = $r->header('sec-websocket-protocol') // "";
d8218001
DM
950 my $wskey = $r->header('sec-websocket-key');
951 die "missing websocket-key\n" if !$wskey;
952 # Note: Digest::SHA::sha1_base64 has wrong padding
953 my $wsaccept = Digest::SHA::sha1_base64("${wskey}258EAFA5-E914-47DA-95CA-C5AB0DC85B11") . "=";
954 if ($res->{status} == HTTP_OK) {
955 $self->websocket_proxy($reqstate, $wsaccept, $wsproto, $res->{data});
956 return;
957 }
958 }
959
960 my $delay = 0;
961 if ($res->{status} == HTTP_UNAUTHORIZED) {
962 # always delay unauthorized calls by 3 seconds
963 $delay = 3 - tv_interval($reqstate->{starttime});
964 $delay = 0 if $delay < 0;
965 }
966
6d832dbc
SR
967 my $download = $res->{download};
968 $download //= $res->{data}->{download}
d8898f5e 969 if defined($res->{data}) && ref($res->{data}) eq 'HASH';
6d832dbc 970 if (defined($download)) {
05e777bc 971 send_file_start($self, $reqstate, $download);
20a61215
DM
972 return;
973 }
974
ca304f91
DM
975 my ($raw, $ct, $nocomp) = $formatter->($res, $res->{data}, $params, $path,
976 $auth, $self->{formatter_config});
d8218001
DM
977
978 my $resp;
979 if (ref($raw) && (ref($raw) eq 'HTTP::Response')) {
980 $resp = $raw;
981 } else {
982 $resp = HTTP::Response->new($res->{status}, $res->{message});
983 $resp->header("Content-Type" => $ct);
984 $resp->content($raw);
985 }
986 $self->response($reqstate, $resp, undef, $nocomp, $delay);
987 };
988 if (my $err = $@) {
989 $self->error($reqstate, 501, $err);
990 }
991}
992
993sub handle_spice_proxy_request {
994 my ($self, $reqstate, $connect_str, $vmid, $node, $spiceport) = @_;
995
996 eval {
997
542f4c3a 998 my ($minport, $maxport) = PVE::Tools::spice_port_range();
9789c451
TL
999 if ($spiceport < $minport || $spiceport > $maxport) {
1000 die "SPICE Port $spiceport is not in allowed range ($minport, $maxport)\n";
1001 }
d8218001 1002
d8218001
DM
1003 my $clientip = $reqstate->{peer_host};
1004 my $r = $reqstate->{request};
1005
d8898f5e 1006 my $remip;
d8218001 1007
d8898f5e
MC
1008 if ($node ne 'localhost' && PVE::INotify::nodename() !~ m/^$node$/i) {
1009 $remip = $self->remote_node_ip($node);
26e73e6b 1010 $self->dprint("REMOTE CONNECT $vmid, $remip, $connect_str");
d8898f5e 1011 } else {
26e73e6b 1012 $self->dprint("CONNECT $vmid, $node, $spiceport");
d8218001
DM
1013 }
1014
1015 if ($remip && $r->header('PVEDisableProxy')) {
1016 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy loop detected");
1017 return;
1018 }
1019
1020 $reqstate->{hdl}->timeout(0);
1021 $reqstate->{hdl}->wbuf_max(64*10*1024);
1022
1023 my $remhost = $remip ? $remip : "localhost";
1024 my $remport = $remip ? 3128 : $spiceport;
1025
1026 tcp_connect $remhost, $remport, sub {
5f14e56e 1027 my ($fh) = @_
d8218001
DM
1028 or die "connect to '$remhost:$remport' failed: $!";
1029
26e73e6b 1030 $self->dprint("CONNECTed to '$remhost:$remport'");
d8218001
DM
1031 $reqstate->{proxyhdl} = AnyEvent::Handle->new(
1032 fh => $fh,
1033 rbuf_max => 64*1024,
1034 wbuf_max => 64*10*1024,
1035 timeout => 5,
1036 on_eof => sub {
1037 my ($hdl) = @_;
1038 eval {
1039 $self->log_aborted_request($reqstate);
1040 $self->client_do_disconnect($reqstate);
1041 };
1042 if (my $err = $@) { syslog('err', $err); }
1043 },
1044 on_error => sub {
1045 my ($hdl, $fatal, $message) = @_;
1046 eval {
1047 $self->log_aborted_request($reqstate, $message);
1048 $self->client_do_disconnect($reqstate);
1049 };
1050 if (my $err = $@) { syslog('err', "$err"); }
1051 });
1052
1053
1054 my $proxyhdlreader = sub {
1055 my ($hdl) = @_;
1056
1057 my $len = length($hdl->{rbuf});
1058 my $data = substr($hdl->{rbuf}, 0, $len, '');
1059
1060 #print "READ1 $len\n";
1061 $reqstate->{hdl}->push_write($data) if $reqstate->{hdl};
1062 };
1063
1064 my $hdlreader = sub {
1065 my ($hdl) = @_;
1066
1067 my $len = length($hdl->{rbuf});
1068 my $data = substr($hdl->{rbuf}, 0, $len, '');
1069
1070 #print "READ0 $len\n";
1071 $reqstate->{proxyhdl}->push_write($data) if $reqstate->{proxyhdl};
1072 };
1073
1074 my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.0';
1075
1076 my $startproxy = sub {
1077 $reqstate->{proxyhdl}->timeout(0);
1078 $reqstate->{proxyhdl}->on_read($proxyhdlreader);
1079 $reqstate->{hdl}->on_read($hdlreader);
1080
1081 # todo: use stop_read/start_read if write buffer grows to much
1082
a4d8bbaf
DC
1083 # a response must be followed by an empty line
1084 my $res = "$proto 200 OK\015\012\015\012";
d8218001
DM
1085 $reqstate->{hdl}->push_write($res);
1086
1087 # log early
1088 $reqstate->{log}->{code} = 200;
1089 $self->log_request($reqstate);
1090 };
1091
1092 if ($remip) {
1093 my $header = "CONNECT ${connect_str} $proto\015\012" .
1094 "Host: ${connect_str}\015\012" .
1095 "Proxy-Connection: keep-alive\015\012" .
1096 "User-Agent: spiceproxy\015\012" .
1097 "PVEDisableProxy: true\015\012" .
1098 "PVEClientIP: $clientip\015\012" .
1099 "\015\012";
1100
1101 $reqstate->{proxyhdl}->push_write($header);
1102 $reqstate->{proxyhdl}->push_read(line => sub {
1103 my ($hdl, $line) = @_;
5f14e56e 1104
d8218001 1105 if ($line =~ m!^$proto 200 OK$!) {
6c31d13e
DC
1106 # read the empty line after the 200 OK
1107 $reqstate->{proxyhdl}->unshift_read(line => sub{
1108 &$startproxy();
1109 });
d8218001
DM
1110 } else {
1111 $reqstate->{hdl}->push_write($line);
1112 $self->client_do_disconnect($reqstate);
1113 }
d8898f5e 1114 });
d8218001
DM
1115 } else {
1116 &$startproxy();
1117 }
1118
1119 };
1120 };
1121 if (my $err = $@) {
1122 warn $err;
1123 $self->log_aborted_request($reqstate, $err);
1124 $self->client_do_disconnect($reqstate);
1125 }
1126}
1127
1128sub handle_request {
1129 my ($self, $reqstate, $auth, $method, $path) = @_;
1130
1131 my $base_uri = $self->{base_uri};
1132
1133 eval {
1134 my $r = $reqstate->{request};
5f14e56e 1135
d8218001
DM
1136 # disable timeout on handle (we already have all data we need)
1137 # we re-enable timeout in response()
1138 $reqstate->{hdl}->timeout(0);
1139
1140 if ($path =~ m/^\Q$base_uri\E/) {
1141 $self->handle_api2_request($reqstate, $auth, $method, $path);
1142 return;
1143 }
1144
1145 if ($self->{pages} && ($method eq 'GET') && (my $handler = $self->{pages}->{$path})) {
1146 if (ref($handler) eq 'CODE') {
1147 my $params = decode_urlencoded($r->url->query());
1148 my ($resp, $userid) = &$handler($self, $reqstate->{request}, $params);
8d88baec
DM
1149 # HACK: see Note 1
1150 Net::SSLeay::ERR_clear_error();
d8218001
DM
1151 $self->response($reqstate, $resp);
1152 } elsif (ref($handler) eq 'HASH') {
1153 if (my $filename = $handler->{file}) {
1154 my $fh = IO::File->new($filename) ||
1155 die "unable to open file '$filename' - $!\n";
1156 send_file_start($self, $reqstate, $filename);
1157 } else {
1158 die "internal error - no handler";
1159 }
1160 } else {
1161 die "internal error - no handler";
1162 }
1163 return;
1164 }
1165
1166 if ($self->{dirs} && ($method eq 'GET')) {
1167 # we only allow simple names
1168 if ($path =~ m!^(/\S+/)([a-zA-Z0-9\-\_\.]+)$!) {
1169 my ($subdir, $file) = ($1, $2);
1170 if (my $dir = $self->{dirs}->{$subdir}) {
1171 my $filename = "$dir$file";
1172 my $fh = IO::File->new($filename) ||
1173 die "unable to open file '$filename' - $!\n";
1174 send_file_start($self, $reqstate, $filename);
1175 return;
1176 }
1177 }
1178 }
1179
666d3ae1 1180 die "no such file '$path'\n";
d8218001
DM
1181 };
1182 if (my $err = $@) {
1183 $self->error($reqstate, 501, $err);
1184 }
1185}
1186
59128f6b
TL
1187my sub assert_form_disposition {
1188 die "wrong Content-Disposition '$_[0]' in multipart, expected 'form-data'\n" if $_[0] ne 'form-data';
1189}
1190
d8218001
DM
1191sub file_upload_multipart {
1192 my ($self, $reqstate, $auth, $method, $path, $rstate) = @_;
1193
1194 eval {
1195 my $boundary = $rstate->{boundary};
1196 my $hdl = $reqstate->{hdl};
d8218001
DM
1197 my $startlen = length($hdl->{rbuf});
1198
59128f6b
TL
1199 my $newline_re = qr/\015?\012/;
1200 my $delim_re = qr/--\Q$boundary\E${newline_re}/;
44791210 1201 my $close_delim_re = qr/--\Q$boundary\E--/;
d8218001 1202
0fbcbc26 1203 # Phase 0 - preserve boundary, but remove everything before
59128f6b 1204 if ($rstate->{phase} == 0 && $hdl->{rbuf} =~ s/^.*?($delim_re)/$1/s) {
0fbcbc26
MH
1205 $rstate->{read} += $startlen - length($hdl->{rbuf});
1206 $rstate->{phase} = 1;
1207 }
d8218001 1208
e3295acc
MH
1209 my $remove_until_data = sub {
1210 my ($hdl) = @_;
1211 # remove any remaining multipart "headers" like Content-Type
1212 $hdl->{rbuf} =~ s/^.*?${newline_re}{2}//s;
1213 };
1214
59128f6b
TL
1215 my $extract_form_disposition = sub {
1216 my ($name) = @_;
e3295acc 1217 if ($hdl->{rbuf} =~ s/^${delim_re}.*?Content-Disposition: (.*?); name="$name"(.*?${delim_re})/$2/s) {
59128f6b 1218 assert_form_disposition($1);
e3295acc
MH
1219 $remove_until_data->($hdl);
1220 $hdl->{rbuf} =~ s/^(.*?)(${delim_re})/$2/s;
1221 $rstate->{params}->{$name} = trim($1);
d8218001 1222 }
59128f6b 1223 };
0fbcbc26 1224
59128f6b
TL
1225 if ($rstate->{phase} == 1) { # Phase 1 - parse payload without file data
1226 $extract_form_disposition->('content');
1227 $extract_form_disposition->('checksum-algorithm');
1228 $extract_form_disposition->('checksum');
0fbcbc26 1229
602eb8aa 1230 if ($hdl->{rbuf} =~ s/^${delim_re}Content-Disposition: (.*?); name="(.*?)"; filename="([^"]+)"//s) {
59128f6b 1231 assert_form_disposition($1);
aad755eb 1232 die "wrong field name '$2' for file upload, expected 'filename'" if $2 ne "filename";
0fbcbc26 1233 $rstate->{phase} = 2;
a66b77d8 1234 $rstate->{params}->{filename} = trim($3);
435dbe0c 1235 $remove_until_data->($hdl); # any remaining multipart "headers" like Content-Type
0fbcbc26
MH
1236 }
1237 }
1238
aad755eb 1239 if ($rstate->{phase} == 2) { # Phase 2 - dump content into file
dafe4416 1240 my ($data, $write_length);
59128f6b 1241 if ($hdl->{rbuf} =~ s/^(.*?)${newline_re}?+${close_delim_re}.*$//s) {
dafe4416
TL
1242 $data = $1;
1243 $write_length = length($data);
0fbcbc26 1244 $rstate->{phase} = 100;
d8218001 1245 } else {
dafe4416
TL
1246 $write_length = length($hdl->{rbuf}) - $rstate->{boundlen};
1247 $data = substr($hdl->{rbuf}, 0, $write_length, '') if $write_length > 0;
1248 }
1249
1250 if ($write_length > 0) {
1251 syswrite($rstate->{outfh}, $data) == $write_length or die "write to temporary file failed - $!\n";
1252 $rstate->{bytes} += $write_length;
d8218001 1253 }
0fbcbc26 1254 }
d8218001 1255
aad755eb 1256 if ($rstate->{phase} == 100) { # Phase 100 - transfer finished
0fbcbc26 1257 my $elapsed = tv_interval($rstate->{starttime});
a2a3d17b
MH
1258 syslog('info', "multipart upload complete (size: %dB time: %.3fs rate: %.2fMiB/s filename: %s)",
1259 $rstate->{bytes}, $elapsed, $rstate->{bytes} / ($elapsed * 1024 * 1024),
1260 $rstate->{params}->{filename}
0fbcbc26
MH
1261 );
1262 $self->handle_api2_request($reqstate, $auth, $method, $path, $rstate);
d8218001
DM
1263 }
1264
91b86f4e 1265 $rstate->{read} += $startlen - length($hdl->{rbuf});
d8218001 1266
aad755eb 1267 if ($rstate->{read} + length($hdl->{rbuf}) >= $rstate->{size} && $rstate->{phase} != 100) {
0fbcbc26 1268 die "upload failed";
d8218001
DM
1269 }
1270 };
1271 if (my $err = $@) {
1272 syslog('err', $err);
1273 $self->error($reqstate, 501, $err);
1274 }
1275}
1276
1277sub parse_content_type {
1278 my ($ctype) = @_;
1279
1280 my ($ct, @params) = split(/\s*[;,]\s*/o, $ctype);
5f14e56e 1281
d8218001
DM
1282 foreach my $v (@params) {
1283 if ($v =~ m/^\s*boundary\s*=\s*(\S+?)\s*$/o) {
1284 return wantarray ? ($ct, $1) : $ct;
1285 }
1286 }
5f14e56e 1287
d8218001
DM
1288 return wantarray ? ($ct) : $ct;
1289}
1290
d8218001
DM
1291my $tmpfile_seq_no = 0;
1292
1293sub get_upload_filename {
1294 # choose unpredictable tmpfile name
5f14e56e 1295
d8218001
DM
1296 $tmpfile_seq_no++;
1297 return "/var/tmp/pveupload-" . Digest::MD5::md5_hex($tmpfile_seq_no . time() . $$);
1298}
1299
1300sub unshift_read_header {
1301 my ($self, $reqstate, $state) = @_;
1302
1303 $state = { size => 0, count => 0 } if !$state;
1304
1305 $reqstate->{hdl}->unshift_read(line => sub {
1306 my ($hdl, $line) = @_;
1307
1308 eval {
1309 # print "$$: got header: $line\n" if $self->{debug};
1310
e7ee5e3f 1311 die "too many http header lines (> $limit_max_headers)\n" if ++$state->{count} >= $limit_max_headers;
d8218001
DM
1312 die "http header too large\n" if ($state->{size} += length($line)) >= $limit_max_header_size;
1313
1314 my $r = $reqstate->{request};
1315 if ($line eq '') {
1316
d8218001
DM
1317 $r->push_header($state->{key}, $state->{val})
1318 if $state->{key};
1319
b636292c
FG
1320 return if !$self->process_header($reqstate);
1321 return if !$self->ensure_tls_connection($reqstate);
1322
1323 $self->authenticate_and_handle_request($reqstate);
d8218001 1324
d8218001
DM
1325 } elsif ($line =~ /^([^:\s]+)\s*:\s*(.*)/) {
1326 $r->push_header($state->{key}, $state->{val}) if $state->{key};
1327 ($state->{key}, $state->{val}) = ($1, $2);
1328 $self->unshift_read_header($reqstate, $state);
1329 } elsif ($line =~ /^\s+(.*)/) {
1330 $state->{val} .= " $1";
1331 $self->unshift_read_header($reqstate, $state);
1332 } else {
1333 $self->error($reqstate, 506, "unable to parse request header");
1334 }
1335 };
1336 warn $@ if $@;
1337 });
1338};
1339
4737252f 1340# sends an (error) response and returns 0 in case of errors
bda48641
MC
1341sub process_header {
1342 my ($self, $reqstate) = @_;
1343
1344 my $request = $reqstate->{request};
1345
1346 my $path = uri_unescape($request->uri->path());
1347 my $method = $request->method();
1348
1349 if (!$known_methods->{$method}) {
1350 my $resp = HTTP::Response->new(HTTP_NOT_IMPLEMENTED, "method '$method' not available");
1351 $self->response($reqstate, $resp);
14f39f12 1352 return 0;
bda48641
MC
1353 }
1354
1355 my $conn = $request->header('Connection');
1356 my $accept_enc = $request->header('Accept-Encoding');
1357 $reqstate->{accept_gzip} = ($accept_enc && $accept_enc =~ m/gzip/) ? 1 : 0;
1358
1359 if ($conn) {
1360 $reqstate->{keep_alive} = 0 if $conn =~ m/close/oi;
1361 } else {
1362 if ($reqstate->{proto}->{ver} < 1001) {
1363 $reqstate->{keep_alive} = 0;
1364 }
1365 }
1366
1367 my $te = $request->header('Transfer-Encoding');
1368 if ($te && lc($te) eq 'chunked') {
1369 # Handle chunked transfer encoding
1370 $self->error($reqstate, 501, "chunked transfer encoding not supported");
14f39f12 1371 return 0;
bda48641
MC
1372 } elsif ($te) {
1373 $self->error($reqstate, 501, "Unknown transfer encoding '$te'");
14f39f12 1374 return 0;
bda48641
MC
1375 }
1376
1377 my $pveclientip = $request->header('PVEClientIP');
1378
1379 # fixme: how can we make PVEClientIP header trusted?
1380 if ($self->{trusted_env} && $pveclientip) {
1381 $reqstate->{peer_host} = $pveclientip;
1382 } else {
1383 $request->header('PVEClientIP', $reqstate->{peer_host});
1384 }
1385
1386 if (my $rpcenv = $self->{rpcenv}) {
1387 $rpcenv->set_request_host($request->header('Host'));
1388 }
1389
1390 return 1;
1391}
1392
4737252f
FG
1393# sends an (redirect) response, disconnects the client and returns 0 if
1394# connection is not TLS-protected
933a4dbb
MC
1395sub ensure_tls_connection {
1396 my ($self, $reqstate) = @_;
1397
1398 # Skip if server doesn't use TLS
1399 if (!$self->{tls_ctx}) {
1400 return 1;
1401 }
1402
1403 # TLS session exists, so the handshake has succeeded
1404 if ($reqstate->{hdl}->{tls}) {
1405 return 1;
1406 }
1407
1408 my $request = $reqstate->{request};
1409 my $method = $request->method();
1410
1411 my $h_host = $reqstate->{request}->header('Host');
1412
1413 die "Header field 'Host' not found in request\n"
1414 if !$h_host;
1415
1416 my $secure_host = "https://" . ($h_host =~ s/^http(s)?:\/\///r);
1417
1418 my $header = HTTP::Headers->new('Location' => $secure_host . $request->uri());
1419
1420 if ($method eq 'GET' || $method eq 'HEAD') {
1421 $self->error($reqstate, 301, 'Moved Permanently', $header);
1422 } else {
1423 $self->error($reqstate, 308, 'Permanent Redirect', $header);
1424 }
1425
1426 # disconnect the client so they may immediately connect again via HTTPS
1427 $self->client_do_disconnect($reqstate);
1428
14f39f12 1429 return 0;
933a4dbb
MC
1430}
1431
f2e54bb7
MC
1432sub authenticate_and_handle_request {
1433 my ($self, $reqstate) = @_;
1434
1435 my $request = $reqstate->{request};
1436 my $method = $request->method();
1437
1438 my $path = uri_unescape($request->uri->path());
1439 my $base_uri = $self->{base_uri};
1440
1441 my $auth = {};
1442
1443 if ($self->{spiceproxy}) {
1444 my $connect_str = $request->header('Host');
1445 my ($vmid, $node, $port) = $self->verify_spice_connect_url($connect_str);
1446
1447 if (!(defined($vmid) && $node && $port)) {
1448 $self->error($reqstate, HTTP_UNAUTHORIZED, "invalid ticket");
1449 return;
1450 }
1451
1452 $self->handle_spice_proxy_request($reqstate, $connect_str, $vmid, $node, $port);
1453 return;
1454
1455 } elsif ($path =~ m/^\Q$base_uri\E/) {
1456 my $token = $request->header('CSRFPreventionToken');
1457 my $cookie = $request->header('Cookie');
1458 my $auth_header = $request->header('Authorization');
1459
1460 # prefer actual cookie
1461 my $ticket = PVE::APIServer::Formatter::extract_auth_value(
1462 $cookie,
1463 $self->{cookie_name}
1464 );
1465
1466 # fallback to cookie in 'Authorization' header
1467 if (!$ticket) {
1468 $ticket = PVE::APIServer::Formatter::extract_auth_value(
1469 $auth_header,
1470 $self->{cookie_name}
1471 );
1472 }
1473
1474 # finally, fallback to API token if no ticket has been provided so far
1475 my $api_token;
1476 if (!$ticket) {
1477 $api_token = PVE::APIServer::Formatter::extract_auth_value(
1478 $auth_header,
1479 $self->{apitoken_name}
1480 );
1481 }
1482
1483 my ($rel_uri, $format) = &$split_abs_uri($path, $self->{base_uri});
1484 if (!$format) {
1485 $self->error($reqstate, HTTP_NOT_IMPLEMENTED, "no such uri");
1486 return;
1487 }
1488
1489 eval {
1490 $auth = $self->auth_handler(
1491 $method,
1492 $rel_uri,
1493 $ticket,
1494 $token,
1495 $api_token,
1496 $reqstate->{peer_host}
1497 );
1498 };
1499 if (my $err = $@) {
1500 # HACK: see Note 1
1501 Net::SSLeay::ERR_clear_error();
1502 # always delay unauthorized calls by 3 seconds
1503 my $delay = 3;
1504
1505 if (ref($err) eq "PVE::Exception") {
1506
1507 $err->{code} ||= HTTP_INTERNAL_SERVER_ERROR,
1508 my $resp = HTTP::Response->new($err->{code}, $err->{msg});
1509 $self->response($reqstate, $resp, undef, 0, $delay);
1510
1511 } elsif (my $formatter = PVE::APIServer::Formatter::get_login_formatter($format)) {
1512 my ($raw, $ct, $nocomp) =
1513 $formatter->($path, $auth, $self->{formatter_config});
1514
1515 my $resp;
1516 if (ref($raw) && (ref($raw) eq 'HTTP::Response')) {
1517 $resp = $raw;
1518
1519 } else {
1520 $resp = HTTP::Response->new(HTTP_UNAUTHORIZED, "Login Required");
1521 $resp->header("Content-Type" => $ct);
1522 $resp->content($raw);
1523 }
1524
1525 $self->response($reqstate, $resp, undef, $nocomp, $delay);
1526
1527 } else {
1528 my $resp = HTTP::Response->new(HTTP_UNAUTHORIZED, $err);
1529 $self->response($reqstate, $resp, undef, 0, $delay);
1530 }
1531
1532 return;
1533 }
1534 }
1535
1536 $reqstate->{log}->{userid} = $auth->{userid};
1537 my $len = $request->header('Content-Length');
1538
1539 if ($len) {
1540
1541 if (!($method eq 'PUT' || $method eq 'POST')) {
1542 $self->error($reqstate, 501, "Unexpected content for method '$method'");
1543 return;
1544 }
1545
1546 my $ctype = $request->header('Content-Type');
1547 my ($ct, $boundary) = $ctype ? parse_content_type($ctype) : ();
1548
1549 if ($auth->{isUpload} && !$self->{trusted_env}) {
1550 die "upload 'Content-Type '$ctype' not implemented\n"
1551 if !($boundary && $ct && ($ct eq 'multipart/form-data'));
1552
1553 die "upload without content length header not supported" if !$len;
1554
1555 die "upload without content length header not supported" if !$len;
1556
1557 $self->dprint("start upload $path $ct $boundary");
1558
1559 my $tmpfilename = get_upload_filename();
1560 my $outfh = IO::File->new($tmpfilename, O_RDWR|O_CREAT|O_EXCL, 0600) ||
1561 die "unable to create temporary upload file '$tmpfilename'";
1562
1563 $reqstate->{keep_alive} = 0;
1564
1565 my $boundlen = length($boundary) + 8; # \015?\012--$boundary--\015?\012
1566
1567 my $state = {
1568 size => $len,
1569 boundary => $boundary,
f2e54bb7
MC
1570 boundlen => $boundlen,
1571 maxheader => 2048 + $boundlen, # should be large enough
1572 params => decode_urlencoded($request->url->query()),
1573 phase => 0,
1574 read => 0,
1575 post_size => 0,
1576 starttime => [gettimeofday],
1577 outfh => $outfh,
1578 };
cb53bd68
TL
1579
1580 die "'tmpfilename' query parameter is not allowed for file uploads\n"
1581 if exists $state->{params}->{tmpfilename};
1582
f2e54bb7
MC
1583 $reqstate->{tmpfilename} = $tmpfilename;
1584 $reqstate->{hdl}->on_read(sub {
1585 $self->file_upload_multipart($reqstate, $auth, $method, $path, $state);
1586 });
1587
1588 return;
1589 }
1590
1591 if ($len > $limit_max_post) {
1592 $self->error($reqstate, 501, "for data too large");
1593 return;
1594 }
1595
1596 if (!$ct || $ct eq 'application/x-www-form-urlencoded' || $ct eq 'application/json') {
1597 $reqstate->{hdl}->unshift_read(chunk => $len, sub {
1598 my ($hdl, $data) = @_;
1599 $request->content($data);
1600 $self->handle_request($reqstate, $auth, $method, $path);
1601 });
1602
1603 } else {
1604 $self->error($reqstate, 506, "upload 'Content-Type '$ctype' not implemented");
1605 }
1606
1607 } else {
1608 $self->handle_request($reqstate, $auth, $method, $path);
1609 }
f2e54bb7
MC
1610}
1611
d8218001
DM
1612sub push_request_header {
1613 my ($self, $reqstate) = @_;
1614
1615 eval {
1616 $reqstate->{hdl}->push_read(line => sub {
1617 my ($hdl, $line) = @_;
1618
1619 eval {
1620 # print "got request header: $line\n" if $self->{debug};
1621
1622 $reqstate->{keep_alive}--;
1623
1624 if ($line =~ /(\S+)\040(\S+)\040HTTP\/(\d+)\.(\d+)/o) {
1625 my ($method, $url, $maj, $min) = ($1, $2, $3, $4);
1626
1627 if ($maj != 1) {
1628 $self->error($reqstate, 506, "http protocol version $maj.$min not supported");
1629 return;
1630 }
c2bd69c7
TL
1631 if ($url =~ m|^[^/]*@|) {
1632 # if an '@' comes before the first slash proxy forwarding might consider
1633 # the frist part of the url to be part of an authority...
1634 $self->error($reqstate, 400, "invalid url");
4099febe 1635 return;
c2bd69c7 1636 }
d8218001
DM
1637
1638 $self->{request_count}++; # only count valid request headers
1639 if ($self->{request_count} >= $self->{max_requests}) {
1640 $self->{end_loop} = 1;
1641 }
1642 $reqstate->{log} = { requestline => $line };
1643 $reqstate->{proto}->{str} = "HTTP/$maj.$min";
1644 $reqstate->{proto}->{maj} = $maj;
1645 $reqstate->{proto}->{min} = $min;
1646 $reqstate->{proto}->{ver} = $maj*1000+$min;
1647 $reqstate->{request} = HTTP::Request->new($method, $url);
148dc08e 1648 $reqstate->{starttime} = [gettimeofday];
d8218001
DM
1649
1650 $self->unshift_read_header($reqstate);
1651 } elsif ($line eq '') {
1652 # ignore empty lines before requests (browser bugs?)
1653 $self->push_request_header($reqstate);
1654 } else {
1655 $self->error($reqstate, 400, 'bad request');
1656 }
1657 };
1658 warn $@ if $@;
1659 });
1660 };
1661 warn $@ if $@;
1662}
1663
1664sub accept {
1665 my ($self) = @_;
1666
1667 my $clientfh;
1668
1669 return if $self->{end_loop};
1670
1671 # we need to m make sure that only one process calls accept
1672 while (!flock($self->{lockfh}, Fcntl::LOCK_EX())) {
1673 next if $! == EINTR;
1674 die "could not get lock on file '$self->{lockfile}' - $!\n";
1675 }
1676
1677 my $again = 0;
1678 my $errmsg;
1679 eval {
1680 while (!$self->{end_loop} &&
1681 !defined($clientfh = $self->{socket}->accept()) &&
1682 ($! == EINTR)) {};
1683
1684 if ($self->{end_loop}) {
1685 $again = 0;
1686 } else {
1687 $again = ($! == EAGAIN || $! == WSAEWOULDBLOCK);
1688 if (!defined($clientfh)) {
1689 $errmsg = "failed to accept connection: $!\n";
1690 }
1691 }
1692 };
1693 warn $@ if $@;
1694
1695 flock($self->{lockfh}, Fcntl::LOCK_UN());
1696
1697 if (!defined($clientfh)) {
1698 return if $again;
1699 die $errmsg if $errmsg;
1700 }
1701
1702 fh_nonblocking $clientfh, 1;
1703
d8218001
DM
1704 return $clientfh;
1705}
1706
1707sub wait_end_loop {
1708 my ($self) = @_;
1709
1710 $self->{end_loop} = 1;
1711
1712 undef $self->{socket_watch};
1713
1714 $0 = "$0 (shutdown)" if $0 !~ m/\(shutdown\)$/;
1715
1716 if ($self->{conn_count} <= 0) {
1717 $self->{end_cond}->send(1);
1718 return;
1719 }
1720
1721 # fork and exit, so that parent starts a new worker
1722 if (fork()) {
1723 exit(0);
1724 }
1725
1726 # else we need to wait until all open connections gets closed
1727 my $w; $w = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1728 eval {
1729 # todo: test for active connections instead (we can abort idle connections)
1730 if ($self->{conn_count} <= 0) {
1731 undef $w;
1732 $self->{end_cond}->send(1);
1733 }
1734 };
1735 warn $@ if $@;
1736 });
1737}
1738
1739
1740sub check_host_access {
1741 my ($self, $clientip) = @_;
5f14e56e 1742
c6de5b3f 1743 $clientip = PVE::APIServer::Utils::normalize_v4_in_v6($clientip);
d8218001
DM
1744 my $cip = Net::IP->new($clientip);
1745
ebcaaf46
SI
1746 if (!$cip) {
1747 $self->dprint("client IP not parsable: $@");
1748 return 0;
1749 }
1750
d8218001
DM
1751 my $match_allow = 0;
1752 my $match_deny = 0;
1753
1754 if ($self->{allow_from}) {
1755 foreach my $t (@{$self->{allow_from}}) {
1756 if ($t->overlaps($cip)) {
1757 $match_allow = 1;
1e169242 1758 $self->dprint("client IP allowed: ". $t->prefix());
d8218001
DM
1759 last;
1760 }
1761 }
1762 }
1763
1764 if ($self->{deny_from}) {
1765 foreach my $t (@{$self->{deny_from}}) {
1766 if ($t->overlaps($cip)) {
1e169242 1767 $self->dprint("client IP denied: ". $t->prefix());
d8218001
DM
1768 $match_deny = 1;
1769 last;
1770 }
1771 }
1772 }
1773
1774 if ($match_allow == $match_deny) {
1775 # match both allow and deny, or no match
1776 return $self->{policy} && $self->{policy} eq 'allow' ? 1 : 0;
1777 }
1778
1779 return $match_allow;
1780}
1781
1782sub accept_connections {
1783 my ($self) = @_;
1784
ebcaaf46 1785 my ($clientfh, $handle_creation);
d8218001
DM
1786 eval {
1787
ebcaaf46 1788 while ($clientfh = $self->accept()) {
d8218001
DM
1789
1790 my $reqstate = { keep_alive => $self->{keep_alive} };
1791
1792 # stop keep-alive when there are many open connections
c82d1707 1793 if ($self->{conn_count} + 1 >= $self->{max_conn_soft_limit}) {
d8218001
DM
1794 $reqstate->{keep_alive} = 0;
1795 }
1796
1797 if (my $sin = getpeername($clientfh)) {
1798 my ($pfamily, $pport, $phost) = PVE::Tools::unpack_sockaddr_in46($sin);
1799 ($reqstate->{peer_port}, $reqstate->{peer_host}) = ($pport, Socket::inet_ntop($pfamily, $phost));
ebcaaf46 1800 } else {
1e169242 1801 $self->dprint("getpeername failed: $!");
ebcaaf46
SI
1802 close($clientfh);
1803 next;
d8218001
DM
1804 }
1805
1806 if (!$self->{trusted_env} && !$self->check_host_access($reqstate->{peer_host})) {
26e73e6b 1807 $self->dprint("ABORT request from $reqstate->{peer_host} - access denied");
d8218001
DM
1808 $reqstate->{log}->{code} = 403;
1809 $self->log_request($reqstate);
ebcaaf46 1810 close($clientfh);
d8218001
DM
1811 next;
1812 }
1813
c82d1707
SI
1814 # Increment conn_count before creating new handle, since creation
1815 # triggers callbacks, which can potentialy decrement (e.g.
1816 # on_error) conn_count before AnyEvent::Handle->new() returns.
1817 $handle_creation = 1;
1818 $self->{conn_count}++;
d8218001
DM
1819 $reqstate->{hdl} = AnyEvent::Handle->new(
1820 fh => $clientfh,
1821 rbuf_max => 64*1024,
1822 timeout => $self->{timeout},
1823 linger => 0, # avoid problems with ssh - really needed ?
1824 on_eof => sub {
1825 my ($hdl) = @_;
1826 eval {
1827 $self->log_aborted_request($reqstate);
1828 $self->client_do_disconnect($reqstate);
1829 };
1830 if (my $err = $@) { syslog('err', $err); }
1831 },
1832 on_error => sub {
1833 my ($hdl, $fatal, $message) = @_;
1834 eval {
1835 $self->log_aborted_request($reqstate, $message);
1836 $self->client_do_disconnect($reqstate);
1837 };
1838 if (my $err = $@) { syslog('err', "$err"); }
1839 },
933a4dbb 1840 );
c82d1707 1841 $handle_creation = 0;
d8218001 1842
26e73e6b 1843 $self->dprint("ACCEPT FH" . $clientfh->fileno() . " CONN$self->{conn_count}");
d8218001 1844
933a4dbb
MC
1845 if ($self->{tls_ctx}) {
1846 $self->dprint("Setting TLS to autostart");
1847 $reqstate->{hdl}->unshift_read(tls_autostart => $self->{tls_ctx}, "accept");
1848 }
1849
d8218001
DM
1850 $self->push_request_header($reqstate);
1851 }
1852 };
1853
1854 if (my $err = $@) {
1855 syslog('err', $err);
1e169242 1856 $self->dprint("connection accept error: $err");
ebcaaf46 1857 close($clientfh);
c82d1707
SI
1858 if ($handle_creation) {
1859 if ($self->{conn_count} <= 0) {
1860 warn "connection count <= 0 not decrementing!\n";
1861 } else {
1862 $self->{conn_count}--;
1863 }
1864 }
d8218001
DM
1865 $self->{end_loop} = 1;
1866 }
1867
1868 $self->wait_end_loop() if $self->{end_loop};
1869}
1870
1871# Note: We can't open log file in non-blocking mode and use AnyEvent::Handle,
1872# because we write from multiple processes, and that would arbitrarily mix output
1873# of all processes.
1874sub open_access_log {
1875 my ($self, $filename) = @_;
1876
1877 my $old_mask = umask(0137);;
1878 my $logfh = IO::File->new($filename, ">>") ||
1879 die "unable to open log file '$filename' - $!\n";
1880 umask($old_mask);
1881
1882 $logfh->autoflush(1);
1883
1884 $self->{logfh} = $logfh;
1885}
1886
1887sub write_log {
1888 my ($self, $data) = @_;
1889
1890 return if !defined($self->{logfh}) || !$data;
1891
1892 my $res = $self->{logfh}->print($data);
1893
1894 if (!$res) {
1895 delete $self->{logfh};
1896 syslog('err', "error writing access log");
1897 $self->{end_loop} = 1; # terminate asap
1898 }
1899}
1900
1901sub atfork_handler {
1902 my ($self) = @_;
1903
1904 eval {
1905 # something else do to ?
1906 close($self->{socket});
1907 };
1908 warn $@ if $@;
1909}
1910
fbc42b33
DM
1911sub run {
1912 my ($self) = @_;
1913
1914 $self->{end_cond}->recv;
1915}
1916
d8218001
DM
1917sub new {
1918 my ($this, %args) = @_;
1919
1920 my $class = ref($this) || $this;
1921
af76fd78 1922 foreach my $req (qw(socket lockfh lockfile)) {
d8218001
DM
1923 die "misssing required argument '$req'" if !defined($args{$req});
1924 }
1925
1926 my $self = bless { %args }, $class;
1927
1928 $self->{cookie_name} //= 'PVEAuthCookie';
362dd8eb 1929 $self->{apitoken_name} //= 'PVEAPIToken';
d8218001 1930 $self->{base_uri} //= "/api2";
911ede9b 1931 $self->{dirs} //= {};
fc87cd5e 1932 $self->{title} //= 'API Inspector';
23dfd1b7 1933 $self->{compression} //= 1;
d8218001 1934
ca304f91
DM
1935 # formatter_config: we pass some configuration values to the Formatter
1936 $self->{formatter_config} = {};
362dd8eb 1937 foreach my $p (qw(apitoken_name cookie_name base_uri title)) {
ca304f91
DM
1938 $self->{formatter_config}->{$p} = $self->{$p};
1939 }
1940 $self->{formatter_config}->{csrfgen_func} =
1941 $self->can('generate_csrf_prevention_token');
1942
1943 # add default dirs which includes jquery and bootstrap
e52d9400
TL
1944 my $jsbase = '/usr/share/javascript';
1945 add_dirs($self->{dirs}, '/js/' => "$jsbase/");
1946 # libjs-bootstrap uses symlinks for this, which we do not want to allow..
1947 my $glyphicons = '/usr/share/fonts/truetype/glyphicons/';
1948 add_dirs($self->{dirs}, '/js/bootstrap/fonts/' => "$glyphicons");
6edb39f6 1949
d8218001
DM
1950 # init inotify
1951 PVE::INotify::inotify_init();
1952
d8218001
DM
1953 fh_nonblocking($self->{socket}, 1);
1954
1955 $self->{end_loop} = 0;
1956 $self->{conn_count} = 0;
1957 $self->{request_count} = 0;
1958 $self->{timeout} = 5 if !$self->{timeout};
1959 $self->{keep_alive} = 0 if !defined($self->{keep_alive});
1960 $self->{max_conn} = 800 if !$self->{max_conn};
1961 $self->{max_requests} = 8000 if !$self->{max_requests};
1962
1963 $self->{policy} = 'allow' if !$self->{policy};
1964
1965 $self->{end_cond} = AnyEvent->condvar;
1966
1967 if ($self->{ssl}) {
fac83ab2
SI
1968 my $ssl_defaults = {
1969 # Note: older versions are considered insecure, for example
1970 # search for "Poodle"-Attack
1971 method => 'any',
1972 sslv2 => 0,
1973 sslv3 => 0,
1974 cipher_list => 'ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256',
1975 honor_cipher_order => 1,
1976 };
1977
95fde1f7
FG
1978 # workaround until anyevent supports TLS 1.3 ciphersuites directly
1979 my $ciphersuites = delete $self->{ssl}->{ciphersuites};
1980
fac83ab2
SI
1981 foreach my $k (keys %$ssl_defaults) {
1982 $self->{ssl}->{$k} //= $ssl_defaults->{$k};
1983 }
1984
1985 if (!defined($self->{ssl}->{dh_file})) {
1986 $self->{ssl}->{dh} = 'skip2048';
1987 }
1988
7599c478
TL
1989 my $tls_ctx_flags = 0;
1990 $tls_ctx_flags |= &Net::SSLeay::OP_NO_COMPRESSION;
1991 $tls_ctx_flags |= &Net::SSLeay::OP_SINGLE_ECDH_USE;
1992 $tls_ctx_flags |= &Net::SSLeay::OP_SINGLE_DH_USE;
1993 $tls_ctx_flags |= &Net::SSLeay::OP_NO_RENEGOTIATION;
1994 if (delete $self->{ssl}->{honor_cipher_order}) {
54c0ead9
SI
1995 $tls_ctx_flags |= &Net::SSLeay::OP_CIPHER_SERVER_PREFERENCE;
1996 }
e9022485
FG
1997 # workaround until anyevent supports disabling TLS 1.3 directly
1998 if (exists($self->{ssl}->{tlsv1_3}) && !$self->{ssl}->{tlsv1_3}) {
1999 $tls_ctx_flags |= &Net::SSLeay::OP_NO_TLSv1_3;
2000 }
2001
54c0ead9 2002
d8218001 2003 $self->{tls_ctx} = AnyEvent::TLS->new(%{$self->{ssl}});
54c0ead9 2004 Net::SSLeay::CTX_set_options($self->{tls_ctx}->{ctx}, $tls_ctx_flags);
34f20af2
FG
2005 if (defined($ciphersuites)) {
2006 warn "Failed to set TLS 1.3 ciphersuites '$ciphersuites'\n"
2007 if !Net::SSLeay::CTX_set_ciphersuites($self->{tls_ctx}->{ctx}, $ciphersuites);
2008 }
d8218001
DM
2009 }
2010
2011 if ($self->{spiceproxy}) {
2012 $known_methods = { CONNECT => 1 };
2013 }
2014
2015 $self->open_access_log($self->{logfile}) if $self->{logfile};
2016
2017 $self->{max_conn_soft_limit} = $self->{max_conn} > 100 ? $self->{max_conn} - 20 : $self->{max_conn};
2018
2019 $self->{socket_watch} = AnyEvent->io(fh => $self->{socket}, poll => 'r', cb => sub {
2020 eval {
2021 if ($self->{conn_count} >= $self->{max_conn}) {
2022 my $w; $w = AnyEvent->timer (after => 1, interval => 1, cb => sub {
2023 if ($self->{conn_count} < $self->{max_conn}) {
2024 undef $w;
2025 $self->accept_connections();
2026 }
2027 });
2028 } else {
2029 $self->accept_connections();
2030 }
2031 };
2032 warn $@ if $@;
2033 });
2034
2035 $self->{term_watch} = AnyEvent->signal(signal => "TERM", cb => sub {
2036 undef $self->{term_watch};
2037 $self->wait_end_loop();
2038 });
2039
2040 $self->{quit_watch} = AnyEvent->signal(signal => "QUIT", cb => sub {
2041 undef $self->{quit_watch};
2042 $self->wait_end_loop();
2043 });
2044
2045 $self->{inotify_poll} = AnyEvent->timer(after => 5, interval => 5, cb => sub {
2046 PVE::INotify::poll(); # read inotify events
2047 });
2048
2049 return $self;
2050}
2051
911ede9b
DM
2052# static helper to add directory including all subdirs
2053# This can be used to setup $self->{dirs}
2054sub add_dirs {
2055 my ($result_hash, $alias, $subdir) = @_;
2056
2057 $result_hash->{$alias} = $subdir;
2058
2059 my $wanted = sub {
2060 my $dir = $File::Find::dir;
2061 if ($dir =~m!^$subdir(.*)$!) {
2062 my $name = "$alias$1/";
2063 $result_hash->{$name} = "$dir/";
2064 }
2065 };
2066
2067 find({wanted => $wanted, follow => 0, no_chdir => 1}, $subdir);
2068}
2069
fbc42b33
DM
2070# abstract functions - subclass should overwrite/implement them
2071
403964f2
DM
2072sub verify_spice_connect_url {
2073 my ($self, $connect_str) = @_;
2074
2075 die "implement me";
2076
2077 #return ($vmid, $node, $port);
2078}
2079
a3bb6070
DM
2080# formatters can call this when the generate a new page
2081sub generate_csrf_prevention_token {
2082 my ($username) = @_;
2083
2084 return undef; # do nothing by default
2085}
2086
d8218001 2087sub auth_handler {
362dd8eb 2088 my ($self, $method, $rel_uri, $ticket, $token, $api_token, $peer_host) = @_;
d8218001 2089
b639f458 2090 die "implement me";
d8218001 2091
b639f458
DM
2092 # return {
2093 # ticket => $ticket,
2094 # token => $token,
2095 # userid => $username,
2096 # age => $age,
2097 # isUpload => $isUpload,
362dd8eb 2098 # api_token => $api_token,
b639f458 2099 #};
d8218001
DM
2100}
2101
d8218001 2102sub rest_handler {
66a7a3a3 2103 my ($self, $clientip, $method, $rel_uri, $auth, $params, $format) = @_;
d8218001 2104
c5f0a96f
DM
2105 # please do not raise exceptions here (always return a result).
2106
b639f458
DM
2107 return {
2108 status => HTTP_NOT_IMPLEMENTED,
2109 message => "Method '$method $rel_uri' not implemented",
d8218001 2110 };
c5f0a96f
DM
2111
2112 # this should return the following properties, which
2113 # are then passed to the Formatter
2114
2115 # status: HTTP status code
2116 # message: Error message
2117 # errors: more detailed error hash (per parameter)
2118 # info: reference to JSON schema definition - useful to format output
2119 # data: result data
2120
2121 # total: additional info passed to output
2122 # changes: additional info passed to output
2123
2124 # if you want to proxy the request to another node return this
2125 # { proxy => $remip, proxynode => $node, proxy_params => $params };
2126
2127 # to pass the request to the local priviledged daemon use:
2128 # { proxy => 'localhost' , proxy_params => $params };
20a61215
DM
2129
2130 # to download aspecific file use:
2131 # { download => "/path/to/file" };
d8218001
DM
2132}
2133
2134sub check_cert_fingerprint {
2135 my ($self, $cert) = @_;
2136
b639f458
DM
2137 die "implement me";
2138 }
d8218001
DM
2139
2140sub initialize_cert_cache {
2141 my ($self, $node) = @_;
2142
b639f458 2143 die "implement me";
d8218001
DM
2144}
2145
2146sub remote_node_ip {
2147 my ($self, $node) = @_;
2148
b639f458 2149 die "implement me";
d8218001 2150
b639f458 2151 # return $remip;
d8218001
DM
2152}
2153
d8218001
DM
2154
21551;