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();
12 use Time
::HiRes
qw(usleep ualarm gettimeofday tv_interval);
13 use Socket
qw(IPPROTO_TCP TCP_NODELAY SOMAXCONN);
14 use POSIX
qw(strftime EINTR EAGAIN);
22 # use AnyEvent::Strict; # only use this for debugging
23 use AnyEvent
::Util
qw(guard fh_nonblocking WSAEWOULDBLOCK WSAEINPROGRESS);
36 use PVE
::APIServer
::Formatter
;
37 use PVE
::APIServer
::Utils
;
42 use HTTP
::Status
qw(:constants);
50 my $limit_max_headers = 64;
51 my $limit_max_header_size = 8*1024;
52 my $limit_max_post = 64*1024;
61 my $split_abs_uri = sub {
62 my ($abs_uri, $base_uri) = @_;
64 my ($format, $rel_uri) = $abs_uri =~ m/^\Q$base_uri\E\/+([a-z
][a-z0-9
]+)(\
/.*)?$/;
65 $rel_uri = '/' if !$rel_uri;
67 return wantarray ?
($rel_uri, $format) : $rel_uri;
71 my ($self, $message) = @_;
73 return if !$self->{debug
};
75 my ($pkg, $pkgfile, $line, $sub) = caller(1);
76 $sub =~ s/^(?:.+::)+//;
77 print "worker[$$]: $pkg +$line: $sub: $message\n";
81 my ($self, $reqstate) = @_;
83 my $loginfo = $reqstate->{log};
85 # like apache2 common log format
86 # LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\""
88 return if $loginfo->{written
}; # avoid duplicate logs
89 $loginfo->{written
} = 1;
91 my $peerip = $reqstate->{peer_host
} || '-';
92 my $userid = $loginfo->{userid
} || '-';
93 my $content_length = defined($loginfo->{content_length
}) ?
$loginfo->{content_length
} : '-';
94 my $code = $loginfo->{code
} || 500;
95 my $requestline = $loginfo->{requestline
} || '-';
96 my $timestr = strftime
("%d/%m/%Y:%H:%M:%S %z", localtime());
98 my $msg = "$peerip - $userid [$timestr] \"$requestline\" $code $content_length\n";
100 $self->write_log($msg);
103 sub log_aborted_request {
104 my ($self, $reqstate, $error) = @_;
106 my $r = $reqstate->{request};
107 return if !$r; # no active request
110 syslog("err
", "problem with client
$reqstate->{peer_host
}; $error");
113 $self->log_request($reqstate);
116 sub cleanup_reqstate {
119 delete $reqstate->{log};
120 delete $reqstate->{request};
121 delete $reqstate->{proto};
122 delete $reqstate->{accept_gzip};
123 delete $reqstate->{starttime};
125 if ($reqstate->{tmpfilename}) {
126 unlink $reqstate->{tmpfilename};
127 delete $reqstate->{tmpfilename};
131 sub client_do_disconnect {
132 my ($self, $reqstate) = @_;
134 cleanup_reqstate($reqstate);
136 my $shutdown_hdl = sub {
139 shutdown($hdl->{fh}, 1);
141 $hdl->on_drain(undef);
142 $hdl->on_read(undef);
146 if (my $proxyhdl = delete $reqstate->{proxyhdl}) {
147 &$shutdown_hdl($proxyhdl);
150 my $hdl = delete $reqstate->{hdl};
153 syslog('err', "detected empty handle
");
157 $self->dprint("close connection
$hdl");
159 &$shutdown_hdl($hdl);
161 warn "connection count
<= 0!\n" if $self->{conn_count} <= 0;
163 $self->{conn_count}--;
165 $self->dprint("CLOSE FH
" . $hdl->{fh}->fileno() . " CONN
$self->{conn_count
}");
168 sub finish_response {
169 my ($self, $reqstate) = @_;
171 cleanup_reqstate($reqstate);
173 my $hdl = $reqstate->{hdl};
174 return if !$hdl; # already disconnected
176 if (!$self->{end_loop} && $reqstate->{keep_alive} > 0) {
177 # print "KEEPALIVE
$reqstate->{keep_alive
}\n" if $self->{debug};
179 eval { $self->push_request_header($reqstate); };
183 $hdl->on_drain (sub {
185 $self->client_do_disconnect($reqstate);
192 sub response_stream {
193 my ($self, $reqstate, $stream_fh) = @_;
195 # disable timeout, we don't know how big the data is
196 $reqstate->{hdl}->timeout(0);
198 my $buf_size = 4*1024*1024;
203 my $reqhdl = $reqstate->{hdl};
206 my $wbuf_len = length($reqhdl->{wbuf});
207 my $rbuf_len = length($hdl->{rbuf});
208 # TODO: Take into account $reqhdl->{wbuf_max} ? Right now
209 # that's unbounded, so just assume $buf_size
210 my $to_read = $buf_size - $wbuf_len;
211 $to_read = $rbuf_len if $rbuf_len < $to_read;
213 my $data = substr($hdl->{rbuf}, 0, $to_read, '');
214 $reqhdl->push_write($data);
215 $rbuf_len -= $to_read;
216 } elsif ($hdl->{_eof}) {
217 # workaround: AnyEvent gives us a fake EPIPE if we don't consume
218 # any data when called at EOF, so unregister ourselves - data is
219 # flushed by on_eof anyway
220 # see: https://sources.debian.org/src/libanyevent-perl/7.170-2/lib/AnyEvent/Handle.pm/#L1329
225 # apply backpressure so we don't accept any more data into
226 # buffer if the client isn't downloading fast enough
227 # note: read_size can double upon read, and we also need to
228 # account for one more read after start_read, so *4
229 if ($rbuf_len + $hdl->{read_size}*4 > $buf_size) {
230 # stop reading until write buffer is empty
232 my $prev_on_drain = $reqhdl->{on_drain};
233 $reqhdl->on_drain(sub {
235 # on_drain called because write buffer is empty, continue reading
236 $hdl->on_read($on_read);
237 if ($prev_on_drain) {
238 $wrhdl->on_drain($prev_on_drain);
239 $prev_on_drain->($wrhdl);
245 $reqstate->{proxyhdl} = AnyEvent::Handle->new(
247 rbuf_max => $buf_size,
253 if (my $reqhdl = $reqstate->{hdl}) {
254 $self->log_aborted_request($reqstate);
255 # write out any remaining data
256 $reqhdl->push_write($hdl->{rbuf}) if length($hdl->{rbuf}) > 0;
258 $reqhdl->push_shutdown();
259 $self->finish_response($reqstate);
262 if (my $err = $@) { syslog('err', "$err"); }
266 my ($hdl, $fatal, $message) = @_;
268 $self->log_aborted_request($reqstate, $message);
269 $self->client_do_disconnect($reqstate);
271 if (my $err = $@) { syslog('err', "$err"); }
278 my ($self, $reqstate, $resp, $mtime, $nocomp, $delay, $stream_fh) = @_;
280 #print "$$: send response
: " . Dumper($resp);
283 $reqstate->{hdl}->timeout_reset();
284 $reqstate->{hdl}->timeout($self->{timeout});
286 $nocomp = 1 if !$self->{compression};
287 $nocomp = 1 if !$reqstate->{accept_gzip};
289 my $code = $resp->code;
290 my $msg = $resp->message || HTTP::Status::status_message($code);
291 ($msg) = $msg =~m/^(.*)$/m;
292 my $content = $resp->content;
294 if ($code =~ /^(1\d\d|[23]04)$/) {
295 # make sure content we have no content
299 $reqstate->{keep_alive} = 0 if ($code >= 400) || $self->{end_loop};
301 $reqstate->{log}->{code} = $code;
303 my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.0';
304 my $res = "$proto $code $msg\015\012";
307 my $date = HTTP::Date::time2str($ctime);
308 $resp->header('Date' => $date);
310 $resp->header('Last-Modified' => HTTP::Date::time2str($mtime));
312 $resp->header('Expires' => $date);
313 $resp->header('Cache-Control' => "max-age
=0");
314 $resp->header("Pragma
", "no-cache
");
317 $resp->header('Server' => "pve-api-daemon
/3.0");
320 if ($content && !$stream_fh) {
322 $content_length = length($content);
324 if (!$nocomp && ($content_length > 1024)) {
325 my $comp = Compress::Zlib::memGzip($content);
326 $resp->header('Content-Encoding', 'gzip');
328 $content_length = length($content);
330 $resp->header("Content-Length
" => $content_length);
331 $reqstate->{log}->{content_length} = $content_length;
334 $resp->remove_header("Content-Length
");
337 if ($reqstate->{keep_alive} > 0) {
338 $resp->push_header('Connection' => 'Keep-Alive');
340 $resp->header('Connection' => 'close');
343 $res .= $resp->headers_as_string("\015\012");
344 #print "SEND
(without content
) $res\n" if $self->{debug};
347 $res .= $content if $content && !$stream_fh;
349 $self->log_request($reqstate, $reqstate->{request});
352 # write headers and preamble...
353 $reqstate->{hdl}->push_write($res);
354 # ...then stream data via an AnyEvent::Handle
355 $self->response_stream($reqstate, $stream_fh);
356 } elsif ($delay && $delay > 0) {
357 my $w; $w = AnyEvent->timer(after => $delay, cb => sub {
358 undef $w; # delete reference
359 $reqstate->{hdl}->push_write($res);
360 $self->finish_response($reqstate);
363 $reqstate->{hdl}->push_write($res);
364 $self->finish_response($reqstate);
369 my ($self, $reqstate, $code, $msg, $hdr, $content) = @_;
372 my $resp = HTTP::Response->new($code, $msg, $hdr, $content);
373 $self->response($reqstate, $resp);
378 my $file_extension_info = {
379 css => { ct => 'text/css' },
380 html => { ct => 'text/html' },
381 js => { ct => 'application/javascript' },
382 json => { ct => 'application/json' },
383 map => { ct => 'application/json' },
384 png => { ct => 'image/png' , nocomp => 1 },
385 ico => { ct => 'image/x-icon', nocomp => 1},
386 gif => { ct => 'image/gif', nocomp => 1},
387 svg => { ct => 'image/svg+xml' },
388 jar => { ct => 'application/java-archive', nocomp => 1},
389 woff => { ct => 'application/font-woff', nocomp => 1},
390 woff2 => { ct => 'application/font-woff2', nocomp => 1},
391 ttf => { ct => 'application/font-snft', nocomp => 1},
392 pdf => { ct => 'application/pdf', nocomp => 1},
393 epub => { ct => 'application/epub+zip', nocomp => 1},
394 mp3 => { ct => 'audio/mpeg', nocomp => 1},
395 oga => { ct => 'audio/ogg', nocomp => 1},
396 tgz => { ct => 'application/x-compressed-tar', nocomp => 1},
399 sub send_file_start {
400 my ($self, $reqstate, $download) = @_;
403 # print "SEND FILE
$filename\n";
404 # Note: aio_load() this is not really async unless we use IO::AIO!
407 my $r = $reqstate->{request};
413 if (ref($download) eq 'HASH') {
414 $mime = $download->{'content-type'};
416 if ($download->{path} && $download->{stream} &&
417 $reqstate->{request}->header('PVEDisableProxy'))
419 # avoid double stream from a file, let the proxy handle it
420 die "internal error
: file proxy streaming only available
for pvedaemon
\n"
421 if !$self->{trusted_env};
422 my $header = HTTP::Headers->new(
423 pvestreamfile => $download->{path},
424 Content_Type => $mime,
426 # we need some data so Content-Length gets set correctly and
427 # the proxy doesn't wait for more data - place a canary
428 my $resp = HTTP::Response->new(200, "OK
", $header, "error canary
");
429 $self->response($reqstate, $resp);
433 if (!($fh = $download->{fh})) {
434 my $path = $download->{path};
435 die "internal error
: {download
} returned but neither fh
not path
given\n"
437 sysopen($fh, "$path", O_NONBLOCK | O_RDONLY)
438 or die "open stream path
'$path' for reading failed
: $!\n";
441 if ($download->{stream}) {
442 my $header = HTTP::Headers->new(Content_Type => $mime);
443 my $resp = HTTP::Response->new(200, "OK
", $header);
444 $self->response($reqstate, $resp, undef, 1, 0, $fh);
448 my $filename = $download;
449 $fh = IO::File->new($filename, '<') ||
450 die "unable to
open file
'$filename' - $!\n";
452 my ($ext) = $filename =~ m/\.([^.]*)$/;
453 my $ext_info = $file_extension_info->{$ext};
455 die "unable to detect content type
" if !$ext_info;
456 $mime = $ext_info->{ct};
457 $nocomp = $ext_info->{nocomp};
460 my $stat = File::stat::stat($fh) ||
463 my $mtime = $stat->mtime;
465 if (my $ifmod = $r->header('if-modified-since')) {
466 my $iftime = HTTP::Date::str2time($ifmod);
467 if ($mtime <= $iftime) {
468 my $resp = HTTP::Response->new(304, "NOT MODIFIED
");
469 $self->response($reqstate, $resp, $mtime);
475 my $len = sysread($fh, $data, $stat->size);
476 die "got short file
\n" if !defined($len) || $len != $stat->size;
478 my $header = HTTP::Headers->new(Content_Type => $mime);
479 my $resp = HTTP::Response->new(200, "OK
", $header, $data);
480 $self->response($reqstate, $resp, $mtime, $nocomp);
483 $self->error($reqstate, 501, $err);
490 sub websocket_proxy {
491 my ($self, $reqstate, $wsaccept, $wsproto, $param) = @_;
497 my $max_payload_size = 128*1024;
500 if ($wsproto eq 'binary') {
502 } elsif ($wsproto eq 'base64') {
505 die "websocket_proxy
: unsupported protocol
'$wsproto'\n";
508 if ($param->{port}) {
509 $remhost = 'localhost';
510 $remport = $param->{port};
511 } elsif ($param->{socket}) {
513 $remport = $param->{socket};
515 die "websocket_proxy
: missing port
or socket\n";
519 my ($data, $opcode) = @_;
524 $string = $opcode ? $opcode : "\x82"; # binary frame
527 $string = $opcode ? $opcode : "\x81"; # text frame
528 $payload = encode_base64($$data, '');
531 my $payload_len = length($payload);
532 if ($payload_len <= 125) {
533 $string .= pack 'C', $payload_len;
534 } elsif ($payload_len <= 0xffff) {
535 $string .= pack 'C', 126;
536 $string .= pack 'n', $payload_len;
538 $string .= pack 'C', 127;
539 $string .= pack 'Q>', $payload_len;
545 tcp_connect $remhost, $remport, sub {
547 or die "connect to
'$remhost:$remport' failed
: $!";
549 $self->dprint("CONNECTed to
'$remhost:$remport'");
551 $reqstate->{proxyhdl} = AnyEvent::Handle->new(
553 rbuf_max => $max_payload_size,
554 wbuf_max => $max_payload_size*5,
559 $self->log_aborted_request($reqstate);
560 $self->client_do_disconnect($reqstate);
562 if (my $err = $@) { syslog('err', $err); }
565 my ($hdl, $fatal, $message) = @_;
567 $self->log_aborted_request($reqstate, $message);
568 $self->client_do_disconnect($reqstate);
570 if (my $err = $@) { syslog('err', "$err"); }
573 my $proxyhdlreader = sub {
576 my $len = length($hdl->{rbuf});
577 my $data = substr($hdl->{rbuf}, 0, $len > $max_payload_size ? $max_payload_size : $len, '');
579 my $string = $encode->(\$data);
581 $reqstate->{hdl}->push_write($string) if $reqstate->{hdl};
584 my $hdlreader = sub {
587 while (my $len = length($hdl->{rbuf})) {
590 my $hdr = unpack('C', substr($hdl->{rbuf}, 0, 1));
591 my $opcode = $hdr & 0b00001111;
592 my $fin = $hdr & 0b10000000;
594 die "received fragmented websocket frame
\n" if !$fin;
596 my $rsv = $hdr & 0b01110000;
597 die "received websocket frame with RSV flags
\n" if $rsv;
599 my $payload_len = unpack 'C', substr($hdl->{rbuf}, 1, 1);
601 my $masked = $payload_len & 0b10000000;
602 die "received unmasked websocket frame from client
\n" if !$masked;
605 $payload_len = $payload_len & 0b01111111;
606 if ($payload_len == 126) {
608 $payload_len = unpack('n', substr($hdl->{rbuf}, $offset, 2));
610 } elsif ($payload_len == 127) {
612 $payload_len = unpack('Q>', substr($hdl->{rbuf}, $offset, 8));
616 die "received too large websocket frame
(len
= $payload_len)\n"
617 if ($payload_len > $max_payload_size) || ($payload_len < 0);
619 return if $len < ($offset + 4 + $payload_len);
621 my $data = substr($hdl->{rbuf}, 0, $offset + 4 + $payload_len, ''); # now consume data
623 my $mask = substr($data, $offset, 4);
626 my $payload = substr($data, $offset, $payload_len);
628 # NULL-mask might be used over TLS, skip to increase performance
629 if ($mask ne pack('N', 0)) {
630 # repeat 4 byte mask to payload length + up to 4 byte
631 $mask = $mask x (int($payload_len / 4) + 1);
632 # truncate mask to payload length
633 substr($mask, $payload_len) = "";
638 $payload = decode_base64($payload) if !$binary;
640 if ($opcode == 1 || $opcode == 2) {
641 $reqstate->{proxyhdl}->push_write($payload) if $reqstate->{proxyhdl};
642 } elsif ($opcode == 8) {
643 my $statuscode = unpack ("n
", $payload);
644 $self->dprint("websocket received
close. status code
: '$statuscode'");
645 if ($reqstate->{proxyhdl}) {
646 $reqstate->{proxyhdl}->push_shutdown();
648 $hdl->push_shutdown();
649 } elsif ($opcode == 9) {
650 # ping received, schedule pong
651 $reqstate->{hdl}->push_write($encode->(\$payload, "\x8A")) if $reqstate->{hdl};
652 } elsif ($opcode == 0xA) {
653 # pong received, continue
655 die "received unhandled websocket opcode
$opcode\n";
660 my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.1';
662 $reqstate->{proxyhdl}->timeout(0);
663 $reqstate->{proxyhdl}->on_read($proxyhdlreader);
664 $reqstate->{hdl}->on_read($hdlreader);
666 # todo: use stop_read/start_read if write buffer grows to much
668 my $res = "$proto 101 Switching Protocols
\015\012" .
669 "Upgrade
: websocket
\015\012" .
670 "Connection
: upgrade
\015\012" .
671 "Sec-WebSocket-Accept
: $wsaccept\015\012" .
672 "Sec-WebSocket-Protocol
: $wsproto\015\012" .
677 $reqstate->{hdl}->push_write($res);
680 $reqstate->{log}->{code} = 101;
681 $self->log_request($reqstate);
687 $self->log_aborted_request($reqstate, $err);
688 $self->client_do_disconnect($reqstate);
693 my ($self, $reqstate, $clientip, $host, $node, $method, $uri, $auth, $params) = @_;
698 if ($host eq 'localhost') {
699 $target = "http
://$host:85$uri";
700 # keep alive for localhost is not worth (connection setup is about 0.2ms)
702 } elsif (Net::IP::ip_is_ipv6($host)) {
703 $target = "https
://[$host]:8006$uri";
705 $target = "https
://$host:8006$uri";
709 PVEDisableProxy => 'true',
710 PVEClientIP => $clientip,
713 $headers->{'cookie'} = PVE::APIServer::Formatter::create_auth_cookie($auth->{ticket}, $self->{cookie_name})
715 $headers->{'Authorization'} = PVE::APIServer::Formatter::create_auth_header($auth->{api_token}, $self->{apitoken_name})
716 if $auth->{api_token};
717 $headers->{'CSRFPreventionToken'} = $auth->{token}
719 $headers->{'Accept-Encoding'} = 'gzip' if ($reqstate->{accept_gzip} && $self->{compression});
721 if (defined(my $host = $reqstate->{request}->header('Host'))) {
722 $headers->{Host} = $host;
727 if ($method eq 'POST' || $method eq 'PUT') {
728 $headers->{'Content-Type'} = 'application/x-www-form-urlencoded';
729 # use URI object to format application/x-www-form-urlencoded content.
730 my $url = URI->new('http:');
731 $url->query_form(%$params);
732 $content = $url->query;
733 if (defined($content)) {
734 $headers->{'Content-Length'} = length($content);
739 # TLS 1.x only, with certificate pinning
745 my (undef, undef, undef, $depth, undef, undef, $cert) = @_;
746 # we don't care about intermediate or root certificates
747 return 1 if $depth != 0;
748 # check server certificate against cache of pinned FPs
749 return $self->check_cert_fingerprint($cert);
753 # load and cache cert fingerprint if first time we proxy to this node
754 $self->initialize_cert_cache($node);
756 my $w; $w = http_request(
761 proxy => undef, # avoid use of $ENV{HTTP_PROXY}
762 keepalive => $keep_alive,
764 tls_ctx => AnyEvent::TLS->new(%{$tls}),
766 my ($body, $hdr) = @_;
770 if (!$reqstate->{hdl}) {
771 warn "proxy detected vanished client connection
\n";
776 my $code = delete $hdr->{Status};
777 my $msg = delete $hdr->{Reason};
778 my $stream = delete $hdr->{pvestreamfile};
780 delete $hdr->{HTTPVersion};
781 my $header = HTTP::Headers->new(%$hdr);
782 if (my $location = $header->header('Location')) {
783 $location =~ s|^http://localhost:85||;
784 $header->header(Location => $location);
787 sysopen(my $fh, "$stream", O_NONBLOCK | O_RDONLY)
788 or die "open stream path
'$stream' for forwarding failed
: $!\n";
789 my $resp = HTTP::Response->new($code, $msg, $header, undef);
790 $self->response($reqstate, $resp, undef, 1, 0, $fh);
792 my $resp = HTTP::Response->new($code, $msg, $header, $body);
793 # Note: disable compression, because body is already compressed
794 $self->response($reqstate, $resp, undef, 1);
803 # return arrays as \0 separated strings (like CGI.pm)
804 # assume data is UTF8 encoded
805 sub decode_urlencoded {
810 return $res if !$data;
812 foreach my $kv (split(/[\&\;]/, $data)) {
813 my ($k, $v) = split(/=/, $kv);
815 $k =~ s/%([0-9a-fA-F][0-9a-fA-F])/chr(hex($1))/eg;
819 $v =~ s/%([0-9a-fA-F][0-9a-fA-F])/chr(hex($1))/eg;
821 $v = Encode::decode('utf8', $v);
823 if (defined(my $old = $res->{$k})) {
834 my ($r, $method) = @_;
838 if ($method eq 'PUT' || $method eq 'POST') {
840 if (my $ctype = $r->header('Content-Type')) {
841 $ct = parse_content_type($ctype);
843 if (defined($ct) && $ct eq 'application/json') {
844 $params = decode_json($r->content);
846 $params = decode_urlencoded($r->content);
850 my $query_params = decode_urlencoded($r->url->query());
852 foreach my $k (keys %{$query_params}) {
853 $params->{$k} = $query_params->{$k};
859 sub handle_api2_request {
860 my ($self, $reqstate, $auth, $method, $path, $upload_state) = @_;
863 my $r = $reqstate->{request};
865 my ($rel_uri, $format) = &$split_abs_uri($path, $self->{base_uri});
867 my $formatter = PVE::APIServer::Formatter::get_formatter($format, $method, $rel_uri);
869 if (!defined($formatter)) {
870 $self->error($reqstate, HTTP_NOT_IMPLEMENTED, "no formatter
for uri
$rel_uri, $format");
874 #print Dumper($upload_state) if $upload_state;
879 $params = $upload_state->{params};
881 $params = extract_params($r, $method);
884 delete $params->{_dc}; # remove disable cache parameter
886 my $clientip = $reqstate->{peer_host};
888 my $res = $self->rest_handler($clientip, $method, $rel_uri, $auth, $params, $format);
891 Net::SSLeay::ERR_clear_error();
893 AnyEvent->now_update(); # in case somebody called sleep()
895 my $upgrade = $r->header('upgrade');
896 $upgrade = lc($upgrade) if $upgrade;
898 if (my $host = $res->{proxy}) {
900 if ($self->{trusted_env}) {
901 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy
not allowed
");
905 if ($host ne 'localhost' && $r->header('PVEDisableProxy')) {
906 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy
loop detected
");
910 $res->{proxy_params}->{tmpfilename} = $reqstate->{tmpfilename} if $upload_state;
912 $self->proxy_request($reqstate, $clientip, $host, $res->{proxynode}, $method,
913 $r->uri, $auth, $res->{proxy_params});
916 } elsif ($upgrade && ($method eq 'GET') && ($path =~ m|websocket$|)) {
917 die "unable to upgrade to protocol
'$upgrade'\n" if !$upgrade || ($upgrade ne 'websocket');
918 my $wsver = $r->header('sec-websocket-version');
919 die "unsupported websocket-version
'$wsver'\n" if !$wsver || ($wsver ne '13');
920 my $wsproto_str = $r->header('sec-websocket-protocol');
921 die "missing websocket-protocol header
" if !$wsproto_str;
923 foreach my $p (PVE::Tools::split_list($wsproto_str)) {
924 $wsproto = $p if !$wsproto && $p eq 'base64';
925 $wsproto = $p if $p eq 'binary';
927 die "unsupported websocket-protocol protocol
'$wsproto_str'\n" if !$wsproto;
928 my $wskey = $r->header('sec-websocket-key');
929 die "missing websocket-key
\n" if !$wskey;
930 # Note: Digest::SHA::sha1_base64 has wrong padding
931 my $wsaccept = Digest::SHA::sha1_base64("${wskey
}258EAFA5-E914-47DA-95CA-C5AB0DC85B11
") . "=";
932 if ($res->{status} == HTTP_OK) {
933 $self->websocket_proxy($reqstate, $wsaccept, $wsproto, $res->{data});
939 if ($res->{status} == HTTP_UNAUTHORIZED) {
940 # always delay unauthorized calls by 3 seconds
941 $delay = 3 - tv_interval($reqstate->{starttime});
942 $delay = 0 if $delay < 0;
945 my $download = $res->{download};
946 $download //= $res->{data}->{download}
947 if defined($res->{data}) && ref($res->{data}) eq 'HASH';
948 if (defined($download)) {
949 send_file_start($self, $reqstate, $download);
953 my ($raw, $ct, $nocomp) = $formatter->($res, $res->{data}, $params, $path,
954 $auth, $self->{formatter_config});
957 if (ref($raw) && (ref($raw) eq 'HTTP::Response')) {
960 $resp = HTTP::Response->new($res->{status}, $res->{message});
961 $resp->header("Content-Type
" => $ct);
962 $resp->content($raw);
964 $self->response($reqstate, $resp, undef, $nocomp, $delay);
967 $self->error($reqstate, 501, $err);
971 sub handle_spice_proxy_request {
972 my ($self, $reqstate, $connect_str, $vmid, $node, $spiceport) = @_;
976 my ($minport, $maxport) = PVE::Tools::spice_port_range();
977 if ($spiceport < $minport || $spiceport > $maxport) {
978 die "SPICE Port
$spiceport is not in allowed range
($minport, $maxport)\n";
981 my $clientip = $reqstate->{peer_host};
982 my $r = $reqstate->{request};
986 if ($node ne 'localhost' && PVE::INotify::nodename() !~ m/^$node$/i) {
987 $remip = $self->remote_node_ip($node);
988 $self->dprint("REMOTE CONNECT
$vmid, $remip, $connect_str");
990 $self->dprint("CONNECT
$vmid, $node, $spiceport");
993 if ($remip && $r->header('PVEDisableProxy')) {
994 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy
loop detected
");
998 $reqstate->{hdl}->timeout(0);
999 $reqstate->{hdl}->wbuf_max(64*10*1024);
1001 my $remhost = $remip ? $remip : "localhost
";
1002 my $remport = $remip ? 3128 : $spiceport;
1004 tcp_connect $remhost, $remport, sub {
1006 or die "connect to
'$remhost:$remport' failed
: $!";
1008 $self->dprint("CONNECTed to
'$remhost:$remport'");
1009 $reqstate->{proxyhdl} = AnyEvent::Handle->new(
1011 rbuf_max => 64*1024,
1012 wbuf_max => 64*10*1024,
1017 $self->log_aborted_request($reqstate);
1018 $self->client_do_disconnect($reqstate);
1020 if (my $err = $@) { syslog('err', $err); }
1023 my ($hdl, $fatal, $message) = @_;
1025 $self->log_aborted_request($reqstate, $message);
1026 $self->client_do_disconnect($reqstate);
1028 if (my $err = $@) { syslog('err', "$err"); }
1032 my $proxyhdlreader = sub {
1035 my $len = length($hdl->{rbuf});
1036 my $data = substr($hdl->{rbuf}, 0, $len, '');
1038 #print "READ1
$len\n";
1039 $reqstate->{hdl}->push_write($data) if $reqstate->{hdl};
1042 my $hdlreader = sub {
1045 my $len = length($hdl->{rbuf});
1046 my $data = substr($hdl->{rbuf}, 0, $len, '');
1048 #print "READ0
$len\n";
1049 $reqstate->{proxyhdl}->push_write($data) if $reqstate->{proxyhdl};
1052 my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.0';
1054 my $startproxy = sub {
1055 $reqstate->{proxyhdl}->timeout(0);
1056 $reqstate->{proxyhdl}->on_read($proxyhdlreader);
1057 $reqstate->{hdl}->on_read($hdlreader);
1059 # todo: use stop_read/start_read if write buffer grows to much
1061 # a response must be followed by an empty line
1062 my $res = "$proto 200 OK
\015\012\015\012";
1063 $reqstate->{hdl}->push_write($res);
1066 $reqstate->{log}->{code} = 200;
1067 $self->log_request($reqstate);
1071 my $header = "CONNECT
${connect_str
} $proto\015\012" .
1072 "Host
: ${connect_str
}\015\012" .
1073 "Proxy-Connection
: keep-alive
\015\012" .
1074 "User-Agent
: spiceproxy
\015\012" .
1075 "PVEDisableProxy
: true
\015\012" .
1076 "PVEClientIP
: $clientip\015\012" .
1079 $reqstate->{proxyhdl}->push_write($header);
1080 $reqstate->{proxyhdl}->push_read(line => sub {
1081 my ($hdl, $line) = @_;
1083 if ($line =~ m!^$proto 200 OK$!) {
1084 # read the empty line after the 200 OK
1085 $reqstate->{proxyhdl}->unshift_read(line => sub{
1089 $reqstate->{hdl}->push_write($line);
1090 $self->client_do_disconnect($reqstate);
1101 $self->log_aborted_request($reqstate, $err);
1102 $self->client_do_disconnect($reqstate);
1106 sub handle_request {
1107 my ($self, $reqstate, $auth, $method, $path) = @_;
1109 my $base_uri = $self->{base_uri};
1112 my $r = $reqstate->{request};
1114 # disable timeout on handle (we already have all data we need)
1115 # we re-enable timeout in response()
1116 $reqstate->{hdl}->timeout(0);
1118 if ($path =~ m/^\Q$base_uri\E/) {
1119 $self->handle_api2_request($reqstate, $auth, $method, $path);
1123 if ($self->{pages} && ($method eq 'GET') && (my $handler = $self->{pages}->{$path})) {
1124 if (ref($handler) eq 'CODE') {
1125 my $params = decode_urlencoded($r->url->query());
1126 my ($resp, $userid) = &$handler($self, $reqstate->{request}, $params);
1128 Net::SSLeay::ERR_clear_error();
1129 $self->response($reqstate, $resp);
1130 } elsif (ref($handler) eq 'HASH') {
1131 if (my $filename = $handler->{file}) {
1132 my $fh = IO::File->new($filename) ||
1133 die "unable to
open file
'$filename' - $!\n";
1134 send_file_start($self, $reqstate, $filename);
1136 die "internal error
- no handler
";
1139 die "internal error
- no handler
";
1144 if ($self->{dirs} && ($method eq 'GET')) {
1145 # we only allow simple names
1146 if ($path =~ m!^(/\S+/)([a-zA-Z0-9\-\_\.]+)$!) {
1147 my ($subdir, $file) = ($1, $2);
1148 if (my $dir = $self->{dirs}->{$subdir}) {
1149 my $filename = "$dir$file";
1150 my $fh = IO::File->new($filename) ||
1151 die "unable to
open file
'$filename' - $!\n";
1152 send_file_start($self, $reqstate, $filename);
1158 die "no such file
'$path'\n";
1161 $self->error($reqstate, 501, $err);
1165 sub file_upload_multipart {
1166 my ($self, $reqstate, $auth, $method, $path, $rstate) = @_;
1169 my $boundary = $rstate->{boundary};
1170 my $hdl = $reqstate->{hdl};
1172 my $startlen = length($hdl->{rbuf});
1174 if ($rstate->{phase} == 0) { # skip everything until start
1175 if ($hdl->{rbuf} =~ s/^.*?--\Q$boundary\E \015?\012
1176 ((?:[^\015]+\015\012)* ) \015?\012//xs) {
1178 my ($ct, $disp, $name, $filename);
1179 foreach my $line (split(/\015?\012/, $header)) {
1180 # assume we have single line headers
1181 if ($line =~ m/^Content-Type\s*:\s*(.*)/i) {
1182 $ct = parse_content_type($1);
1183 } elsif ($line =~ m/^Content-Disposition\s*:\s*(.*)/i) {
1184 ($disp, $name, $filename) = parse_content_disposition($1);
1188 if (!($disp && $disp eq 'form-data' && $name)) {
1189 syslog('err', "wrong content disposition
in multipart
- abort upload
");
1190 $rstate->{phase} = -1;
1193 $rstate->{fieldname} = $name;
1196 if ($name eq 'filename') {
1197 # found file upload data
1198 $rstate->{phase} = 1;
1199 $rstate->{filename} = $filename;
1201 syslog('err', "wrong field name
for file upload
- abort upload
");
1202 $rstate->{phase} = -1;
1205 # found form data for field $name
1206 $rstate->{phase} = 2;
1210 my $len = length($hdl->{rbuf});
1211 substr($hdl->{rbuf}, 0, $len - $rstate->{maxheader}, '')
1212 if $len > $rstate->{maxheader}; # skip garbage
1214 } elsif ($rstate->{phase} == 1) { # inside file - dump until end marker
1215 if ($hdl->{rbuf} =~ s/^(.*?)\015?\012(--\Q$boundary\E(--)? \015?\012(.*))$/$2/xs) {
1216 my ($rest, $eof) = ($1, $3);
1217 my $len = length($rest);
1218 die "write to temporary file failed
- $!"
1219 if syswrite($rstate->{outfh}, $rest) != $len;
1220 $rstate->{ctx}->add($rest);
1221 $rstate->{params}->{filename} = $rstate->{filename};
1222 $rstate->{md5sum} = $rstate->{ctx}->hexdigest;
1223 $rstate->{bytes} += $len;
1224 $rstate->{phase} = $eof ? 100 : 0;
1226 my $len = length($hdl->{rbuf});
1227 my $wlen = $len - $rstate->{boundlen};
1229 my $data = substr($hdl->{rbuf}, 0, $wlen, '');
1230 die "write to temporary file failed
- $!"
1231 if syswrite($rstate->{outfh}, $data) != $wlen;
1232 $rstate->{bytes} += $wlen;
1233 $rstate->{ctx}->add($data);
1236 } elsif ($rstate->{phase} == 2) { # inside normal field
1238 if ($hdl->{rbuf} =~ s/^(.*?)\015?\012(--\Q$boundary\E(--)? \015?\012(.*))$/$2/xs) {
1239 my ($rest, $eof) = ($1, $3);
1240 my $len = length($rest);
1241 $rstate->{post_size} += $len;
1242 if ($rstate->{post_size} < $limit_max_post) {
1243 $rstate->{params}->{$rstate->{fieldname}} = $rest;
1244 $rstate->{phase} = $eof ? 100 : 0;
1246 syslog('err', "form data to large
- abort upload
");
1247 $rstate->{phase} = -1; # skip
1251 my $len = length($hdl->{rbuf});
1252 substr($hdl->{rbuf}, 0, $len, ''); # empty rbuf
1255 $rstate->{read} += ($startlen - length($hdl->{rbuf}));
1257 if (!$rstate->{done} && ($rstate->{read} + length($hdl->{rbuf})) >= $rstate->{size}) {
1258 $rstate->{done} = 1; # make sure we dont get called twice
1259 if ($rstate->{phase} < 0 || !$rstate->{md5sum}) {
1260 die "upload failed
\n";
1262 my $elapsed = tv_interval($rstate->{starttime});
1264 my $rate = int($rstate->{bytes}/($elapsed*1024*1024));
1265 syslog('info', "multipart upload complete
" .
1266 "(size
: %d time: %ds rate
: %.2fMiB
/s md5sum
: $rstate->{md5sum
})",
1267 $rstate->{bytes}, $elapsed, $rate);
1268 $self->handle_api2_request($reqstate, $auth, $method, $path, $rstate);
1273 syslog('err', $err);
1274 $self->error($reqstate, 501, $err);
1278 sub parse_content_type {
1281 my ($ct, @params) = split(/\s*[;,]\s*/o, $ctype);
1283 foreach my $v (@params) {
1284 if ($v =~ m/^\s*boundary\s*=\s*(\S+?)\s*$/o) {
1285 return wantarray ? ($ct, $1) : $ct;
1289 return wantarray ? ($ct) : $ct;
1292 sub parse_content_disposition {
1295 my ($disp, @params) = split(/\s*[;,]\s*/o, $line);
1299 foreach my $v (@params) {
1300 if ($v =~ m/^\s*name\s*=\s*(\S+?)\s*$/o) {
1302 $name =~ s/^"(.*)"$/$1/;
1303 } elsif ($v =~ m/^\s*filename\s*=\s*(.+?)\s*$/o) {
1305 $filename =~ s/^"(.*)"$/$1/;
1309 return wantarray ? ($disp, $name, $filename) : $disp;
1312 my $tmpfile_seq_no = 0;
1314 sub get_upload_filename {
1315 # choose unpredictable tmpfile name
1318 return "/var/tmp
/pveupload-
" . Digest::MD5::md5_hex($tmpfile_seq_no . time() . $$);
1321 sub unshift_read_header {
1322 my ($self, $reqstate, $state) = @_;
1324 $state = { size => 0, count => 0 } if !$state;
1326 $reqstate->{hdl}->unshift_read(line => sub {
1327 my ($hdl, $line) = @_;
1330 # print "$$: got header
: $line\n" if $self->{debug};
1332 die "too many http header lines
(> $limit_max_headers)\n" if ++$state->{count} >= $limit_max_headers;
1333 die "http header too large
\n" if ($state->{size} += length($line)) >= $limit_max_header_size;
1335 my $r = $reqstate->{request};
1338 my $path = uri_unescape($r->uri->path());
1339 my $method = $r->method();
1341 $r->push_header($state->{key}, $state->{val})
1344 if (!$known_methods->{$method}) {
1345 my $resp = HTTP::Response->new(HTTP_NOT_IMPLEMENTED, "method '$method' not available
");
1346 $self->response($reqstate, $resp);
1350 my $conn = $r->header('Connection');
1351 my $accept_enc = $r->header('Accept-Encoding');
1352 $reqstate->{accept_gzip} = ($accept_enc && $accept_enc =~ m/gzip/) ? 1 : 0;
1355 $reqstate->{keep_alive} = 0 if $conn =~ m/close/oi;
1357 if ($reqstate->{proto}->{ver} < 1001) {
1358 $reqstate->{keep_alive} = 0;
1362 my $te = $r->header('Transfer-Encoding');
1363 if ($te && lc($te) eq 'chunked') {
1364 # Handle chunked transfer encoding
1365 $self->error($reqstate, 501, "chunked transfer encoding
not supported
");
1368 $self->error($reqstate, 501, "Unknown transfer encoding
'$te'");
1372 my $pveclientip = $r->header('PVEClientIP');
1373 my $base_uri = $self->{base_uri};
1375 # fixme: how can we make PVEClientIP header trusted?
1376 if ($self->{trusted_env} && $pveclientip) {
1377 $reqstate->{peer_host} = $pveclientip;
1379 $r->header('PVEClientIP', $reqstate->{peer_host});
1382 my $len = $r->header('Content-Length');
1384 my $host_header = $r->header('Host');
1385 if (my $rpcenv = $self->{rpcenv}) {
1386 $rpcenv->set_request_host($host_header);
1389 # header processing complete - authenticate now
1392 if ($self->{spiceproxy}) {
1393 my $connect_str = $host_header;
1394 my ($vmid, $node, $port) = $self->verify_spice_connect_url($connect_str);
1395 if (!(defined($vmid) && $node && $port)) {
1396 $self->error($reqstate, HTTP_UNAUTHORIZED, "invalid ticket
");
1399 $self->handle_spice_proxy_request($reqstate, $connect_str, $vmid, $node, $port);
1401 } elsif ($path =~ m/^\Q$base_uri\E/) {
1402 my $token = $r->header('CSRFPreventionToken');
1403 my $cookie = $r->header('Cookie');
1404 my $auth_header = $r->header('Authorization');
1406 # prefer actual cookie
1407 my $ticket = PVE::APIServer::Formatter::extract_auth_value($cookie, $self->{cookie_name});
1409 # fallback to cookie in 'Authorization' header
1410 $ticket = PVE::APIServer::Formatter::extract_auth_value($auth_header, $self->{cookie_name})
1413 # finally, fallback to API token if no ticket has been provided so far
1415 $api_token = PVE::APIServer::Formatter::extract_auth_value($auth_header, $self->{apitoken_name})
1418 my ($rel_uri, $format) = &$split_abs_uri($path, $self->{base_uri});
1420 $self->error($reqstate, HTTP_NOT_IMPLEMENTED, "no such uri
");
1425 $auth = $self->auth_handler($method, $rel_uri, $ticket, $token, $api_token,
1426 $reqstate->{peer_host});
1430 Net::SSLeay::ERR_clear_error();
1431 # always delay unauthorized calls by 3 seconds
1434 if (ref($err) eq "PVE
::Exception
") {
1436 $err->{code} ||= HTTP_INTERNAL_SERVER_ERROR,
1437 my $resp = HTTP::Response->new($err->{code}, $err->{msg});
1438 $self->response($reqstate, $resp, undef, 0, $delay);
1440 } elsif (my $formatter = PVE::APIServer::Formatter::get_login_formatter($format)) {
1441 my ($raw, $ct, $nocomp) =
1442 $formatter->($path, $auth, $self->{formatter_config});
1444 if (ref($raw) && (ref($raw) eq 'HTTP::Response')) {
1447 $resp = HTTP::Response->new(HTTP_UNAUTHORIZED, "Login Required
");
1448 $resp->header("Content-Type
" => $ct);
1449 $resp->content($raw);
1451 $self->response($reqstate, $resp, undef, $nocomp, $delay);
1453 my $resp = HTTP::Response->new(HTTP_UNAUTHORIZED, $err);
1454 $self->response($reqstate, $resp, undef, 0, $delay);
1460 $reqstate->{log}->{userid} = $auth->{userid};
1464 if (!($method eq 'PUT' || $method eq 'POST')) {
1465 $self->error($reqstate, 501, "Unexpected content
for method '$method'");
1469 my $ctype = $r->header('Content-Type');
1470 my ($ct, $boundary);
1471 ($ct, $boundary)= parse_content_type($ctype) if $ctype;
1473 if ($auth->{isUpload} && !$self->{trusted_env}) {
1474 die "upload
'Content-Type '$ctype' not implemented\n"
1475 if !($boundary && $ct && ($ct eq 'multipart
/form-data
'));
1477 die "upload without content length header not supported" if !$len;
1479 die "upload without content length header not supported" if !$len;
1481 $self->dprint("start upload $path $ct $boundary");
1483 my $tmpfilename = get_upload_filename();
1484 my $outfh = IO::File->new($tmpfilename, O_RDWR|O_CREAT|O_EXCL, 0600) ||
1485 die "unable to create temporary upload file '$tmpfilename'";
1487 $reqstate->{keep_alive} = 0;
1489 my $boundlen = length($boundary) + 8; # \015?\012--$boundary--\015?\012
1493 boundary => $boundary,
1494 ctx => Digest::MD5->new,
1495 boundlen => $boundlen,
1496 maxheader => 2048 + $boundlen, # should be large enough
1497 params => decode_urlencoded($r->url->query()),
1501 starttime => [gettimeofday],
1504 $reqstate->{tmpfilename} = $tmpfilename;
1505 $reqstate->{hdl}->on_read(sub { $self->file_upload_multipart($reqstate, $auth, $method, $path, $state); });
1509 if ($len > $limit_max_post) {
1510 $self->error($reqstate, 501, "for data too large");
1514 if (!$ct || $ct eq 'application
/x-www-form-urlencoded' || $ct eq 'application/json
') {
1515 $reqstate->{hdl}->unshift_read(chunk => $len, sub {
1516 my ($hdl, $data) = @_;
1518 $self->handle_request($reqstate, $auth, $method, $path);
1521 $self->error($reqstate, 506, "upload 'Content-Type
'$ctype' not implemented
");
1524 $self->handle_request($reqstate, $auth, $method, $path);
1526 } elsif ($line =~ /^([^:\s]+)\s*:\s*(.*)/) {
1527 $r->push_header($state->{key}, $state->{val}) if $state->{key};
1528 ($state->{key}, $state->{val}) = ($1, $2);
1529 $self->unshift_read_header($reqstate, $state);
1530 } elsif ($line =~ /^\s+(.*)/) {
1531 $state->{val} .= " $1";
1532 $self->unshift_read_header($reqstate, $state);
1534 $self->error($reqstate, 506, "unable to parse request header
");
1541 sub push_request_header {
1542 my ($self, $reqstate) = @_;
1545 $reqstate->{hdl}->push_read(line => sub {
1546 my ($hdl, $line) = @_;
1549 # print "got request header
: $line\n" if $self->{debug};
1551 $reqstate->{keep_alive}--;
1553 if ($line =~ /(\S+)\040(\S+)\040HTTP\/(\d+)\.(\d+)/o) {
1554 my ($method, $url, $maj, $min) = ($1, $2, $3, $4);
1557 $self->error($reqstate, 506, "http protocol version
$maj.$min not supported
");
1561 $self->{request_count}++; # only count valid request headers
1562 if ($self->{request_count} >= $self->{max_requests}) {
1563 $self->{end_loop} = 1;
1565 $reqstate->{log} = { requestline => $line };
1566 $reqstate->{proto}->{str} = "HTTP
/$maj.$min";
1567 $reqstate->{proto}->{maj} = $maj;
1568 $reqstate->{proto}->{min} = $min;
1569 $reqstate->{proto}->{ver} = $maj*1000+$min;
1570 $reqstate->{request} = HTTP::Request->new($method, $url);
1571 $reqstate->{starttime} = [gettimeofday],
1573 $self->unshift_read_header($reqstate);
1574 } elsif ($line eq '') {
1575 # ignore empty lines before requests (browser bugs?)
1576 $self->push_request_header($reqstate);
1578 $self->error($reqstate, 400, 'bad request');
1592 return if $self->{end_loop};
1594 # we need to m make sure that only one process calls accept
1595 while (!flock($self->{lockfh}, Fcntl::LOCK_EX())) {
1596 next if $! == EINTR;
1597 die "could
not get
lock on file
'$self->{lockfile}' - $!\n";
1603 while (!$self->{end_loop} &&
1604 !defined($clientfh = $self->{socket}->accept()) &&
1607 if ($self->{end_loop}) {
1610 $again = ($! == EAGAIN || $! == WSAEWOULDBLOCK);
1611 if (!defined($clientfh)) {
1612 $errmsg = "failed to
accept connection
: $!\n";
1618 flock($self->{lockfh}, Fcntl::LOCK_UN());
1620 if (!defined($clientfh)) {
1622 die $errmsg if $errmsg;
1625 fh_nonblocking $clientfh, 1;
1633 $self->{end_loop} = 1;
1635 undef $self->{socket_watch};
1637 $0 = "$0 (shutdown)" if $0 !~ m/\(shutdown\)$/;
1639 if ($self->{conn_count} <= 0) {
1640 $self->{end_cond}->send(1);
1644 # fork and exit, so that parent starts a new worker
1649 # else we need to wait until all open connections gets closed
1650 my $w; $w = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1652 # todo: test for active connections instead (we can abort idle connections)
1653 if ($self->{conn_count} <= 0) {
1655 $self->{end_cond}->send(1);
1663 sub check_host_access {
1664 my ($self, $clientip) = @_;
1666 $clientip = PVE::APIServer::Utils::normalize_v4_in_v6($clientip);
1667 my $cip = Net::IP->new($clientip);
1670 $self->dprint("client IP
not parsable
: $@");
1674 my $match_allow = 0;
1677 if ($self->{allow_from}) {
1678 foreach my $t (@{$self->{allow_from}}) {
1679 if ($t->overlaps($cip)) {
1681 $self->dprint("client IP allowed
: ". $t->prefix());
1687 if ($self->{deny_from}) {
1688 foreach my $t (@{$self->{deny_from}}) {
1689 if ($t->overlaps($cip)) {
1690 $self->dprint("client IP denied
: ". $t->prefix());
1697 if ($match_allow == $match_deny) {
1698 # match both allow and deny, or no match
1699 return $self->{policy} && $self->{policy} eq 'allow' ? 1 : 0;
1702 return $match_allow;
1705 sub accept_connections {
1708 my ($clientfh, $handle_creation);
1711 while ($clientfh = $self->accept()) {
1713 my $reqstate = { keep_alive => $self->{keep_alive} };
1715 # stop keep-alive when there are many open connections
1716 if ($self->{conn_count} + 1 >= $self->{max_conn_soft_limit}) {
1717 $reqstate->{keep_alive} = 0;
1720 if (my $sin = getpeername($clientfh)) {
1721 my ($pfamily, $pport, $phost) = PVE::Tools::unpack_sockaddr_in46($sin);
1722 ($reqstate->{peer_port}, $reqstate->{peer_host}) = ($pport, Socket::inet_ntop($pfamily, $phost));
1724 $self->dprint("getpeername failed
: $!");
1729 if (!$self->{trusted_env} && !$self->check_host_access($reqstate->{peer_host})) {
1730 $self->dprint("ABORT request from
$reqstate->{peer_host
} - access denied
");
1731 $reqstate->{log}->{code} = 403;
1732 $self->log_request($reqstate);
1737 # Increment conn_count before creating new handle, since creation
1738 # triggers callbacks, which can potentialy decrement (e.g.
1739 # on_error) conn_count before AnyEvent::Handle->new() returns.
1740 $handle_creation = 1;
1741 $self->{conn_count}++;
1742 $reqstate->{hdl} = AnyEvent::Handle->new(
1744 rbuf_max => 64*1024,
1745 timeout => $self->{timeout},
1746 linger => 0, # avoid problems with ssh - really needed ?
1750 $self->log_aborted_request($reqstate);
1751 $self->client_do_disconnect($reqstate);
1753 if (my $err = $@) { syslog('err', $err); }
1756 my ($hdl, $fatal, $message) = @_;
1758 $self->log_aborted_request($reqstate, $message);
1759 $self->client_do_disconnect($reqstate);
1761 if (my $err = $@) { syslog('err', "$err"); }
1763 ($self->{tls_ctx} ? (tls => "accept", tls_ctx => $self->{tls_ctx}) : ()));
1764 $handle_creation = 0;
1766 $self->dprint("ACCEPT FH
" . $clientfh->fileno() . " CONN
$self->{conn_count
}");
1768 $self->push_request_header($reqstate);
1773 syslog('err', $err);
1774 $self->dprint("connection
accept error
: $err");
1776 if ($handle_creation) {
1777 if ($self->{conn_count} <= 0) {
1778 warn "connection count
<= 0 not decrementing
!\n";
1780 $self->{conn_count}--;
1783 $self->{end_loop} = 1;
1786 $self->wait_end_loop() if $self->{end_loop};
1789 # Note: We can't open log file in non-blocking mode and use AnyEvent::Handle,
1790 # because we write from multiple processes, and that would arbitrarily mix output
1792 sub open_access_log {
1793 my ($self, $filename) = @_;
1795 my $old_mask = umask(0137);;
1796 my $logfh = IO::File->new($filename, ">>") ||
1797 die "unable to
open log file
'$filename' - $!\n";
1800 $logfh->autoflush(1);
1802 $self->{logfh} = $logfh;
1806 my ($self, $data) = @_;
1808 return if !defined($self->{logfh}) || !$data;
1810 my $res = $self->{logfh}->print($data);
1813 delete $self->{logfh};
1814 syslog('err', "error writing access
log");
1815 $self->{end_loop} = 1; # terminate asap
1819 sub atfork_handler {
1823 # something else do to ?
1824 close($self->{socket});
1832 $self->{end_cond}->recv;
1836 my ($this, %args) = @_;
1838 my $class = ref($this) || $this;
1840 foreach my $req (qw(socket lockfh lockfile)) {
1841 die "misssing required argument '$req'" if !defined($args{$req});
1844 my $self = bless { %args }, $class;
1846 $self->{cookie_name
} //= 'PVEAuthCookie';
1847 $self->{apitoken_name
} //= 'PVEAPIToken';
1848 $self->{base_uri
} //= "/api2";
1849 $self->{dirs
} //= {};
1850 $self->{title
} //= 'API Inspector';
1851 $self->{compression
} //= 1;
1853 # formatter_config: we pass some configuration values to the Formatter
1854 $self->{formatter_config
} = {};
1855 foreach my $p (qw(apitoken_name cookie_name base_uri title)) {
1856 $self->{formatter_config
}->{$p} = $self->{$p};
1858 $self->{formatter_config
}->{csrfgen_func
} =
1859 $self->can('generate_csrf_prevention_token');
1861 # add default dirs which includes jquery and bootstrap
1862 my $jsbase = '/usr/share/javascript';
1863 add_dirs
($self->{dirs
}, '/js/' => "$jsbase/");
1864 # libjs-bootstrap uses symlinks for this, which we do not want to allow..
1865 my $glyphicons = '/usr/share/fonts/truetype/glyphicons/';
1866 add_dirs
($self->{dirs
}, '/js/bootstrap/fonts/' => "$glyphicons");
1869 PVE
::INotify
::inotify_init
();
1871 fh_nonblocking
($self->{socket}, 1);
1873 $self->{end_loop
} = 0;
1874 $self->{conn_count
} = 0;
1875 $self->{request_count
} = 0;
1876 $self->{timeout
} = 5 if !$self->{timeout
};
1877 $self->{keep_alive
} = 0 if !defined($self->{keep_alive
});
1878 $self->{max_conn
} = 800 if !$self->{max_conn
};
1879 $self->{max_requests
} = 8000 if !$self->{max_requests
};
1881 $self->{policy
} = 'allow' if !$self->{policy
};
1883 $self->{end_cond
} = AnyEvent-
>condvar;
1886 my $ssl_defaults = {
1887 # Note: older versions are considered insecure, for example
1888 # search for "Poodle"-Attack
1892 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',
1893 honor_cipher_order
=> 1,
1896 foreach my $k (keys %$ssl_defaults) {
1897 $self->{ssl
}->{$k} //= $ssl_defaults->{$k};
1900 if (!defined($self->{ssl
}->{dh_file
})) {
1901 $self->{ssl
}->{dh
} = 'skip2048';
1904 my $tls_ctx_flags = &Net
::SSLeay
::OP_NO_COMPRESSION
| &Net
::SSLeay
::OP_SINGLE_ECDH_USE
| &Net
::SSLeay
::OP_SINGLE_DH_USE
;
1905 if ( delete $self->{ssl
}->{honor_cipher_order
} ) {
1906 $tls_ctx_flags |= &Net
::SSLeay
::OP_CIPHER_SERVER_PREFERENCE
;
1909 $self->{tls_ctx
} = AnyEvent
::TLS-
>new(%{$self->{ssl
}});
1910 Net
::SSLeay
::CTX_set_options
($self->{tls_ctx
}->{ctx
}, $tls_ctx_flags);
1913 if ($self->{spiceproxy
}) {
1914 $known_methods = { CONNECT
=> 1 };
1917 $self->open_access_log($self->{logfile
}) if $self->{logfile
};
1919 $self->{max_conn_soft_limit
} = $self->{max_conn
} > 100 ?
$self->{max_conn
} - 20 : $self->{max_conn
};
1921 $self->{socket_watch
} = AnyEvent-
>io(fh
=> $self->{socket}, poll
=> 'r', cb
=> sub {
1923 if ($self->{conn_count
} >= $self->{max_conn
}) {
1924 my $w; $w = AnyEvent-
>timer (after
=> 1, interval
=> 1, cb
=> sub {
1925 if ($self->{conn_count
} < $self->{max_conn
}) {
1927 $self->accept_connections();
1931 $self->accept_connections();
1937 $self->{term_watch
} = AnyEvent-
>signal(signal
=> "TERM", cb
=> sub {
1938 undef $self->{term_watch
};
1939 $self->wait_end_loop();
1942 $self->{quit_watch
} = AnyEvent-
>signal(signal
=> "QUIT", cb
=> sub {
1943 undef $self->{quit_watch
};
1944 $self->wait_end_loop();
1947 $self->{inotify_poll
} = AnyEvent-
>timer(after
=> 5, interval
=> 5, cb
=> sub {
1948 PVE
::INotify
::poll
(); # read inotify events
1954 # static helper to add directory including all subdirs
1955 # This can be used to setup $self->{dirs}
1957 my ($result_hash, $alias, $subdir) = @_;
1959 $result_hash->{$alias} = $subdir;
1962 my $dir = $File::Find
::dir
;
1963 if ($dir =~m!^$subdir(.*)$!) {
1964 my $name = "$alias$1/";
1965 $result_hash->{$name} = "$dir/";
1969 find
({wanted
=> $wanted, follow
=> 0, no_chdir
=> 1}, $subdir);
1972 # abstract functions - subclass should overwrite/implement them
1974 sub verify_spice_connect_url
{
1975 my ($self, $connect_str) = @_;
1979 #return ($vmid, $node, $port);
1982 # formatters can call this when the generate a new page
1983 sub generate_csrf_prevention_token
{
1984 my ($username) = @_;
1986 return undef; # do nothing by default
1990 my ($self, $method, $rel_uri, $ticket, $token, $api_token, $peer_host) = @_;
1995 # ticket => $ticket,
1997 # userid => $username,
1999 # isUpload => $isUpload,
2000 # api_token => $api_token,
2005 my ($self, $clientip, $method, $rel_uri, $auth, $params, $format) = @_;
2007 # please do not raise exceptions here (always return a result).
2010 status
=> HTTP_NOT_IMPLEMENTED
,
2011 message
=> "Method '$method $rel_uri' not implemented",
2014 # this should return the following properties, which
2015 # are then passed to the Formatter
2017 # status: HTTP status code
2018 # message: Error message
2019 # errors: more detailed error hash (per parameter)
2020 # info: reference to JSON schema definition - useful to format output
2023 # total: additional info passed to output
2024 # changes: additional info passed to output
2026 # if you want to proxy the request to another node return this
2027 # { proxy => $remip, proxynode => $node, proxy_params => $params };
2029 # to pass the request to the local priviledged daemon use:
2030 # { proxy => 'localhost' , proxy_params => $params };
2032 # to download aspecific file use:
2033 # { download => "/path/to/file" };
2036 sub check_cert_fingerprint
{
2037 my ($self, $cert) = @_;
2042 sub initialize_cert_cache
{
2043 my ($self, $node) = @_;
2048 sub remote_node_ip
{
2049 my ($self, $node) = @_;