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);
15 # use AnyEvent::Strict; # only use this for debugging
16 use AnyEvent
::Util
qw(guard fh_nonblocking WSAEWOULDBLOCK WSAEINPROGRESS);
28 use PVE
::APIServer
::Formatter
;
33 use HTTP
::Status
qw(:constants);
40 my $limit_max_headers = 30;
41 my $limit_max_header_size = 8*1024;
42 my $limit_max_post = 16*1024;
51 my $split_abs_uri = sub {
52 my ($abs_uri, $base_uri) = @_;
54 my ($format, $rel_uri) = $abs_uri =~ m/^\Q$base_uri\E\/+([a-z
][a-z0-9
]+)(\
/.*)?$/;
55 $rel_uri = '/' if !$rel_uri;
57 return wantarray ?
($rel_uri, $format) : $rel_uri;
61 my ($self, $reqstate) = @_;
63 my $loginfo = $reqstate->{log};
65 # like apache2 common log format
66 # LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\""
68 return if $loginfo->{written
}; # avoid duplicate logs
69 $loginfo->{written
} = 1;
71 my $peerip = $reqstate->{peer_host
} || '-';
72 my $userid = $loginfo->{userid
} || '-';
73 my $content_length = defined($loginfo->{content_length
}) ?
$loginfo->{content_length
} : '-';
74 my $code = $loginfo->{code
} || 500;
75 my $requestline = $loginfo->{requestline
} || '-';
76 my $timestr = strftime
("%d/%b/%Y:%H:%M:%S %z", localtime());
78 my $msg = "$peerip - $userid [$timestr] \"$requestline\" $code $content_length\n";
80 $self->write_log($msg);
83 sub log_aborted_request {
84 my ($self, $reqstate, $error) = @_;
86 my $r = $reqstate->{request};
87 return if !$r; # no active request
90 syslog("err
", "problem with client
$reqstate->{peer_host
}; $error");
93 $self->log_request($reqstate);
96 sub cleanup_reqstate {
99 delete $reqstate->{log};
100 delete $reqstate->{request};
101 delete $reqstate->{proto};
102 delete $reqstate->{accept_gzip};
103 delete $reqstate->{starttime};
105 if ($reqstate->{tmpfilename}) {
106 unlink $reqstate->{tmpfilename};
107 delete $reqstate->{tmpfilename};
111 sub client_do_disconnect {
112 my ($self, $reqstate) = @_;
114 cleanup_reqstate($reqstate);
116 my $shutdown_hdl = sub {
119 shutdown($hdl->{fh}, 1);
121 $hdl->on_drain(undef);
122 $hdl->on_read(undef);
126 if (my $proxyhdl = delete $reqstate->{proxyhdl}) {
127 &$shutdown_hdl($proxyhdl);
130 my $hdl = delete $reqstate->{hdl};
133 syslog('err', "detected empty handle
");
137 print "close connection
$hdl\n" if $self->{debug};
139 &$shutdown_hdl($hdl);
141 $self->{conn_count}--;
143 print "$$: CLOSE FH
" . $hdl->{fh}->fileno() . " CONN
$self->{conn_count
}\n" if $self->{debug};
146 sub finish_response {
147 my ($self, $reqstate) = @_;
149 my $hdl = $reqstate->{hdl};
151 cleanup_reqstate($reqstate);
153 if (!$self->{end_loop} && $reqstate->{keep_alive} > 0) {
154 # print "KEEPALIVE
$reqstate->{keep_alive
}\n" if $self->{debug};
156 eval { $self->push_request_header($reqstate); };
160 $hdl->on_drain (sub {
162 $self->client_do_disconnect($reqstate);
170 my ($self, $reqstate, $resp, $mtime, $nocomp, $delay) = @_;
172 #print "$$: send response
: " . Dumper($resp);
175 $reqstate->{hdl}->timeout_reset();
176 $reqstate->{hdl}->timeout($self->{timeout});
178 $nocomp = 1 if !$reqstate->{accept_gzip};
180 my $code = $resp->code;
181 my $msg = $resp->message || HTTP::Status::status_message($code);
182 ($msg) = $msg =~m/^(.*)$/m;
183 my $content = $resp->content;
185 if ($code =~ /^(1\d\d|[23]04)$/) {
186 # make sure content we have no content
190 $reqstate->{keep_alive} = 0 if ($code >= 400) || $self->{end_loop};
192 $reqstate->{log}->{code} = $code;
194 my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.0';
195 my $res = "$proto $code $msg\015\012";
198 my $date = HTTP::Date::time2str($ctime);
199 $resp->header('Date' => $date);
201 $resp->header('Last-Modified' => HTTP::Date::time2str($mtime));
203 $resp->header('Expires' => $date);
204 $resp->header('Cache-Control' => "max-age
=0");
205 $resp->header("Pragma
", "no-cache
");
208 $resp->header('Server' => "pve-api-daemon
/3.0");
213 $content_length = length($content);
215 if (!$nocomp && ($content_length > 1024)) {
216 my $comp = Compress::Zlib::memGzip($content);
217 $resp->header('Content-Encoding', 'gzip');
219 $content_length = length($content);
221 $resp->header("Content-Length
" => $content_length);
222 $reqstate->{log}->{content_length} = $content_length;
225 $resp->remove_header("Content-Length
");
228 if ($reqstate->{keep_alive} > 0) {
229 $resp->push_header('Connection' => 'Keep-Alive');
231 $resp->header('Connection' => 'close');
234 $res .= $resp->headers_as_string("\015\012");
235 #print "SEND
(without content
) $res\n" if $self->{debug};
238 $res .= $content if $content;
240 $self->log_request($reqstate, $reqstate->{request});
242 if ($delay && $delay > 0) {
243 my $w; $w = AnyEvent->timer(after => $delay, cb => sub {
244 undef $w; # delete reference
245 $reqstate->{hdl}->push_write($res);
246 $self->finish_response($reqstate);
249 $reqstate->{hdl}->push_write($res);
250 $self->finish_response($reqstate);
255 my ($self, $reqstate, $code, $msg, $hdr, $content) = @_;
258 my $resp = HTTP::Response->new($code, $msg, $hdr, $content);
259 $self->response($reqstate, $resp);
264 my $file_extension_info = {
265 css => { ct => 'text/css' },
266 html => { ct => 'text/html' },
267 js => { ct => 'application/javascript' },
268 png => { ct => 'image/png' , nocomp => 1 },
269 ico => { ct => 'image/x-icon', nocomp => 1},
270 gif => { ct => 'image/gif', nocomp => 1},
271 jar => { ct => 'application/java-archive', nocomp => 1},
272 woff => { ct => 'application/font-woff', nocomp => 1},
273 woff2 => { ct => 'application/font-woff2', nocomp => 1},
274 ttf => { ct => 'application/font-snft', nocomp => 1},
275 pdf => { ct => 'application/pdf', nocomp => 1},
276 epub => { ct => 'application/epub+zip', nocomp => 1},
279 sub send_file_start {
280 my ($self, $reqstate, $filename) = @_;
283 # print "SEND FILE
$filename\n";
284 # Note: aio_load() this is not really async unless we use IO::AIO!
287 my $r = $reqstate->{request};
289 my $fh = IO::File->new($filename, '<') ||
291 my $stat = File::stat::stat($fh) ||
294 my $mtime = $stat->mtime;
296 if (my $ifmod = $r->header('if-modified-since')) {
297 my $iftime = HTTP::Date::str2time($ifmod);
298 if ($mtime <= $iftime) {
299 my $resp = HTTP::Response->new(304, "NOT MODIFIED
");
300 $self->response($reqstate, $resp, $mtime);
306 my $len = sysread($fh, $data, $stat->size);
307 die "got short file
\n" if !defined($len) || $len != $stat->size;
309 my ($ext) = $filename =~ m/\.([^.]*)$/;
310 my $ext_info = $file_extension_info->{$ext};
312 die "unable to detect content type
" if !$ext_info;
314 my $header = HTTP::Headers->new(Content_Type => $ext_info->{ct});
315 my $resp = HTTP::Response->new(200, "OK
", $header, $data);
316 $self->response($reqstate, $resp, $mtime, $ext_info->{nocomp});
319 $self->error($reqstate, 501, $err);
326 sub websocket_proxy {
327 my ($self, $reqstate, $wsaccept, $wsproto, $param) = @_;
333 my $max_payload_size = 65536;
336 if ($wsproto eq 'binary') {
338 } elsif ($wsproto eq 'base64') {
341 die "websocket_proxy
: unsupported protocol
'$wsproto'\n";
344 if ($param->{port}) {
345 $remhost = 'localhost';
346 $remport = $param->{port};
347 } elsif ($param->{socket}) {
349 $remport = $param->{socket};
351 die "websocket_proxy
: missing port
or socket\n";
354 tcp_connect $remhost, $remport, sub {
356 or die "connect to
'$remhost:$remport' failed
: $!";
358 print "$$: CONNECTed to
'$remhost:$remport'\n" if $self->{debug};
360 $reqstate->{proxyhdl} = AnyEvent::Handle->new(
363 wbuf_max => 64*10*1024,
368 $self->log_aborted_request($reqstate);
369 $self->client_do_disconnect($reqstate);
371 if (my $err = $@) { syslog('err', $err); }
374 my ($hdl, $fatal, $message) = @_;
376 $self->log_aborted_request($reqstate, $message);
377 $self->client_do_disconnect($reqstate);
379 if (my $err = $@) { syslog('err', "$err"); }
382 my $proxyhdlreader = sub {
385 my $len = length($hdl->{rbuf});
386 my $data = substr($hdl->{rbuf}, 0, $len, '');
392 $string = "\x82"; # binary frame
395 $string = "\x81"; # text frame
396 $payload = encode_base64($data, '');
399 my $payload_len = length($payload);
400 if ($payload_len <= 125) {
401 $string .= pack 'C', $payload_len;
402 } elsif ($payload_len <= 0xffff) {
403 $string .= pack 'C', 126;
404 $string .= pack 'n', $payload_len;
406 $string .= pack 'C', 127;
407 $string .= pack 'Q>', $payload_len;
411 $reqstate->{hdl}->push_write($string) if $reqstate->{hdl};
414 my $hdlreader = sub {
417 my $len = length($hdl->{rbuf});
420 my $hdr = unpack('C', substr($hdl->{rbuf}, 0, 1));
421 my $opcode = $hdr & 0b00001111;
422 my $fin = $hdr & 0b10000000;
424 die "received fragmented websocket frame
\n" if !$fin;
426 my $rsv = $hdr & 0b01110000;
427 die "received websocket frame with RSV flags
\n" if $rsv;
429 my $payload_len = unpack 'C', substr($hdl->{rbuf}, 1, 1);
431 my $masked = $payload_len & 0b10000000;
432 die "received unmasked websocket frame from client
\n" if !$masked;
435 $payload_len = $payload_len & 0b01111111;
436 if ($payload_len == 126) {
438 $payload_len = unpack('n', substr($hdl->{rbuf}, $offset, 2));
440 } elsif ($payload_len == 127) {
442 $payload_len = unpack('Q>', substr($hdl->{rbuf}, $offset, 8));
446 die "received too large websocket frame
(len
= $payload_len)\n"
447 if ($payload_len > $max_payload_size) || ($payload_len < 0);
449 return if $len < ($offset + 4 + $payload_len);
451 my $data = substr($hdl->{rbuf}, 0, $len, ''); # now consume data
453 my @mask = (unpack('C', substr($data, $offset+0, 1)),
454 unpack('C', substr($data, $offset+1, 1)),
455 unpack('C', substr($data, $offset+2, 1)),
456 unpack('C', substr($data, $offset+3, 1)));
460 my $payload = substr($data, $offset, $payload_len);
462 for (my $i = 0; $i < $payload_len; $i++) {
463 my $d = unpack('C', substr($payload, $i, 1));
464 my $n = $d ^ $mask[$i % 4];
465 substr($payload, $i, 1, pack('C', $n));
468 $payload = decode_base64($payload) if !$binary;
470 if ($opcode == 1 || $opcode == 2) {
471 $reqstate->{proxyhdl}->push_write($payload) if $reqstate->{proxyhdl};
472 } elsif ($opcode == 8) {
473 print "websocket received
close\n" if $self->{debug};
474 if ($reqstate->{proxyhdl}) {
475 $reqstate->{proxyhdl}->push_write($payload);
476 $reqstate->{proxyhdl}->push_shutdown();
478 $hdl->push_shutdown();
480 die "received unhandled websocket opcode
$opcode\n";
484 my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.1';
486 $reqstate->{proxyhdl}->timeout(0);
487 $reqstate->{proxyhdl}->on_read($proxyhdlreader);
488 $reqstate->{hdl}->on_read($hdlreader);
490 # todo: use stop_read/start_read if write buffer grows to much
492 my $res = "$proto 101 Switching Protocols
\015\012" .
493 "Upgrade
: websocket
\015\012" .
494 "Connection
: upgrade
\015\012" .
495 "Sec-WebSocket-Accept
: $wsaccept\015\012" .
496 "Sec-WebSocket-Protocol
: $wsproto\015\012" .
499 print $res if $self->{debug};
501 $reqstate->{hdl}->push_write($res);
504 $reqstate->{log}->{code} = 101;
505 $self->log_request($reqstate);
511 $self->log_aborted_request($reqstate, $err);
512 $self->client_do_disconnect($reqstate);
517 my ($self, $reqstate, $clientip, $host, $node, $method, $uri, $ticket, $token, $params) = @_;
522 if ($host eq 'localhost') {
523 $target = "http
://$host:85$uri";
524 # keep alive for localhost is not worth (connection setup is about 0.2ms)
526 } elsif (Net::IP::ip_is_ipv6($host)) {
527 $target = "https
://[$host]:8006$uri";
529 $target = "https
://$host:8006$uri";
533 PVEDisableProxy => 'true',
534 PVEClientIP => $clientip,
537 $headers->{'cookie'} = PVE::APIServer::Formatter::create_auth_cookie($ticket, $self->{cookie_name}) if $ticket;
538 $headers->{'CSRFPreventionToken'} = $token if $token;
539 $headers->{'Accept-Encoding'} = 'gzip' if $reqstate->{accept_gzip};
543 if ($method eq 'POST' || $method eq 'PUT') {
544 $headers->{'Content-Type'} = 'application/x-www-form-urlencoded';
545 # use URI object to format application/x-www-form-urlencoded content.
546 my $url = URI->new('http:');
547 $url->query_form(%$params);
548 $content = $url->query;
549 if (defined($content)) {
550 $headers->{'Content-Length'} = length($content);
555 # TLS 1.x only, with certificate pinning
561 my (undef, undef, undef, $depth, undef, undef, $cert) = @_;
562 # we don't care about intermediate or root certificates
563 return 1 if $depth != 0;
564 # check server certificate against cache of pinned FPs
565 return $self->check_cert_fingerprint($cert);
569 # load and cache cert fingerprint if first time we proxy to this node
570 $self->initialize_cert_cache($node);
572 my $w; $w = http_request(
577 proxy => undef, # avoid use of $ENV{HTTP_PROXY}
578 keepalive => $keep_alive,
580 tls_ctx => AnyEvent::TLS->new(%{$tls}),
582 my ($body, $hdr) = @_;
586 if (!$reqstate->{hdl}) {
587 warn "proxy detected vanished client connection
\n";
592 my $code = delete $hdr->{Status};
593 my $msg = delete $hdr->{Reason};
595 delete $hdr->{HTTPVersion};
596 my $header = HTTP::Headers->new(%$hdr);
597 if (my $location = $header->header('Location')) {
598 $location =~ s|^http://localhost:85||;
599 $header->header(Location => $location);
601 my $resp = HTTP::Response->new($code, $msg, $header, $body);
602 # Note: disable compression, because body is already compressed
603 $self->response($reqstate, $resp, undef, 1);
611 # return arrays as \0 separated strings (like CGI.pm)
612 sub decode_urlencoded {
617 return $res if !$data;
619 foreach my $kv (split(/[\&\;]/, $data)) {
620 my ($k, $v) = split(/=/, $kv);
622 $k =~ s/%([0-9a-fA-F][0-9a-fA-F])/chr(hex($1))/eg;
624 $v =~ s/%([0-9a-fA-F][0-9a-fA-F])/chr(hex($1))/eg;
626 if (defined(my $old = $res->{$k})) {
627 $res->{$k} = "$old\0$v";
636 my ($r, $method) = @_;
640 if ($method eq 'PUT' || $method eq 'POST') {
641 $params = decode_urlencoded($r->content);
644 my $query_params = decode_urlencoded($r->url->query());
646 foreach my $k (keys %{$query_params}) {
647 $params->{$k} = $query_params->{$k};
650 return PVE::Tools::decode_utf8_parameters($params);
653 sub handle_api2_request {
654 my ($self, $reqstate, $auth, $method, $path, $upload_state) = @_;
657 my $r = $reqstate->{request};
659 my ($rel_uri, $format) = &$split_abs_uri($path, $self->{base_uri});
661 my $formatter = PVE::APIServer::Formatter::get_formatter($format, $method, $rel_uri);
663 if (!defined($formatter)) {
664 $self->error($reqstate, HTTP_NOT_IMPLEMENTED, "no such uri
$rel_uri, $format");
668 #print Dumper($upload_state) if $upload_state;
670 my $rpcenv = $self->{rpcenv};
675 $params = $upload_state->{params};
677 $params = extract_params($r, $method);
680 delete $params->{_dc}; # remove disable cache parameter
682 my $clientip = $reqstate->{peer_host};
684 $rpcenv->init_request();
686 my $res = $self->rest_handler($clientip, $method, $rel_uri, $auth, $params);
688 AnyEvent->now_update(); # in case somebody called sleep()
690 $rpcenv->set_user(undef); # clear after request
692 my $upgrade = $r->header('upgrade');
693 $upgrade = lc($upgrade) if $upgrade;
695 if (my $host = $res->{proxy}) {
697 if ($self->{trusted_env}) {
698 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy
not allowed
");
702 if ($host ne 'localhost' && $r->header('PVEDisableProxy')) {
703 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy
loop detected
");
707 $res->{proxy_params}->{tmpfilename} = $reqstate->{tmpfilename} if $upload_state;
709 $self->proxy_request($reqstate, $clientip, $host, $res->{proxynode}, $method,
710 $r->uri, $auth->{ticket}, $auth->{token}, $res->{proxy_params}, $res->{proxynode});
713 } elsif ($upgrade && ($method eq 'GET') && ($path =~ m|websocket$|)) {
714 die "unable to upgrade to protocol
'$upgrade'\n" if !$upgrade || ($upgrade ne 'websocket');
715 my $wsver = $r->header('sec-websocket-version');
716 die "unsupported websocket-version
'$wsver'\n" if !$wsver || ($wsver ne '13');
717 my $wsproto_str = $r->header('sec-websocket-protocol');
718 die "missing websocket-protocol header
" if !$wsproto_str;
720 foreach my $p (PVE::Tools::split_list($wsproto_str)) {
721 $wsproto = $p if !$wsproto && $p eq 'base64';
722 $wsproto = $p if $p eq 'binary';
724 die "unsupported websocket-protocol protocol
'$wsproto_str'\n" if !$wsproto;
725 my $wskey = $r->header('sec-websocket-key');
726 die "missing websocket-key
\n" if !$wskey;
727 # Note: Digest::SHA::sha1_base64 has wrong padding
728 my $wsaccept = Digest::SHA::sha1_base64("${wskey
}258EAFA5-E914-47DA-95CA-C5AB0DC85B11
") . "=";
729 if ($res->{status} == HTTP_OK) {
730 $self->websocket_proxy($reqstate, $wsaccept, $wsproto, $res->{data});
736 if ($res->{status} == HTTP_UNAUTHORIZED) {
737 # always delay unauthorized calls by 3 seconds
738 $delay = 3 - tv_interval($reqstate->{starttime});
739 $delay = 0 if $delay < 0;
742 my $csrfgen_func = $self->can('generate_csrf_prevention_token');
743 my ($raw, $ct, $nocomp) = &$formatter($res, $res->{data}, $params, $path, $auth, $csrfgen_func);
746 if (ref($raw) && (ref($raw) eq 'HTTP::Response')) {
749 $resp = HTTP::Response->new($res->{status}, $res->{message});
750 $resp->header("Content-Type
" => $ct);
751 $resp->content($raw);
753 $self->response($reqstate, $resp, undef, $nocomp, $delay);
756 $self->error($reqstate, 501, $err);
760 sub handle_spice_proxy_request {
761 my ($self, $reqstate, $connect_str, $vmid, $node, $spiceport) = @_;
765 die "Port
$spiceport is not allowed
" if ($spiceport < 61000 || $spiceport > 61099);
767 my $rpcenv = $self->{rpcenv};
768 $rpcenv->init_request();
770 my $clientip = $reqstate->{peer_host};
771 my $r = $reqstate->{request};
775 if ($node ne 'localhost' && PVE::INotify::nodename() !~ m/^$node$/i) {
776 $remip = $self->remote_node_ip($node);
777 print "REMOTE CONNECT
$vmid, $remip, $connect_str\n" if $self->{debug};
779 print "$$: CONNECT
$vmid, $node, $spiceport\n" if $self->{debug};
782 if ($remip && $r->header('PVEDisableProxy')) {
783 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy
loop detected
");
787 $reqstate->{hdl}->timeout(0);
788 $reqstate->{hdl}->wbuf_max(64*10*1024);
790 my $remhost = $remip ? $remip : "localhost
";
791 my $remport = $remip ? 3128 : $spiceport;
793 tcp_connect $remhost, $remport, sub {
795 or die "connect to
'$remhost:$remport' failed
: $!";
797 print "$$: CONNECTed to
'$remhost:$remport'\n" if $self->{debug};
798 $reqstate->{proxyhdl} = AnyEvent::Handle->new(
801 wbuf_max => 64*10*1024,
806 $self->log_aborted_request($reqstate);
807 $self->client_do_disconnect($reqstate);
809 if (my $err = $@) { syslog('err', $err); }
812 my ($hdl, $fatal, $message) = @_;
814 $self->log_aborted_request($reqstate, $message);
815 $self->client_do_disconnect($reqstate);
817 if (my $err = $@) { syslog('err', "$err"); }
821 my $proxyhdlreader = sub {
824 my $len = length($hdl->{rbuf});
825 my $data = substr($hdl->{rbuf}, 0, $len, '');
827 #print "READ1
$len\n";
828 $reqstate->{hdl}->push_write($data) if $reqstate->{hdl};
831 my $hdlreader = sub {
834 my $len = length($hdl->{rbuf});
835 my $data = substr($hdl->{rbuf}, 0, $len, '');
837 #print "READ0
$len\n";
838 $reqstate->{proxyhdl}->push_write($data) if $reqstate->{proxyhdl};
841 my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.0';
843 my $startproxy = sub {
844 $reqstate->{proxyhdl}->timeout(0);
845 $reqstate->{proxyhdl}->on_read($proxyhdlreader);
846 $reqstate->{hdl}->on_read($hdlreader);
848 # todo: use stop_read/start_read if write buffer grows to much
850 my $res = "$proto 200 OK
\015\012"; # hope this is the right answer?
851 $reqstate->{hdl}->push_write($res);
854 $reqstate->{log}->{code} = 200;
855 $self->log_request($reqstate);
859 my $header = "CONNECT
${connect_str
} $proto\015\012" .
860 "Host
: ${connect_str
}\015\012" .
861 "Proxy-Connection
: keep-alive
\015\012" .
862 "User-Agent
: spiceproxy
\015\012" .
863 "PVEDisableProxy
: true
\015\012" .
864 "PVEClientIP
: $clientip\015\012" .
867 $reqstate->{proxyhdl}->push_write($header);
868 $reqstate->{proxyhdl}->push_read(line => sub {
869 my ($hdl, $line) = @_;
871 if ($line =~ m!^$proto 200 OK$!) {
874 $reqstate->{hdl}->push_write($line);
875 $self->client_do_disconnect($reqstate);
886 $self->log_aborted_request($reqstate, $err);
887 $self->client_do_disconnect($reqstate);
892 my ($self, $reqstate, $auth, $method, $path) = @_;
894 my $base_uri = $self->{base_uri};
897 my $r = $reqstate->{request};
899 # disable timeout on handle (we already have all data we need)
900 # we re-enable timeout in response()
901 $reqstate->{hdl}->timeout(0);
903 if ($path =~ m/^\Q$base_uri\E/) {
904 $self->handle_api2_request($reqstate, $auth, $method, $path);
908 if ($self->{pages} && ($method eq 'GET') && (my $handler = $self->{pages}->{$path})) {
909 if (ref($handler) eq 'CODE') {
910 my $params = decode_urlencoded($r->url->query());
911 my ($resp, $userid) = &$handler($self, $reqstate->{request}, $params);
912 $self->response($reqstate, $resp);
913 } elsif (ref($handler) eq 'HASH') {
914 if (my $filename = $handler->{file}) {
915 my $fh = IO::File->new($filename) ||
916 die "unable to
open file
'$filename' - $!\n";
917 send_file_start($self, $reqstate, $filename);
919 die "internal error
- no handler
";
922 die "internal error
- no handler
";
927 if ($self->{dirs} && ($method eq 'GET')) {
928 # we only allow simple names
929 if ($path =~ m!^(/\S+/)([a-zA-Z0-9\-\_\.]+)$!) {
930 my ($subdir, $file) = ($1, $2);
931 if (my $dir = $self->{dirs}->{$subdir}) {
932 my $filename = "$dir$file";
933 my $fh = IO::File->new($filename) ||
934 die "unable to
open file
'$filename' - $!\n";
935 send_file_start($self, $reqstate, $filename);
941 die "no such file
'$path'";
944 $self->error($reqstate, 501, $err);
948 sub file_upload_multipart {
949 my ($self, $reqstate, $auth, $method, $path, $rstate) = @_;
952 my $boundary = $rstate->{boundary};
953 my $hdl = $reqstate->{hdl};
955 my $startlen = length($hdl->{rbuf});
957 if ($rstate->{phase} == 0) { # skip everything until start
958 if ($hdl->{rbuf} =~ s/^.*?--\Q$boundary\E \015?\012
959 ((?:[^\015]+\015\012)* ) \015?\012//xs) {
961 my ($ct, $disp, $name, $filename);
962 foreach my $line (split(/\015?\012/, $header)) {
963 # assume we have single line headers
964 if ($line =~ m/^Content-Type\s*:\s*(.*)/i) {
965 $ct = parse_content_type($1);
966 } elsif ($line =~ m/^Content-Disposition\s*:\s*(.*)/i) {
967 ($disp, $name, $filename) = parse_content_disposition($1);
971 if (!($disp && $disp eq 'form-data' && $name)) {
972 syslog('err', "wrong content disposition
in multipart
- abort upload
");
973 $rstate->{phase} = -1;
976 $rstate->{fieldname} = $name;
979 if ($name eq 'filename') {
980 # found file upload data
981 $rstate->{phase} = 1;
982 $rstate->{filename} = $filename;
984 syslog('err', "wrong field name
for file upload
- abort upload
");
985 $rstate->{phase} = -1;
988 # found form data for field $name
989 $rstate->{phase} = 2;
993 my $len = length($hdl->{rbuf});
994 substr($hdl->{rbuf}, 0, $len - $rstate->{maxheader}, '')
995 if $len > $rstate->{maxheader}; # skip garbage
997 } elsif ($rstate->{phase} == 1) { # inside file - dump until end marker
998 if ($hdl->{rbuf} =~ s/^(.*?)\015?\012(--\Q$boundary\E(--)? \015?\012(.*))$/$2/xs) {
999 my ($rest, $eof) = ($1, $3);
1000 my $len = length($rest);
1001 die "write to temporary file failed
- $!"
1002 if syswrite($rstate->{outfh}, $rest) != $len;
1003 $rstate->{ctx}->add($rest);
1004 $rstate->{params}->{filename} = $rstate->{filename};
1005 $rstate->{md5sum} = $rstate->{ctx}->hexdigest;
1006 $rstate->{bytes} += $len;
1007 $rstate->{phase} = $eof ? 100 : 0;
1009 my $len = length($hdl->{rbuf});
1010 my $wlen = $len - $rstate->{boundlen};
1012 my $data = substr($hdl->{rbuf}, 0, $wlen, '');
1013 die "write to temporary file failed
- $!"
1014 if syswrite($rstate->{outfh}, $data) != $wlen;
1015 $rstate->{bytes} += $wlen;
1016 $rstate->{ctx}->add($data);
1019 } elsif ($rstate->{phase} == 2) { # inside normal field
1021 if ($hdl->{rbuf} =~ s/^(.*?)\015?\012(--\Q$boundary\E(--)? \015?\012(.*))$/$2/xs) {
1022 my ($rest, $eof) = ($1, $3);
1023 my $len = length($rest);
1024 $rstate->{post_size} += $len;
1025 if ($rstate->{post_size} < $limit_max_post) {
1026 $rstate->{params}->{$rstate->{fieldname}} = $rest;
1027 $rstate->{phase} = $eof ? 100 : 0;
1029 syslog('err', "form data to large
- abort upload
");
1030 $rstate->{phase} = -1; # skip
1034 my $len = length($hdl->{rbuf});
1035 substr($hdl->{rbuf}, 0, $len, ''); # empty rbuf
1038 $rstate->{read} += ($startlen - length($hdl->{rbuf}));
1040 if (!$rstate->{done} && ($rstate->{read} + length($hdl->{rbuf})) >= $rstate->{size}) {
1041 $rstate->{done} = 1; # make sure we dont get called twice
1042 if ($rstate->{phase} < 0 || !$rstate->{md5sum}) {
1043 die "upload failed
\n";
1045 my $elapsed = tv_interval($rstate->{starttime});
1047 my $rate = int($rstate->{bytes}/($elapsed*1024*1024));
1048 syslog('info', "multipart upload complete
" .
1049 "(size
: %d time: %ds rate
: %.2fMiB
/s md5sum
: $rstate->{md5sum
})",
1050 $rstate->{bytes}, $elapsed, $rate);
1051 $self->handle_api2_request($reqstate, $auth, $method, $path, $rstate);
1056 syslog('err', $err);
1057 $self->error($reqstate, 501, $err);
1061 sub parse_content_type {
1064 my ($ct, @params) = split(/\s*[;,]\s*/o, $ctype);
1066 foreach my $v (@params) {
1067 if ($v =~ m/^\s*boundary\s*=\s*(\S+?)\s*$/o) {
1068 return wantarray ? ($ct, $1) : $ct;
1072 return wantarray ? ($ct) : $ct;
1075 sub parse_content_disposition {
1078 my ($disp, @params) = split(/\s*[;,]\s*/o, $line);
1082 foreach my $v (@params) {
1083 if ($v =~ m/^\s*name\s*=\s*(\S+?)\s*$/o) {
1085 $name =~ s/^"(.*)"$/$1/;
1086 } elsif ($v =~ m/^\s*filename\s*=\s*(.+?)\s*$/o) {
1088 $filename =~ s/^"(.*)"$/$1/;
1092 return wantarray ? ($disp, $name, $filename) : $disp;
1095 my $tmpfile_seq_no = 0;
1097 sub get_upload_filename {
1098 # choose unpredictable tmpfile name
1101 return "/var/tmp
/pveupload-
" . Digest::MD5::md5_hex($tmpfile_seq_no . time() . $$);
1104 sub unshift_read_header {
1105 my ($self, $reqstate, $state) = @_;
1107 $state = { size => 0, count => 0 } if !$state;
1109 $reqstate->{hdl}->unshift_read(line => sub {
1110 my ($hdl, $line) = @_;
1113 # print "$$: got header
: $line\n" if $self->{debug};
1115 die "to many http header lines
\n" if ++$state->{count} >= $limit_max_headers;
1116 die "http header too large
\n" if ($state->{size} += length($line)) >= $limit_max_header_size;
1118 my $r = $reqstate->{request};
1121 my $path = uri_unescape($r->uri->path());
1122 my $method = $r->method();
1124 $r->push_header($state->{key}, $state->{val})
1127 if (!$known_methods->{$method}) {
1128 my $resp = HTTP::Response->new(HTTP_NOT_IMPLEMENTED, "method '$method' not available
");
1129 $self->response($reqstate, $resp);
1133 my $conn = $r->header('Connection');
1134 my $accept_enc = $r->header('Accept-Encoding');
1135 $reqstate->{accept_gzip} = ($accept_enc && $accept_enc =~ m/gzip/) ? 1 : 0;
1138 $reqstate->{keep_alive} = 0 if $conn =~ m/close/oi;
1140 if ($reqstate->{proto}->{ver} < 1001) {
1141 $reqstate->{keep_alive} = 0;
1145 my $te = $r->header('Transfer-Encoding');
1146 if ($te && lc($te) eq 'chunked') {
1147 # Handle chunked transfer encoding
1148 $self->error($reqstate, 501, "chunked transfer encoding
not supported
");
1151 $self->error($reqstate, 501, "Unknown transfer encoding
'$te'");
1155 my $pveclientip = $r->header('PVEClientIP');
1156 my $base_uri = $self->{base_uri};
1158 # fixme: how can we make PVEClientIP header trusted?
1159 if ($self->{trusted_env} && $pveclientip) {
1160 $reqstate->{peer_host} = $pveclientip;
1162 $r->header('PVEClientIP', $reqstate->{peer_host});
1165 my $len = $r->header('Content-Length');
1167 # header processing complete - authenticate now
1170 if ($self->{spiceproxy}) {
1171 my $connect_str = $r->header('Host');
1172 my ($vmid, $node, $port) = $self->verify_spice_connect_url($connect_str);
1173 if (!(defined($vmid) && $node && $port)) {
1174 $self->error($reqstate, HTTP_UNAUTHORIZED, "invalid ticket
");
1177 $self->handle_spice_proxy_request($reqstate, $connect_str, $vmid, $node, $port);
1179 } elsif ($path =~ m/^\Q$base_uri\E/) {
1180 my $token = $r->header('CSRFPreventionToken');
1181 my $cookie = $r->header('Cookie');
1182 my $ticket = PVE::APIServer::Formatter::extract_auth_cookie($cookie, $self->{cookie_name});
1184 my ($rel_uri, $format) = &$split_abs_uri($path, $self->{base_uri});
1186 $self->error($reqstate, HTTP_NOT_IMPLEMENTED, "no such uri
");
1190 my $rpcenv = $self->{rpcenv};
1191 # set environment variables
1192 $rpcenv->set_user(undef);
1193 $rpcenv->set_language('C');
1194 $rpcenv->set_client_ip($reqstate->{peer_host});
1197 $auth = $self->auth_handler($method, $rel_uri, $ticket, $token);
1200 # always delay unauthorized calls by 3 seconds
1202 if (my $formatter = PVE::APIServer::Formatter::get_login_formatter($format)) {
1203 my ($raw, $ct, $nocomp) = &$formatter($path, $auth);
1205 if (ref($raw) && (ref($raw) eq 'HTTP::Response')) {
1208 $resp = HTTP::Response->new(HTTP_UNAUTHORIZED, "Login Required
");
1209 $resp->header("Content-Type
" => $ct);
1210 $resp->content($raw);
1212 $self->response($reqstate, $resp, undef, $nocomp, 3);
1214 my $resp = HTTP::Response->new(HTTP_UNAUTHORIZED, $err);
1215 $self->response($reqstate, $resp, undef, 0, $delay);
1221 $reqstate->{log}->{userid} = $auth->{userid};
1225 if (!($method eq 'PUT' || $method eq 'POST')) {
1226 $self->error($reqstate, 501, "Unexpected content
for method '$method'");
1230 my $ctype = $r->header('Content-Type');
1231 my ($ct, $boundary) = parse_content_type($ctype) if $ctype;
1233 if ($auth->{isUpload} && !$self->{trusted_env}) {
1234 die "upload
'Content-Type '$ctype' not implemented\n"
1235 if !($boundary && $ct && ($ct eq 'multipart
/form-data
'));
1237 die "upload without content length header not supported" if !$len;
1239 die "upload without content length header not supported" if !$len;
1241 print "start upload $path $ct $boundary\n" if $self->{debug};
1243 my $tmpfilename = get_upload_filename();
1244 my $outfh = IO::File->new($tmpfilename, O_RDWR|O_CREAT|O_EXCL, 0600) ||
1245 die "unable to create temporary upload file '$tmpfilename'";
1247 $reqstate->{keep_alive} = 0;
1249 my $boundlen = length($boundary) + 8; # \015?\012--$boundary--\015?\012
1253 boundary => $boundary,
1254 ctx => Digest::MD5->new,
1255 boundlen => $boundlen,
1256 maxheader => 2048 + $boundlen, # should be large enough
1257 params => decode_urlencoded($r->url->query()),
1261 starttime => [gettimeofday],
1264 $reqstate->{tmpfilename} = $tmpfilename;
1265 $reqstate->{hdl}->on_read(sub { $self->file_upload_multipart($reqstate, $auth, $method, $path, $state); });
1269 if ($len > $limit_max_post) {
1270 $self->error($reqstate, 501, "for data too large");
1274 if (!$ct || $ct eq 'application
/x-www-form-urlencoded
') {
1275 $reqstate->{hdl}->unshift_read(chunk => $len, sub {
1276 my ($hdl, $data) = @_;
1278 $self->handle_request($reqstate, $auth, $method, $path);
1281 $self->error($reqstate, 506, "upload 'Content-Type
'$ctype' not implemented
");
1284 $self->handle_request($reqstate, $auth, $method, $path);
1286 } elsif ($line =~ /^([^:\s]+)\s*:\s*(.*)/) {
1287 $r->push_header($state->{key}, $state->{val}) if $state->{key};
1288 ($state->{key}, $state->{val}) = ($1, $2);
1289 $self->unshift_read_header($reqstate, $state);
1290 } elsif ($line =~ /^\s+(.*)/) {
1291 $state->{val} .= " $1";
1292 $self->unshift_read_header($reqstate, $state);
1294 $self->error($reqstate, 506, "unable to parse request header
");
1301 sub push_request_header {
1302 my ($self, $reqstate) = @_;
1305 $reqstate->{hdl}->push_read(line => sub {
1306 my ($hdl, $line) = @_;
1309 # print "got request header
: $line\n" if $self->{debug};
1311 $reqstate->{keep_alive}--;
1313 if ($line =~ /(\S+)\040(\S+)\040HTTP\/(\d+)\.(\d+)/o) {
1314 my ($method, $url, $maj, $min) = ($1, $2, $3, $4);
1317 $self->error($reqstate, 506, "http protocol version
$maj.$min not supported
");
1321 $self->{request_count}++; # only count valid request headers
1322 if ($self->{request_count} >= $self->{max_requests}) {
1323 $self->{end_loop} = 1;
1325 $reqstate->{log} = { requestline => $line };
1326 $reqstate->{proto}->{str} = "HTTP
/$maj.$min";
1327 $reqstate->{proto}->{maj} = $maj;
1328 $reqstate->{proto}->{min} = $min;
1329 $reqstate->{proto}->{ver} = $maj*1000+$min;
1330 $reqstate->{request} = HTTP::Request->new($method, $url);
1331 $reqstate->{starttime} = [gettimeofday],
1333 $self->unshift_read_header($reqstate);
1334 } elsif ($line eq '') {
1335 # ignore empty lines before requests (browser bugs?)
1336 $self->push_request_header($reqstate);
1338 $self->error($reqstate, 400, 'bad request');
1352 return if $self->{end_loop};
1354 # we need to m make sure that only one process calls accept
1355 while (!flock($self->{lockfh}, Fcntl::LOCK_EX())) {
1356 next if $! == EINTR;
1357 die "could
not get
lock on file
'$self->{lockfile}' - $!\n";
1363 while (!$self->{end_loop} &&
1364 !defined($clientfh = $self->{socket}->accept()) &&
1367 if ($self->{end_loop}) {
1370 $again = ($! == EAGAIN || $! == WSAEWOULDBLOCK);
1371 if (!defined($clientfh)) {
1372 $errmsg = "failed to
accept connection
: $!\n";
1378 flock($self->{lockfh}, Fcntl::LOCK_UN());
1380 if (!defined($clientfh)) {
1382 die $errmsg if $errmsg;
1385 fh_nonblocking $clientfh, 1;
1387 $self->{conn_count}++;
1395 $self->{end_loop} = 1;
1397 undef $self->{socket_watch};
1399 $0 = "$0 (shutdown)" if $0 !~ m/\(shutdown\)$/;
1401 if ($self->{conn_count} <= 0) {
1402 $self->{end_cond}->send(1);
1406 # fork and exit, so that parent starts a new worker
1411 # else we need to wait until all open connections gets closed
1412 my $w; $w = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1414 # todo: test for active connections instead (we can abort idle connections)
1415 if ($self->{conn_count} <= 0) {
1417 $self->{end_cond}->send(1);
1425 sub check_host_access {
1426 my ($self, $clientip) = @_;
1428 my $cip = Net::IP->new($clientip);
1430 my $match_allow = 0;
1433 if ($self->{allow_from}) {
1434 foreach my $t (@{$self->{allow_from}}) {
1435 if ($t->overlaps($cip)) {
1442 if ($self->{deny_from}) {
1443 foreach my $t (@{$self->{deny_from}}) {
1444 if ($t->overlaps($cip)) {
1451 if ($match_allow == $match_deny) {
1452 # match both allow and deny, or no match
1453 return $self->{policy} && $self->{policy} eq 'allow' ? 1 : 0;
1456 return $match_allow;
1459 sub accept_connections {
1464 while (my $clientfh = $self->accept()) {
1466 my $reqstate = { keep_alive => $self->{keep_alive} };
1468 # stop keep-alive when there are many open connections
1469 if ($self->{conn_count} >= $self->{max_conn_soft_limit}) {
1470 $reqstate->{keep_alive} = 0;
1473 if (my $sin = getpeername($clientfh)) {
1474 my ($pfamily, $pport, $phost) = PVE::Tools::unpack_sockaddr_in46($sin);
1475 ($reqstate->{peer_port}, $reqstate->{peer_host}) = ($pport, Socket::inet_ntop($pfamily, $phost));
1478 if (!$self->{trusted_env} && !$self->check_host_access($reqstate->{peer_host})) {
1479 print "$$: ABORT request from
$reqstate->{peer_host
} - access denied
\n" if $self->{debug};
1480 $reqstate->{log}->{code} = 403;
1481 $self->log_request($reqstate);
1485 $reqstate->{hdl} = AnyEvent::Handle->new(
1487 rbuf_max => 64*1024,
1488 timeout => $self->{timeout},
1489 linger => 0, # avoid problems with ssh - really needed ?
1493 $self->log_aborted_request($reqstate);
1494 $self->client_do_disconnect($reqstate);
1496 if (my $err = $@) { syslog('err', $err); }
1499 my ($hdl, $fatal, $message) = @_;
1501 $self->log_aborted_request($reqstate, $message);
1502 $self->client_do_disconnect($reqstate);
1504 if (my $err = $@) { syslog('err', "$err"); }
1506 ($self->{tls_ctx} ? (tls => "accept", tls_ctx => $self->{tls_ctx}) : ()));
1508 print "$$: ACCEPT FH
" . $clientfh->fileno() . " CONN
$self->{conn_count
}\n" if $self->{debug};
1510 $self->push_request_header($reqstate);
1515 syslog('err', $err);
1516 $self->{end_loop} = 1;
1519 $self->wait_end_loop() if $self->{end_loop};
1522 # Note: We can't open log file in non-blocking mode and use AnyEvent::Handle,
1523 # because we write from multiple processes, and that would arbitrarily mix output
1525 sub open_access_log {
1526 my ($self, $filename) = @_;
1528 my $old_mask = umask(0137);;
1529 my $logfh = IO::File->new($filename, ">>") ||
1530 die "unable to
open log file
'$filename' - $!\n";
1533 $logfh->autoflush(1);
1535 $self->{logfh} = $logfh;
1539 my ($self, $data) = @_;
1541 return if !defined($self->{logfh}) || !$data;
1543 my $res = $self->{logfh}->print($data);
1546 delete $self->{logfh};
1547 syslog('err', "error writing access
log");
1548 $self->{end_loop} = 1; # terminate asap
1552 sub atfork_handler {
1556 # something else do to ?
1557 close($self->{socket});
1565 $self->{end_cond}->recv;
1569 my ($this, %args) = @_;
1571 my $class = ref($this) || $this;
1573 foreach my $req (qw(base_handler_class socket lockfh lockfile)) {
1574 die "misssing required argument '$req'" if !defined($args{$req});
1577 my $self = bless { %args }, $class;
1579 $self->{cookie_name
} //= 'PVEAuthCookie';
1580 $self->{base_uri
} //= "/api2";
1581 $self->{dirs
} //= {};
1583 my $base = '/usr/share/libpve-http-server-perl';
1584 add_dirs
($self->{dirs
}, '/css/' => "$base/css/");
1585 add_dirs
($self->{dirs
}, '/js/' => "$base/js/");
1586 add_dirs
($self->{dirs
}, '/fonts/' => "$base/fonts/");
1589 PVE
::INotify
::inotify_init
();
1591 fh_nonblocking
($self->{socket}, 1);
1593 $self->{end_loop
} = 0;
1594 $self->{conn_count
} = 0;
1595 $self->{request_count
} = 0;
1596 $self->{timeout
} = 5 if !$self->{timeout
};
1597 $self->{keep_alive
} = 0 if !defined($self->{keep_alive
});
1598 $self->{max_conn
} = 800 if !$self->{max_conn
};
1599 $self->{max_requests
} = 8000 if !$self->{max_requests
};
1601 $self->{policy
} = 'allow' if !$self->{policy
};
1603 $self->{end_cond
} = AnyEvent-
>condvar;
1606 $self->{tls_ctx
} = AnyEvent
::TLS-
>new(%{$self->{ssl
}});
1607 # TODO : openssl >= 1.0.2 supports SSL_CTX_set_ecdh_auto to select a curve depending on
1608 # server and client availability from SSL_CTX_set1_curves.
1609 # that way other curves like 25519 can be used.
1610 # openssl 1.0.1 can only support 1 curve at a time.
1611 my $curve = Net
::SSLeay
::OBJ_txt2nid
('prime256v1');
1612 my $ecdh = Net
::SSLeay
::EC_KEY_new_by_curve_name
($curve);
1613 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
);
1614 Net
::SSLeay
::CTX_set_tmp_ecdh
($self->{tls_ctx
}->{ctx
}, $ecdh);
1615 Net
::SSLeay
::EC_KEY_free
($ecdh);
1618 if ($self->{spiceproxy
}) {
1619 $known_methods = { CONNECT
=> 1 };
1622 $self->open_access_log($self->{logfile
}) if $self->{logfile
};
1624 $self->{max_conn_soft_limit
} = $self->{max_conn
} > 100 ?
$self->{max_conn
} - 20 : $self->{max_conn
};
1626 $self->{socket_watch
} = AnyEvent-
>io(fh
=> $self->{socket}, poll
=> 'r', cb
=> sub {
1628 if ($self->{conn_count
} >= $self->{max_conn
}) {
1629 my $w; $w = AnyEvent-
>timer (after
=> 1, interval
=> 1, cb
=> sub {
1630 if ($self->{conn_count
} < $self->{max_conn
}) {
1632 $self->accept_connections();
1636 $self->accept_connections();
1642 $self->{term_watch
} = AnyEvent-
>signal(signal
=> "TERM", cb
=> sub {
1643 undef $self->{term_watch
};
1644 $self->wait_end_loop();
1647 $self->{quit_watch
} = AnyEvent-
>signal(signal
=> "QUIT", cb
=> sub {
1648 undef $self->{quit_watch
};
1649 $self->wait_end_loop();
1652 $self->{inotify_poll
} = AnyEvent-
>timer(after
=> 5, interval
=> 5, cb
=> sub {
1653 PVE
::INotify
::poll
(); # read inotify events
1659 # static helper to add directory including all subdirs
1660 # This can be used to setup $self->{dirs}
1662 my ($result_hash, $alias, $subdir) = @_;
1664 $result_hash->{$alias} = $subdir;
1667 my $dir = $File::Find
::dir
;
1668 if ($dir =~m!^$subdir(.*)$!) {
1669 my $name = "$alias$1/";
1670 $result_hash->{$name} = "$dir/";
1674 find
({wanted
=> $wanted, follow
=> 0, no_chdir
=> 1}, $subdir);
1677 # abstract functions - subclass should overwrite/implement them
1679 sub verify_spice_connect_url
{
1680 my ($self, $connect_str) = @_;
1684 #return ($vmid, $node, $port);
1687 # formatters can call this when the generate a new page
1688 sub generate_csrf_prevention_token
{
1689 my ($username) = @_;
1691 return undef; # do nothing by default
1695 my ($self, $method, $rel_uri, $ticket, $token) = @_;
1700 # ticket => $ticket,
1702 # userid => $username,
1704 # isUpload => $isUpload,
1705 # cookie_name => $self->{cookie_name},
1710 my ($self, $clientip, $method, $rel_uri, $auth, $params) = @_;
1713 status
=> HTTP_NOT_IMPLEMENTED
,
1714 message
=> "Method '$method $rel_uri' not implemented",
1718 sub check_cert_fingerprint
{
1719 my ($self, $cert) = @_;
1724 sub initialize_cert_cache
{
1725 my ($self, $node) = @_;
1730 sub remote_node_ip
{
1731 my ($self, $node) = @_;