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
;
41 use HTTP
::Status
qw(:constants);
48 my $limit_max_headers = 30;
49 my $limit_max_header_size = 8*1024;
50 my $limit_max_post = 16*1024;
59 my $split_abs_uri = sub {
60 my ($abs_uri, $base_uri) = @_;
62 my ($format, $rel_uri) = $abs_uri =~ m/^\Q$base_uri\E\/+([a-z
][a-z0-9
]+)(\
/.*)?$/;
63 $rel_uri = '/' if !$rel_uri;
65 return wantarray ?
($rel_uri, $format) : $rel_uri;
69 my ($self, $reqstate) = @_;
71 my $loginfo = $reqstate->{log};
73 # like apache2 common log format
74 # LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\""
76 return if $loginfo->{written
}; # avoid duplicate logs
77 $loginfo->{written
} = 1;
79 my $peerip = $reqstate->{peer_host
} || '-';
80 my $userid = $loginfo->{userid
} || '-';
81 my $content_length = defined($loginfo->{content_length
}) ?
$loginfo->{content_length
} : '-';
82 my $code = $loginfo->{code
} || 500;
83 my $requestline = $loginfo->{requestline
} || '-';
84 my $timestr = strftime
("%d/%m/%Y:%H:%M:%S %z", localtime());
86 my $msg = "$peerip - $userid [$timestr] \"$requestline\" $code $content_length\n";
88 $self->write_log($msg);
91 sub log_aborted_request {
92 my ($self, $reqstate, $error) = @_;
94 my $r = $reqstate->{request};
95 return if !$r; # no active request
98 syslog("err
", "problem with client
$reqstate->{peer_host
}; $error");
101 $self->log_request($reqstate);
104 sub cleanup_reqstate {
107 delete $reqstate->{log};
108 delete $reqstate->{request};
109 delete $reqstate->{proto};
110 delete $reqstate->{accept_gzip};
111 delete $reqstate->{starttime};
113 if ($reqstate->{tmpfilename}) {
114 unlink $reqstate->{tmpfilename};
115 delete $reqstate->{tmpfilename};
119 sub client_do_disconnect {
120 my ($self, $reqstate) = @_;
122 cleanup_reqstate($reqstate);
124 my $shutdown_hdl = sub {
127 shutdown($hdl->{fh}, 1);
129 $hdl->on_drain(undef);
130 $hdl->on_read(undef);
134 if (my $proxyhdl = delete $reqstate->{proxyhdl}) {
135 &$shutdown_hdl($proxyhdl);
138 my $hdl = delete $reqstate->{hdl};
141 syslog('err', "detected empty handle
");
145 print "close connection
$hdl\n" if $self->{debug};
147 &$shutdown_hdl($hdl);
149 $self->{conn_count}--;
151 print "$$: CLOSE FH
" . $hdl->{fh}->fileno() . " CONN
$self->{conn_count
}\n" if $self->{debug};
154 sub finish_response {
155 my ($self, $reqstate) = @_;
157 cleanup_reqstate($reqstate);
159 my $hdl = $reqstate->{hdl};
160 return if !$hdl; # already disconnected
162 if (!$self->{end_loop} && $reqstate->{keep_alive} > 0) {
163 # print "KEEPALIVE
$reqstate->{keep_alive
}\n" if $self->{debug};
165 eval { $self->push_request_header($reqstate); };
169 $hdl->on_drain (sub {
171 $self->client_do_disconnect($reqstate);
179 my ($self, $reqstate, $resp, $mtime, $nocomp, $delay) = @_;
181 #print "$$: send response
: " . Dumper($resp);
184 $reqstate->{hdl}->timeout_reset();
185 $reqstate->{hdl}->timeout($self->{timeout});
187 $nocomp = 1 if !$reqstate->{accept_gzip};
189 my $code = $resp->code;
190 my $msg = $resp->message || HTTP::Status::status_message($code);
191 ($msg) = $msg =~m/^(.*)$/m;
192 my $content = $resp->content;
194 if ($code =~ /^(1\d\d|[23]04)$/) {
195 # make sure content we have no content
199 $reqstate->{keep_alive} = 0 if ($code >= 400) || $self->{end_loop};
201 $reqstate->{log}->{code} = $code;
203 my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.0';
204 my $res = "$proto $code $msg\015\012";
207 my $date = HTTP::Date::time2str($ctime);
208 $resp->header('Date' => $date);
210 $resp->header('Last-Modified' => HTTP::Date::time2str($mtime));
212 $resp->header('Expires' => $date);
213 $resp->header('Cache-Control' => "max-age
=0");
214 $resp->header("Pragma
", "no-cache
");
217 $resp->header('Server' => "pve-api-daemon
/3.0");
222 $content_length = length($content);
224 if (!$nocomp && ($content_length > 1024)) {
225 my $comp = Compress::Zlib::memGzip($content);
226 $resp->header('Content-Encoding', 'gzip');
228 $content_length = length($content);
230 $resp->header("Content-Length
" => $content_length);
231 $reqstate->{log}->{content_length} = $content_length;
234 $resp->remove_header("Content-Length
");
237 if ($reqstate->{keep_alive} > 0) {
238 $resp->push_header('Connection' => 'Keep-Alive');
240 $resp->header('Connection' => 'close');
243 $res .= $resp->headers_as_string("\015\012");
244 #print "SEND
(without content
) $res\n" if $self->{debug};
247 $res .= $content if $content;
249 $self->log_request($reqstate, $reqstate->{request});
251 if ($delay && $delay > 0) {
252 my $w; $w = AnyEvent->timer(after => $delay, cb => sub {
253 undef $w; # delete reference
254 $reqstate->{hdl}->push_write($res);
255 $self->finish_response($reqstate);
258 $reqstate->{hdl}->push_write($res);
259 $self->finish_response($reqstate);
264 my ($self, $reqstate, $code, $msg, $hdr, $content) = @_;
267 my $resp = HTTP::Response->new($code, $msg, $hdr, $content);
268 $self->response($reqstate, $resp);
273 my $file_extension_info = {
274 css => { ct => 'text/css' },
275 html => { ct => 'text/html' },
276 js => { ct => 'application/javascript' },
277 png => { ct => 'image/png' , nocomp => 1 },
278 ico => { ct => 'image/x-icon', nocomp => 1},
279 gif => { ct => 'image/gif', nocomp => 1},
280 jar => { ct => 'application/java-archive', nocomp => 1},
281 woff => { ct => 'application/font-woff', nocomp => 1},
282 woff2 => { ct => 'application/font-woff2', nocomp => 1},
283 ttf => { ct => 'application/font-snft', nocomp => 1},
284 pdf => { ct => 'application/pdf', nocomp => 1},
285 epub => { ct => 'application/epub+zip', nocomp => 1},
288 sub send_file_start {
289 my ($self, $reqstate, $filename) = @_;
292 # print "SEND FILE
$filename\n";
293 # Note: aio_load() this is not really async unless we use IO::AIO!
296 my $r = $reqstate->{request};
298 my $fh = IO::File->new($filename, '<') ||
300 my $stat = File::stat::stat($fh) ||
303 my $mtime = $stat->mtime;
305 if (my $ifmod = $r->header('if-modified-since')) {
306 my $iftime = HTTP::Date::str2time($ifmod);
307 if ($mtime <= $iftime) {
308 my $resp = HTTP::Response->new(304, "NOT MODIFIED
");
309 $self->response($reqstate, $resp, $mtime);
315 my $len = sysread($fh, $data, $stat->size);
316 die "got short file
\n" if !defined($len) || $len != $stat->size;
318 my ($ext) = $filename =~ m/\.([^.]*)$/;
319 my $ext_info = $file_extension_info->{$ext};
321 die "unable to detect content type
" if !$ext_info;
323 my $header = HTTP::Headers->new(Content_Type => $ext_info->{ct});
324 my $resp = HTTP::Response->new(200, "OK
", $header, $data);
325 $self->response($reqstate, $resp, $mtime, $ext_info->{nocomp});
328 $self->error($reqstate, 501, $err);
335 sub websocket_proxy {
336 my ($self, $reqstate, $wsaccept, $wsproto, $param) = @_;
342 my $max_payload_size = 65536;
345 if ($wsproto eq 'binary') {
347 } elsif ($wsproto eq 'base64') {
350 die "websocket_proxy
: unsupported protocol
'$wsproto'\n";
353 if ($param->{port}) {
354 $remhost = 'localhost';
355 $remport = $param->{port};
356 } elsif ($param->{socket}) {
358 $remport = $param->{socket};
360 die "websocket_proxy
: missing port
or socket\n";
363 tcp_connect $remhost, $remport, sub {
365 or die "connect to
'$remhost:$remport' failed
: $!";
367 print "$$: CONNECTed to
'$remhost:$remport'\n" if $self->{debug};
369 $reqstate->{proxyhdl} = AnyEvent::Handle->new(
372 wbuf_max => 64*10*1024,
377 $self->log_aborted_request($reqstate);
378 $self->client_do_disconnect($reqstate);
380 if (my $err = $@) { syslog('err', $err); }
383 my ($hdl, $fatal, $message) = @_;
385 $self->log_aborted_request($reqstate, $message);
386 $self->client_do_disconnect($reqstate);
388 if (my $err = $@) { syslog('err', "$err"); }
391 my $proxyhdlreader = sub {
394 my $len = length($hdl->{rbuf});
395 my $data = substr($hdl->{rbuf}, 0, $len, '');
401 $string = "\x82"; # binary frame
404 $string = "\x81"; # text frame
405 $payload = encode_base64($data, '');
408 my $payload_len = length($payload);
409 if ($payload_len <= 125) {
410 $string .= pack 'C', $payload_len;
411 } elsif ($payload_len <= 0xffff) {
412 $string .= pack 'C', 126;
413 $string .= pack 'n', $payload_len;
415 $string .= pack 'C', 127;
416 $string .= pack 'Q>', $payload_len;
420 $reqstate->{hdl}->push_write($string) if $reqstate->{hdl};
423 my $hdlreader = sub {
426 my $len = length($hdl->{rbuf});
429 my $hdr = unpack('C', substr($hdl->{rbuf}, 0, 1));
430 my $opcode = $hdr & 0b00001111;
431 my $fin = $hdr & 0b10000000;
433 die "received fragmented websocket frame
\n" if !$fin;
435 my $rsv = $hdr & 0b01110000;
436 die "received websocket frame with RSV flags
\n" if $rsv;
438 my $payload_len = unpack 'C', substr($hdl->{rbuf}, 1, 1);
440 my $masked = $payload_len & 0b10000000;
441 die "received unmasked websocket frame from client
\n" if !$masked;
444 $payload_len = $payload_len & 0b01111111;
445 if ($payload_len == 126) {
447 $payload_len = unpack('n', substr($hdl->{rbuf}, $offset, 2));
449 } elsif ($payload_len == 127) {
451 $payload_len = unpack('Q>', substr($hdl->{rbuf}, $offset, 8));
455 die "received too large websocket frame
(len
= $payload_len)\n"
456 if ($payload_len > $max_payload_size) || ($payload_len < 0);
458 return if $len < ($offset + 4 + $payload_len);
460 my $data = substr($hdl->{rbuf}, 0, $len, ''); # now consume data
462 my @mask = (unpack('C', substr($data, $offset+0, 1)),
463 unpack('C', substr($data, $offset+1, 1)),
464 unpack('C', substr($data, $offset+2, 1)),
465 unpack('C', substr($data, $offset+3, 1)));
469 my $payload = substr($data, $offset, $payload_len);
471 for (my $i = 0; $i < $payload_len; $i++) {
472 my $d = unpack('C', substr($payload, $i, 1));
473 my $n = $d ^ $mask[$i % 4];
474 substr($payload, $i, 1, pack('C', $n));
477 $payload = decode_base64($payload) if !$binary;
479 if ($opcode == 1 || $opcode == 2) {
480 $reqstate->{proxyhdl}->push_write($payload) if $reqstate->{proxyhdl};
481 } elsif ($opcode == 8) {
482 print "websocket received
close\n" if $self->{debug};
483 if ($reqstate->{proxyhdl}) {
484 $reqstate->{proxyhdl}->push_write($payload);
485 $reqstate->{proxyhdl}->push_shutdown();
487 $hdl->push_shutdown();
489 die "received unhandled websocket opcode
$opcode\n";
493 my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.1';
495 $reqstate->{proxyhdl}->timeout(0);
496 $reqstate->{proxyhdl}->on_read($proxyhdlreader);
497 $reqstate->{hdl}->on_read($hdlreader);
499 # todo: use stop_read/start_read if write buffer grows to much
501 my $res = "$proto 101 Switching Protocols
\015\012" .
502 "Upgrade
: websocket
\015\012" .
503 "Connection
: upgrade
\015\012" .
504 "Sec-WebSocket-Accept
: $wsaccept\015\012" .
505 "Sec-WebSocket-Protocol
: $wsproto\015\012" .
508 print $res if $self->{debug};
510 $reqstate->{hdl}->push_write($res);
513 $reqstate->{log}->{code} = 101;
514 $self->log_request($reqstate);
520 $self->log_aborted_request($reqstate, $err);
521 $self->client_do_disconnect($reqstate);
526 my ($self, $reqstate, $clientip, $host, $node, $method, $uri, $ticket, $token, $params) = @_;
531 if ($host eq 'localhost') {
532 $target = "http
://$host:85$uri";
533 # keep alive for localhost is not worth (connection setup is about 0.2ms)
535 } elsif (Net::IP::ip_is_ipv6($host)) {
536 $target = "https
://[$host]:8006$uri";
538 $target = "https
://$host:8006$uri";
542 PVEDisableProxy => 'true',
543 PVEClientIP => $clientip,
546 $headers->{'cookie'} = PVE::APIServer::Formatter::create_auth_cookie($ticket, $self->{cookie_name}) if $ticket;
547 $headers->{'CSRFPreventionToken'} = $token if $token;
548 $headers->{'Accept-Encoding'} = 'gzip' if $reqstate->{accept_gzip};
552 if ($method eq 'POST' || $method eq 'PUT') {
553 $headers->{'Content-Type'} = 'application/x-www-form-urlencoded';
554 # use URI object to format application/x-www-form-urlencoded content.
555 my $url = URI->new('http:');
556 $url->query_form(%$params);
557 $content = $url->query;
558 if (defined($content)) {
559 $headers->{'Content-Length'} = length($content);
564 # TLS 1.x only, with certificate pinning
570 my (undef, undef, undef, $depth, undef, undef, $cert) = @_;
571 # we don't care about intermediate or root certificates
572 return 1 if $depth != 0;
573 # check server certificate against cache of pinned FPs
574 return $self->check_cert_fingerprint($cert);
578 # load and cache cert fingerprint if first time we proxy to this node
579 $self->initialize_cert_cache($node);
581 my $w; $w = http_request(
586 proxy => undef, # avoid use of $ENV{HTTP_PROXY}
587 keepalive => $keep_alive,
589 tls_ctx => AnyEvent::TLS->new(%{$tls}),
591 my ($body, $hdr) = @_;
595 if (!$reqstate->{hdl}) {
596 warn "proxy detected vanished client connection
\n";
601 my $code = delete $hdr->{Status};
602 my $msg = delete $hdr->{Reason};
604 delete $hdr->{HTTPVersion};
605 my $header = HTTP::Headers->new(%$hdr);
606 if (my $location = $header->header('Location')) {
607 $location =~ s|^http://localhost:85||;
608 $header->header(Location => $location);
610 my $resp = HTTP::Response->new($code, $msg, $header, $body);
611 # Note: disable compression, because body is already compressed
612 $self->response($reqstate, $resp, undef, 1);
620 # return arrays as \0 separated strings (like CGI.pm)
621 # assume data is UTF8 encoded
622 sub decode_urlencoded {
627 return $res if !$data;
629 foreach my $kv (split(/[\&\;]/, $data)) {
630 my ($k, $v) = split(/=/, $kv);
632 $k =~ s/%([0-9a-fA-F][0-9a-fA-F])/chr(hex($1))/eg;
634 $v =~ s/%([0-9a-fA-F][0-9a-fA-F])/chr(hex($1))/eg;
636 $v = Encode::decode('utf8', $v);
638 if (defined(my $old = $res->{$k})) {
639 $res->{$k} = "$old\0$v";
648 my ($r, $method) = @_;
652 if ($method eq 'PUT' || $method eq 'POST') {
653 $params = decode_urlencoded($r->content);
656 my $query_params = decode_urlencoded($r->url->query());
658 foreach my $k (keys %{$query_params}) {
659 $params->{$k} = $query_params->{$k};
665 sub handle_api2_request {
666 my ($self, $reqstate, $auth, $method, $path, $upload_state) = @_;
669 my $r = $reqstate->{request};
671 my ($rel_uri, $format) = &$split_abs_uri($path, $self->{base_uri});
673 my $formatter = PVE::APIServer::Formatter::get_formatter($format, $method, $rel_uri);
675 if (!defined($formatter)) {
676 $self->error($reqstate, HTTP_NOT_IMPLEMENTED, "no formatter
for uri
$rel_uri, $format");
680 #print Dumper($upload_state) if $upload_state;
685 $params = $upload_state->{params};
687 $params = extract_params($r, $method);
690 delete $params->{_dc}; # remove disable cache parameter
692 my $clientip = $reqstate->{peer_host};
694 my $res = $self->rest_handler($clientip, $method, $rel_uri, $auth, $params);
697 Net::SSLeay::ERR_clear_error();
699 AnyEvent->now_update(); # in case somebody called sleep()
701 my $upgrade = $r->header('upgrade');
702 $upgrade = lc($upgrade) if $upgrade;
704 if (my $host = $res->{proxy}) {
706 if ($self->{trusted_env}) {
707 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy
not allowed
");
711 if ($host ne 'localhost' && $r->header('PVEDisableProxy')) {
712 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy
loop detected
");
716 $res->{proxy_params}->{tmpfilename} = $reqstate->{tmpfilename} if $upload_state;
718 $self->proxy_request($reqstate, $clientip, $host, $res->{proxynode}, $method,
719 $r->uri, $auth->{ticket}, $auth->{token}, $res->{proxy_params}, $res->{proxynode});
722 } elsif ($upgrade && ($method eq 'GET') && ($path =~ m|websocket$|)) {
723 die "unable to upgrade to protocol
'$upgrade'\n" if !$upgrade || ($upgrade ne 'websocket');
724 my $wsver = $r->header('sec-websocket-version');
725 die "unsupported websocket-version
'$wsver'\n" if !$wsver || ($wsver ne '13');
726 my $wsproto_str = $r->header('sec-websocket-protocol');
727 die "missing websocket-protocol header
" if !$wsproto_str;
729 foreach my $p (PVE::Tools::split_list($wsproto_str)) {
730 $wsproto = $p if !$wsproto && $p eq 'base64';
731 $wsproto = $p if $p eq 'binary';
733 die "unsupported websocket-protocol protocol
'$wsproto_str'\n" if !$wsproto;
734 my $wskey = $r->header('sec-websocket-key');
735 die "missing websocket-key
\n" if !$wskey;
736 # Note: Digest::SHA::sha1_base64 has wrong padding
737 my $wsaccept = Digest::SHA::sha1_base64("${wskey
}258EAFA5-E914-47DA-95CA-C5AB0DC85B11
") . "=";
738 if ($res->{status} == HTTP_OK) {
739 $self->websocket_proxy($reqstate, $wsaccept, $wsproto, $res->{data});
745 if ($res->{status} == HTTP_UNAUTHORIZED) {
746 # always delay unauthorized calls by 3 seconds
747 $delay = 3 - tv_interval($reqstate->{starttime});
748 $delay = 0 if $delay < 0;
751 my ($raw, $ct, $nocomp) = $formatter->($res, $res->{data}, $params, $path,
752 $auth, $self->{formatter_config});
755 if (ref($raw) && (ref($raw) eq 'HTTP::Response')) {
758 $resp = HTTP::Response->new($res->{status}, $res->{message});
759 $resp->header("Content-Type
" => $ct);
760 $resp->content($raw);
762 $self->response($reqstate, $resp, undef, $nocomp, $delay);
765 $self->error($reqstate, 501, $err);
769 sub handle_spice_proxy_request {
770 my ($self, $reqstate, $connect_str, $vmid, $node, $spiceport) = @_;
774 die "Port
$spiceport is not allowed
" if ($spiceport < 61000 || $spiceport > 61099);
776 my $clientip = $reqstate->{peer_host};
777 my $r = $reqstate->{request};
781 if ($node ne 'localhost' && PVE::INotify::nodename() !~ m/^$node$/i) {
782 $remip = $self->remote_node_ip($node);
783 print "REMOTE CONNECT
$vmid, $remip, $connect_str\n" if $self->{debug};
785 print "$$: CONNECT
$vmid, $node, $spiceport\n" if $self->{debug};
788 if ($remip && $r->header('PVEDisableProxy')) {
789 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy
loop detected
");
793 $reqstate->{hdl}->timeout(0);
794 $reqstate->{hdl}->wbuf_max(64*10*1024);
796 my $remhost = $remip ? $remip : "localhost
";
797 my $remport = $remip ? 3128 : $spiceport;
799 tcp_connect $remhost, $remport, sub {
801 or die "connect to
'$remhost:$remport' failed
: $!";
803 print "$$: CONNECTed to
'$remhost:$remport'\n" if $self->{debug};
804 $reqstate->{proxyhdl} = AnyEvent::Handle->new(
807 wbuf_max => 64*10*1024,
812 $self->log_aborted_request($reqstate);
813 $self->client_do_disconnect($reqstate);
815 if (my $err = $@) { syslog('err', $err); }
818 my ($hdl, $fatal, $message) = @_;
820 $self->log_aborted_request($reqstate, $message);
821 $self->client_do_disconnect($reqstate);
823 if (my $err = $@) { syslog('err', "$err"); }
827 my $proxyhdlreader = sub {
830 my $len = length($hdl->{rbuf});
831 my $data = substr($hdl->{rbuf}, 0, $len, '');
833 #print "READ1
$len\n";
834 $reqstate->{hdl}->push_write($data) if $reqstate->{hdl};
837 my $hdlreader = sub {
840 my $len = length($hdl->{rbuf});
841 my $data = substr($hdl->{rbuf}, 0, $len, '');
843 #print "READ0
$len\n";
844 $reqstate->{proxyhdl}->push_write($data) if $reqstate->{proxyhdl};
847 my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.0';
849 my $startproxy = sub {
850 $reqstate->{proxyhdl}->timeout(0);
851 $reqstate->{proxyhdl}->on_read($proxyhdlreader);
852 $reqstate->{hdl}->on_read($hdlreader);
854 # todo: use stop_read/start_read if write buffer grows to much
856 my $res = "$proto 200 OK
\015\012"; # hope this is the right answer?
857 $reqstate->{hdl}->push_write($res);
860 $reqstate->{log}->{code} = 200;
861 $self->log_request($reqstate);
865 my $header = "CONNECT
${connect_str
} $proto\015\012" .
866 "Host
: ${connect_str
}\015\012" .
867 "Proxy-Connection
: keep-alive
\015\012" .
868 "User-Agent
: spiceproxy
\015\012" .
869 "PVEDisableProxy
: true
\015\012" .
870 "PVEClientIP
: $clientip\015\012" .
873 $reqstate->{proxyhdl}->push_write($header);
874 $reqstate->{proxyhdl}->push_read(line => sub {
875 my ($hdl, $line) = @_;
877 if ($line =~ m!^$proto 200 OK$!) {
880 $reqstate->{hdl}->push_write($line);
881 $self->client_do_disconnect($reqstate);
892 $self->log_aborted_request($reqstate, $err);
893 $self->client_do_disconnect($reqstate);
898 my ($self, $reqstate, $auth, $method, $path) = @_;
900 my $base_uri = $self->{base_uri};
903 my $r = $reqstate->{request};
905 # disable timeout on handle (we already have all data we need)
906 # we re-enable timeout in response()
907 $reqstate->{hdl}->timeout(0);
909 if ($path =~ m/^\Q$base_uri\E/) {
910 $self->handle_api2_request($reqstate, $auth, $method, $path);
914 if ($self->{pages} && ($method eq 'GET') && (my $handler = $self->{pages}->{$path})) {
915 if (ref($handler) eq 'CODE') {
916 my $params = decode_urlencoded($r->url->query());
917 my ($resp, $userid) = &$handler($self, $reqstate->{request}, $params);
919 Net::SSLeay::ERR_clear_error();
920 $self->response($reqstate, $resp);
921 } elsif (ref($handler) eq 'HASH') {
922 if (my $filename = $handler->{file}) {
923 my $fh = IO::File->new($filename) ||
924 die "unable to
open file
'$filename' - $!\n";
925 send_file_start($self, $reqstate, $filename);
927 die "internal error
- no handler
";
930 die "internal error
- no handler
";
935 if ($self->{dirs} && ($method eq 'GET')) {
936 # we only allow simple names
937 if ($path =~ m!^(/\S+/)([a-zA-Z0-9\-\_\.]+)$!) {
938 my ($subdir, $file) = ($1, $2);
939 if (my $dir = $self->{dirs}->{$subdir}) {
940 my $filename = "$dir$file";
941 my $fh = IO::File->new($filename) ||
942 die "unable to
open file
'$filename' - $!\n";
943 send_file_start($self, $reqstate, $filename);
949 die "no such file
'$path'\n";
952 $self->error($reqstate, 501, $err);
956 sub file_upload_multipart {
957 my ($self, $reqstate, $auth, $method, $path, $rstate) = @_;
960 my $boundary = $rstate->{boundary};
961 my $hdl = $reqstate->{hdl};
963 my $startlen = length($hdl->{rbuf});
965 if ($rstate->{phase} == 0) { # skip everything until start
966 if ($hdl->{rbuf} =~ s/^.*?--\Q$boundary\E \015?\012
967 ((?:[^\015]+\015\012)* ) \015?\012//xs) {
969 my ($ct, $disp, $name, $filename);
970 foreach my $line (split(/\015?\012/, $header)) {
971 # assume we have single line headers
972 if ($line =~ m/^Content-Type\s*:\s*(.*)/i) {
973 $ct = parse_content_type($1);
974 } elsif ($line =~ m/^Content-Disposition\s*:\s*(.*)/i) {
975 ($disp, $name, $filename) = parse_content_disposition($1);
979 if (!($disp && $disp eq 'form-data' && $name)) {
980 syslog('err', "wrong content disposition
in multipart
- abort upload
");
981 $rstate->{phase} = -1;
984 $rstate->{fieldname} = $name;
987 if ($name eq 'filename') {
988 # found file upload data
989 $rstate->{phase} = 1;
990 $rstate->{filename} = $filename;
992 syslog('err', "wrong field name
for file upload
- abort upload
");
993 $rstate->{phase} = -1;
996 # found form data for field $name
997 $rstate->{phase} = 2;
1001 my $len = length($hdl->{rbuf});
1002 substr($hdl->{rbuf}, 0, $len - $rstate->{maxheader}, '')
1003 if $len > $rstate->{maxheader}; # skip garbage
1005 } elsif ($rstate->{phase} == 1) { # inside file - dump until end marker
1006 if ($hdl->{rbuf} =~ s/^(.*?)\015?\012(--\Q$boundary\E(--)? \015?\012(.*))$/$2/xs) {
1007 my ($rest, $eof) = ($1, $3);
1008 my $len = length($rest);
1009 die "write to temporary file failed
- $!"
1010 if syswrite($rstate->{outfh}, $rest) != $len;
1011 $rstate->{ctx}->add($rest);
1012 $rstate->{params}->{filename} = $rstate->{filename};
1013 $rstate->{md5sum} = $rstate->{ctx}->hexdigest;
1014 $rstate->{bytes} += $len;
1015 $rstate->{phase} = $eof ? 100 : 0;
1017 my $len = length($hdl->{rbuf});
1018 my $wlen = $len - $rstate->{boundlen};
1020 my $data = substr($hdl->{rbuf}, 0, $wlen, '');
1021 die "write to temporary file failed
- $!"
1022 if syswrite($rstate->{outfh}, $data) != $wlen;
1023 $rstate->{bytes} += $wlen;
1024 $rstate->{ctx}->add($data);
1027 } elsif ($rstate->{phase} == 2) { # inside normal field
1029 if ($hdl->{rbuf} =~ s/^(.*?)\015?\012(--\Q$boundary\E(--)? \015?\012(.*))$/$2/xs) {
1030 my ($rest, $eof) = ($1, $3);
1031 my $len = length($rest);
1032 $rstate->{post_size} += $len;
1033 if ($rstate->{post_size} < $limit_max_post) {
1034 $rstate->{params}->{$rstate->{fieldname}} = $rest;
1035 $rstate->{phase} = $eof ? 100 : 0;
1037 syslog('err', "form data to large
- abort upload
");
1038 $rstate->{phase} = -1; # skip
1042 my $len = length($hdl->{rbuf});
1043 substr($hdl->{rbuf}, 0, $len, ''); # empty rbuf
1046 $rstate->{read} += ($startlen - length($hdl->{rbuf}));
1048 if (!$rstate->{done} && ($rstate->{read} + length($hdl->{rbuf})) >= $rstate->{size}) {
1049 $rstate->{done} = 1; # make sure we dont get called twice
1050 if ($rstate->{phase} < 0 || !$rstate->{md5sum}) {
1051 die "upload failed
\n";
1053 my $elapsed = tv_interval($rstate->{starttime});
1055 my $rate = int($rstate->{bytes}/($elapsed*1024*1024));
1056 syslog('info', "multipart upload complete
" .
1057 "(size
: %d time: %ds rate
: %.2fMiB
/s md5sum
: $rstate->{md5sum
})",
1058 $rstate->{bytes}, $elapsed, $rate);
1059 $self->handle_api2_request($reqstate, $auth, $method, $path, $rstate);
1064 syslog('err', $err);
1065 $self->error($reqstate, 501, $err);
1069 sub parse_content_type {
1072 my ($ct, @params) = split(/\s*[;,]\s*/o, $ctype);
1074 foreach my $v (@params) {
1075 if ($v =~ m/^\s*boundary\s*=\s*(\S+?)\s*$/o) {
1076 return wantarray ? ($ct, $1) : $ct;
1080 return wantarray ? ($ct) : $ct;
1083 sub parse_content_disposition {
1086 my ($disp, @params) = split(/\s*[;,]\s*/o, $line);
1090 foreach my $v (@params) {
1091 if ($v =~ m/^\s*name\s*=\s*(\S+?)\s*$/o) {
1093 $name =~ s/^"(.*)"$/$1/;
1094 } elsif ($v =~ m/^\s*filename\s*=\s*(.+?)\s*$/o) {
1096 $filename =~ s/^"(.*)"$/$1/;
1100 return wantarray ? ($disp, $name, $filename) : $disp;
1103 my $tmpfile_seq_no = 0;
1105 sub get_upload_filename {
1106 # choose unpredictable tmpfile name
1109 return "/var/tmp
/pveupload-
" . Digest::MD5::md5_hex($tmpfile_seq_no . time() . $$);
1112 sub unshift_read_header {
1113 my ($self, $reqstate, $state) = @_;
1115 $state = { size => 0, count => 0 } if !$state;
1117 $reqstate->{hdl}->unshift_read(line => sub {
1118 my ($hdl, $line) = @_;
1121 # print "$$: got header
: $line\n" if $self->{debug};
1123 die "to many http header lines
\n" if ++$state->{count} >= $limit_max_headers;
1124 die "http header too large
\n" if ($state->{size} += length($line)) >= $limit_max_header_size;
1126 my $r = $reqstate->{request};
1129 my $path = uri_unescape($r->uri->path());
1130 my $method = $r->method();
1132 $r->push_header($state->{key}, $state->{val})
1135 if (!$known_methods->{$method}) {
1136 my $resp = HTTP::Response->new(HTTP_NOT_IMPLEMENTED, "method '$method' not available
");
1137 $self->response($reqstate, $resp);
1141 my $conn = $r->header('Connection');
1142 my $accept_enc = $r->header('Accept-Encoding');
1143 $reqstate->{accept_gzip} = ($accept_enc && $accept_enc =~ m/gzip/) ? 1 : 0;
1146 $reqstate->{keep_alive} = 0 if $conn =~ m/close/oi;
1148 if ($reqstate->{proto}->{ver} < 1001) {
1149 $reqstate->{keep_alive} = 0;
1153 my $te = $r->header('Transfer-Encoding');
1154 if ($te && lc($te) eq 'chunked') {
1155 # Handle chunked transfer encoding
1156 $self->error($reqstate, 501, "chunked transfer encoding
not supported
");
1159 $self->error($reqstate, 501, "Unknown transfer encoding
'$te'");
1163 my $pveclientip = $r->header('PVEClientIP');
1164 my $base_uri = $self->{base_uri};
1166 # fixme: how can we make PVEClientIP header trusted?
1167 if ($self->{trusted_env} && $pveclientip) {
1168 $reqstate->{peer_host} = $pveclientip;
1170 $r->header('PVEClientIP', $reqstate->{peer_host});
1173 my $len = $r->header('Content-Length');
1175 # header processing complete - authenticate now
1178 if ($self->{spiceproxy}) {
1179 my $connect_str = $r->header('Host');
1180 my ($vmid, $node, $port) = $self->verify_spice_connect_url($connect_str);
1181 if (!(defined($vmid) && $node && $port)) {
1182 $self->error($reqstate, HTTP_UNAUTHORIZED, "invalid ticket
");
1185 $self->handle_spice_proxy_request($reqstate, $connect_str, $vmid, $node, $port);
1187 } elsif ($path =~ m/^\Q$base_uri\E/) {
1188 my $token = $r->header('CSRFPreventionToken');
1189 my $cookie = $r->header('Cookie');
1190 my $ticket = PVE::APIServer::Formatter::extract_auth_cookie($cookie, $self->{cookie_name});
1192 my ($rel_uri, $format) = &$split_abs_uri($path, $self->{base_uri});
1194 $self->error($reqstate, HTTP_NOT_IMPLEMENTED, "no such uri
");
1199 $auth = $self->auth_handler($method, $rel_uri, $ticket, $token,
1200 $reqstate->{peer_host});
1204 Net::SSLeay::ERR_clear_error();
1205 # always delay unauthorized calls by 3 seconds
1207 if (my $formatter = PVE::APIServer::Formatter::get_login_formatter($format)) {
1208 my ($raw, $ct, $nocomp) =
1209 $formatter->($path, $auth, $self->{formatter_config});
1211 if (ref($raw) && (ref($raw) eq 'HTTP::Response')) {
1214 $resp = HTTP::Response->new(HTTP_UNAUTHORIZED, "Login Required
");
1215 $resp->header("Content-Type
" => $ct);
1216 $resp->content($raw);
1218 $self->response($reqstate, $resp, undef, $nocomp, $delay);
1220 my $resp = HTTP::Response->new(HTTP_UNAUTHORIZED, $err);
1221 $self->response($reqstate, $resp, undef, 0, $delay);
1227 $reqstate->{log}->{userid} = $auth->{userid};
1231 if (!($method eq 'PUT' || $method eq 'POST')) {
1232 $self->error($reqstate, 501, "Unexpected content
for method '$method'");
1236 my $ctype = $r->header('Content-Type');
1237 my ($ct, $boundary) = parse_content_type($ctype) if $ctype;
1239 if ($auth->{isUpload} && !$self->{trusted_env}) {
1240 die "upload
'Content-Type '$ctype' not implemented\n"
1241 if !($boundary && $ct && ($ct eq 'multipart
/form-data
'));
1243 die "upload without content length header not supported" if !$len;
1245 die "upload without content length header not supported" if !$len;
1247 print "start upload $path $ct $boundary\n" if $self->{debug};
1249 my $tmpfilename = get_upload_filename();
1250 my $outfh = IO::File->new($tmpfilename, O_RDWR|O_CREAT|O_EXCL, 0600) ||
1251 die "unable to create temporary upload file '$tmpfilename'";
1253 $reqstate->{keep_alive} = 0;
1255 my $boundlen = length($boundary) + 8; # \015?\012--$boundary--\015?\012
1259 boundary => $boundary,
1260 ctx => Digest::MD5->new,
1261 boundlen => $boundlen,
1262 maxheader => 2048 + $boundlen, # should be large enough
1263 params => decode_urlencoded($r->url->query()),
1267 starttime => [gettimeofday],
1270 $reqstate->{tmpfilename} = $tmpfilename;
1271 $reqstate->{hdl}->on_read(sub { $self->file_upload_multipart($reqstate, $auth, $method, $path, $state); });
1275 if ($len > $limit_max_post) {
1276 $self->error($reqstate, 501, "for data too large");
1280 if (!$ct || $ct eq 'application
/x-www-form-urlencoded
') {
1281 $reqstate->{hdl}->unshift_read(chunk => $len, sub {
1282 my ($hdl, $data) = @_;
1284 $self->handle_request($reqstate, $auth, $method, $path);
1287 $self->error($reqstate, 506, "upload 'Content-Type
'$ctype' not implemented
");
1290 $self->handle_request($reqstate, $auth, $method, $path);
1292 } elsif ($line =~ /^([^:\s]+)\s*:\s*(.*)/) {
1293 $r->push_header($state->{key}, $state->{val}) if $state->{key};
1294 ($state->{key}, $state->{val}) = ($1, $2);
1295 $self->unshift_read_header($reqstate, $state);
1296 } elsif ($line =~ /^\s+(.*)/) {
1297 $state->{val} .= " $1";
1298 $self->unshift_read_header($reqstate, $state);
1300 $self->error($reqstate, 506, "unable to parse request header
");
1307 sub push_request_header {
1308 my ($self, $reqstate) = @_;
1311 $reqstate->{hdl}->push_read(line => sub {
1312 my ($hdl, $line) = @_;
1315 # print "got request header
: $line\n" if $self->{debug};
1317 $reqstate->{keep_alive}--;
1319 if ($line =~ /(\S+)\040(\S+)\040HTTP\/(\d+)\.(\d+)/o) {
1320 my ($method, $url, $maj, $min) = ($1, $2, $3, $4);
1323 $self->error($reqstate, 506, "http protocol version
$maj.$min not supported
");
1327 $self->{request_count}++; # only count valid request headers
1328 if ($self->{request_count} >= $self->{max_requests}) {
1329 $self->{end_loop} = 1;
1331 $reqstate->{log} = { requestline => $line };
1332 $reqstate->{proto}->{str} = "HTTP
/$maj.$min";
1333 $reqstate->{proto}->{maj} = $maj;
1334 $reqstate->{proto}->{min} = $min;
1335 $reqstate->{proto}->{ver} = $maj*1000+$min;
1336 $reqstate->{request} = HTTP::Request->new($method, $url);
1337 $reqstate->{starttime} = [gettimeofday],
1339 $self->unshift_read_header($reqstate);
1340 } elsif ($line eq '') {
1341 # ignore empty lines before requests (browser bugs?)
1342 $self->push_request_header($reqstate);
1344 $self->error($reqstate, 400, 'bad request');
1358 return if $self->{end_loop};
1360 # we need to m make sure that only one process calls accept
1361 while (!flock($self->{lockfh}, Fcntl::LOCK_EX())) {
1362 next if $! == EINTR;
1363 die "could
not get
lock on file
'$self->{lockfile}' - $!\n";
1369 while (!$self->{end_loop} &&
1370 !defined($clientfh = $self->{socket}->accept()) &&
1373 if ($self->{end_loop}) {
1376 $again = ($! == EAGAIN || $! == WSAEWOULDBLOCK);
1377 if (!defined($clientfh)) {
1378 $errmsg = "failed to
accept connection
: $!\n";
1384 flock($self->{lockfh}, Fcntl::LOCK_UN());
1386 if (!defined($clientfh)) {
1388 die $errmsg if $errmsg;
1391 fh_nonblocking $clientfh, 1;
1393 $self->{conn_count}++;
1401 $self->{end_loop} = 1;
1403 undef $self->{socket_watch};
1405 $0 = "$0 (shutdown)" if $0 !~ m/\(shutdown\)$/;
1407 if ($self->{conn_count} <= 0) {
1408 $self->{end_cond}->send(1);
1412 # fork and exit, so that parent starts a new worker
1417 # else we need to wait until all open connections gets closed
1418 my $w; $w = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1420 # todo: test for active connections instead (we can abort idle connections)
1421 if ($self->{conn_count} <= 0) {
1423 $self->{end_cond}->send(1);
1431 sub check_host_access {
1432 my ($self, $clientip) = @_;
1434 my $cip = Net::IP->new($clientip);
1436 my $match_allow = 0;
1439 if ($self->{allow_from}) {
1440 foreach my $t (@{$self->{allow_from}}) {
1441 if ($t->overlaps($cip)) {
1448 if ($self->{deny_from}) {
1449 foreach my $t (@{$self->{deny_from}}) {
1450 if ($t->overlaps($cip)) {
1457 if ($match_allow == $match_deny) {
1458 # match both allow and deny, or no match
1459 return $self->{policy} && $self->{policy} eq 'allow' ? 1 : 0;
1462 return $match_allow;
1465 sub accept_connections {
1470 while (my $clientfh = $self->accept()) {
1472 my $reqstate = { keep_alive => $self->{keep_alive} };
1474 # stop keep-alive when there are many open connections
1475 if ($self->{conn_count} >= $self->{max_conn_soft_limit}) {
1476 $reqstate->{keep_alive} = 0;
1479 if (my $sin = getpeername($clientfh)) {
1480 my ($pfamily, $pport, $phost) = PVE::Tools::unpack_sockaddr_in46($sin);
1481 ($reqstate->{peer_port}, $reqstate->{peer_host}) = ($pport, Socket::inet_ntop($pfamily, $phost));
1484 if (!$self->{trusted_env} && !$self->check_host_access($reqstate->{peer_host})) {
1485 print "$$: ABORT request from
$reqstate->{peer_host
} - access denied
\n" if $self->{debug};
1486 $reqstate->{log}->{code} = 403;
1487 $self->log_request($reqstate);
1491 $reqstate->{hdl} = AnyEvent::Handle->new(
1493 rbuf_max => 64*1024,
1494 timeout => $self->{timeout},
1495 linger => 0, # avoid problems with ssh - really needed ?
1499 $self->log_aborted_request($reqstate);
1500 $self->client_do_disconnect($reqstate);
1502 if (my $err = $@) { syslog('err', $err); }
1505 my ($hdl, $fatal, $message) = @_;
1507 $self->log_aborted_request($reqstate, $message);
1508 $self->client_do_disconnect($reqstate);
1510 if (my $err = $@) { syslog('err', "$err"); }
1512 ($self->{tls_ctx} ? (tls => "accept", tls_ctx => $self->{tls_ctx}) : ()));
1514 print "$$: ACCEPT FH
" . $clientfh->fileno() . " CONN
$self->{conn_count
}\n" if $self->{debug};
1516 $self->push_request_header($reqstate);
1521 syslog('err', $err);
1522 $self->{end_loop} = 1;
1525 $self->wait_end_loop() if $self->{end_loop};
1528 # Note: We can't open log file in non-blocking mode and use AnyEvent::Handle,
1529 # because we write from multiple processes, and that would arbitrarily mix output
1531 sub open_access_log {
1532 my ($self, $filename) = @_;
1534 my $old_mask = umask(0137);;
1535 my $logfh = IO::File->new($filename, ">>") ||
1536 die "unable to
open log file
'$filename' - $!\n";
1539 $logfh->autoflush(1);
1541 $self->{logfh} = $logfh;
1545 my ($self, $data) = @_;
1547 return if !defined($self->{logfh}) || !$data;
1549 my $res = $self->{logfh}->print($data);
1552 delete $self->{logfh};
1553 syslog('err', "error writing access
log");
1554 $self->{end_loop} = 1; # terminate asap
1558 sub atfork_handler {
1562 # something else do to ?
1563 close($self->{socket});
1571 $self->{end_cond}->recv;
1575 my ($this, %args) = @_;
1577 my $class = ref($this) || $this;
1579 foreach my $req (qw(socket lockfh lockfile)) {
1580 die "misssing required argument '$req'" if !defined($args{$req});
1583 my $self = bless { %args }, $class;
1585 $self->{cookie_name
} //= 'PVEAuthCookie';
1586 $self->{base_uri
} //= "/api2";
1587 $self->{dirs
} //= {};
1588 $self->{title
} //= 'API Inspector';
1590 # formatter_config: we pass some configuration values to the Formatter
1591 $self->{formatter_config
} = {};
1592 foreach my $p (qw(cookie_name base_uri title)) {
1593 $self->{formatter_config
}->{$p} = $self->{$p};
1595 $self->{formatter_config
}->{csrfgen_func
} =
1596 $self->can('generate_csrf_prevention_token');
1598 # add default dirs which includes jquery and bootstrap
1599 my $base = '/usr/share/libpve-http-server-perl';
1600 add_dirs
($self->{dirs
}, '/css/' => "$base/css/");
1601 add_dirs
($self->{dirs
}, '/js/' => "$base/js/");
1602 add_dirs
($self->{dirs
}, '/fonts/' => "$base/fonts/");
1605 PVE
::INotify
::inotify_init
();
1607 fh_nonblocking
($self->{socket}, 1);
1609 $self->{end_loop
} = 0;
1610 $self->{conn_count
} = 0;
1611 $self->{request_count
} = 0;
1612 $self->{timeout
} = 5 if !$self->{timeout
};
1613 $self->{keep_alive
} = 0 if !defined($self->{keep_alive
});
1614 $self->{max_conn
} = 800 if !$self->{max_conn
};
1615 $self->{max_requests
} = 8000 if !$self->{max_requests
};
1617 $self->{policy
} = 'allow' if !$self->{policy
};
1619 $self->{end_cond
} = AnyEvent-
>condvar;
1622 $self->{tls_ctx
} = AnyEvent
::TLS-
>new(%{$self->{ssl
}});
1623 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
);
1626 if ($self->{spiceproxy
}) {
1627 $known_methods = { CONNECT
=> 1 };
1630 $self->open_access_log($self->{logfile
}) if $self->{logfile
};
1632 $self->{max_conn_soft_limit
} = $self->{max_conn
} > 100 ?
$self->{max_conn
} - 20 : $self->{max_conn
};
1634 $self->{socket_watch
} = AnyEvent-
>io(fh
=> $self->{socket}, poll
=> 'r', cb
=> sub {
1636 if ($self->{conn_count
} >= $self->{max_conn
}) {
1637 my $w; $w = AnyEvent-
>timer (after
=> 1, interval
=> 1, cb
=> sub {
1638 if ($self->{conn_count
} < $self->{max_conn
}) {
1640 $self->accept_connections();
1644 $self->accept_connections();
1650 $self->{term_watch
} = AnyEvent-
>signal(signal
=> "TERM", cb
=> sub {
1651 undef $self->{term_watch
};
1652 $self->wait_end_loop();
1655 $self->{quit_watch
} = AnyEvent-
>signal(signal
=> "QUIT", cb
=> sub {
1656 undef $self->{quit_watch
};
1657 $self->wait_end_loop();
1660 $self->{inotify_poll
} = AnyEvent-
>timer(after
=> 5, interval
=> 5, cb
=> sub {
1661 PVE
::INotify
::poll
(); # read inotify events
1667 # static helper to add directory including all subdirs
1668 # This can be used to setup $self->{dirs}
1670 my ($result_hash, $alias, $subdir) = @_;
1672 $result_hash->{$alias} = $subdir;
1675 my $dir = $File::Find
::dir
;
1676 if ($dir =~m!^$subdir(.*)$!) {
1677 my $name = "$alias$1/";
1678 $result_hash->{$name} = "$dir/";
1682 find
({wanted
=> $wanted, follow
=> 0, no_chdir
=> 1}, $subdir);
1685 # abstract functions - subclass should overwrite/implement them
1687 sub verify_spice_connect_url
{
1688 my ($self, $connect_str) = @_;
1692 #return ($vmid, $node, $port);
1695 # formatters can call this when the generate a new page
1696 sub generate_csrf_prevention_token
{
1697 my ($username) = @_;
1699 return undef; # do nothing by default
1703 my ($self, $method, $rel_uri, $ticket, $token, $peer_host) = @_;
1708 # ticket => $ticket,
1710 # userid => $username,
1712 # isUpload => $isUpload,
1717 my ($self, $clientip, $method, $rel_uri, $auth, $params) = @_;
1719 # please do not raise exceptions here (always return a result).
1722 status
=> HTTP_NOT_IMPLEMENTED
,
1723 message
=> "Method '$method $rel_uri' not implemented",
1726 # this should return the following properties, which
1727 # are then passed to the Formatter
1729 # status: HTTP status code
1730 # message: Error message
1731 # errors: more detailed error hash (per parameter)
1732 # info: reference to JSON schema definition - useful to format output
1735 # total: additional info passed to output
1736 # changes: additional info passed to output
1738 # if you want to proxy the request to another node return this
1739 # { proxy => $remip, proxynode => $node, proxy_params => $params };
1741 # to pass the request to the local priviledged daemon use:
1742 # { proxy => 'localhost' , proxy_params => $params };
1745 sub check_cert_fingerprint
{
1746 my ($self, $cert) = @_;
1751 sub initialize_cert_cache
{
1752 my ($self, $node) = @_;
1757 sub remote_node_ip
{
1758 my ($self, $node) = @_;