1 package PVE
::APIServer
::AnyEvent
;
5 use Time
::HiRes
qw(usleep ualarm gettimeofday tv_interval);
6 use Socket
qw(IPPROTO_TCP TCP_NODELAY SOMAXCONN);
7 use POSIX
qw(strftime EINTR EAGAIN);
14 # use AnyEvent::Strict; # only use this for debugging
15 use AnyEvent
::Util
qw(guard fh_nonblocking WSAEWOULDBLOCK WSAEINPROGRESS);
27 use PVE
::APIServer
::Formatter
;
32 use HTTP
::Status
qw(:constants);
39 my $limit_max_headers = 30;
40 my $limit_max_header_size = 8*1024;
41 my $limit_max_post = 16*1024;
50 my $split_abs_uri = sub {
51 my ($abs_uri, $base_uri) = @_;
53 my ($format, $rel_uri) = $abs_uri =~ m/^\Q$base_uri\E\/+([a-z
][a-z0-9
]+)(\
/.*)?$/;
54 $rel_uri = '/' if !$rel_uri;
56 return wantarray ?
($rel_uri, $format) : $rel_uri;
60 my ($self, $reqstate) = @_;
62 my $loginfo = $reqstate->{log};
64 # like apache2 common log format
65 # LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\""
67 return if $loginfo->{written
}; # avoid duplicate logs
68 $loginfo->{written
} = 1;
70 my $peerip = $reqstate->{peer_host
} || '-';
71 my $userid = $loginfo->{userid
} || '-';
72 my $content_length = defined($loginfo->{content_length
}) ?
$loginfo->{content_length
} : '-';
73 my $code = $loginfo->{code
} || 500;
74 my $requestline = $loginfo->{requestline
} || '-';
75 my $timestr = strftime
("%d/%b/%Y:%H:%M:%S %z", localtime());
77 my $msg = "$peerip - $userid [$timestr] \"$requestline\" $code $content_length\n";
79 $self->write_log($msg);
82 sub log_aborted_request {
83 my ($self, $reqstate, $error) = @_;
85 my $r = $reqstate->{request};
86 return if !$r; # no active request
89 syslog("err
", "problem with client
$reqstate->{peer_host
}; $error");
92 $self->log_request($reqstate);
95 sub cleanup_reqstate {
98 delete $reqstate->{log};
99 delete $reqstate->{request};
100 delete $reqstate->{proto};
101 delete $reqstate->{accept_gzip};
102 delete $reqstate->{starttime};
104 if ($reqstate->{tmpfilename}) {
105 unlink $reqstate->{tmpfilename};
106 delete $reqstate->{tmpfilename};
110 sub client_do_disconnect {
111 my ($self, $reqstate) = @_;
113 cleanup_reqstate($reqstate);
115 my $shutdown_hdl = sub {
118 shutdown($hdl->{fh}, 1);
120 $hdl->on_drain(undef);
121 $hdl->on_read(undef);
125 if (my $proxyhdl = delete $reqstate->{proxyhdl}) {
126 &$shutdown_hdl($proxyhdl);
129 my $hdl = delete $reqstate->{hdl};
132 syslog('err', "detected empty handle
");
136 print "close connection
$hdl\n" if $self->{debug};
138 &$shutdown_hdl($hdl);
140 $self->{conn_count}--;
142 print "$$: CLOSE FH
" . $hdl->{fh}->fileno() . " CONN
$self->{conn_count
}\n" if $self->{debug};
145 sub finish_response {
146 my ($self, $reqstate) = @_;
148 my $hdl = $reqstate->{hdl};
150 cleanup_reqstate($reqstate);
152 if (!$self->{end_loop} && $reqstate->{keep_alive} > 0) {
153 # print "KEEPALIVE
$reqstate->{keep_alive
}\n" if $self->{debug};
155 eval { $self->push_request_header($reqstate); };
159 $hdl->on_drain (sub {
161 $self->client_do_disconnect($reqstate);
169 my ($self, $reqstate, $resp, $mtime, $nocomp, $delay) = @_;
171 #print "$$: send response
: " . Dumper($resp);
174 $reqstate->{hdl}->timeout_reset();
175 $reqstate->{hdl}->timeout($self->{timeout});
177 $nocomp = 1 if !$reqstate->{accept_gzip};
179 my $code = $resp->code;
180 my $msg = $resp->message || HTTP::Status::status_message($code);
181 ($msg) = $msg =~m/^(.*)$/m;
182 my $content = $resp->content;
184 if ($code =~ /^(1\d\d|[23]04)$/) {
185 # make sure content we have no content
189 $reqstate->{keep_alive} = 0 if ($code >= 400) || $self->{end_loop};
191 $reqstate->{log}->{code} = $code;
193 my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.0';
194 my $res = "$proto $code $msg\015\012";
197 my $date = HTTP::Date::time2str($ctime);
198 $resp->header('Date' => $date);
200 $resp->header('Last-Modified' => HTTP::Date::time2str($mtime));
202 $resp->header('Expires' => $date);
203 $resp->header('Cache-Control' => "max-age
=0");
204 $resp->header("Pragma
", "no-cache
");
207 $resp->header('Server' => "pve-api-daemon
/3.0");
212 $content_length = length($content);
214 if (!$nocomp && ($content_length > 1024)) {
215 my $comp = Compress::Zlib::memGzip($content);
216 $resp->header('Content-Encoding', 'gzip');
218 $content_length = length($content);
220 $resp->header("Content-Length
" => $content_length);
221 $reqstate->{log}->{content_length} = $content_length;
224 $resp->remove_header("Content-Length
");
227 if ($reqstate->{keep_alive} > 0) {
228 $resp->push_header('Connection' => 'Keep-Alive');
230 $resp->header('Connection' => 'close');
233 $res .= $resp->headers_as_string("\015\012");
234 #print "SEND
(without content
) $res\n" if $self->{debug};
237 $res .= $content if $content;
239 $self->log_request($reqstate, $reqstate->{request});
241 if ($delay && $delay > 0) {
242 my $w; $w = AnyEvent->timer(after => $delay, cb => sub {
243 undef $w; # delete reference
244 $reqstate->{hdl}->push_write($res);
245 $self->finish_response($reqstate);
248 $reqstate->{hdl}->push_write($res);
249 $self->finish_response($reqstate);
254 my ($self, $reqstate, $code, $msg, $hdr, $content) = @_;
257 my $resp = HTTP::Response->new($code, $msg, $hdr, $content);
258 $self->response($reqstate, $resp);
263 my $file_extension_info = {
264 css => { ct => 'text/css' },
265 html => { ct => 'text/html' },
266 js => { ct => 'application/javascript' },
267 png => { ct => 'image/png' , nocomp => 1 },
268 ico => { ct => 'image/x-icon', nocomp => 1},
269 gif => { ct => 'image/gif', nocomp => 1},
270 jar => { ct => 'application/java-archive', nocomp => 1},
271 woff => { ct => 'application/font-woff', nocomp => 1},
272 woff2 => { ct => 'application/font-woff2', nocomp => 1},
273 ttf => { ct => 'application/font-snft', nocomp => 1},
274 pdf => { ct => 'application/pdf', nocomp => 1},
275 epub => { ct => 'application/epub+zip', nocomp => 1},
278 sub send_file_start {
279 my ($self, $reqstate, $filename) = @_;
282 # print "SEND FILE
$filename\n";
283 # Note: aio_load() this is not really async unless we use IO::AIO!
286 my $r = $reqstate->{request};
288 my $fh = IO::File->new($filename, '<') ||
290 my $stat = File::stat::stat($fh) ||
293 my $mtime = $stat->mtime;
295 if (my $ifmod = $r->header('if-modified-since')) {
296 my $iftime = HTTP::Date::str2time($ifmod);
297 if ($mtime <= $iftime) {
298 my $resp = HTTP::Response->new(304, "NOT MODIFIED
");
299 $self->response($reqstate, $resp, $mtime);
305 my $len = sysread($fh, $data, $stat->size);
306 die "got short file
\n" if !defined($len) || $len != $stat->size;
308 my ($ext) = $filename =~ m/\.([^.]*)$/;
309 my $ext_info = $file_extension_info->{$ext};
311 die "unable to detect content type
" if !$ext_info;
313 my $header = HTTP::Headers->new(Content_Type => $ext_info->{ct});
314 my $resp = HTTP::Response->new(200, "OK
", $header, $data);
315 $self->response($reqstate, $resp, $mtime, $ext_info->{nocomp});
318 $self->error($reqstate, 501, $err);
325 sub websocket_proxy {
326 my ($self, $reqstate, $wsaccept, $wsproto, $param) = @_;
332 my $max_payload_size = 65536;
335 if ($wsproto eq 'binary') {
337 } elsif ($wsproto eq 'base64') {
340 die "websocket_proxy
: unsupported protocol
'$wsproto'\n";
343 if ($param->{port}) {
344 $remhost = 'localhost';
345 $remport = $param->{port};
346 } elsif ($param->{socket}) {
348 $remport = $param->{socket};
350 die "websocket_proxy
: missing port
or socket\n";
353 tcp_connect $remhost, $remport, sub {
355 or die "connect to
'$remhost:$remport' failed
: $!";
357 print "$$: CONNECTed to
'$remhost:$remport'\n" if $self->{debug};
359 $reqstate->{proxyhdl} = AnyEvent::Handle->new(
362 wbuf_max => 64*10*1024,
367 $self->log_aborted_request($reqstate);
368 $self->client_do_disconnect($reqstate);
370 if (my $err = $@) { syslog('err', $err); }
373 my ($hdl, $fatal, $message) = @_;
375 $self->log_aborted_request($reqstate, $message);
376 $self->client_do_disconnect($reqstate);
378 if (my $err = $@) { syslog('err', "$err"); }
381 my $proxyhdlreader = sub {
384 my $len = length($hdl->{rbuf});
385 my $data = substr($hdl->{rbuf}, 0, $len, '');
391 $string = "\x82"; # binary frame
394 $string = "\x81"; # text frame
395 $payload = encode_base64($data, '');
398 my $payload_len = length($payload);
399 if ($payload_len <= 125) {
400 $string .= pack 'C', $payload_len;
401 } elsif ($payload_len <= 0xffff) {
402 $string .= pack 'C', 126;
403 $string .= pack 'n', $payload_len;
405 $string .= pack 'C', 127;
406 $string .= pack 'Q>', $payload_len;
410 $reqstate->{hdl}->push_write($string) if $reqstate->{hdl};
413 my $hdlreader = sub {
416 my $len = length($hdl->{rbuf});
419 my $hdr = unpack('C', substr($hdl->{rbuf}, 0, 1));
420 my $opcode = $hdr & 0b00001111;
421 my $fin = $hdr & 0b10000000;
423 die "received fragmented websocket frame
\n" if !$fin;
425 my $rsv = $hdr & 0b01110000;
426 die "received websocket frame with RSV flags
\n" if $rsv;
428 my $payload_len = unpack 'C', substr($hdl->{rbuf}, 1, 1);
430 my $masked = $payload_len & 0b10000000;
431 die "received unmasked websocket frame from client
\n" if !$masked;
434 $payload_len = $payload_len & 0b01111111;
435 if ($payload_len == 126) {
437 $payload_len = unpack('n', substr($hdl->{rbuf}, $offset, 2));
439 } elsif ($payload_len == 127) {
441 $payload_len = unpack('Q>', substr($hdl->{rbuf}, $offset, 8));
445 die "received too large websocket frame
(len
= $payload_len)\n"
446 if ($payload_len > $max_payload_size) || ($payload_len < 0);
448 return if $len < ($offset + 4 + $payload_len);
450 my $data = substr($hdl->{rbuf}, 0, $len, ''); # now consume data
452 my @mask = (unpack('C', substr($data, $offset+0, 1)),
453 unpack('C', substr($data, $offset+1, 1)),
454 unpack('C', substr($data, $offset+2, 1)),
455 unpack('C', substr($data, $offset+3, 1)));
459 my $payload = substr($data, $offset, $payload_len);
461 for (my $i = 0; $i < $payload_len; $i++) {
462 my $d = unpack('C', substr($payload, $i, 1));
463 my $n = $d ^ $mask[$i % 4];
464 substr($payload, $i, 1, pack('C', $n));
467 $payload = decode_base64($payload) if !$binary;
469 if ($opcode == 1 || $opcode == 2) {
470 $reqstate->{proxyhdl}->push_write($payload) if $reqstate->{proxyhdl};
471 } elsif ($opcode == 8) {
472 print "websocket received
close\n" if $self->{debug};
473 if ($reqstate->{proxyhdl}) {
474 $reqstate->{proxyhdl}->push_write($payload);
475 $reqstate->{proxyhdl}->push_shutdown();
477 $hdl->push_shutdown();
479 die "received unhandled websocket opcode
$opcode\n";
483 my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.1';
485 $reqstate->{proxyhdl}->timeout(0);
486 $reqstate->{proxyhdl}->on_read($proxyhdlreader);
487 $reqstate->{hdl}->on_read($hdlreader);
489 # todo: use stop_read/start_read if write buffer grows to much
491 my $res = "$proto 101 Switching Protocols
\015\012" .
492 "Upgrade
: websocket
\015\012" .
493 "Connection
: upgrade
\015\012" .
494 "Sec-WebSocket-Accept
: $wsaccept\015\012" .
495 "Sec-WebSocket-Protocol
: $wsproto\015\012" .
498 print $res if $self->{debug};
500 $reqstate->{hdl}->push_write($res);
503 $reqstate->{log}->{code} = 101;
504 $self->log_request($reqstate);
510 $self->log_aborted_request($reqstate, $err);
511 $self->client_do_disconnect($reqstate);
516 my ($self, $reqstate, $clientip, $host, $node, $method, $uri, $ticket, $token, $params) = @_;
521 if ($host eq 'localhost') {
522 $target = "http
://$host:85$uri";
523 # keep alive for localhost is not worth (connection setup is about 0.2ms)
525 } elsif (Net::IP::ip_is_ipv6($host)) {
526 $target = "https
://[$host]:8006$uri";
528 $target = "https
://$host:8006$uri";
532 PVEDisableProxy => 'true',
533 PVEClientIP => $clientip,
536 $headers->{'cookie'} = PVE::APIServer::Formatter::create_auth_cookie($ticket, $self->{cookie_name}) if $ticket;
537 $headers->{'CSRFPreventionToken'} = $token if $token;
538 $headers->{'Accept-Encoding'} = 'gzip' if $reqstate->{accept_gzip};
542 if ($method eq 'POST' || $method eq 'PUT') {
543 $headers->{'Content-Type'} = 'application/x-www-form-urlencoded';
544 # use URI object to format application/x-www-form-urlencoded content.
545 my $url = URI->new('http:');
546 $url->query_form(%$params);
547 $content = $url->query;
548 if (defined($content)) {
549 $headers->{'Content-Length'} = length($content);
554 # TLS 1.x only, with certificate pinning
560 my (undef, undef, undef, $depth, undef, undef, $cert) = @_;
561 # we don't care about intermediate or root certificates
562 return 1 if $depth != 0;
563 # check server certificate against cache of pinned FPs
564 return $self->check_cert_fingerprint($cert);
568 # load and cache cert fingerprint if first time we proxy to this node
569 $self->initialize_cert_cache($node);
571 my $w; $w = http_request(
576 proxy => undef, # avoid use of $ENV{HTTP_PROXY}
577 keepalive => $keep_alive,
579 tls_ctx => AnyEvent::TLS->new(%{$tls}),
581 my ($body, $hdr) = @_;
585 if (!$reqstate->{hdl}) {
586 warn "proxy detected vanished client connection
\n";
591 my $code = delete $hdr->{Status};
592 my $msg = delete $hdr->{Reason};
594 delete $hdr->{HTTPVersion};
595 my $header = HTTP::Headers->new(%$hdr);
596 if (my $location = $header->header('Location')) {
597 $location =~ s|^http://localhost:85||;
598 $header->header(Location => $location);
600 my $resp = HTTP::Response->new($code, $msg, $header, $body);
601 # Note: disable compression, because body is already compressed
602 $self->response($reqstate, $resp, undef, 1);
610 # return arrays as \0 separated strings (like CGI.pm)
611 sub decode_urlencoded {
616 return $res if !$data;
618 foreach my $kv (split(/[\&\;]/, $data)) {
619 my ($k, $v) = split(/=/, $kv);
621 $k =~ s/%([0-9a-fA-F][0-9a-fA-F])/chr(hex($1))/eg;
623 $v =~ s/%([0-9a-fA-F][0-9a-fA-F])/chr(hex($1))/eg;
625 if (defined(my $old = $res->{$k})) {
626 $res->{$k} = "$old\0$v";
635 my ($r, $method) = @_;
639 if ($method eq 'PUT' || $method eq 'POST') {
640 $params = decode_urlencoded($r->content);
643 my $query_params = decode_urlencoded($r->url->query());
645 foreach my $k (keys %{$query_params}) {
646 $params->{$k} = $query_params->{$k};
649 return PVE::Tools::decode_utf8_parameters($params);
652 sub handle_api2_request {
653 my ($self, $reqstate, $auth, $method, $path, $upload_state) = @_;
656 my $r = $reqstate->{request};
658 my ($rel_uri, $format) = &$split_abs_uri($path, $self->{base_uri});
660 my $formatter = PVE::APIServer::Formatter::get_formatter($format, $method, $rel_uri);
662 if (!defined($formatter)) {
663 $self->error($reqstate, HTTP_NOT_IMPLEMENTED, "no such uri
$rel_uri, $format");
667 #print Dumper($upload_state) if $upload_state;
669 my $rpcenv = $self->{rpcenv};
674 $params = $upload_state->{params};
676 $params = extract_params($r, $method);
679 delete $params->{_dc}; # remove disable cache parameter
681 my $clientip = $reqstate->{peer_host};
683 $rpcenv->init_request();
685 my $res = $self->rest_handler($clientip, $method, $rel_uri, $auth, $params);
687 AnyEvent->now_update(); # in case somebody called sleep()
689 $rpcenv->set_user(undef); # clear after request
691 my $upgrade = $r->header('upgrade');
692 $upgrade = lc($upgrade) if $upgrade;
694 if (my $host = $res->{proxy}) {
696 if ($self->{trusted_env}) {
697 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy
not allowed
");
701 if ($host ne 'localhost' && $r->header('PVEDisableProxy')) {
702 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy
loop detected
");
706 $res->{proxy_params}->{tmpfilename} = $reqstate->{tmpfilename} if $upload_state;
708 $self->proxy_request($reqstate, $clientip, $host, $res->{proxynode}, $method,
709 $r->uri, $auth->{ticket}, $auth->{token}, $res->{proxy_params}, $res->{proxynode});
712 } elsif ($upgrade && ($method eq 'GET') && ($path =~ m|websocket$|)) {
713 die "unable to upgrade to protocol
'$upgrade'\n" if !$upgrade || ($upgrade ne 'websocket');
714 my $wsver = $r->header('sec-websocket-version');
715 die "unsupported websocket-version
'$wsver'\n" if !$wsver || ($wsver ne '13');
716 my $wsproto_str = $r->header('sec-websocket-protocol');
717 die "missing websocket-protocol header
" if !$wsproto_str;
719 foreach my $p (PVE::Tools::split_list($wsproto_str)) {
720 $wsproto = $p if !$wsproto && $p eq 'base64';
721 $wsproto = $p if $p eq 'binary';
723 die "unsupported websocket-protocol protocol
'$wsproto_str'\n" if !$wsproto;
724 my $wskey = $r->header('sec-websocket-key');
725 die "missing websocket-key
\n" if !$wskey;
726 # Note: Digest::SHA::sha1_base64 has wrong padding
727 my $wsaccept = Digest::SHA::sha1_base64("${wskey
}258EAFA5-E914-47DA-95CA-C5AB0DC85B11
") . "=";
728 if ($res->{status} == HTTP_OK) {
729 $self->websocket_proxy($reqstate, $wsaccept, $wsproto, $res->{data});
735 if ($res->{status} == HTTP_UNAUTHORIZED) {
736 # always delay unauthorized calls by 3 seconds
737 $delay = 3 - tv_interval($reqstate->{starttime});
738 $delay = 0 if $delay < 0;
741 my ($raw, $ct, $nocomp) = &$formatter($res, $res->{data}, $params, $path, $auth);
744 if (ref($raw) && (ref($raw) eq 'HTTP::Response')) {
747 $resp = HTTP::Response->new($res->{status}, $res->{message});
748 $resp->header("Content-Type
" => $ct);
749 $resp->content($raw);
751 $self->response($reqstate, $resp, undef, $nocomp, $delay);
754 $self->error($reqstate, 501, $err);
758 sub handle_spice_proxy_request {
759 my ($self, $reqstate, $connect_str, $vmid, $node, $spiceport) = @_;
763 die "Port
$spiceport is not allowed
" if ($spiceport < 61000 || $spiceport > 61099);
765 my $rpcenv = $self->{rpcenv};
766 $rpcenv->init_request();
768 my $clientip = $reqstate->{peer_host};
769 my $r = $reqstate->{request};
773 if ($node ne 'localhost' && PVE::INotify::nodename() !~ m/^$node$/i) {
774 $remip = $self->remote_node_ip($node);
775 print "REMOTE CONNECT
$vmid, $remip, $connect_str\n" if $self->{debug};
777 print "$$: CONNECT
$vmid, $node, $spiceport\n" if $self->{debug};
780 if ($remip && $r->header('PVEDisableProxy')) {
781 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy
loop detected
");
785 $reqstate->{hdl}->timeout(0);
786 $reqstate->{hdl}->wbuf_max(64*10*1024);
788 my $remhost = $remip ? $remip : "localhost
";
789 my $remport = $remip ? 3128 : $spiceport;
791 tcp_connect $remhost, $remport, sub {
793 or die "connect to
'$remhost:$remport' failed
: $!";
795 print "$$: CONNECTed to
'$remhost:$remport'\n" if $self->{debug};
796 $reqstate->{proxyhdl} = AnyEvent::Handle->new(
799 wbuf_max => 64*10*1024,
804 $self->log_aborted_request($reqstate);
805 $self->client_do_disconnect($reqstate);
807 if (my $err = $@) { syslog('err', $err); }
810 my ($hdl, $fatal, $message) = @_;
812 $self->log_aborted_request($reqstate, $message);
813 $self->client_do_disconnect($reqstate);
815 if (my $err = $@) { syslog('err', "$err"); }
819 my $proxyhdlreader = sub {
822 my $len = length($hdl->{rbuf});
823 my $data = substr($hdl->{rbuf}, 0, $len, '');
825 #print "READ1
$len\n";
826 $reqstate->{hdl}->push_write($data) if $reqstate->{hdl};
829 my $hdlreader = sub {
832 my $len = length($hdl->{rbuf});
833 my $data = substr($hdl->{rbuf}, 0, $len, '');
835 #print "READ0
$len\n";
836 $reqstate->{proxyhdl}->push_write($data) if $reqstate->{proxyhdl};
839 my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.0';
841 my $startproxy = sub {
842 $reqstate->{proxyhdl}->timeout(0);
843 $reqstate->{proxyhdl}->on_read($proxyhdlreader);
844 $reqstate->{hdl}->on_read($hdlreader);
846 # todo: use stop_read/start_read if write buffer grows to much
848 my $res = "$proto 200 OK
\015\012"; # hope this is the right answer?
849 $reqstate->{hdl}->push_write($res);
852 $reqstate->{log}->{code} = 200;
853 $self->log_request($reqstate);
857 my $header = "CONNECT
${connect_str
} $proto\015\012" .
858 "Host
: ${connect_str
}\015\012" .
859 "Proxy-Connection
: keep-alive
\015\012" .
860 "User-Agent
: spiceproxy
\015\012" .
861 "PVEDisableProxy
: true
\015\012" .
862 "PVEClientIP
: $clientip\015\012" .
865 $reqstate->{proxyhdl}->push_write($header);
866 $reqstate->{proxyhdl}->push_read(line => sub {
867 my ($hdl, $line) = @_;
869 if ($line =~ m!^$proto 200 OK$!) {
872 $reqstate->{hdl}->push_write($line);
873 $self->client_do_disconnect($reqstate);
884 $self->log_aborted_request($reqstate, $err);
885 $self->client_do_disconnect($reqstate);
890 my ($self, $reqstate, $auth, $method, $path) = @_;
892 my $base_uri = $self->{base_uri};
895 my $r = $reqstate->{request};
897 # disable timeout on handle (we already have all data we need)
898 # we re-enable timeout in response()
899 $reqstate->{hdl}->timeout(0);
901 if ($path =~ m/^\Q$base_uri\E/) {
902 $self->handle_api2_request($reqstate, $auth, $method, $path);
906 if ($self->{pages} && ($method eq 'GET') && (my $handler = $self->{pages}->{$path})) {
907 if (ref($handler) eq 'CODE') {
908 my $params = decode_urlencoded($r->url->query());
909 my ($resp, $userid) = &$handler($self, $reqstate->{request}, $params);
910 $self->response($reqstate, $resp);
911 } elsif (ref($handler) eq 'HASH') {
912 if (my $filename = $handler->{file}) {
913 my $fh = IO::File->new($filename) ||
914 die "unable to
open file
'$filename' - $!\n";
915 send_file_start($self, $reqstate, $filename);
917 die "internal error
- no handler
";
920 die "internal error
- no handler
";
925 if ($self->{dirs} && ($method eq 'GET')) {
926 # we only allow simple names
927 if ($path =~ m!^(/\S+/)([a-zA-Z0-9\-\_\.]+)$!) {
928 my ($subdir, $file) = ($1, $2);
929 if (my $dir = $self->{dirs}->{$subdir}) {
930 my $filename = "$dir$file";
931 my $fh = IO::File->new($filename) ||
932 die "unable to
open file
'$filename' - $!\n";
933 send_file_start($self, $reqstate, $filename);
939 die "no such file
'$path'";
942 $self->error($reqstate, 501, $err);
946 sub file_upload_multipart {
947 my ($self, $reqstate, $auth, $method, $path, $rstate) = @_;
950 my $boundary = $rstate->{boundary};
951 my $hdl = $reqstate->{hdl};
953 my $startlen = length($hdl->{rbuf});
955 if ($rstate->{phase} == 0) { # skip everything until start
956 if ($hdl->{rbuf} =~ s/^.*?--\Q$boundary\E \015?\012
957 ((?:[^\015]+\015\012)* ) \015?\012//xs) {
959 my ($ct, $disp, $name, $filename);
960 foreach my $line (split(/\015?\012/, $header)) {
961 # assume we have single line headers
962 if ($line =~ m/^Content-Type\s*:\s*(.*)/i) {
963 $ct = parse_content_type($1);
964 } elsif ($line =~ m/^Content-Disposition\s*:\s*(.*)/i) {
965 ($disp, $name, $filename) = parse_content_disposition($1);
969 if (!($disp && $disp eq 'form-data' && $name)) {
970 syslog('err', "wrong content disposition
in multipart
- abort upload
");
971 $rstate->{phase} = -1;
974 $rstate->{fieldname} = $name;
977 if ($name eq 'filename') {
978 # found file upload data
979 $rstate->{phase} = 1;
980 $rstate->{filename} = $filename;
982 syslog('err', "wrong field name
for file upload
- abort upload
");
983 $rstate->{phase} = -1;
986 # found form data for field $name
987 $rstate->{phase} = 2;
991 my $len = length($hdl->{rbuf});
992 substr($hdl->{rbuf}, 0, $len - $rstate->{maxheader}, '')
993 if $len > $rstate->{maxheader}; # skip garbage
995 } elsif ($rstate->{phase} == 1) { # inside file - dump until end marker
996 if ($hdl->{rbuf} =~ s/^(.*?)\015?\012(--\Q$boundary\E(--)? \015?\012(.*))$/$2/xs) {
997 my ($rest, $eof) = ($1, $3);
998 my $len = length($rest);
999 die "write to temporary file failed
- $!"
1000 if syswrite($rstate->{outfh}, $rest) != $len;
1001 $rstate->{ctx}->add($rest);
1002 $rstate->{params}->{filename} = $rstate->{filename};
1003 $rstate->{md5sum} = $rstate->{ctx}->hexdigest;
1004 $rstate->{bytes} += $len;
1005 $rstate->{phase} = $eof ? 100 : 0;
1007 my $len = length($hdl->{rbuf});
1008 my $wlen = $len - $rstate->{boundlen};
1010 my $data = substr($hdl->{rbuf}, 0, $wlen, '');
1011 die "write to temporary file failed
- $!"
1012 if syswrite($rstate->{outfh}, $data) != $wlen;
1013 $rstate->{bytes} += $wlen;
1014 $rstate->{ctx}->add($data);
1017 } elsif ($rstate->{phase} == 2) { # inside normal field
1019 if ($hdl->{rbuf} =~ s/^(.*?)\015?\012(--\Q$boundary\E(--)? \015?\012(.*))$/$2/xs) {
1020 my ($rest, $eof) = ($1, $3);
1021 my $len = length($rest);
1022 $rstate->{post_size} += $len;
1023 if ($rstate->{post_size} < $limit_max_post) {
1024 $rstate->{params}->{$rstate->{fieldname}} = $rest;
1025 $rstate->{phase} = $eof ? 100 : 0;
1027 syslog('err', "form data to large
- abort upload
");
1028 $rstate->{phase} = -1; # skip
1032 my $len = length($hdl->{rbuf});
1033 substr($hdl->{rbuf}, 0, $len, ''); # empty rbuf
1036 $rstate->{read} += ($startlen - length($hdl->{rbuf}));
1038 if (!$rstate->{done} && ($rstate->{read} + length($hdl->{rbuf})) >= $rstate->{size}) {
1039 $rstate->{done} = 1; # make sure we dont get called twice
1040 if ($rstate->{phase} < 0 || !$rstate->{md5sum}) {
1041 die "upload failed
\n";
1043 my $elapsed = tv_interval($rstate->{starttime});
1045 my $rate = int($rstate->{bytes}/($elapsed*1024*1024));
1046 syslog('info', "multipart upload complete
" .
1047 "(size
: %d time: %ds rate
: %.2fMiB
/s md5sum
: $rstate->{md5sum
})",
1048 $rstate->{bytes}, $elapsed, $rate);
1049 $self->handle_api2_request($reqstate, $auth, $method, $path, $rstate);
1054 syslog('err', $err);
1055 $self->error($reqstate, 501, $err);
1059 sub parse_content_type {
1062 my ($ct, @params) = split(/\s*[;,]\s*/o, $ctype);
1064 foreach my $v (@params) {
1065 if ($v =~ m/^\s*boundary\s*=\s*(\S+?)\s*$/o) {
1066 return wantarray ? ($ct, $1) : $ct;
1070 return wantarray ? ($ct) : $ct;
1073 sub parse_content_disposition {
1076 my ($disp, @params) = split(/\s*[;,]\s*/o, $line);
1080 foreach my $v (@params) {
1081 if ($v =~ m/^\s*name\s*=\s*(\S+?)\s*$/o) {
1083 $name =~ s/^"(.*)"$/$1/;
1084 } elsif ($v =~ m/^\s*filename\s*=\s*(.+?)\s*$/o) {
1086 $filename =~ s/^"(.*)"$/$1/;
1090 return wantarray ? ($disp, $name, $filename) : $disp;
1093 my $tmpfile_seq_no = 0;
1095 sub get_upload_filename {
1096 # choose unpredictable tmpfile name
1099 return "/var/tmp
/pveupload-
" . Digest::MD5::md5_hex($tmpfile_seq_no . time() . $$);
1102 sub unshift_read_header {
1103 my ($self, $reqstate, $state) = @_;
1105 $state = { size => 0, count => 0 } if !$state;
1107 $reqstate->{hdl}->unshift_read(line => sub {
1108 my ($hdl, $line) = @_;
1111 # print "$$: got header
: $line\n" if $self->{debug};
1113 die "to many http header lines
\n" if ++$state->{count} >= $limit_max_headers;
1114 die "http header too large
\n" if ($state->{size} += length($line)) >= $limit_max_header_size;
1116 my $r = $reqstate->{request};
1119 my $path = uri_unescape($r->uri->path());
1120 my $method = $r->method();
1122 $r->push_header($state->{key}, $state->{val})
1125 if (!$known_methods->{$method}) {
1126 my $resp = HTTP::Response->new(HTTP_NOT_IMPLEMENTED, "method '$method' not available
");
1127 $self->response($reqstate, $resp);
1131 my $conn = $r->header('Connection');
1132 my $accept_enc = $r->header('Accept-Encoding');
1133 $reqstate->{accept_gzip} = ($accept_enc && $accept_enc =~ m/gzip/) ? 1 : 0;
1136 $reqstate->{keep_alive} = 0 if $conn =~ m/close/oi;
1138 if ($reqstate->{proto}->{ver} < 1001) {
1139 $reqstate->{keep_alive} = 0;
1143 my $te = $r->header('Transfer-Encoding');
1144 if ($te && lc($te) eq 'chunked') {
1145 # Handle chunked transfer encoding
1146 $self->error($reqstate, 501, "chunked transfer encoding
not supported
");
1149 $self->error($reqstate, 501, "Unknown transfer encoding
'$te'");
1153 my $pveclientip = $r->header('PVEClientIP');
1154 my $base_uri = $self->{base_uri};
1156 # fixme: how can we make PVEClientIP header trusted?
1157 if ($self->{trusted_env} && $pveclientip) {
1158 $reqstate->{peer_host} = $pveclientip;
1160 $r->header('PVEClientIP', $reqstate->{peer_host});
1163 my $len = $r->header('Content-Length');
1165 # header processing complete - authenticate now
1168 if ($self->{spiceproxy}) {
1169 my $connect_str = $r->header('Host');
1170 my ($vmid, $node, $port) = $self->verify_spice_connect_url($connect_str);
1171 if (!(defined($vmid) && $node && $port)) {
1172 $self->error($reqstate, HTTP_UNAUTHORIZED, "invalid ticket
");
1175 $self->handle_spice_proxy_request($reqstate, $connect_str, $vmid, $node, $port);
1177 } elsif ($path =~ m/^\Q$base_uri\E/) {
1178 my $token = $r->header('CSRFPreventionToken');
1179 my $cookie = $r->header('Cookie');
1180 my $ticket = PVE::APIServer::Formatter::extract_auth_cookie($cookie, $self->{cookie_name});
1182 my ($rel_uri, $format) = &$split_abs_uri($path, $self->{base_uri});
1184 $self->error($reqstate, HTTP_NOT_IMPLEMENTED, "no such uri
");
1188 my $rpcenv = $self->{rpcenv};
1189 # set environment variables
1190 $rpcenv->set_user(undef);
1191 $rpcenv->set_language('C');
1192 $rpcenv->set_client_ip($reqstate->{peer_host});
1195 $auth = $self->auth_handler($method, $rel_uri, $ticket, $token);
1198 # always delay unauthorized calls by 3 seconds
1200 if (my $formatter = PVE::APIServer::Formatter::get_login_formatter($format)) {
1201 my ($raw, $ct, $nocomp) = &$formatter($path, $auth);
1203 if (ref($raw) && (ref($raw) eq 'HTTP::Response')) {
1206 $resp = HTTP::Response->new(HTTP_UNAUTHORIZED, "Login Required
");
1207 $resp->header("Content-Type
" => $ct);
1208 $resp->content($raw);
1210 $self->response($reqstate, $resp, undef, $nocomp, 3);
1212 my $resp = HTTP::Response->new(HTTP_UNAUTHORIZED, $err);
1213 $self->response($reqstate, $resp, undef, 0, $delay);
1219 $reqstate->{log}->{userid} = $auth->{userid};
1223 if (!($method eq 'PUT' || $method eq 'POST')) {
1224 $self->error($reqstate, 501, "Unexpected content
for method '$method'");
1228 my $ctype = $r->header('Content-Type');
1229 my ($ct, $boundary) = parse_content_type($ctype) if $ctype;
1231 if ($auth->{isUpload} && !$self->{trusted_env}) {
1232 die "upload
'Content-Type '$ctype' not implemented\n"
1233 if !($boundary && $ct && ($ct eq 'multipart
/form-data
'));
1235 die "upload without content length header not supported" if !$len;
1237 die "upload without content length header not supported" if !$len;
1239 print "start upload $path $ct $boundary\n" if $self->{debug};
1241 my $tmpfilename = get_upload_filename();
1242 my $outfh = IO::File->new($tmpfilename, O_RDWR|O_CREAT|O_EXCL, 0600) ||
1243 die "unable to create temporary upload file '$tmpfilename'";
1245 $reqstate->{keep_alive} = 0;
1247 my $boundlen = length($boundary) + 8; # \015?\012--$boundary--\015?\012
1251 boundary => $boundary,
1252 ctx => Digest::MD5->new,
1253 boundlen => $boundlen,
1254 maxheader => 2048 + $boundlen, # should be large enough
1255 params => decode_urlencoded($r->url->query()),
1259 starttime => [gettimeofday],
1262 $reqstate->{tmpfilename} = $tmpfilename;
1263 $reqstate->{hdl}->on_read(sub { $self->file_upload_multipart($reqstate, $auth, $method, $path, $state); });
1267 if ($len > $limit_max_post) {
1268 $self->error($reqstate, 501, "for data too large");
1272 if (!$ct || $ct eq 'application
/x-www-form-urlencoded
') {
1273 $reqstate->{hdl}->unshift_read(chunk => $len, sub {
1274 my ($hdl, $data) = @_;
1276 $self->handle_request($reqstate, $auth, $method, $path);
1279 $self->error($reqstate, 506, "upload 'Content-Type
'$ctype' not implemented
");
1282 $self->handle_request($reqstate, $auth, $method, $path);
1284 } elsif ($line =~ /^([^:\s]+)\s*:\s*(.*)/) {
1285 $r->push_header($state->{key}, $state->{val}) if $state->{key};
1286 ($state->{key}, $state->{val}) = ($1, $2);
1287 $self->unshift_read_header($reqstate, $state);
1288 } elsif ($line =~ /^\s+(.*)/) {
1289 $state->{val} .= " $1";
1290 $self->unshift_read_header($reqstate, $state);
1292 $self->error($reqstate, 506, "unable to parse request header
");
1299 sub push_request_header {
1300 my ($self, $reqstate) = @_;
1303 $reqstate->{hdl}->push_read(line => sub {
1304 my ($hdl, $line) = @_;
1307 # print "got request header
: $line\n" if $self->{debug};
1309 $reqstate->{keep_alive}--;
1311 if ($line =~ /(\S+)\040(\S+)\040HTTP\/(\d+)\.(\d+)/o) {
1312 my ($method, $url, $maj, $min) = ($1, $2, $3, $4);
1315 $self->error($reqstate, 506, "http protocol version
$maj.$min not supported
");
1319 $self->{request_count}++; # only count valid request headers
1320 if ($self->{request_count} >= $self->{max_requests}) {
1321 $self->{end_loop} = 1;
1323 $reqstate->{log} = { requestline => $line };
1324 $reqstate->{proto}->{str} = "HTTP
/$maj.$min";
1325 $reqstate->{proto}->{maj} = $maj;
1326 $reqstate->{proto}->{min} = $min;
1327 $reqstate->{proto}->{ver} = $maj*1000+$min;
1328 $reqstate->{request} = HTTP::Request->new($method, $url);
1329 $reqstate->{starttime} = [gettimeofday],
1331 $self->unshift_read_header($reqstate);
1332 } elsif ($line eq '') {
1333 # ignore empty lines before requests (browser bugs?)
1334 $self->push_request_header($reqstate);
1336 $self->error($reqstate, 400, 'bad request');
1350 return if $self->{end_loop};
1352 # we need to m make sure that only one process calls accept
1353 while (!flock($self->{lockfh}, Fcntl::LOCK_EX())) {
1354 next if $! == EINTR;
1355 die "could
not get
lock on file
'$self->{lockfile}' - $!\n";
1361 while (!$self->{end_loop} &&
1362 !defined($clientfh = $self->{socket}->accept()) &&
1365 if ($self->{end_loop}) {
1368 $again = ($! == EAGAIN || $! == WSAEWOULDBLOCK);
1369 if (!defined($clientfh)) {
1370 $errmsg = "failed to
accept connection
: $!\n";
1376 flock($self->{lockfh}, Fcntl::LOCK_UN());
1378 if (!defined($clientfh)) {
1380 die $errmsg if $errmsg;
1383 fh_nonblocking $clientfh, 1;
1385 $self->{conn_count}++;
1393 $self->{end_loop} = 1;
1395 undef $self->{socket_watch};
1397 $0 = "$0 (shutdown)" if $0 !~ m/\(shutdown\)$/;
1399 if ($self->{conn_count} <= 0) {
1400 $self->{end_cond}->send(1);
1404 # fork and exit, so that parent starts a new worker
1409 # else we need to wait until all open connections gets closed
1410 my $w; $w = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1412 # todo: test for active connections instead (we can abort idle connections)
1413 if ($self->{conn_count} <= 0) {
1415 $self->{end_cond}->send(1);
1423 sub check_host_access {
1424 my ($self, $clientip) = @_;
1426 my $cip = Net::IP->new($clientip);
1428 my $match_allow = 0;
1431 if ($self->{allow_from}) {
1432 foreach my $t (@{$self->{allow_from}}) {
1433 if ($t->overlaps($cip)) {
1440 if ($self->{deny_from}) {
1441 foreach my $t (@{$self->{deny_from}}) {
1442 if ($t->overlaps($cip)) {
1449 if ($match_allow == $match_deny) {
1450 # match both allow and deny, or no match
1451 return $self->{policy} && $self->{policy} eq 'allow' ? 1 : 0;
1454 return $match_allow;
1457 sub accept_connections {
1462 while (my $clientfh = $self->accept()) {
1464 my $reqstate = { keep_alive => $self->{keep_alive} };
1466 # stop keep-alive when there are many open connections
1467 if ($self->{conn_count} >= $self->{max_conn_soft_limit}) {
1468 $reqstate->{keep_alive} = 0;
1471 if (my $sin = getpeername($clientfh)) {
1472 my ($pfamily, $pport, $phost) = PVE::Tools::unpack_sockaddr_in46($sin);
1473 ($reqstate->{peer_port}, $reqstate->{peer_host}) = ($pport, Socket::inet_ntop($pfamily, $phost));
1476 if (!$self->{trusted_env} && !$self->check_host_access($reqstate->{peer_host})) {
1477 print "$$: ABORT request from
$reqstate->{peer_host
} - access denied
\n" if $self->{debug};
1478 $reqstate->{log}->{code} = 403;
1479 $self->log_request($reqstate);
1483 $reqstate->{hdl} = AnyEvent::Handle->new(
1485 rbuf_max => 64*1024,
1486 timeout => $self->{timeout},
1487 linger => 0, # avoid problems with ssh - really needed ?
1491 $self->log_aborted_request($reqstate);
1492 $self->client_do_disconnect($reqstate);
1494 if (my $err = $@) { syslog('err', $err); }
1497 my ($hdl, $fatal, $message) = @_;
1499 $self->log_aborted_request($reqstate, $message);
1500 $self->client_do_disconnect($reqstate);
1502 if (my $err = $@) { syslog('err', "$err"); }
1504 ($self->{tls_ctx} ? (tls => "accept", tls_ctx => $self->{tls_ctx}) : ()));
1506 print "$$: ACCEPT FH
" . $clientfh->fileno() . " CONN
$self->{conn_count
}\n" if $self->{debug};
1508 $self->push_request_header($reqstate);
1513 syslog('err', $err);
1514 $self->{end_loop} = 1;
1517 $self->wait_end_loop() if $self->{end_loop};
1520 # Note: We can't open log file in non-blocking mode and use AnyEvent::Handle,
1521 # because we write from multiple processes, and that would arbitrarily mix output
1523 sub open_access_log {
1524 my ($self, $filename) = @_;
1526 my $old_mask = umask(0137);;
1527 my $logfh = IO::File->new($filename, ">>") ||
1528 die "unable to
open log file
'$filename' - $!\n";
1531 $logfh->autoflush(1);
1533 $self->{logfh} = $logfh;
1537 my ($self, $data) = @_;
1539 return if !defined($self->{logfh}) || !$data;
1541 my $res = $self->{logfh}->print($data);
1544 delete $self->{logfh};
1545 syslog('err', "error writing access
log");
1546 $self->{end_loop} = 1; # terminate asap
1550 sub atfork_handler {
1554 # something else do to ?
1555 close($self->{socket});
1563 $self->{end_cond}->recv;
1567 my ($this, %args) = @_;
1569 my $class = ref($this) || $this;
1571 foreach my $req (qw(base_handler_class socket lockfh lockfile)) {
1572 die "misssing required argument '$req'" if !defined($args{$req});
1575 my $self = bless { %args }, $class;
1577 $self->{cookie_name
} //= 'PVEAuthCookie';
1578 $self->{base_uri
} //= "/api2";
1581 PVE
::INotify
::inotify_init
();
1583 fh_nonblocking
($self->{socket}, 1);
1585 $self->{end_loop
} = 0;
1586 $self->{conn_count
} = 0;
1587 $self->{request_count
} = 0;
1588 $self->{timeout
} = 5 if !$self->{timeout
};
1589 $self->{keep_alive
} = 0 if !defined($self->{keep_alive
});
1590 $self->{max_conn
} = 800 if !$self->{max_conn
};
1591 $self->{max_requests
} = 8000 if !$self->{max_requests
};
1593 $self->{policy
} = 'allow' if !$self->{policy
};
1595 $self->{end_cond
} = AnyEvent-
>condvar;
1598 $self->{tls_ctx
} = AnyEvent
::TLS-
>new(%{$self->{ssl
}});
1599 # TODO : openssl >= 1.0.2 supports SSL_CTX_set_ecdh_auto to select a curve depending on
1600 # server and client availability from SSL_CTX_set1_curves.
1601 # that way other curves like 25519 can be used.
1602 # openssl 1.0.1 can only support 1 curve at a time.
1603 my $curve = Net
::SSLeay
::OBJ_txt2nid
('prime256v1');
1604 my $ecdh = Net
::SSLeay
::EC_KEY_new_by_curve_name
($curve);
1605 Net
::SSLeay
::CTX_set_options
($self->{tls_ctx
}->{ctx
}, &Net
::SSLeay
::OP_NO_COMPRESSION
| &Net
::SSLeay
::OP_SINGLE_ECDH_USE
| &Net
::SSLeay
::OP_SINGLE_DH_USE
);
1606 Net
::SSLeay
::CTX_set_tmp_ecdh
($self->{tls_ctx
}->{ctx
}, $ecdh);
1607 Net
::SSLeay
::EC_KEY_free
($ecdh);
1610 if ($self->{spiceproxy
}) {
1611 $known_methods = { CONNECT
=> 1 };
1614 $self->open_access_log($self->{logfile
}) if $self->{logfile
};
1616 $self->{max_conn_soft_limit
} = $self->{max_conn
} > 100 ?
$self->{max_conn
} - 20 : $self->{max_conn
};
1618 $self->{socket_watch
} = AnyEvent-
>io(fh
=> $self->{socket}, poll
=> 'r', cb
=> sub {
1620 if ($self->{conn_count
} >= $self->{max_conn
}) {
1621 my $w; $w = AnyEvent-
>timer (after
=> 1, interval
=> 1, cb
=> sub {
1622 if ($self->{conn_count
} < $self->{max_conn
}) {
1624 $self->accept_connections();
1628 $self->accept_connections();
1634 $self->{term_watch
} = AnyEvent-
>signal(signal
=> "TERM", cb
=> sub {
1635 undef $self->{term_watch
};
1636 $self->wait_end_loop();
1639 $self->{quit_watch
} = AnyEvent-
>signal(signal
=> "QUIT", cb
=> sub {
1640 undef $self->{quit_watch
};
1641 $self->wait_end_loop();
1644 $self->{inotify_poll
} = AnyEvent-
>timer(after
=> 5, interval
=> 5, cb
=> sub {
1645 PVE
::INotify
::poll
(); # read inotify events
1651 # abstract functions - subclass should overwrite/implement them
1653 sub verify_spice_connect_url
{
1654 my ($self, $connect_str) = @_;
1658 #return ($vmid, $node, $port);
1662 my ($self, $method, $rel_uri, $ticket, $token) = @_;
1667 # ticket => $ticket,
1669 # userid => $username,
1671 # isUpload => $isUpload,
1672 # cookie_name => $self->{cookie_name},
1678 my ($self, $clientip, $method, $rel_uri, $auth, $params) = @_;
1681 status
=> HTTP_NOT_IMPLEMENTED
,
1682 message
=> "Method '$method $rel_uri' not implemented",
1686 sub check_cert_fingerprint
{
1687 my ($self, $cert) = @_;
1692 sub initialize_cert_cache
{
1693 my ($self, $node) = @_;
1698 sub remote_node_ip
{
1699 my ($self, $node) = @_;