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 = 64*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 json => { ct => 'application/json' },
278 png => { ct => 'image/png' , nocomp => 1 },
279 ico => { ct => 'image/x-icon', nocomp => 1},
280 gif => { ct => 'image/gif', nocomp => 1},
281 svg => { ct => 'image/svg+xml' },
282 jar => { ct => 'application/java-archive', nocomp => 1},
283 woff => { ct => 'application/font-woff', nocomp => 1},
284 woff2 => { ct => 'application/font-woff2', nocomp => 1},
285 ttf => { ct => 'application/font-snft', nocomp => 1},
286 pdf => { ct => 'application/pdf', nocomp => 1},
287 epub => { ct => 'application/epub+zip', nocomp => 1},
288 mp3 => { ct => 'audio/mpeg', nocomp => 1},
289 oga => { ct => 'audio/ogg', nocomp => 1},
290 tgz => { ct => 'application/x-compressed-tar', nocomp => 1},
293 sub send_file_start {
294 my ($self, $reqstate, $filename) = @_;
297 # print "SEND FILE
$filename\n";
298 # Note: aio_load() this is not really async unless we use IO::AIO!
301 my $r = $reqstate->{request};
303 my $fh = IO::File->new($filename, '<') ||
305 my $stat = File::stat::stat($fh) ||
308 my $mtime = $stat->mtime;
310 if (my $ifmod = $r->header('if-modified-since')) {
311 my $iftime = HTTP::Date::str2time($ifmod);
312 if ($mtime <= $iftime) {
313 my $resp = HTTP::Response->new(304, "NOT MODIFIED
");
314 $self->response($reqstate, $resp, $mtime);
320 my $len = sysread($fh, $data, $stat->size);
321 die "got short file
\n" if !defined($len) || $len != $stat->size;
323 my ($ext) = $filename =~ m/\.([^.]*)$/;
324 my $ext_info = $file_extension_info->{$ext};
326 die "unable to detect content type
" if !$ext_info;
328 my $header = HTTP::Headers->new(Content_Type => $ext_info->{ct});
329 my $resp = HTTP::Response->new(200, "OK
", $header, $data);
330 $self->response($reqstate, $resp, $mtime, $ext_info->{nocomp});
333 $self->error($reqstate, 501, $err);
340 sub websocket_proxy {
341 my ($self, $reqstate, $wsaccept, $wsproto, $param) = @_;
347 my $max_payload_size = 65536;
350 if ($wsproto eq 'binary') {
352 } elsif ($wsproto eq 'base64') {
355 die "websocket_proxy
: unsupported protocol
'$wsproto'\n";
358 if ($param->{port}) {
359 $remhost = 'localhost';
360 $remport = $param->{port};
361 } elsif ($param->{socket}) {
363 $remport = $param->{socket};
365 die "websocket_proxy
: missing port
or socket\n";
368 tcp_connect $remhost, $remport, sub {
370 or die "connect to
'$remhost:$remport' failed
: $!";
372 print "$$: CONNECTed to
'$remhost:$remport'\n" if $self->{debug};
374 $reqstate->{proxyhdl} = AnyEvent::Handle->new(
377 wbuf_max => 64*10*1024,
382 $self->log_aborted_request($reqstate);
383 $self->client_do_disconnect($reqstate);
385 if (my $err = $@) { syslog('err', $err); }
388 my ($hdl, $fatal, $message) = @_;
390 $self->log_aborted_request($reqstate, $message);
391 $self->client_do_disconnect($reqstate);
393 if (my $err = $@) { syslog('err', "$err"); }
396 my $proxyhdlreader = sub {
399 my $len = length($hdl->{rbuf});
400 my $data = substr($hdl->{rbuf}, 0, $len, '');
406 $string = "\x82"; # binary frame
409 $string = "\x81"; # text frame
410 $payload = encode_base64($data, '');
413 my $payload_len = length($payload);
414 if ($payload_len <= 125) {
415 $string .= pack 'C', $payload_len;
416 } elsif ($payload_len <= 0xffff) {
417 $string .= pack 'C', 126;
418 $string .= pack 'n', $payload_len;
420 $string .= pack 'C', 127;
421 $string .= pack 'Q>', $payload_len;
425 $reqstate->{hdl}->push_write($string) if $reqstate->{hdl};
428 my $hdlreader = sub {
431 my $len = length($hdl->{rbuf});
434 my $hdr = unpack('C', substr($hdl->{rbuf}, 0, 1));
435 my $opcode = $hdr & 0b00001111;
436 my $fin = $hdr & 0b10000000;
438 die "received fragmented websocket frame
\n" if !$fin;
440 my $rsv = $hdr & 0b01110000;
441 die "received websocket frame with RSV flags
\n" if $rsv;
443 my $payload_len = unpack 'C', substr($hdl->{rbuf}, 1, 1);
445 my $masked = $payload_len & 0b10000000;
446 die "received unmasked websocket frame from client
\n" if !$masked;
449 $payload_len = $payload_len & 0b01111111;
450 if ($payload_len == 126) {
452 $payload_len = unpack('n', substr($hdl->{rbuf}, $offset, 2));
454 } elsif ($payload_len == 127) {
456 $payload_len = unpack('Q>', substr($hdl->{rbuf}, $offset, 8));
460 die "received too large websocket frame
(len
= $payload_len)\n"
461 if ($payload_len > $max_payload_size) || ($payload_len < 0);
463 return if $len < ($offset + 4 + $payload_len);
465 my $data = substr($hdl->{rbuf}, 0, $len, ''); # now consume data
467 my @mask = (unpack('C', substr($data, $offset+0, 1)),
468 unpack('C', substr($data, $offset+1, 1)),
469 unpack('C', substr($data, $offset+2, 1)),
470 unpack('C', substr($data, $offset+3, 1)));
474 my $payload = substr($data, $offset, $payload_len);
476 for (my $i = 0; $i < $payload_len; $i++) {
477 my $d = unpack('C', substr($payload, $i, 1));
478 my $n = $d ^ $mask[$i % 4];
479 substr($payload, $i, 1, pack('C', $n));
482 $payload = decode_base64($payload) if !$binary;
484 if ($opcode == 1 || $opcode == 2) {
485 $reqstate->{proxyhdl}->push_write($payload) if $reqstate->{proxyhdl};
486 } elsif ($opcode == 8) {
487 my $statuscode = unpack ("n
", $payload);
488 print "websocket received
close. status code
: '$statuscode'\n" if $self->{debug};
489 if ($reqstate->{proxyhdl}) {
490 $reqstate->{proxyhdl}->push_shutdown();
492 $hdl->push_shutdown();
494 die "received unhandled websocket opcode
$opcode\n";
498 my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.1';
500 $reqstate->{proxyhdl}->timeout(0);
501 $reqstate->{proxyhdl}->on_read($proxyhdlreader);
502 $reqstate->{hdl}->on_read($hdlreader);
504 # todo: use stop_read/start_read if write buffer grows to much
506 my $res = "$proto 101 Switching Protocols
\015\012" .
507 "Upgrade
: websocket
\015\012" .
508 "Connection
: upgrade
\015\012" .
509 "Sec-WebSocket-Accept
: $wsaccept\015\012" .
510 "Sec-WebSocket-Protocol
: $wsproto\015\012" .
513 print $res if $self->{debug};
515 $reqstate->{hdl}->push_write($res);
518 $reqstate->{log}->{code} = 101;
519 $self->log_request($reqstate);
525 $self->log_aborted_request($reqstate, $err);
526 $self->client_do_disconnect($reqstate);
531 my ($self, $reqstate, $clientip, $host, $node, $method, $uri, $ticket, $token, $params) = @_;
536 if ($host eq 'localhost') {
537 $target = "http
://$host:85$uri";
538 # keep alive for localhost is not worth (connection setup is about 0.2ms)
540 } elsif (Net::IP::ip_is_ipv6($host)) {
541 $target = "https
://[$host]:8006$uri";
543 $target = "https
://$host:8006$uri";
547 PVEDisableProxy => 'true',
548 PVEClientIP => $clientip,
551 $headers->{'cookie'} = PVE::APIServer::Formatter::create_auth_cookie($ticket, $self->{cookie_name}) if $ticket;
552 $headers->{'CSRFPreventionToken'} = $token if $token;
553 $headers->{'Accept-Encoding'} = 'gzip' if $reqstate->{accept_gzip};
557 if ($method eq 'POST' || $method eq 'PUT') {
558 $headers->{'Content-Type'} = 'application/x-www-form-urlencoded';
559 # use URI object to format application/x-www-form-urlencoded content.
560 my $url = URI->new('http:');
561 $url->query_form(%$params);
562 $content = $url->query;
563 if (defined($content)) {
564 $headers->{'Content-Length'} = length($content);
569 # TLS 1.x only, with certificate pinning
575 my (undef, undef, undef, $depth, undef, undef, $cert) = @_;
576 # we don't care about intermediate or root certificates
577 return 1 if $depth != 0;
578 # check server certificate against cache of pinned FPs
579 return $self->check_cert_fingerprint($cert);
583 # load and cache cert fingerprint if first time we proxy to this node
584 $self->initialize_cert_cache($node);
586 my $w; $w = http_request(
591 proxy => undef, # avoid use of $ENV{HTTP_PROXY}
592 keepalive => $keep_alive,
594 tls_ctx => AnyEvent::TLS->new(%{$tls}),
596 my ($body, $hdr) = @_;
600 if (!$reqstate->{hdl}) {
601 warn "proxy detected vanished client connection
\n";
606 my $code = delete $hdr->{Status};
607 my $msg = delete $hdr->{Reason};
609 delete $hdr->{HTTPVersion};
610 my $header = HTTP::Headers->new(%$hdr);
611 if (my $location = $header->header('Location')) {
612 $location =~ s|^http://localhost:85||;
613 $header->header(Location => $location);
615 my $resp = HTTP::Response->new($code, $msg, $header, $body);
616 # Note: disable compression, because body is already compressed
617 $self->response($reqstate, $resp, undef, 1);
625 # return arrays as \0 separated strings (like CGI.pm)
626 # assume data is UTF8 encoded
627 sub decode_urlencoded {
632 return $res if !$data;
634 foreach my $kv (split(/[\&\;]/, $data)) {
635 my ($k, $v) = split(/=/, $kv);
637 $k =~ s/%([0-9a-fA-F][0-9a-fA-F])/chr(hex($1))/eg;
639 $v =~ s/%([0-9a-fA-F][0-9a-fA-F])/chr(hex($1))/eg;
641 $v = Encode::decode('utf8', $v);
643 if (defined(my $old = $res->{$k})) {
644 $res->{$k} = "$old\0$v";
653 my ($r, $method) = @_;
657 if ($method eq 'PUT' || $method eq 'POST') {
658 $params = decode_urlencoded($r->content);
661 my $query_params = decode_urlencoded($r->url->query());
663 foreach my $k (keys %{$query_params}) {
664 $params->{$k} = $query_params->{$k};
670 sub handle_api2_request {
671 my ($self, $reqstate, $auth, $method, $path, $upload_state) = @_;
674 my $r = $reqstate->{request};
676 my ($rel_uri, $format) = &$split_abs_uri($path, $self->{base_uri});
678 my $formatter = PVE::APIServer::Formatter::get_formatter($format, $method, $rel_uri);
680 if (!defined($formatter)) {
681 $self->error($reqstate, HTTP_NOT_IMPLEMENTED, "no formatter
for uri
$rel_uri, $format");
685 #print Dumper($upload_state) if $upload_state;
690 $params = $upload_state->{params};
692 $params = extract_params($r, $method);
695 delete $params->{_dc}; # remove disable cache parameter
697 my $clientip = $reqstate->{peer_host};
699 my $res = $self->rest_handler($clientip, $method, $rel_uri, $auth, $params, $format);
702 Net::SSLeay::ERR_clear_error();
704 AnyEvent->now_update(); # in case somebody called sleep()
706 my $upgrade = $r->header('upgrade');
707 $upgrade = lc($upgrade) if $upgrade;
709 if (my $host = $res->{proxy}) {
711 if ($self->{trusted_env}) {
712 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy
not allowed
");
716 if ($host ne 'localhost' && $r->header('PVEDisableProxy')) {
717 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy
loop detected
");
721 $res->{proxy_params}->{tmpfilename} = $reqstate->{tmpfilename} if $upload_state;
723 $self->proxy_request($reqstate, $clientip, $host, $res->{proxynode}, $method,
724 $r->uri, $auth->{ticket}, $auth->{token}, $res->{proxy_params}, $res->{proxynode});
727 } elsif ($upgrade && ($method eq 'GET') && ($path =~ m|websocket$|)) {
728 die "unable to upgrade to protocol
'$upgrade'\n" if !$upgrade || ($upgrade ne 'websocket');
729 my $wsver = $r->header('sec-websocket-version');
730 die "unsupported websocket-version
'$wsver'\n" if !$wsver || ($wsver ne '13');
731 my $wsproto_str = $r->header('sec-websocket-protocol');
732 die "missing websocket-protocol header
" if !$wsproto_str;
734 foreach my $p (PVE::Tools::split_list($wsproto_str)) {
735 $wsproto = $p if !$wsproto && $p eq 'base64';
736 $wsproto = $p if $p eq 'binary';
738 die "unsupported websocket-protocol protocol
'$wsproto_str'\n" if !$wsproto;
739 my $wskey = $r->header('sec-websocket-key');
740 die "missing websocket-key
\n" if !$wskey;
741 # Note: Digest::SHA::sha1_base64 has wrong padding
742 my $wsaccept = Digest::SHA::sha1_base64("${wskey
}258EAFA5-E914-47DA-95CA-C5AB0DC85B11
") . "=";
743 if ($res->{status} == HTTP_OK) {
744 $self->websocket_proxy($reqstate, $wsaccept, $wsproto, $res->{data});
750 if ($res->{status} == HTTP_UNAUTHORIZED) {
751 # always delay unauthorized calls by 3 seconds
752 $delay = 3 - tv_interval($reqstate->{starttime});
753 $delay = 0 if $delay < 0;
756 if (defined(my $filename = $res->{download})) {
757 my $fh = IO::File->new($filename) ||
758 die "unable to
open file
'$filename' - $!\n";
759 send_file_start($self, $reqstate, $filename);
763 my ($raw, $ct, $nocomp) = $formatter->($res, $res->{data}, $params, $path,
764 $auth, $self->{formatter_config});
767 if (ref($raw) && (ref($raw) eq 'HTTP::Response')) {
770 $resp = HTTP::Response->new($res->{status}, $res->{message});
771 $resp->header("Content-Type
" => $ct);
772 $resp->content($raw);
774 $self->response($reqstate, $resp, undef, $nocomp, $delay);
777 $self->error($reqstate, 501, $err);
781 sub handle_spice_proxy_request {
782 my ($self, $reqstate, $connect_str, $vmid, $node, $spiceport) = @_;
786 die "Port
$spiceport is not allowed
" if ($spiceport < 61000 || $spiceport > 61099);
788 my $clientip = $reqstate->{peer_host};
789 my $r = $reqstate->{request};
793 if ($node ne 'localhost' && PVE::INotify::nodename() !~ m/^$node$/i) {
794 $remip = $self->remote_node_ip($node);
795 print "REMOTE CONNECT
$vmid, $remip, $connect_str\n" if $self->{debug};
797 print "$$: CONNECT
$vmid, $node, $spiceport\n" if $self->{debug};
800 if ($remip && $r->header('PVEDisableProxy')) {
801 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy
loop detected
");
805 $reqstate->{hdl}->timeout(0);
806 $reqstate->{hdl}->wbuf_max(64*10*1024);
808 my $remhost = $remip ? $remip : "localhost
";
809 my $remport = $remip ? 3128 : $spiceport;
811 tcp_connect $remhost, $remport, sub {
813 or die "connect to
'$remhost:$remport' failed
: $!";
815 print "$$: CONNECTed to
'$remhost:$remport'\n" if $self->{debug};
816 $reqstate->{proxyhdl} = AnyEvent::Handle->new(
819 wbuf_max => 64*10*1024,
824 $self->log_aborted_request($reqstate);
825 $self->client_do_disconnect($reqstate);
827 if (my $err = $@) { syslog('err', $err); }
830 my ($hdl, $fatal, $message) = @_;
832 $self->log_aborted_request($reqstate, $message);
833 $self->client_do_disconnect($reqstate);
835 if (my $err = $@) { syslog('err', "$err"); }
839 my $proxyhdlreader = sub {
842 my $len = length($hdl->{rbuf});
843 my $data = substr($hdl->{rbuf}, 0, $len, '');
845 #print "READ1
$len\n";
846 $reqstate->{hdl}->push_write($data) if $reqstate->{hdl};
849 my $hdlreader = sub {
852 my $len = length($hdl->{rbuf});
853 my $data = substr($hdl->{rbuf}, 0, $len, '');
855 #print "READ0
$len\n";
856 $reqstate->{proxyhdl}->push_write($data) if $reqstate->{proxyhdl};
859 my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.0';
861 my $startproxy = sub {
862 $reqstate->{proxyhdl}->timeout(0);
863 $reqstate->{proxyhdl}->on_read($proxyhdlreader);
864 $reqstate->{hdl}->on_read($hdlreader);
866 # todo: use stop_read/start_read if write buffer grows to much
868 my $res = "$proto 200 OK
\015\012"; # hope this is the right answer?
869 $reqstate->{hdl}->push_write($res);
872 $reqstate->{log}->{code} = 200;
873 $self->log_request($reqstate);
877 my $header = "CONNECT
${connect_str
} $proto\015\012" .
878 "Host
: ${connect_str
}\015\012" .
879 "Proxy-Connection
: keep-alive
\015\012" .
880 "User-Agent
: spiceproxy
\015\012" .
881 "PVEDisableProxy
: true
\015\012" .
882 "PVEClientIP
: $clientip\015\012" .
885 $reqstate->{proxyhdl}->push_write($header);
886 $reqstate->{proxyhdl}->push_read(line => sub {
887 my ($hdl, $line) = @_;
889 if ($line =~ m!^$proto 200 OK$!) {
892 $reqstate->{hdl}->push_write($line);
893 $self->client_do_disconnect($reqstate);
904 $self->log_aborted_request($reqstate, $err);
905 $self->client_do_disconnect($reqstate);
910 my ($self, $reqstate, $auth, $method, $path) = @_;
912 my $base_uri = $self->{base_uri};
915 my $r = $reqstate->{request};
917 # disable timeout on handle (we already have all data we need)
918 # we re-enable timeout in response()
919 $reqstate->{hdl}->timeout(0);
921 if ($path =~ m/^\Q$base_uri\E/) {
922 $self->handle_api2_request($reqstate, $auth, $method, $path);
926 if ($self->{pages} && ($method eq 'GET') && (my $handler = $self->{pages}->{$path})) {
927 if (ref($handler) eq 'CODE') {
928 my $params = decode_urlencoded($r->url->query());
929 my ($resp, $userid) = &$handler($self, $reqstate->{request}, $params);
931 Net::SSLeay::ERR_clear_error();
932 $self->response($reqstate, $resp);
933 } elsif (ref($handler) eq 'HASH') {
934 if (my $filename = $handler->{file}) {
935 my $fh = IO::File->new($filename) ||
936 die "unable to
open file
'$filename' - $!\n";
937 send_file_start($self, $reqstate, $filename);
939 die "internal error
- no handler
";
942 die "internal error
- no handler
";
947 if ($self->{dirs} && ($method eq 'GET')) {
948 # we only allow simple names
949 if ($path =~ m!^(/\S+/)([a-zA-Z0-9\-\_\.]+)$!) {
950 my ($subdir, $file) = ($1, $2);
951 if (my $dir = $self->{dirs}->{$subdir}) {
952 my $filename = "$dir$file";
953 my $fh = IO::File->new($filename) ||
954 die "unable to
open file
'$filename' - $!\n";
955 send_file_start($self, $reqstate, $filename);
961 die "no such file
'$path'\n";
964 $self->error($reqstate, 501, $err);
968 sub file_upload_multipart {
969 my ($self, $reqstate, $auth, $method, $path, $rstate) = @_;
972 my $boundary = $rstate->{boundary};
973 my $hdl = $reqstate->{hdl};
975 my $startlen = length($hdl->{rbuf});
977 if ($rstate->{phase} == 0) { # skip everything until start
978 if ($hdl->{rbuf} =~ s/^.*?--\Q$boundary\E \015?\012
979 ((?:[^\015]+\015\012)* ) \015?\012//xs) {
981 my ($ct, $disp, $name, $filename);
982 foreach my $line (split(/\015?\012/, $header)) {
983 # assume we have single line headers
984 if ($line =~ m/^Content-Type\s*:\s*(.*)/i) {
985 $ct = parse_content_type($1);
986 } elsif ($line =~ m/^Content-Disposition\s*:\s*(.*)/i) {
987 ($disp, $name, $filename) = parse_content_disposition($1);
991 if (!($disp && $disp eq 'form-data' && $name)) {
992 syslog('err', "wrong content disposition
in multipart
- abort upload
");
993 $rstate->{phase} = -1;
996 $rstate->{fieldname} = $name;
999 if ($name eq 'filename') {
1000 # found file upload data
1001 $rstate->{phase} = 1;
1002 $rstate->{filename} = $filename;
1004 syslog('err', "wrong field name
for file upload
- abort upload
");
1005 $rstate->{phase} = -1;
1008 # found form data for field $name
1009 $rstate->{phase} = 2;
1013 my $len = length($hdl->{rbuf});
1014 substr($hdl->{rbuf}, 0, $len - $rstate->{maxheader}, '')
1015 if $len > $rstate->{maxheader}; # skip garbage
1017 } elsif ($rstate->{phase} == 1) { # inside file - dump until end marker
1018 if ($hdl->{rbuf} =~ s/^(.*?)\015?\012(--\Q$boundary\E(--)? \015?\012(.*))$/$2/xs) {
1019 my ($rest, $eof) = ($1, $3);
1020 my $len = length($rest);
1021 die "write to temporary file failed
- $!"
1022 if syswrite($rstate->{outfh}, $rest) != $len;
1023 $rstate->{ctx}->add($rest);
1024 $rstate->{params}->{filename} = $rstate->{filename};
1025 $rstate->{md5sum} = $rstate->{ctx}->hexdigest;
1026 $rstate->{bytes} += $len;
1027 $rstate->{phase} = $eof ? 100 : 0;
1029 my $len = length($hdl->{rbuf});
1030 my $wlen = $len - $rstate->{boundlen};
1032 my $data = substr($hdl->{rbuf}, 0, $wlen, '');
1033 die "write to temporary file failed
- $!"
1034 if syswrite($rstate->{outfh}, $data) != $wlen;
1035 $rstate->{bytes} += $wlen;
1036 $rstate->{ctx}->add($data);
1039 } elsif ($rstate->{phase} == 2) { # inside normal field
1041 if ($hdl->{rbuf} =~ s/^(.*?)\015?\012(--\Q$boundary\E(--)? \015?\012(.*))$/$2/xs) {
1042 my ($rest, $eof) = ($1, $3);
1043 my $len = length($rest);
1044 $rstate->{post_size} += $len;
1045 if ($rstate->{post_size} < $limit_max_post) {
1046 $rstate->{params}->{$rstate->{fieldname}} = $rest;
1047 $rstate->{phase} = $eof ? 100 : 0;
1049 syslog('err', "form data to large
- abort upload
");
1050 $rstate->{phase} = -1; # skip
1054 my $len = length($hdl->{rbuf});
1055 substr($hdl->{rbuf}, 0, $len, ''); # empty rbuf
1058 $rstate->{read} += ($startlen - length($hdl->{rbuf}));
1060 if (!$rstate->{done} && ($rstate->{read} + length($hdl->{rbuf})) >= $rstate->{size}) {
1061 $rstate->{done} = 1; # make sure we dont get called twice
1062 if ($rstate->{phase} < 0 || !$rstate->{md5sum}) {
1063 die "upload failed
\n";
1065 my $elapsed = tv_interval($rstate->{starttime});
1067 my $rate = int($rstate->{bytes}/($elapsed*1024*1024));
1068 syslog('info', "multipart upload complete
" .
1069 "(size
: %d time: %ds rate
: %.2fMiB
/s md5sum
: $rstate->{md5sum
})",
1070 $rstate->{bytes}, $elapsed, $rate);
1071 $self->handle_api2_request($reqstate, $auth, $method, $path, $rstate);
1076 syslog('err', $err);
1077 $self->error($reqstate, 501, $err);
1081 sub parse_content_type {
1084 my ($ct, @params) = split(/\s*[;,]\s*/o, $ctype);
1086 foreach my $v (@params) {
1087 if ($v =~ m/^\s*boundary\s*=\s*(\S+?)\s*$/o) {
1088 return wantarray ? ($ct, $1) : $ct;
1092 return wantarray ? ($ct) : $ct;
1095 sub parse_content_disposition {
1098 my ($disp, @params) = split(/\s*[;,]\s*/o, $line);
1102 foreach my $v (@params) {
1103 if ($v =~ m/^\s*name\s*=\s*(\S+?)\s*$/o) {
1105 $name =~ s/^"(.*)"$/$1/;
1106 } elsif ($v =~ m/^\s*filename\s*=\s*(.+?)\s*$/o) {
1108 $filename =~ s/^"(.*)"$/$1/;
1112 return wantarray ? ($disp, $name, $filename) : $disp;
1115 my $tmpfile_seq_no = 0;
1117 sub get_upload_filename {
1118 # choose unpredictable tmpfile name
1121 return "/var/tmp
/pveupload-
" . Digest::MD5::md5_hex($tmpfile_seq_no . time() . $$);
1124 sub unshift_read_header {
1125 my ($self, $reqstate, $state) = @_;
1127 $state = { size => 0, count => 0 } if !$state;
1129 $reqstate->{hdl}->unshift_read(line => sub {
1130 my ($hdl, $line) = @_;
1133 # print "$$: got header
: $line\n" if $self->{debug};
1135 die "to many http header lines
\n" if ++$state->{count} >= $limit_max_headers;
1136 die "http header too large
\n" if ($state->{size} += length($line)) >= $limit_max_header_size;
1138 my $r = $reqstate->{request};
1141 my $path = uri_unescape($r->uri->path());
1142 my $method = $r->method();
1144 $r->push_header($state->{key}, $state->{val})
1147 if (!$known_methods->{$method}) {
1148 my $resp = HTTP::Response->new(HTTP_NOT_IMPLEMENTED, "method '$method' not available
");
1149 $self->response($reqstate, $resp);
1153 my $conn = $r->header('Connection');
1154 my $accept_enc = $r->header('Accept-Encoding');
1155 $reqstate->{accept_gzip} = ($accept_enc && $accept_enc =~ m/gzip/) ? 1 : 0;
1158 $reqstate->{keep_alive} = 0 if $conn =~ m/close/oi;
1160 if ($reqstate->{proto}->{ver} < 1001) {
1161 $reqstate->{keep_alive} = 0;
1165 my $te = $r->header('Transfer-Encoding');
1166 if ($te && lc($te) eq 'chunked') {
1167 # Handle chunked transfer encoding
1168 $self->error($reqstate, 501, "chunked transfer encoding
not supported
");
1171 $self->error($reqstate, 501, "Unknown transfer encoding
'$te'");
1175 my $pveclientip = $r->header('PVEClientIP');
1176 my $base_uri = $self->{base_uri};
1178 # fixme: how can we make PVEClientIP header trusted?
1179 if ($self->{trusted_env} && $pveclientip) {
1180 $reqstate->{peer_host} = $pveclientip;
1182 $r->header('PVEClientIP', $reqstate->{peer_host});
1185 my $len = $r->header('Content-Length');
1187 # header processing complete - authenticate now
1190 if ($self->{spiceproxy}) {
1191 my $connect_str = $r->header('Host');
1192 my ($vmid, $node, $port) = $self->verify_spice_connect_url($connect_str);
1193 if (!(defined($vmid) && $node && $port)) {
1194 $self->error($reqstate, HTTP_UNAUTHORIZED, "invalid ticket
");
1197 $self->handle_spice_proxy_request($reqstate, $connect_str, $vmid, $node, $port);
1199 } elsif ($path =~ m/^\Q$base_uri\E/) {
1200 my $token = $r->header('CSRFPreventionToken');
1201 my $cookie = $r->header('Cookie');
1202 my $ticket = PVE::APIServer::Formatter::extract_auth_cookie($cookie, $self->{cookie_name});
1204 my ($rel_uri, $format) = &$split_abs_uri($path, $self->{base_uri});
1206 $self->error($reqstate, HTTP_NOT_IMPLEMENTED, "no such uri
");
1211 $auth = $self->auth_handler($method, $rel_uri, $ticket, $token,
1212 $reqstate->{peer_host});
1216 Net::SSLeay::ERR_clear_error();
1217 # always delay unauthorized calls by 3 seconds
1219 if (my $formatter = PVE::APIServer::Formatter::get_login_formatter($format)) {
1220 my ($raw, $ct, $nocomp) =
1221 $formatter->($path, $auth, $self->{formatter_config});
1223 if (ref($raw) && (ref($raw) eq 'HTTP::Response')) {
1226 $resp = HTTP::Response->new(HTTP_UNAUTHORIZED, "Login Required
");
1227 $resp->header("Content-Type
" => $ct);
1228 $resp->content($raw);
1230 $self->response($reqstate, $resp, undef, $nocomp, $delay);
1232 my $resp = HTTP::Response->new(HTTP_UNAUTHORIZED, $err);
1233 $self->response($reqstate, $resp, undef, 0, $delay);
1239 $reqstate->{log}->{userid} = $auth->{userid};
1243 if (!($method eq 'PUT' || $method eq 'POST')) {
1244 $self->error($reqstate, 501, "Unexpected content
for method '$method'");
1248 my $ctype = $r->header('Content-Type');
1249 my ($ct, $boundary) = parse_content_type($ctype) if $ctype;
1251 if ($auth->{isUpload} && !$self->{trusted_env}) {
1252 die "upload
'Content-Type '$ctype' not implemented\n"
1253 if !($boundary && $ct && ($ct eq 'multipart
/form-data
'));
1255 die "upload without content length header not supported" if !$len;
1257 die "upload without content length header not supported" if !$len;
1259 print "start upload $path $ct $boundary\n" if $self->{debug};
1261 my $tmpfilename = get_upload_filename();
1262 my $outfh = IO::File->new($tmpfilename, O_RDWR|O_CREAT|O_EXCL, 0600) ||
1263 die "unable to create temporary upload file '$tmpfilename'";
1265 $reqstate->{keep_alive} = 0;
1267 my $boundlen = length($boundary) + 8; # \015?\012--$boundary--\015?\012
1271 boundary => $boundary,
1272 ctx => Digest::MD5->new,
1273 boundlen => $boundlen,
1274 maxheader => 2048 + $boundlen, # should be large enough
1275 params => decode_urlencoded($r->url->query()),
1279 starttime => [gettimeofday],
1282 $reqstate->{tmpfilename} = $tmpfilename;
1283 $reqstate->{hdl}->on_read(sub { $self->file_upload_multipart($reqstate, $auth, $method, $path, $state); });
1287 if ($len > $limit_max_post) {
1288 $self->error($reqstate, 501, "for data too large");
1292 if (!$ct || $ct eq 'application
/x-www-form-urlencoded
') {
1293 $reqstate->{hdl}->unshift_read(chunk => $len, sub {
1294 my ($hdl, $data) = @_;
1296 $self->handle_request($reqstate, $auth, $method, $path);
1299 $self->error($reqstate, 506, "upload 'Content-Type
'$ctype' not implemented
");
1302 $self->handle_request($reqstate, $auth, $method, $path);
1304 } elsif ($line =~ /^([^:\s]+)\s*:\s*(.*)/) {
1305 $r->push_header($state->{key}, $state->{val}) if $state->{key};
1306 ($state->{key}, $state->{val}) = ($1, $2);
1307 $self->unshift_read_header($reqstate, $state);
1308 } elsif ($line =~ /^\s+(.*)/) {
1309 $state->{val} .= " $1";
1310 $self->unshift_read_header($reqstate, $state);
1312 $self->error($reqstate, 506, "unable to parse request header
");
1319 sub push_request_header {
1320 my ($self, $reqstate) = @_;
1323 $reqstate->{hdl}->push_read(line => sub {
1324 my ($hdl, $line) = @_;
1327 # print "got request header
: $line\n" if $self->{debug};
1329 $reqstate->{keep_alive}--;
1331 if ($line =~ /(\S+)\040(\S+)\040HTTP\/(\d+)\.(\d+)/o) {
1332 my ($method, $url, $maj, $min) = ($1, $2, $3, $4);
1335 $self->error($reqstate, 506, "http protocol version
$maj.$min not supported
");
1339 $self->{request_count}++; # only count valid request headers
1340 if ($self->{request_count} >= $self->{max_requests}) {
1341 $self->{end_loop} = 1;
1343 $reqstate->{log} = { requestline => $line };
1344 $reqstate->{proto}->{str} = "HTTP
/$maj.$min";
1345 $reqstate->{proto}->{maj} = $maj;
1346 $reqstate->{proto}->{min} = $min;
1347 $reqstate->{proto}->{ver} = $maj*1000+$min;
1348 $reqstate->{request} = HTTP::Request->new($method, $url);
1349 $reqstate->{starttime} = [gettimeofday],
1351 $self->unshift_read_header($reqstate);
1352 } elsif ($line eq '') {
1353 # ignore empty lines before requests (browser bugs?)
1354 $self->push_request_header($reqstate);
1356 $self->error($reqstate, 400, 'bad request');
1370 return if $self->{end_loop};
1372 # we need to m make sure that only one process calls accept
1373 while (!flock($self->{lockfh}, Fcntl::LOCK_EX())) {
1374 next if $! == EINTR;
1375 die "could
not get
lock on file
'$self->{lockfile}' - $!\n";
1381 while (!$self->{end_loop} &&
1382 !defined($clientfh = $self->{socket}->accept()) &&
1385 if ($self->{end_loop}) {
1388 $again = ($! == EAGAIN || $! == WSAEWOULDBLOCK);
1389 if (!defined($clientfh)) {
1390 $errmsg = "failed to
accept connection
: $!\n";
1396 flock($self->{lockfh}, Fcntl::LOCK_UN());
1398 if (!defined($clientfh)) {
1400 die $errmsg if $errmsg;
1403 fh_nonblocking $clientfh, 1;
1405 $self->{conn_count}++;
1413 $self->{end_loop} = 1;
1415 undef $self->{socket_watch};
1417 $0 = "$0 (shutdown)" if $0 !~ m/\(shutdown\)$/;
1419 if ($self->{conn_count} <= 0) {
1420 $self->{end_cond}->send(1);
1424 # fork and exit, so that parent starts a new worker
1429 # else we need to wait until all open connections gets closed
1430 my $w; $w = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1432 # todo: test for active connections instead (we can abort idle connections)
1433 if ($self->{conn_count} <= 0) {
1435 $self->{end_cond}->send(1);
1443 sub check_host_access {
1444 my ($self, $clientip) = @_;
1446 my $cip = Net::IP->new($clientip);
1448 my $match_allow = 0;
1451 if ($self->{allow_from}) {
1452 foreach my $t (@{$self->{allow_from}}) {
1453 if ($t->overlaps($cip)) {
1460 if ($self->{deny_from}) {
1461 foreach my $t (@{$self->{deny_from}}) {
1462 if ($t->overlaps($cip)) {
1469 if ($match_allow == $match_deny) {
1470 # match both allow and deny, or no match
1471 return $self->{policy} && $self->{policy} eq 'allow' ? 1 : 0;
1474 return $match_allow;
1477 sub accept_connections {
1482 while (my $clientfh = $self->accept()) {
1484 my $reqstate = { keep_alive => $self->{keep_alive} };
1486 # stop keep-alive when there are many open connections
1487 if ($self->{conn_count} >= $self->{max_conn_soft_limit}) {
1488 $reqstate->{keep_alive} = 0;
1491 if (my $sin = getpeername($clientfh)) {
1492 my ($pfamily, $pport, $phost) = PVE::Tools::unpack_sockaddr_in46($sin);
1493 ($reqstate->{peer_port}, $reqstate->{peer_host}) = ($pport, Socket::inet_ntop($pfamily, $phost));
1496 if (!$self->{trusted_env} && !$self->check_host_access($reqstate->{peer_host})) {
1497 print "$$: ABORT request from
$reqstate->{peer_host
} - access denied
\n" if $self->{debug};
1498 $reqstate->{log}->{code} = 403;
1499 $self->log_request($reqstate);
1503 $reqstate->{hdl} = AnyEvent::Handle->new(
1505 rbuf_max => 64*1024,
1506 timeout => $self->{timeout},
1507 linger => 0, # avoid problems with ssh - really needed ?
1511 $self->log_aborted_request($reqstate);
1512 $self->client_do_disconnect($reqstate);
1514 if (my $err = $@) { syslog('err', $err); }
1517 my ($hdl, $fatal, $message) = @_;
1519 $self->log_aborted_request($reqstate, $message);
1520 $self->client_do_disconnect($reqstate);
1522 if (my $err = $@) { syslog('err', "$err"); }
1524 ($self->{tls_ctx} ? (tls => "accept", tls_ctx => $self->{tls_ctx}) : ()));
1526 print "$$: ACCEPT FH
" . $clientfh->fileno() . " CONN
$self->{conn_count
}\n" if $self->{debug};
1528 $self->push_request_header($reqstate);
1533 syslog('err', $err);
1534 $self->{end_loop} = 1;
1537 $self->wait_end_loop() if $self->{end_loop};
1540 # Note: We can't open log file in non-blocking mode and use AnyEvent::Handle,
1541 # because we write from multiple processes, and that would arbitrarily mix output
1543 sub open_access_log {
1544 my ($self, $filename) = @_;
1546 my $old_mask = umask(0137);;
1547 my $logfh = IO::File->new($filename, ">>") ||
1548 die "unable to
open log file
'$filename' - $!\n";
1551 $logfh->autoflush(1);
1553 $self->{logfh} = $logfh;
1557 my ($self, $data) = @_;
1559 return if !defined($self->{logfh}) || !$data;
1561 my $res = $self->{logfh}->print($data);
1564 delete $self->{logfh};
1565 syslog('err', "error writing access
log");
1566 $self->{end_loop} = 1; # terminate asap
1570 sub atfork_handler {
1574 # something else do to ?
1575 close($self->{socket});
1583 $self->{end_cond}->recv;
1587 my ($this, %args) = @_;
1589 my $class = ref($this) || $this;
1591 foreach my $req (qw(socket lockfh lockfile)) {
1592 die "misssing required argument '$req'" if !defined($args{$req});
1595 my $self = bless { %args }, $class;
1597 $self->{cookie_name
} //= 'PVEAuthCookie';
1598 $self->{base_uri
} //= "/api2";
1599 $self->{dirs
} //= {};
1600 $self->{title
} //= 'API Inspector';
1602 # formatter_config: we pass some configuration values to the Formatter
1603 $self->{formatter_config
} = {};
1604 foreach my $p (qw(cookie_name base_uri title)) {
1605 $self->{formatter_config
}->{$p} = $self->{$p};
1607 $self->{formatter_config
}->{csrfgen_func
} =
1608 $self->can('generate_csrf_prevention_token');
1610 # add default dirs which includes jquery and bootstrap
1611 my $base = '/usr/share/libpve-http-server-perl';
1612 add_dirs
($self->{dirs
}, '/css/' => "$base/css/");
1613 add_dirs
($self->{dirs
}, '/js/' => "$base/js/");
1614 add_dirs
($self->{dirs
}, '/fonts/' => "$base/fonts/");
1617 PVE
::INotify
::inotify_init
();
1619 fh_nonblocking
($self->{socket}, 1);
1621 $self->{end_loop
} = 0;
1622 $self->{conn_count
} = 0;
1623 $self->{request_count
} = 0;
1624 $self->{timeout
} = 5 if !$self->{timeout
};
1625 $self->{keep_alive
} = 0 if !defined($self->{keep_alive
});
1626 $self->{max_conn
} = 800 if !$self->{max_conn
};
1627 $self->{max_requests
} = 8000 if !$self->{max_requests
};
1629 $self->{policy
} = 'allow' if !$self->{policy
};
1631 $self->{end_cond
} = AnyEvent-
>condvar;
1634 $self->{tls_ctx
} = AnyEvent
::TLS-
>new(%{$self->{ssl
}});
1635 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
);
1638 if ($self->{spiceproxy
}) {
1639 $known_methods = { CONNECT
=> 1 };
1642 $self->open_access_log($self->{logfile
}) if $self->{logfile
};
1644 $self->{max_conn_soft_limit
} = $self->{max_conn
} > 100 ?
$self->{max_conn
} - 20 : $self->{max_conn
};
1646 $self->{socket_watch
} = AnyEvent-
>io(fh
=> $self->{socket}, poll
=> 'r', cb
=> sub {
1648 if ($self->{conn_count
} >= $self->{max_conn
}) {
1649 my $w; $w = AnyEvent-
>timer (after
=> 1, interval
=> 1, cb
=> sub {
1650 if ($self->{conn_count
} < $self->{max_conn
}) {
1652 $self->accept_connections();
1656 $self->accept_connections();
1662 $self->{term_watch
} = AnyEvent-
>signal(signal
=> "TERM", cb
=> sub {
1663 undef $self->{term_watch
};
1664 $self->wait_end_loop();
1667 $self->{quit_watch
} = AnyEvent-
>signal(signal
=> "QUIT", cb
=> sub {
1668 undef $self->{quit_watch
};
1669 $self->wait_end_loop();
1672 $self->{inotify_poll
} = AnyEvent-
>timer(after
=> 5, interval
=> 5, cb
=> sub {
1673 PVE
::INotify
::poll
(); # read inotify events
1679 # static helper to add directory including all subdirs
1680 # This can be used to setup $self->{dirs}
1682 my ($result_hash, $alias, $subdir) = @_;
1684 $result_hash->{$alias} = $subdir;
1687 my $dir = $File::Find
::dir
;
1688 if ($dir =~m!^$subdir(.*)$!) {
1689 my $name = "$alias$1/";
1690 $result_hash->{$name} = "$dir/";
1694 find
({wanted
=> $wanted, follow
=> 0, no_chdir
=> 1}, $subdir);
1697 # abstract functions - subclass should overwrite/implement them
1699 sub verify_spice_connect_url
{
1700 my ($self, $connect_str) = @_;
1704 #return ($vmid, $node, $port);
1707 # formatters can call this when the generate a new page
1708 sub generate_csrf_prevention_token
{
1709 my ($username) = @_;
1711 return undef; # do nothing by default
1715 my ($self, $method, $rel_uri, $ticket, $token, $peer_host) = @_;
1720 # ticket => $ticket,
1722 # userid => $username,
1724 # isUpload => $isUpload,
1729 my ($self, $clientip, $method, $rel_uri, $auth, $params, $format) = @_;
1731 # please do not raise exceptions here (always return a result).
1734 status
=> HTTP_NOT_IMPLEMENTED
,
1735 message
=> "Method '$method $rel_uri' not implemented",
1738 # this should return the following properties, which
1739 # are then passed to the Formatter
1741 # status: HTTP status code
1742 # message: Error message
1743 # errors: more detailed error hash (per parameter)
1744 # info: reference to JSON schema definition - useful to format output
1747 # total: additional info passed to output
1748 # changes: additional info passed to output
1750 # if you want to proxy the request to another node return this
1751 # { proxy => $remip, proxynode => $node, proxy_params => $params };
1753 # to pass the request to the local priviledged daemon use:
1754 # { proxy => 'localhost' , proxy_params => $params };
1756 # to download aspecific file use:
1757 # { download => "/path/to/file" };
1760 sub check_cert_fingerprint
{
1761 my ($self, $cert) = @_;
1766 sub initialize_cert_cache
{
1767 my ($self, $node) = @_;
1772 sub remote_node_ip
{
1773 my ($self, $node) = @_;