1 package PVE
::APIServer
::AnyEvent
;
3 # Note 1: interactions with Crypt::OpenSSL::RSA
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();
17 # use AnyEvent::Strict; # only use this for debugging
19 use AnyEvent
::Util
qw(guard fh_nonblocking WSAEWOULDBLOCK WSAEINPROGRESS);
32 use POSIX
qw(strftime EINTR EAGAIN);
33 use Socket
qw(IPPROTO_TCP TCP_NODELAY SOMAXCONN);
34 use Time
::HiRes
qw(usleep ualarm gettimeofday tv_interval);
36 #use Data::Dumper; # FIXME: remove, just use: print to_json([$var], {pretty => 1}) ."\n";
41 use HTTP
::Status
qw(:constants);
49 use PVE
::Tools
qw(trim);
51 use PVE
::APIServer
::Formatter
;
52 use PVE
::APIServer
::Utils
;
54 my $limit_max_headers = 64;
55 my $limit_max_header_size = 8*1024;
56 my $limit_max_post = 64*1024;
65 my $split_abs_uri = sub {
66 my ($abs_uri, $base_uri) = @_;
68 my ($format, $rel_uri) = $abs_uri =~ m/^\Q$base_uri\E\/+([a-z
][a-z0-9
]+)(\
/.*)?$/;
69 $rel_uri = '/' if !$rel_uri;
71 return wantarray ?
($rel_uri, $format) : $rel_uri;
75 my ($self, $message) = @_;
77 return if !$self->{debug
};
79 my ($pkg, $pkgfile, $line, $sub) = caller(1);
80 $sub =~ s/^(?:.+::)+//;
81 print "worker[$$]: $pkg +$line: $sub: $message\n";
85 my ($self, $reqstate) = @_;
87 my $loginfo = $reqstate->{log};
89 # like apache2 common log format
90 # LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\""
92 return if $loginfo->{written
}; # avoid duplicate logs
93 $loginfo->{written
} = 1;
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
} || '-';
100 my $timestr = strftime
("%d/%m/%Y:%H:%M:%S %z", localtime());
102 my $msg = "$peerip - $userid [$timestr] \"$requestline\" $code $content_length\n";
104 $self->write_log($msg);
107 sub log_aborted_request {
108 my ($self, $reqstate, $error) = @_;
110 my $r = $reqstate->{request};
111 return if !$r; # no active request
114 syslog("err
", "problem with client
$reqstate->{peer_host
}; $error");
117 $self->log_request($reqstate);
120 sub cleanup_reqstate {
121 my ($reqstate, $deletetmpfile) = @_;
123 delete $reqstate->{log};
124 delete $reqstate->{request};
125 delete $reqstate->{proto};
126 delete $reqstate->{accept_gzip};
127 delete $reqstate->{starttime};
129 if ($reqstate->{tmpfilename}) {
130 unlink $reqstate->{tmpfilename} if $deletetmpfile;
131 delete $reqstate->{tmpfilename};
135 sub client_do_disconnect {
136 my ($self, $reqstate) = @_;
138 cleanup_reqstate($reqstate, 1);
140 my $shutdown_hdl = sub {
143 shutdown($hdl->{fh}, 1);
145 $hdl->on_drain(undef);
146 $hdl->on_read(undef);
150 if (my $proxyhdl = delete $reqstate->{proxyhdl}) {
151 &$shutdown_hdl($proxyhdl)
152 if !$proxyhdl->{block_disconnect};
155 my $hdl = delete $reqstate->{hdl};
158 syslog('err', "detected empty handle
");
162 $self->dprint("close connection
$hdl");
164 &$shutdown_hdl($hdl);
166 warn "connection count
<= 0!\n" if $self->{conn_count} <= 0;
168 $self->{conn_count}--;
170 $self->dprint("CLOSE FH
" . $hdl->{fh}->fileno() . " CONN
$self->{conn_count
}");
173 sub finish_response {
174 my ($self, $reqstate) = @_;
176 cleanup_reqstate($reqstate, 0);
178 my $hdl = $reqstate->{hdl};
179 return if !$hdl; # already disconnected
181 if (!$self->{end_loop} && $reqstate->{keep_alive} > 0) {
182 # print "KEEPALIVE
$reqstate->{keep_alive
}\n" if $self->{debug};
184 eval { $self->push_request_header($reqstate); };
188 $hdl->on_drain (sub {
190 $self->client_do_disconnect($reqstate);
197 sub response_stream {
198 my ($self, $reqstate, $stream_fh) = @_;
200 # disable timeout, we don't know how big the data is
201 $reqstate->{hdl}->timeout(0);
203 my $buf_size = 4*1024*1024;
208 my $reqhdl = $reqstate->{hdl};
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;
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
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
237 my $prev_on_drain = $reqhdl->{on_drain};
238 $reqhdl->on_drain(sub {
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);
250 $reqstate->{proxyhdl} = AnyEvent::Handle->new(
252 rbuf_max => $buf_size,
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;
263 $reqhdl->push_shutdown();
264 $self->finish_response($reqstate);
267 if (my $err = $@) { syslog('err', "$err"); }
271 my ($hdl, $fatal, $message) = @_;
273 $self->log_aborted_request($reqstate, $message);
274 $self->client_do_disconnect($reqstate);
276 if (my $err = $@) { syslog('err', "$err"); }
283 my ($self, $reqstate, $resp, $mtime, $nocomp, $delay, $stream_fh) = @_;
285 #print "$$: send response
: " . Dumper($resp);
288 $reqstate->{hdl}->timeout_reset();
289 $reqstate->{hdl}->timeout($self->{timeout});
291 $nocomp = 1 if !$self->{compression};
292 $nocomp = 1 if !$reqstate->{accept_gzip};
294 my $code = $resp->code;
295 my $msg = $resp->message || HTTP::Status::status_message($code);
296 my $content = $resp->content;
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);
306 if ($code =~ /^(1\d\d|[23]04)$/) {
307 # make sure informational, no content and not modified response send no content
311 $reqstate->{keep_alive} = 0 if ($code >= 400) || $self->{end_loop};
313 $reqstate->{log}->{code} = $code;
315 my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.0';
316 my $res = "$proto $code $msg\015\012";
319 my $date = HTTP::Date::time2str($ctime);
320 $resp->header('Date' => $date);
322 $resp->header('Last-Modified' => HTTP::Date::time2str($mtime));
324 $resp->header('Expires' => $date);
325 $resp->header('Cache-Control' => "max-age
=0");
326 $resp->header("Pragma
", "no-cache
");
329 $resp->header('Server' => "pve-api-daemon
/3.0");
332 if ($content && !$stream_fh) {
334 $content_length = length($content);
336 if (!$nocomp && ($content_length > 1024)) {
337 my $comp = Compress::Zlib::memGzip($content);
338 $resp->header('Content-Encoding', 'gzip');
340 $content_length = length($content);
342 $resp->header("Content-Length
" => $content_length);
343 $reqstate->{log}->{content_length} = $content_length;
346 $resp->remove_header("Content-Length
");
349 if ($reqstate->{keep_alive} > 0) {
350 $resp->push_header('Connection' => 'Keep-Alive');
352 $resp->header('Connection' => 'close');
355 $res .= $resp->headers_as_string("\015\012");
356 #print "SEND
(without content
) $res\n" if $self->{debug};
359 $res .= $content if $content && !$stream_fh;
361 $self->log_request($reqstate, $reqstate->{request});
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) {
369 my $w; $w = AnyEvent->timer(after => $delay, cb => sub {
370 undef $w; # delete reference
371 return if !$reqstate->{hdl}; # already disconnected
372 $reqstate->{hdl}->push_write($res);
373 $self->finish_response($reqstate);
376 $reqstate->{hdl}->push_write($res);
377 $self->finish_response($reqstate);
382 my ($self, $reqstate, $code, $msg, $hdr, $content) = @_;
385 my $resp = HTTP::Response->new($code, $msg, $hdr, $content);
386 $self->response($reqstate, $resp);
391 my $file_extension_info = {
392 css => { ct => 'text/css' },
393 html => { ct => 'text/html' },
394 js => { ct => 'application/javascript' },
395 json => { ct => 'application/json' },
396 map => { ct => 'application/json' },
397 png => { ct => 'image/png' , nocomp => 1 },
398 ico => { ct => 'image/x-icon', nocomp => 1},
399 gif => { ct => 'image/gif', nocomp => 1},
400 svg => { ct => 'image/svg+xml' },
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},
407 mp3 => { ct => 'audio/mpeg', nocomp => 1},
408 oga => { ct => 'audio/ogg', nocomp => 1},
409 tgz => { ct => 'application/x-compressed-tar', nocomp => 1},
412 sub send_file_start {
413 my ($self, $reqstate, $download) = @_;
416 # print "SEND FILE
$filename\n";
417 # Note: aio_load() this is not really async unless we use IO::AIO!
420 my $r = $reqstate->{request};
426 if (ref($download) eq 'HASH') {
427 $mime = $download->{'content-type'};
428 my $encoding = $download->{'content-encoding'};
429 my $disposition = $download->{'content-disposition'};
431 if ($download->{path} && $download->{stream} &&
432 $reqstate->{request}->header('PVEDisableProxy'))
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,
441 $header->header('Content-Encoding' => $encoding) if defined($encoding);
442 $header->header('Content-Disposition' => $disposition) if defined($disposition);
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);
450 if (!($fh = $download->{fh})) {
451 my $path = $download->{path};
452 die "internal error
: {download
} returned but neither fh
not path
given\n"
454 sysopen($fh, "$path", O_NONBLOCK | O_RDONLY)
455 or die "open stream path
'$path' for reading failed
: $!\n";
458 if ($download->{stream}) {
459 my $header = HTTP::Headers->new(Content_Type => $mime);
460 $header->header('Content-Encoding' => $encoding) if defined($encoding);
461 $header->header('Content-Disposition' => $disposition) if defined($disposition);
462 my $resp = HTTP::Response->new(200, "OK
", $header);
463 $self->response($reqstate, $resp, undef, 1, 0, $fh);
467 my $filename = $download;
468 $fh = IO::File->new($filename, '<') ||
469 die "unable to
open file
'$filename' - $!\n";
471 my ($ext) = $filename =~ m/\.([^.]*)$/;
472 my $ext_info = $file_extension_info->{$ext};
474 die "unable to detect content type
" if !$ext_info;
475 $mime = $ext_info->{ct};
476 $nocomp = $ext_info->{nocomp};
479 my $stat = File::stat::stat($fh) ||
482 my $mtime = $stat->mtime;
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);
494 my $len = sysread($fh, $data, $stat->size);
495 die "got short file
\n" if !defined($len) || $len != $stat->size;
497 my $header = HTTP::Headers->new(Content_Type => $mime);
498 my $resp = HTTP::Response->new(200, "OK
", $header, $data);
499 $self->response($reqstate, $resp, $mtime, $nocomp);
502 $self->error($reqstate, 501, $err);
509 sub websocket_proxy {
510 my ($self, $reqstate, $wsaccept, $wsproto, $param) = @_;
516 my $max_payload_size = 128*1024;
518 if ($param->{port}) {
519 $remhost = 'localhost';
520 $remport = $param->{port};
521 } elsif ($param->{socket}) {
523 $remport = $param->{socket};
525 die "websocket_proxy
: missing port
or socket\n";
529 my ($data, $opcode) = @_;
534 $string = $opcode ? $opcode : "\x82"; # binary frame
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;
544 $string .= pack 'C', 127;
545 $string .= pack 'Q>', $payload_len;
551 tcp_connect $remhost, $remport, sub {
553 or die "connect to
'$remhost:$remport' failed
: $!";
555 $self->dprint("CONNECTed to
'$remhost:$remport'");
557 $reqstate->{proxyhdl} = AnyEvent::Handle->new(
559 rbuf_max => $max_payload_size,
560 wbuf_max => $max_payload_size*5,
565 $self->log_aborted_request($reqstate);
566 $self->client_do_disconnect($reqstate);
568 if (my $err = $@) { syslog('err', $err); }
571 my ($hdl, $fatal, $message) = @_;
573 $self->log_aborted_request($reqstate, $message);
574 $self->client_do_disconnect($reqstate);
576 if (my $err = $@) { syslog('err', "$err"); }
579 my $proxyhdlreader = sub {
582 my $len = length($hdl->{rbuf});
583 my $data = substr($hdl->{rbuf}, 0, $len > $max_payload_size ? $max_payload_size : $len, '');
585 my $string = $encode->(\$data);
587 $reqstate->{hdl}->push_write($string) if $reqstate->{hdl};
590 my $hdlreader = sub {
593 while (my $len = length($hdl->{rbuf})) {
596 my $hdr = unpack('C', substr($hdl->{rbuf}, 0, 1));
597 my $opcode = $hdr & 0b00001111;
598 my $fin = $hdr & 0b10000000;
600 die "received fragmented websocket frame
\n" if !$fin;
602 my $rsv = $hdr & 0b01110000;
603 die "received websocket frame with RSV flags
\n" if $rsv;
605 my $payload_len = unpack 'C', substr($hdl->{rbuf}, 1, 1);
607 my $masked = $payload_len & 0b10000000;
608 die "received unmasked websocket frame from client
\n" if !$masked;
611 $payload_len = $payload_len & 0b01111111;
612 if ($payload_len == 126) {
614 $payload_len = unpack('n', substr($hdl->{rbuf}, $offset, 2));
616 } elsif ($payload_len == 127) {
618 $payload_len = unpack('Q>', substr($hdl->{rbuf}, $offset, 8));
622 die "received too large websocket frame
(len
= $payload_len)\n"
623 if ($payload_len > $max_payload_size) || ($payload_len < 0);
625 return if $len < ($offset + 4 + $payload_len);
627 my $data = substr($hdl->{rbuf}, 0, $offset + 4 + $payload_len, ''); # now consume data
629 my $mask = substr($data, $offset, 4);
632 my $payload = substr($data, $offset, $payload_len);
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) = "";
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);
648 $self->dprint("websocket received
close. status code
: '$statuscode'");
649 if (my $proxyhdl = $reqstate->{proxyhdl}) {
650 $proxyhdl->{block_disconnect} = 1 if length $proxyhdl->{wbuf};
652 $proxyhdl->push_shutdown();
654 $hdl->push_shutdown();
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
661 die "received unhandled websocket opcode
$opcode\n";
666 my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.1';
668 $reqstate->{proxyhdl}->timeout(0);
669 $reqstate->{proxyhdl}->on_read($proxyhdlreader);
670 $reqstate->{hdl}->on_read($hdlreader);
672 # todo: use stop_read/start_read if write buffer grows to much
674 # FIXME: remove protocol in PVE/PMG 8.x
676 # for backwards, compatibility, we have to reply with the websocket
677 # subprotocol from the request
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" .
682 ($wsproto ne "" ? "Sec-WebSocket-Protocol
: $wsproto\015\012" : "") .
687 $reqstate->{hdl}->push_write($res);
690 $reqstate->{log}->{code} = 101;
691 $self->log_request($reqstate);
697 $self->log_aborted_request($reqstate, $err);
698 $self->client_do_disconnect($reqstate);
703 my ($self, $reqstate, $clientip, $host, $node, $method, $uri, $auth, $params) = @_;
709 # stringify URI object and verify it starts with a slash
712 $self->error($reqstate, 400, "invalid proxy uri
");
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)
721 $may_stream_file = 1;
722 } elsif (Net::IP::ip_is_ipv6($host)) {
723 $target = "https
://[$host]:8006$uri";
725 $target = "https
://$host:8006$uri";
729 PVEDisableProxy => 'true',
730 PVEClientIP => $clientip,
733 $headers->{'cookie'} = PVE::APIServer::Formatter::create_auth_cookie($auth->{ticket}, $self->{cookie_name})
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}
739 $headers->{'Accept-Encoding'} = 'gzip' if ($reqstate->{accept_gzip} && $self->{compression});
741 if (defined(my $host = $reqstate->{request}->header('Host'))) {
742 $headers->{Host} = $host;
747 if ($method eq 'POST' || $method eq 'PUT') {
748 $headers->{'Content-Type'} = 'application/x-www-form-urlencoded';
749 # use URI object to format application/x-www-form-urlencoded content.
750 my $url = URI->new('http:');
751 $url->query_form(%$params);
752 $content = $url->query;
753 if (defined($content)) {
754 $headers->{'Content-Length'} = length($content);
759 # TLS 1.x only, with certificate pinning
765 my (undef, undef, undef, $depth, undef, undef, $cert) = @_;
766 # we don't care about intermediate or root certificates
767 return 1 if $depth != 0;
768 # check server certificate against cache of pinned FPs
769 return $self->check_cert_fingerprint($cert);
773 # load and cache cert fingerprint if first time we proxy to this node
774 $self->initialize_cert_cache($node);
776 my $w; $w = http_request(
781 proxy => undef, # avoid use of $ENV{HTTP_PROXY}
782 keepalive => $keep_alive,
784 tls_ctx => AnyEvent::TLS->new(%{$tls}),
786 my ($body, $hdr) = @_;
790 if (!$reqstate->{hdl}) {
791 warn "proxy detected vanished client connection
\n";
796 my $code = delete $hdr->{Status};
797 my $msg = delete $hdr->{Reason};
798 my $stream = delete $hdr->{pvestreamfile};
800 delete $hdr->{HTTPVersion};
801 my $header = HTTP::Headers->new(%$hdr);
802 if (my $location = $header->header('Location')) {
803 $location =~ s|^http://localhost:85||;
804 $header->header(Location => $location);
807 if (!$may_stream_file) {
808 $self->error($reqstate, 403, 'streaming denied');
811 sysopen(my $fh, "$stream", O_NONBLOCK | O_RDONLY)
812 or die "open stream path
'$stream' for forwarding failed
: $!\n";
813 my $resp = HTTP::Response->new($code, $msg, $header, undef);
814 $self->response($reqstate, $resp, undef, 1, 0, $fh);
816 my $resp = HTTP::Response->new($code, $msg, $header, $body);
817 # Note: disable compression, because body is already compressed
818 $self->response($reqstate, $resp, undef, 1);
827 # return arrays as \0 separated strings (like CGI.pm)
828 # assume data is UTF8 encoded
829 sub decode_urlencoded {
834 return $res if !$data;
836 foreach my $kv (split(/[\&\;]/, $data)) {
837 my ($k, $v) = split(/=/, $kv);
839 $k =~ s/%([0-9a-fA-F][0-9a-fA-F])/chr(hex($1))/eg;
843 $v =~ s/%([0-9a-fA-F][0-9a-fA-F])/chr(hex($1))/eg;
845 $v = Encode::decode('utf8', $v);
847 if (defined(my $old = $res->{$k})) {
858 my ($r, $method) = @_;
862 if ($method eq 'PUT' || $method eq 'POST') {
864 if (my $ctype = $r->header('Content-Type')) {
865 $ct = parse_content_type($ctype);
867 if (defined($ct) && $ct eq 'application/json') {
868 $params = decode_json($r->content);
870 $params = decode_urlencoded($r->content);
874 my $query_params = decode_urlencoded($r->url->query());
876 foreach my $k (keys %{$query_params}) {
877 $params->{$k} = $query_params->{$k};
883 sub handle_api2_request {
884 my ($self, $reqstate, $auth, $method, $path, $upload_state) = @_;
887 my $r = $reqstate->{request};
889 my ($rel_uri, $format) = &$split_abs_uri($path, $self->{base_uri});
891 my $formatter = PVE::APIServer::Formatter::get_formatter($format, $method, $rel_uri);
893 if (!defined($formatter)) {
894 $self->error($reqstate, HTTP_NOT_IMPLEMENTED, "no formatter
for uri
$rel_uri, $format");
898 #print Dumper($upload_state) if $upload_state;
903 $params = $upload_state->{params};
905 $params = extract_params($r, $method);
908 delete $params->{_dc} if $params; # remove disable cache parameter
910 my $clientip = $reqstate->{peer_host};
912 my $res = $self->rest_handler($clientip, $method, $rel_uri, $auth, $params, $format);
915 Net::SSLeay::ERR_clear_error();
917 AnyEvent->now_update(); # in case somebody called sleep()
919 my $upgrade = $r->header('upgrade');
920 $upgrade = lc($upgrade) if $upgrade;
922 if (my $host = $res->{proxy}) {
924 if ($self->{trusted_env}) {
925 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy
not allowed
");
929 if ($host ne 'localhost' && $r->header('PVEDisableProxy')) {
930 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy
loop detected
");
934 $res->{proxy_params}->{tmpfilename} = $reqstate->{tmpfilename} if $upload_state;
936 $self->proxy_request($reqstate, $clientip, $host, $res->{proxynode}, $method,
937 $r->uri, $auth, $res->{proxy_params});
940 } elsif ($upgrade && ($method eq 'GET') && ($path =~ m|websocket$|)) {
941 die "unable to upgrade to protocol
'$upgrade'\n" if !$upgrade || ($upgrade ne 'websocket');
942 my $wsver = $r->header('sec-websocket-version');
943 die "unsupported websocket-version
'$wsver'\n" if !$wsver || ($wsver ne '13');
944 my $wsproto = $r->header('sec-websocket-protocol') // "";
945 my $wskey = $r->header('sec-websocket-key');
946 die "missing websocket-key
\n" if !$wskey;
947 # Note: Digest::SHA::sha1_base64 has wrong padding
948 my $wsaccept = Digest::SHA::sha1_base64("${wskey
}258EAFA5-E914-47DA-95CA-C5AB0DC85B11
") . "=";
949 if ($res->{status} == HTTP_OK) {
950 $self->websocket_proxy($reqstate, $wsaccept, $wsproto, $res->{data});
956 if ($res->{status} == HTTP_UNAUTHORIZED) {
957 # always delay unauthorized calls by 3 seconds
958 $delay = 3 - tv_interval($reqstate->{starttime});
959 $delay = 0 if $delay < 0;
962 my $download = $res->{download};
963 $download //= $res->{data}->{download}
964 if defined($res->{data}) && ref($res->{data}) eq 'HASH';
965 if (defined($download)) {
966 send_file_start($self, $reqstate, $download);
970 my ($raw, $ct, $nocomp) = $formatter->($res, $res->{data}, $params, $path,
971 $auth, $self->{formatter_config});
974 if (ref($raw) && (ref($raw) eq 'HTTP::Response')) {
977 $resp = HTTP::Response->new($res->{status}, $res->{message});
978 $resp->header("Content-Type
" => $ct);
979 $resp->content($raw);
981 $self->response($reqstate, $resp, undef, $nocomp, $delay);
984 $self->error($reqstate, 501, $err);
988 sub handle_spice_proxy_request {
989 my ($self, $reqstate, $connect_str, $vmid, $node, $spiceport) = @_;
993 my ($minport, $maxport) = PVE::Tools::spice_port_range();
994 if ($spiceport < $minport || $spiceport > $maxport) {
995 die "SPICE Port
$spiceport is not in allowed range
($minport, $maxport)\n";
998 my $clientip = $reqstate->{peer_host};
999 my $r = $reqstate->{request};
1003 if ($node ne 'localhost' && PVE::INotify::nodename() !~ m/^$node$/i) {
1004 $remip = $self->remote_node_ip($node);
1005 $self->dprint("REMOTE CONNECT
$vmid, $remip, $connect_str");
1007 $self->dprint("CONNECT
$vmid, $node, $spiceport");
1010 if ($remip && $r->header('PVEDisableProxy')) {
1011 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy
loop detected
");
1015 $reqstate->{hdl}->timeout(0);
1016 $reqstate->{hdl}->wbuf_max(64*10*1024);
1018 my $remhost = $remip ? $remip : "localhost
";
1019 my $remport = $remip ? 3128 : $spiceport;
1021 tcp_connect $remhost, $remport, sub {
1023 or die "connect to
'$remhost:$remport' failed
: $!";
1025 $self->dprint("CONNECTed to
'$remhost:$remport'");
1026 $reqstate->{proxyhdl} = AnyEvent::Handle->new(
1028 rbuf_max => 64*1024,
1029 wbuf_max => 64*10*1024,
1034 $self->log_aborted_request($reqstate);
1035 $self->client_do_disconnect($reqstate);
1037 if (my $err = $@) { syslog('err', $err); }
1040 my ($hdl, $fatal, $message) = @_;
1042 $self->log_aborted_request($reqstate, $message);
1043 $self->client_do_disconnect($reqstate);
1045 if (my $err = $@) { syslog('err', "$err"); }
1049 my $proxyhdlreader = sub {
1052 my $len = length($hdl->{rbuf});
1053 my $data = substr($hdl->{rbuf}, 0, $len, '');
1055 #print "READ1
$len\n";
1056 $reqstate->{hdl}->push_write($data) if $reqstate->{hdl};
1059 my $hdlreader = sub {
1062 my $len = length($hdl->{rbuf});
1063 my $data = substr($hdl->{rbuf}, 0, $len, '');
1065 #print "READ0
$len\n";
1066 $reqstate->{proxyhdl}->push_write($data) if $reqstate->{proxyhdl};
1069 my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.0';
1071 my $startproxy = sub {
1072 $reqstate->{proxyhdl}->timeout(0);
1073 $reqstate->{proxyhdl}->on_read($proxyhdlreader);
1074 $reqstate->{hdl}->on_read($hdlreader);
1076 # todo: use stop_read/start_read if write buffer grows to much
1078 # a response must be followed by an empty line
1079 my $res = "$proto 200 OK
\015\012\015\012";
1080 $reqstate->{hdl}->push_write($res);
1083 $reqstate->{log}->{code} = 200;
1084 $self->log_request($reqstate);
1088 my $header = "CONNECT
${connect_str
} $proto\015\012" .
1089 "Host
: ${connect_str
}\015\012" .
1090 "Proxy-Connection
: keep-alive
\015\012" .
1091 "User-Agent
: spiceproxy
\015\012" .
1092 "PVEDisableProxy
: true
\015\012" .
1093 "PVEClientIP
: $clientip\015\012" .
1096 $reqstate->{proxyhdl}->push_write($header);
1097 $reqstate->{proxyhdl}->push_read(line => sub {
1098 my ($hdl, $line) = @_;
1100 if ($line =~ m!^$proto 200 OK$!) {
1101 # read the empty line after the 200 OK
1102 $reqstate->{proxyhdl}->unshift_read(line => sub{
1106 $reqstate->{hdl}->push_write($line);
1107 $self->client_do_disconnect($reqstate);
1118 $self->log_aborted_request($reqstate, $err);
1119 $self->client_do_disconnect($reqstate);
1123 sub handle_request {
1124 my ($self, $reqstate, $auth, $method, $path) = @_;
1126 my $base_uri = $self->{base_uri};
1129 my $r = $reqstate->{request};
1131 # disable timeout on handle (we already have all data we need)
1132 # we re-enable timeout in response()
1133 $reqstate->{hdl}->timeout(0);
1135 if ($path =~ m/^\Q$base_uri\E/) {
1136 $self->handle_api2_request($reqstate, $auth, $method, $path);
1140 if ($self->{pages} && ($method eq 'GET') && (my $handler = $self->{pages}->{$path})) {
1141 if (ref($handler) eq 'CODE') {
1142 my $params = decode_urlencoded($r->url->query());
1143 my ($resp, $userid) = &$handler($self, $reqstate->{request}, $params);
1145 Net::SSLeay::ERR_clear_error();
1146 $self->response($reqstate, $resp);
1147 } elsif (ref($handler) eq 'HASH') {
1148 if (my $filename = $handler->{file}) {
1149 my $fh = IO::File->new($filename) ||
1150 die "unable to
open file
'$filename' - $!\n";
1151 send_file_start($self, $reqstate, $filename);
1153 die "internal error
- no handler
";
1156 die "internal error
- no handler
";
1161 if ($self->{dirs} && ($method eq 'GET')) {
1162 # we only allow simple names
1163 if ($path =~ m!^(/\S+/)([a-zA-Z0-9\-\_\.]+)$!) {
1164 my ($subdir, $file) = ($1, $2);
1165 if (my $dir = $self->{dirs}->{$subdir}) {
1166 my $filename = "$dir$file";
1167 my $fh = IO::File->new($filename) ||
1168 die "unable to
open file
'$filename' - $!\n";
1169 send_file_start($self, $reqstate, $filename);
1175 die "no such file
'$path'\n";
1178 $self->error($reqstate, 501, $err);
1182 my sub assert_form_disposition {
1183 die "wrong Content-Disposition
'$_[0]' in multipart
, expected
'form-data'\n" if $_[0] ne 'form-data';
1186 sub file_upload_multipart {
1187 my ($self, $reqstate, $auth, $method, $path, $rstate) = @_;
1190 my $boundary = $rstate->{boundary};
1191 my $hdl = $reqstate->{hdl};
1192 my $startlen = length($hdl->{rbuf});
1194 my $newline_re = qr/\015?\012/;
1195 my $delim_re = qr/--\Q$boundary\E${newline_re}/;
1196 my $close_delim_re = qr/--\Q$boundary\E--/;
1198 # Phase 0 - preserve boundary, but remove everything before
1199 if ($rstate->{phase} == 0 && $hdl->{rbuf} =~ s/^.*?($delim_re)/$1/s) {
1200 $rstate->{read} += $startlen - length($hdl->{rbuf});
1201 $rstate->{phase} = 1;
1204 my $remove_until_data = sub {
1206 # remove any remaining multipart "headers
" like Content-Type
1207 $hdl->{rbuf} =~ s/^.*?${newline_re}{2}//s;
1210 my $extract_form_disposition = sub {
1212 if ($hdl->{rbuf} =~ s/^${delim_re}.*?Content-Disposition: (.*?); name="$name"(.*?${delim_re})/$2/s) {
1213 assert_form_disposition($1);
1214 $remove_until_data->($hdl);
1215 $hdl->{rbuf} =~ s/^(.*?)(${delim_re})/$2/s;
1216 $rstate->{params}->{$name} = trim($1);
1220 if ($rstate->{phase} == 1) { # Phase 1 - parse payload without file data
1221 $extract_form_disposition->('content');
1222 $extract_form_disposition->('checksum-algorithm');
1223 $extract_form_disposition->('checksum');
1225 if ($hdl->{rbuf} =~ s/^${delim_re}Content-Disposition: (.*?); name="(.*?)"; filename="([^"]+)"${newline_re}//s) {
1226 assert_form_disposition($1);
1227 die "wrong field name
'$2' for file upload
, expected
'filename'" if $2 ne "filename
";
1228 $rstate->{phase} = 2;
1229 $rstate->{params}->{filename} = trim($3);
1230 $remove_until_data->($hdl); # any remaining multipart "headers
" like Content-Type
1234 if ($rstate->{phase} == 2) { # Phase 2 - dump content into file
1235 my ($data, $write_length);
1236 if ($hdl->{rbuf} =~ s/^(.*?)${newline_re}?+${close_delim_re}.*$//s) {
1238 $write_length = length($data);
1239 $rstate->{phase} = 100;
1241 $write_length = length($hdl->{rbuf}) - $rstate->{boundlen};
1242 $data = substr($hdl->{rbuf}, 0, $write_length, '') if $write_length > 0;
1245 if ($write_length > 0) {
1246 syswrite($rstate->{outfh}, $data) == $write_length or die "write to temporary file failed
- $!\n";
1247 $rstate->{bytes} += $write_length;
1248 $rstate->{ctx}->add($data);
1252 if ($rstate->{phase} == 100) { # Phase 100 - transfer finished
1253 $rstate->{md5sum} = $rstate->{ctx}->hexdigest;
1254 my $elapsed = tv_interval($rstate->{starttime});
1255 syslog('info', "multipart upload complete
(size
: %dB time: %.3fs rate
: %.2fMiB
/s md5sum
: %s)",
1256 $rstate->{bytes}, $elapsed, $rstate->{bytes} / ($elapsed * 1024 * 1024), $rstate->{md5sum}
1258 $self->handle_api2_request($reqstate, $auth, $method, $path, $rstate);
1261 $rstate->{read} += $startlen - length($hdl->{rbuf});
1263 if ($rstate->{read} + length($hdl->{rbuf}) >= $rstate->{size} && $rstate->{phase} != 100) {
1264 die "upload failed
";
1268 syslog('err', $err);
1269 $self->error($reqstate, 501, $err);
1273 sub parse_content_type {
1276 my ($ct, @params) = split(/\s*[;,]\s*/o, $ctype);
1278 foreach my $v (@params) {
1279 if ($v =~ m/^\s*boundary\s*=\s*(\S+?)\s*$/o) {
1280 return wantarray ? ($ct, $1) : $ct;
1284 return wantarray ? ($ct) : $ct;
1287 my $tmpfile_seq_no = 0;
1289 sub get_upload_filename {
1290 # choose unpredictable tmpfile name
1293 return "/var/tmp
/pveupload-
" . Digest::MD5::md5_hex($tmpfile_seq_no . time() . $$);
1296 sub unshift_read_header {
1297 my ($self, $reqstate, $state) = @_;
1299 $state = { size => 0, count => 0 } if !$state;
1301 $reqstate->{hdl}->unshift_read(line => sub {
1302 my ($hdl, $line) = @_;
1305 # print "$$: got header
: $line\n" if $self->{debug};
1307 die "too many http header lines
(> $limit_max_headers)\n" if ++$state->{count} >= $limit_max_headers;
1308 die "http header too large
\n" if ($state->{size} += length($line)) >= $limit_max_header_size;
1310 my $r = $reqstate->{request};
1313 my $path = uri_unescape($r->uri->path());
1314 my $method = $r->method();
1316 $r->push_header($state->{key}, $state->{val})
1319 if (!$known_methods->{$method}) {
1320 my $resp = HTTP::Response->new(HTTP_NOT_IMPLEMENTED, "method '$method' not available
");
1321 $self->response($reqstate, $resp);
1325 my $conn = $r->header('Connection');
1326 my $accept_enc = $r->header('Accept-Encoding');
1327 $reqstate->{accept_gzip} = ($accept_enc && $accept_enc =~ m/gzip/) ? 1 : 0;
1330 $reqstate->{keep_alive} = 0 if $conn =~ m/close/oi;
1332 if ($reqstate->{proto}->{ver} < 1001) {
1333 $reqstate->{keep_alive} = 0;
1337 my $te = $r->header('Transfer-Encoding');
1338 if ($te && lc($te) eq 'chunked') {
1339 # Handle chunked transfer encoding
1340 $self->error($reqstate, 501, "chunked transfer encoding
not supported
");
1343 $self->error($reqstate, 501, "Unknown transfer encoding
'$te'");
1347 my $pveclientip = $r->header('PVEClientIP');
1348 my $base_uri = $self->{base_uri};
1350 # fixme: how can we make PVEClientIP header trusted?
1351 if ($self->{trusted_env} && $pveclientip) {
1352 $reqstate->{peer_host} = $pveclientip;
1354 $r->header('PVEClientIP', $reqstate->{peer_host});
1357 my $len = $r->header('Content-Length');
1359 my $host_header = $r->header('Host');
1360 if (my $rpcenv = $self->{rpcenv}) {
1361 $rpcenv->set_request_host($host_header);
1364 # header processing complete - authenticate now
1367 if ($self->{spiceproxy}) {
1368 my $connect_str = $host_header;
1369 my ($vmid, $node, $port) = $self->verify_spice_connect_url($connect_str);
1370 if (!(defined($vmid) && $node && $port)) {
1371 $self->error($reqstate, HTTP_UNAUTHORIZED, "invalid ticket
");
1374 $self->handle_spice_proxy_request($reqstate, $connect_str, $vmid, $node, $port);
1376 } elsif ($path =~ m/^\Q$base_uri\E/) {
1377 my $token = $r->header('CSRFPreventionToken');
1378 my $cookie = $r->header('Cookie');
1379 my $auth_header = $r->header('Authorization');
1381 # prefer actual cookie
1382 my $ticket = PVE::APIServer::Formatter::extract_auth_value($cookie, $self->{cookie_name});
1384 # fallback to cookie in 'Authorization' header
1385 $ticket = PVE::APIServer::Formatter::extract_auth_value($auth_header, $self->{cookie_name})
1388 # finally, fallback to API token if no ticket has been provided so far
1390 $api_token = PVE::APIServer::Formatter::extract_auth_value($auth_header, $self->{apitoken_name})
1393 my ($rel_uri, $format) = &$split_abs_uri($path, $self->{base_uri});
1395 $self->error($reqstate, HTTP_NOT_IMPLEMENTED, "no such uri
");
1400 $auth = $self->auth_handler($method, $rel_uri, $ticket, $token, $api_token,
1401 $reqstate->{peer_host});
1405 Net::SSLeay::ERR_clear_error();
1406 # always delay unauthorized calls by 3 seconds
1409 if (ref($err) eq "PVE
::Exception
") {
1411 $err->{code} ||= HTTP_INTERNAL_SERVER_ERROR,
1412 my $resp = HTTP::Response->new($err->{code}, $err->{msg});
1413 $self->response($reqstate, $resp, undef, 0, $delay);
1415 } elsif (my $formatter = PVE::APIServer::Formatter::get_login_formatter($format)) {
1416 my ($raw, $ct, $nocomp) =
1417 $formatter->($path, $auth, $self->{formatter_config});
1419 if (ref($raw) && (ref($raw) eq 'HTTP::Response')) {
1422 $resp = HTTP::Response->new(HTTP_UNAUTHORIZED, "Login Required
");
1423 $resp->header("Content-Type
" => $ct);
1424 $resp->content($raw);
1426 $self->response($reqstate, $resp, undef, $nocomp, $delay);
1428 my $resp = HTTP::Response->new(HTTP_UNAUTHORIZED, $err);
1429 $self->response($reqstate, $resp, undef, 0, $delay);
1435 $reqstate->{log}->{userid} = $auth->{userid};
1439 if (!($method eq 'PUT' || $method eq 'POST')) {
1440 $self->error($reqstate, 501, "Unexpected content
for method '$method'");
1444 my $ctype = $r->header('Content-Type');
1445 my ($ct, $boundary) = $ctype ? parse_content_type($ctype) : ();
1447 if ($auth->{isUpload} && !$self->{trusted_env}) {
1448 die "upload
'Content-Type '$ctype' not implemented\n"
1449 if !($boundary && $ct && ($ct eq 'multipart
/form-data
'));
1451 die "upload without content length header not supported" if !$len;
1453 die "upload without content length header not supported" if !$len;
1455 $self->dprint("start upload $path $ct $boundary");
1457 my $tmpfilename = get_upload_filename();
1458 my $outfh = IO::File->new($tmpfilename, O_RDWR|O_CREAT|O_EXCL, 0600) ||
1459 die "unable to create temporary upload file '$tmpfilename'";
1461 $reqstate->{keep_alive} = 0;
1463 my $boundlen = length($boundary) + 8; # \015?\012--$boundary--\015?\012
1467 boundary => $boundary,
1468 ctx => Digest::MD5->new,
1469 boundlen => $boundlen,
1470 maxheader => 2048 + $boundlen, # should be large enough
1471 params => decode_urlencoded($r->url->query()),
1475 starttime => [gettimeofday],
1478 $reqstate->{tmpfilename} = $tmpfilename;
1479 $reqstate->{hdl}->on_read(sub {
1480 $self->file_upload_multipart($reqstate, $auth, $method, $path, $state);
1485 if ($len > $limit_max_post) {
1486 $self->error($reqstate, 501, "for data too large");
1490 if (!$ct || $ct eq 'application
/x-www-form-urlencoded' || $ct eq 'application/json
') {
1491 $reqstate->{hdl}->unshift_read(chunk => $len, sub {
1492 my ($hdl, $data) = @_;
1494 $self->handle_request($reqstate, $auth, $method, $path);
1497 $self->error($reqstate, 506, "upload 'Content-Type
'$ctype' not implemented
");
1500 $self->handle_request($reqstate, $auth, $method, $path);
1502 } elsif ($line =~ /^([^:\s]+)\s*:\s*(.*)/) {
1503 $r->push_header($state->{key}, $state->{val}) if $state->{key};
1504 ($state->{key}, $state->{val}) = ($1, $2);
1505 $self->unshift_read_header($reqstate, $state);
1506 } elsif ($line =~ /^\s+(.*)/) {
1507 $state->{val} .= " $1";
1508 $self->unshift_read_header($reqstate, $state);
1510 $self->error($reqstate, 506, "unable to parse request header
");
1517 sub push_request_header {
1518 my ($self, $reqstate) = @_;
1521 $reqstate->{hdl}->push_read(line => sub {
1522 my ($hdl, $line) = @_;
1525 # print "got request header
: $line\n" if $self->{debug};
1527 $reqstate->{keep_alive}--;
1529 if ($line =~ /(\S+)\040(\S+)\040HTTP\/(\d+)\.(\d+)/o) {
1530 my ($method, $url, $maj, $min) = ($1, $2, $3, $4);
1533 $self->error($reqstate, 506, "http protocol version
$maj.$min not supported
");
1536 if ($url =~ m|^[^/]*@|) {
1537 # if an '@' comes before the first slash proxy forwarding might consider
1538 # the frist part of the url to be part of an authority...
1539 $self->error($reqstate, 400, "invalid url
");
1543 $self->{request_count}++; # only count valid request headers
1544 if ($self->{request_count} >= $self->{max_requests}) {
1545 $self->{end_loop} = 1;
1547 $reqstate->{log} = { requestline => $line };
1548 $reqstate->{proto}->{str} = "HTTP
/$maj.$min";
1549 $reqstate->{proto}->{maj} = $maj;
1550 $reqstate->{proto}->{min} = $min;
1551 $reqstate->{proto}->{ver} = $maj*1000+$min;
1552 $reqstate->{request} = HTTP::Request->new($method, $url);
1553 $reqstate->{starttime} = [gettimeofday],
1555 $self->unshift_read_header($reqstate);
1556 } elsif ($line eq '') {
1557 # ignore empty lines before requests (browser bugs?)
1558 $self->push_request_header($reqstate);
1560 $self->error($reqstate, 400, 'bad request');
1574 return if $self->{end_loop};
1576 # we need to m make sure that only one process calls accept
1577 while (!flock($self->{lockfh}, Fcntl::LOCK_EX())) {
1578 next if $! == EINTR;
1579 die "could
not get
lock on file
'$self->{lockfile}' - $!\n";
1585 while (!$self->{end_loop} &&
1586 !defined($clientfh = $self->{socket}->accept()) &&
1589 if ($self->{end_loop}) {
1592 $again = ($! == EAGAIN || $! == WSAEWOULDBLOCK);
1593 if (!defined($clientfh)) {
1594 $errmsg = "failed to
accept connection
: $!\n";
1600 flock($self->{lockfh}, Fcntl::LOCK_UN());
1602 if (!defined($clientfh)) {
1604 die $errmsg if $errmsg;
1607 fh_nonblocking $clientfh, 1;
1615 $self->{end_loop} = 1;
1617 undef $self->{socket_watch};
1619 $0 = "$0 (shutdown)" if $0 !~ m/\(shutdown\)$/;
1621 if ($self->{conn_count} <= 0) {
1622 $self->{end_cond}->send(1);
1626 # fork and exit, so that parent starts a new worker
1631 # else we need to wait until all open connections gets closed
1632 my $w; $w = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1634 # todo: test for active connections instead (we can abort idle connections)
1635 if ($self->{conn_count} <= 0) {
1637 $self->{end_cond}->send(1);
1645 sub check_host_access {
1646 my ($self, $clientip) = @_;
1648 $clientip = PVE::APIServer::Utils::normalize_v4_in_v6($clientip);
1649 my $cip = Net::IP->new($clientip);
1652 $self->dprint("client IP
not parsable
: $@");
1656 my $match_allow = 0;
1659 if ($self->{allow_from}) {
1660 foreach my $t (@{$self->{allow_from}}) {
1661 if ($t->overlaps($cip)) {
1663 $self->dprint("client IP allowed
: ". $t->prefix());
1669 if ($self->{deny_from}) {
1670 foreach my $t (@{$self->{deny_from}}) {
1671 if ($t->overlaps($cip)) {
1672 $self->dprint("client IP denied
: ". $t->prefix());
1679 if ($match_allow == $match_deny) {
1680 # match both allow and deny, or no match
1681 return $self->{policy} && $self->{policy} eq 'allow' ? 1 : 0;
1684 return $match_allow;
1687 sub accept_connections {
1690 my ($clientfh, $handle_creation);
1693 while ($clientfh = $self->accept()) {
1695 my $reqstate = { keep_alive => $self->{keep_alive} };
1697 # stop keep-alive when there are many open connections
1698 if ($self->{conn_count} + 1 >= $self->{max_conn_soft_limit}) {
1699 $reqstate->{keep_alive} = 0;
1702 if (my $sin = getpeername($clientfh)) {
1703 my ($pfamily, $pport, $phost) = PVE::Tools::unpack_sockaddr_in46($sin);
1704 ($reqstate->{peer_port}, $reqstate->{peer_host}) = ($pport, Socket::inet_ntop($pfamily, $phost));
1706 $self->dprint("getpeername failed
: $!");
1711 if (!$self->{trusted_env} && !$self->check_host_access($reqstate->{peer_host})) {
1712 $self->dprint("ABORT request from
$reqstate->{peer_host
} - access denied
");
1713 $reqstate->{log}->{code} = 403;
1714 $self->log_request($reqstate);
1719 # Increment conn_count before creating new handle, since creation
1720 # triggers callbacks, which can potentialy decrement (e.g.
1721 # on_error) conn_count before AnyEvent::Handle->new() returns.
1722 $handle_creation = 1;
1723 $self->{conn_count}++;
1724 $reqstate->{hdl} = AnyEvent::Handle->new(
1726 rbuf_max => 64*1024,
1727 timeout => $self->{timeout},
1728 linger => 0, # avoid problems with ssh - really needed ?
1732 $self->log_aborted_request($reqstate);
1733 $self->client_do_disconnect($reqstate);
1735 if (my $err = $@) { syslog('err', $err); }
1738 my ($hdl, $fatal, $message) = @_;
1740 $self->log_aborted_request($reqstate, $message);
1741 $self->client_do_disconnect($reqstate);
1743 if (my $err = $@) { syslog('err', "$err"); }
1745 ($self->{tls_ctx} ? (tls => "accept", tls_ctx => $self->{tls_ctx}) : ()));
1746 $handle_creation = 0;
1748 $self->dprint("ACCEPT FH
" . $clientfh->fileno() . " CONN
$self->{conn_count
}");
1750 $self->push_request_header($reqstate);
1755 syslog('err', $err);
1756 $self->dprint("connection
accept error
: $err");
1758 if ($handle_creation) {
1759 if ($self->{conn_count} <= 0) {
1760 warn "connection count
<= 0 not decrementing
!\n";
1762 $self->{conn_count}--;
1765 $self->{end_loop} = 1;
1768 $self->wait_end_loop() if $self->{end_loop};
1771 # Note: We can't open log file in non-blocking mode and use AnyEvent::Handle,
1772 # because we write from multiple processes, and that would arbitrarily mix output
1774 sub open_access_log {
1775 my ($self, $filename) = @_;
1777 my $old_mask = umask(0137);;
1778 my $logfh = IO::File->new($filename, ">>") ||
1779 die "unable to
open log file
'$filename' - $!\n";
1782 $logfh->autoflush(1);
1784 $self->{logfh} = $logfh;
1788 my ($self, $data) = @_;
1790 return if !defined($self->{logfh}) || !$data;
1792 my $res = $self->{logfh}->print($data);
1795 delete $self->{logfh};
1796 syslog('err', "error writing access
log");
1797 $self->{end_loop} = 1; # terminate asap
1801 sub atfork_handler {
1805 # something else do to ?
1806 close($self->{socket});
1814 $self->{end_cond}->recv;
1818 my ($this, %args) = @_;
1820 my $class = ref($this) || $this;
1822 foreach my $req (qw(socket lockfh lockfile)) {
1823 die "misssing required argument '$req'" if !defined($args{$req});
1826 my $self = bless { %args }, $class;
1828 $self->{cookie_name
} //= 'PVEAuthCookie';
1829 $self->{apitoken_name
} //= 'PVEAPIToken';
1830 $self->{base_uri
} //= "/api2";
1831 $self->{dirs
} //= {};
1832 $self->{title
} //= 'API Inspector';
1833 $self->{compression
} //= 1;
1835 # formatter_config: we pass some configuration values to the Formatter
1836 $self->{formatter_config
} = {};
1837 foreach my $p (qw(apitoken_name cookie_name base_uri title)) {
1838 $self->{formatter_config
}->{$p} = $self->{$p};
1840 $self->{formatter_config
}->{csrfgen_func
} =
1841 $self->can('generate_csrf_prevention_token');
1843 # add default dirs which includes jquery and bootstrap
1844 my $jsbase = '/usr/share/javascript';
1845 add_dirs
($self->{dirs
}, '/js/' => "$jsbase/");
1846 # libjs-bootstrap uses symlinks for this, which we do not want to allow..
1847 my $glyphicons = '/usr/share/fonts/truetype/glyphicons/';
1848 add_dirs
($self->{dirs
}, '/js/bootstrap/fonts/' => "$glyphicons");
1851 PVE
::INotify
::inotify_init
();
1853 fh_nonblocking
($self->{socket}, 1);
1855 $self->{end_loop
} = 0;
1856 $self->{conn_count
} = 0;
1857 $self->{request_count
} = 0;
1858 $self->{timeout
} = 5 if !$self->{timeout
};
1859 $self->{keep_alive
} = 0 if !defined($self->{keep_alive
});
1860 $self->{max_conn
} = 800 if !$self->{max_conn
};
1861 $self->{max_requests
} = 8000 if !$self->{max_requests
};
1863 $self->{policy
} = 'allow' if !$self->{policy
};
1865 $self->{end_cond
} = AnyEvent-
>condvar;
1868 my $ssl_defaults = {
1869 # Note: older versions are considered insecure, for example
1870 # search for "Poodle"-Attack
1874 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',
1875 honor_cipher_order
=> 1,
1878 # workaround until anyevent supports TLS 1.3 ciphersuites directly
1879 my $ciphersuites = delete $self->{ssl
}->{ciphersuites
};
1881 foreach my $k (keys %$ssl_defaults) {
1882 $self->{ssl
}->{$k} //= $ssl_defaults->{$k};
1885 if (!defined($self->{ssl
}->{dh_file
})) {
1886 $self->{ssl
}->{dh
} = 'skip2048';
1889 my $tls_ctx_flags = 0;
1890 $tls_ctx_flags |= &Net
::SSLeay
::OP_NO_COMPRESSION
;
1891 $tls_ctx_flags |= &Net
::SSLeay
::OP_SINGLE_ECDH_USE
;
1892 $tls_ctx_flags |= &Net
::SSLeay
::OP_SINGLE_DH_USE
;
1893 $tls_ctx_flags |= &Net
::SSLeay
::OP_NO_RENEGOTIATION
;
1894 if (delete $self->{ssl
}->{honor_cipher_order
}) {
1895 $tls_ctx_flags |= &Net
::SSLeay
::OP_CIPHER_SERVER_PREFERENCE
;
1897 # workaround until anyevent supports disabling TLS 1.3 directly
1898 if (exists($self->{ssl
}->{tlsv1_3
}) && !$self->{ssl
}->{tlsv1_3
}) {
1899 $tls_ctx_flags |= &Net
::SSLeay
::OP_NO_TLSv1_3
;
1903 $self->{tls_ctx
} = AnyEvent
::TLS-
>new(%{$self->{ssl
}});
1904 Net
::SSLeay
::CTX_set_options
($self->{tls_ctx
}->{ctx
}, $tls_ctx_flags);
1905 if (defined($ciphersuites)) {
1906 warn "Failed to set TLS 1.3 ciphersuites '$ciphersuites'\n"
1907 if !Net
::SSLeay
::CTX_set_ciphersuites
($self->{tls_ctx
}->{ctx
}, $ciphersuites);
1911 if ($self->{spiceproxy
}) {
1912 $known_methods = { CONNECT
=> 1 };
1915 $self->open_access_log($self->{logfile
}) if $self->{logfile
};
1917 $self->{max_conn_soft_limit
} = $self->{max_conn
} > 100 ?
$self->{max_conn
} - 20 : $self->{max_conn
};
1919 $self->{socket_watch
} = AnyEvent-
>io(fh
=> $self->{socket}, poll
=> 'r', cb
=> sub {
1921 if ($self->{conn_count
} >= $self->{max_conn
}) {
1922 my $w; $w = AnyEvent-
>timer (after
=> 1, interval
=> 1, cb
=> sub {
1923 if ($self->{conn_count
} < $self->{max_conn
}) {
1925 $self->accept_connections();
1929 $self->accept_connections();
1935 $self->{term_watch
} = AnyEvent-
>signal(signal
=> "TERM", cb
=> sub {
1936 undef $self->{term_watch
};
1937 $self->wait_end_loop();
1940 $self->{quit_watch
} = AnyEvent-
>signal(signal
=> "QUIT", cb
=> sub {
1941 undef $self->{quit_watch
};
1942 $self->wait_end_loop();
1945 $self->{inotify_poll
} = AnyEvent-
>timer(after
=> 5, interval
=> 5, cb
=> sub {
1946 PVE
::INotify
::poll
(); # read inotify events
1952 # static helper to add directory including all subdirs
1953 # This can be used to setup $self->{dirs}
1955 my ($result_hash, $alias, $subdir) = @_;
1957 $result_hash->{$alias} = $subdir;
1960 my $dir = $File::Find
::dir
;
1961 if ($dir =~m!^$subdir(.*)$!) {
1962 my $name = "$alias$1/";
1963 $result_hash->{$name} = "$dir/";
1967 find
({wanted
=> $wanted, follow
=> 0, no_chdir
=> 1}, $subdir);
1970 # abstract functions - subclass should overwrite/implement them
1972 sub verify_spice_connect_url
{
1973 my ($self, $connect_str) = @_;
1977 #return ($vmid, $node, $port);
1980 # formatters can call this when the generate a new page
1981 sub generate_csrf_prevention_token
{
1982 my ($username) = @_;
1984 return undef; # do nothing by default
1988 my ($self, $method, $rel_uri, $ticket, $token, $api_token, $peer_host) = @_;
1993 # ticket => $ticket,
1995 # userid => $username,
1997 # isUpload => $isUpload,
1998 # api_token => $api_token,
2003 my ($self, $clientip, $method, $rel_uri, $auth, $params, $format) = @_;
2005 # please do not raise exceptions here (always return a result).
2008 status
=> HTTP_NOT_IMPLEMENTED
,
2009 message
=> "Method '$method $rel_uri' not implemented",
2012 # this should return the following properties, which
2013 # are then passed to the Formatter
2015 # status: HTTP status code
2016 # message: Error message
2017 # errors: more detailed error hash (per parameter)
2018 # info: reference to JSON schema definition - useful to format output
2021 # total: additional info passed to output
2022 # changes: additional info passed to output
2024 # if you want to proxy the request to another node return this
2025 # { proxy => $remip, proxynode => $node, proxy_params => $params };
2027 # to pass the request to the local priviledged daemon use:
2028 # { proxy => 'localhost' , proxy_params => $params };
2030 # to download aspecific file use:
2031 # { download => "/path/to/file" };
2034 sub check_cert_fingerprint
{
2035 my ($self, $cert) = @_;
2040 sub initialize_cert_cache
{
2041 my ($self, $node) = @_;
2046 sub remote_node_ip
{
2047 my ($self, $node) = @_;