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);
35 use PVE
::APIServer
::Formatter
;
40 use HTTP
::Status
qw(:constants);
47 my $limit_max_headers = 30;
48 my $limit_max_header_size = 8*1024;
49 my $limit_max_post = 16*1024;
58 my $split_abs_uri = sub {
59 my ($abs_uri, $base_uri) = @_;
61 my ($format, $rel_uri) = $abs_uri =~ m/^\Q$base_uri\E\/+([a-z
][a-z0-9
]+)(\
/.*)?$/;
62 $rel_uri = '/' if !$rel_uri;
64 return wantarray ?
($rel_uri, $format) : $rel_uri;
68 my ($self, $reqstate) = @_;
70 my $loginfo = $reqstate->{log};
72 # like apache2 common log format
73 # LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\""
75 return if $loginfo->{written
}; # avoid duplicate logs
76 $loginfo->{written
} = 1;
78 my $peerip = $reqstate->{peer_host
} || '-';
79 my $userid = $loginfo->{userid
} || '-';
80 my $content_length = defined($loginfo->{content_length
}) ?
$loginfo->{content_length
} : '-';
81 my $code = $loginfo->{code
} || 500;
82 my $requestline = $loginfo->{requestline
} || '-';
83 my $timestr = strftime
("%d/%m/%Y:%H:%M:%S %z", localtime());
85 my $msg = "$peerip - $userid [$timestr] \"$requestline\" $code $content_length\n";
87 $self->write_log($msg);
90 sub log_aborted_request {
91 my ($self, $reqstate, $error) = @_;
93 my $r = $reqstate->{request};
94 return if !$r; # no active request
97 syslog("err
", "problem with client
$reqstate->{peer_host
}; $error");
100 $self->log_request($reqstate);
103 sub cleanup_reqstate {
106 delete $reqstate->{log};
107 delete $reqstate->{request};
108 delete $reqstate->{proto};
109 delete $reqstate->{accept_gzip};
110 delete $reqstate->{starttime};
112 if ($reqstate->{tmpfilename}) {
113 unlink $reqstate->{tmpfilename};
114 delete $reqstate->{tmpfilename};
118 sub client_do_disconnect {
119 my ($self, $reqstate) = @_;
121 cleanup_reqstate($reqstate);
123 my $shutdown_hdl = sub {
126 shutdown($hdl->{fh}, 1);
128 $hdl->on_drain(undef);
129 $hdl->on_read(undef);
133 if (my $proxyhdl = delete $reqstate->{proxyhdl}) {
134 &$shutdown_hdl($proxyhdl);
137 my $hdl = delete $reqstate->{hdl};
140 syslog('err', "detected empty handle
");
144 print "close connection
$hdl\n" if $self->{debug};
146 &$shutdown_hdl($hdl);
148 $self->{conn_count}--;
150 print "$$: CLOSE FH
" . $hdl->{fh}->fileno() . " CONN
$self->{conn_count
}\n" if $self->{debug};
153 sub finish_response {
154 my ($self, $reqstate) = @_;
156 cleanup_reqstate($reqstate);
158 my $hdl = $reqstate->{hdl};
159 return if !$hdl; # already disconnected
161 if (!$self->{end_loop} && $reqstate->{keep_alive} > 0) {
162 # print "KEEPALIVE
$reqstate->{keep_alive
}\n" if $self->{debug};
164 eval { $self->push_request_header($reqstate); };
168 $hdl->on_drain (sub {
170 $self->client_do_disconnect($reqstate);
178 my ($self, $reqstate, $resp, $mtime, $nocomp, $delay) = @_;
180 #print "$$: send response
: " . Dumper($resp);
183 $reqstate->{hdl}->timeout_reset();
184 $reqstate->{hdl}->timeout($self->{timeout});
186 $nocomp = 1 if !$reqstate->{accept_gzip};
188 my $code = $resp->code;
189 my $msg = $resp->message || HTTP::Status::status_message($code);
190 ($msg) = $msg =~m/^(.*)$/m;
191 my $content = $resp->content;
193 if ($code =~ /^(1\d\d|[23]04)$/) {
194 # make sure content we have no content
198 $reqstate->{keep_alive} = 0 if ($code >= 400) || $self->{end_loop};
200 $reqstate->{log}->{code} = $code;
202 my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.0';
203 my $res = "$proto $code $msg\015\012";
206 my $date = HTTP::Date::time2str($ctime);
207 $resp->header('Date' => $date);
209 $resp->header('Last-Modified' => HTTP::Date::time2str($mtime));
211 $resp->header('Expires' => $date);
212 $resp->header('Cache-Control' => "max-age
=0");
213 $resp->header("Pragma
", "no-cache
");
216 $resp->header('Server' => "pve-api-daemon
/3.0");
221 $content_length = length($content);
223 if (!$nocomp && ($content_length > 1024)) {
224 my $comp = Compress::Zlib::memGzip($content);
225 $resp->header('Content-Encoding', 'gzip');
227 $content_length = length($content);
229 $resp->header("Content-Length
" => $content_length);
230 $reqstate->{log}->{content_length} = $content_length;
233 $resp->remove_header("Content-Length
");
236 if ($reqstate->{keep_alive} > 0) {
237 $resp->push_header('Connection' => 'Keep-Alive');
239 $resp->header('Connection' => 'close');
242 $res .= $resp->headers_as_string("\015\012");
243 #print "SEND
(without content
) $res\n" if $self->{debug};
246 $res .= $content if $content;
248 $self->log_request($reqstate, $reqstate->{request});
250 if ($delay && $delay > 0) {
251 my $w; $w = AnyEvent->timer(after => $delay, cb => sub {
252 undef $w; # delete reference
253 $reqstate->{hdl}->push_write($res);
254 $self->finish_response($reqstate);
257 $reqstate->{hdl}->push_write($res);
258 $self->finish_response($reqstate);
263 my ($self, $reqstate, $code, $msg, $hdr, $content) = @_;
266 my $resp = HTTP::Response->new($code, $msg, $hdr, $content);
267 $self->response($reqstate, $resp);
272 my $file_extension_info = {
273 css => { ct => 'text/css' },
274 html => { ct => 'text/html' },
275 js => { ct => 'application/javascript' },
276 png => { ct => 'image/png' , nocomp => 1 },
277 ico => { ct => 'image/x-icon', nocomp => 1},
278 gif => { ct => 'image/gif', nocomp => 1},
279 jar => { ct => 'application/java-archive', nocomp => 1},
280 woff => { ct => 'application/font-woff', nocomp => 1},
281 woff2 => { ct => 'application/font-woff2', nocomp => 1},
282 ttf => { ct => 'application/font-snft', nocomp => 1},
283 pdf => { ct => 'application/pdf', nocomp => 1},
284 epub => { ct => 'application/epub+zip', nocomp => 1},
287 sub send_file_start {
288 my ($self, $reqstate, $filename) = @_;
291 # print "SEND FILE
$filename\n";
292 # Note: aio_load() this is not really async unless we use IO::AIO!
295 my $r = $reqstate->{request};
297 my $fh = IO::File->new($filename, '<') ||
299 my $stat = File::stat::stat($fh) ||
302 my $mtime = $stat->mtime;
304 if (my $ifmod = $r->header('if-modified-since')) {
305 my $iftime = HTTP::Date::str2time($ifmod);
306 if ($mtime <= $iftime) {
307 my $resp = HTTP::Response->new(304, "NOT MODIFIED
");
308 $self->response($reqstate, $resp, $mtime);
314 my $len = sysread($fh, $data, $stat->size);
315 die "got short file
\n" if !defined($len) || $len != $stat->size;
317 my ($ext) = $filename =~ m/\.([^.]*)$/;
318 my $ext_info = $file_extension_info->{$ext};
320 die "unable to detect content type
" if !$ext_info;
322 my $header = HTTP::Headers->new(Content_Type => $ext_info->{ct});
323 my $resp = HTTP::Response->new(200, "OK
", $header, $data);
324 $self->response($reqstate, $resp, $mtime, $ext_info->{nocomp});
327 $self->error($reqstate, 501, $err);
334 sub websocket_proxy {
335 my ($self, $reqstate, $wsaccept, $wsproto, $param) = @_;
341 my $max_payload_size = 65536;
344 if ($wsproto eq 'binary') {
346 } elsif ($wsproto eq 'base64') {
349 die "websocket_proxy
: unsupported protocol
'$wsproto'\n";
352 if ($param->{port}) {
353 $remhost = 'localhost';
354 $remport = $param->{port};
355 } elsif ($param->{socket}) {
357 $remport = $param->{socket};
359 die "websocket_proxy
: missing port
or socket\n";
362 tcp_connect $remhost, $remport, sub {
364 or die "connect to
'$remhost:$remport' failed
: $!";
366 print "$$: CONNECTed to
'$remhost:$remport'\n" if $self->{debug};
368 $reqstate->{proxyhdl} = AnyEvent::Handle->new(
371 wbuf_max => 64*10*1024,
376 $self->log_aborted_request($reqstate);
377 $self->client_do_disconnect($reqstate);
379 if (my $err = $@) { syslog('err', $err); }
382 my ($hdl, $fatal, $message) = @_;
384 $self->log_aborted_request($reqstate, $message);
385 $self->client_do_disconnect($reqstate);
387 if (my $err = $@) { syslog('err', "$err"); }
390 my $proxyhdlreader = sub {
393 my $len = length($hdl->{rbuf});
394 my $data = substr($hdl->{rbuf}, 0, $len, '');
400 $string = "\x82"; # binary frame
403 $string = "\x81"; # text frame
404 $payload = encode_base64($data, '');
407 my $payload_len = length($payload);
408 if ($payload_len <= 125) {
409 $string .= pack 'C', $payload_len;
410 } elsif ($payload_len <= 0xffff) {
411 $string .= pack 'C', 126;
412 $string .= pack 'n', $payload_len;
414 $string .= pack 'C', 127;
415 $string .= pack 'Q>', $payload_len;
419 $reqstate->{hdl}->push_write($string) if $reqstate->{hdl};
422 my $hdlreader = sub {
425 my $len = length($hdl->{rbuf});
428 my $hdr = unpack('C', substr($hdl->{rbuf}, 0, 1));
429 my $opcode = $hdr & 0b00001111;
430 my $fin = $hdr & 0b10000000;
432 die "received fragmented websocket frame
\n" if !$fin;
434 my $rsv = $hdr & 0b01110000;
435 die "received websocket frame with RSV flags
\n" if $rsv;
437 my $payload_len = unpack 'C', substr($hdl->{rbuf}, 1, 1);
439 my $masked = $payload_len & 0b10000000;
440 die "received unmasked websocket frame from client
\n" if !$masked;
443 $payload_len = $payload_len & 0b01111111;
444 if ($payload_len == 126) {
446 $payload_len = unpack('n', substr($hdl->{rbuf}, $offset, 2));
448 } elsif ($payload_len == 127) {
450 $payload_len = unpack('Q>', substr($hdl->{rbuf}, $offset, 8));
454 die "received too large websocket frame
(len
= $payload_len)\n"
455 if ($payload_len > $max_payload_size) || ($payload_len < 0);
457 return if $len < ($offset + 4 + $payload_len);
459 my $data = substr($hdl->{rbuf}, 0, $len, ''); # now consume data
461 my @mask = (unpack('C', substr($data, $offset+0, 1)),
462 unpack('C', substr($data, $offset+1, 1)),
463 unpack('C', substr($data, $offset+2, 1)),
464 unpack('C', substr($data, $offset+3, 1)));
468 my $payload = substr($data, $offset, $payload_len);
470 for (my $i = 0; $i < $payload_len; $i++) {
471 my $d = unpack('C', substr($payload, $i, 1));
472 my $n = $d ^ $mask[$i % 4];
473 substr($payload, $i, 1, pack('C', $n));
476 $payload = decode_base64($payload) if !$binary;
478 if ($opcode == 1 || $opcode == 2) {
479 $reqstate->{proxyhdl}->push_write($payload) if $reqstate->{proxyhdl};
480 } elsif ($opcode == 8) {
481 print "websocket received
close\n" if $self->{debug};
482 if ($reqstate->{proxyhdl}) {
483 $reqstate->{proxyhdl}->push_write($payload);
484 $reqstate->{proxyhdl}->push_shutdown();
486 $hdl->push_shutdown();
488 die "received unhandled websocket opcode
$opcode\n";
492 my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.1';
494 $reqstate->{proxyhdl}->timeout(0);
495 $reqstate->{proxyhdl}->on_read($proxyhdlreader);
496 $reqstate->{hdl}->on_read($hdlreader);
498 # todo: use stop_read/start_read if write buffer grows to much
500 my $res = "$proto 101 Switching Protocols
\015\012" .
501 "Upgrade
: websocket
\015\012" .
502 "Connection
: upgrade
\015\012" .
503 "Sec-WebSocket-Accept
: $wsaccept\015\012" .
504 "Sec-WebSocket-Protocol
: $wsproto\015\012" .
507 print $res if $self->{debug};
509 $reqstate->{hdl}->push_write($res);
512 $reqstate->{log}->{code} = 101;
513 $self->log_request($reqstate);
519 $self->log_aborted_request($reqstate, $err);
520 $self->client_do_disconnect($reqstate);
525 my ($self, $reqstate, $clientip, $host, $node, $method, $uri, $ticket, $token, $params) = @_;
530 if ($host eq 'localhost') {
531 $target = "http
://$host:85$uri";
532 # keep alive for localhost is not worth (connection setup is about 0.2ms)
534 } elsif (Net::IP::ip_is_ipv6($host)) {
535 $target = "https
://[$host]:8006$uri";
537 $target = "https
://$host:8006$uri";
541 PVEDisableProxy => 'true',
542 PVEClientIP => $clientip,
545 $headers->{'cookie'} = PVE::APIServer::Formatter::create_auth_cookie($ticket, $self->{cookie_name}) if $ticket;
546 $headers->{'CSRFPreventionToken'} = $token if $token;
547 $headers->{'Accept-Encoding'} = 'gzip' if $reqstate->{accept_gzip};
551 if ($method eq 'POST' || $method eq 'PUT') {
552 $headers->{'Content-Type'} = 'application/x-www-form-urlencoded';
553 # use URI object to format application/x-www-form-urlencoded content.
554 my $url = URI->new('http:');
555 $url->query_form(%$params);
556 $content = $url->query;
557 if (defined($content)) {
558 $headers->{'Content-Length'} = length($content);
563 # TLS 1.x only, with certificate pinning
569 my (undef, undef, undef, $depth, undef, undef, $cert) = @_;
570 # we don't care about intermediate or root certificates
571 return 1 if $depth != 0;
572 # check server certificate against cache of pinned FPs
573 return $self->check_cert_fingerprint($cert);
577 # load and cache cert fingerprint if first time we proxy to this node
578 $self->initialize_cert_cache($node);
580 my $w; $w = http_request(
585 proxy => undef, # avoid use of $ENV{HTTP_PROXY}
586 keepalive => $keep_alive,
588 tls_ctx => AnyEvent::TLS->new(%{$tls}),
590 my ($body, $hdr) = @_;
594 if (!$reqstate->{hdl}) {
595 warn "proxy detected vanished client connection
\n";
600 my $code = delete $hdr->{Status};
601 my $msg = delete $hdr->{Reason};
603 delete $hdr->{HTTPVersion};
604 my $header = HTTP::Headers->new(%$hdr);
605 if (my $location = $header->header('Location')) {
606 $location =~ s|^http://localhost:85||;
607 $header->header(Location => $location);
609 my $resp = HTTP::Response->new($code, $msg, $header, $body);
610 # Note: disable compression, because body is already compressed
611 $self->response($reqstate, $resp, undef, 1);
619 # return arrays as \0 separated strings (like CGI.pm)
620 sub decode_urlencoded {
625 return $res if !$data;
627 foreach my $kv (split(/[\&\;]/, $data)) {
628 my ($k, $v) = split(/=/, $kv);
630 $k =~ s/%([0-9a-fA-F][0-9a-fA-F])/chr(hex($1))/eg;
632 $v =~ s/%([0-9a-fA-F][0-9a-fA-F])/chr(hex($1))/eg;
634 if (defined(my $old = $res->{$k})) {
635 $res->{$k} = "$old\0$v";
644 my ($r, $method) = @_;
648 if ($method eq 'PUT' || $method eq 'POST') {
649 $params = decode_urlencoded($r->content);
652 my $query_params = decode_urlencoded($r->url->query());
654 foreach my $k (keys %{$query_params}) {
655 $params->{$k} = $query_params->{$k};
658 return PVE::Tools::decode_utf8_parameters($params);
661 sub handle_api2_request {
662 my ($self, $reqstate, $auth, $method, $path, $upload_state) = @_;
665 my $r = $reqstate->{request};
667 my ($rel_uri, $format) = &$split_abs_uri($path, $self->{base_uri});
669 my $formatter = PVE::APIServer::Formatter::get_formatter($format, $method, $rel_uri);
671 if (!defined($formatter)) {
672 $self->error($reqstate, HTTP_NOT_IMPLEMENTED, "no formatter
for uri
$rel_uri, $format");
676 #print Dumper($upload_state) if $upload_state;
681 $params = $upload_state->{params};
683 $params = extract_params($r, $method);
686 delete $params->{_dc}; # remove disable cache parameter
688 my $clientip = $reqstate->{peer_host};
690 my $res = $self->rest_handler($clientip, $method, $rel_uri, $auth, $params);
693 Net::SSLeay::ERR_clear_error();
695 AnyEvent->now_update(); # in case somebody called sleep()
697 my $upgrade = $r->header('upgrade');
698 $upgrade = lc($upgrade) if $upgrade;
700 if (my $host = $res->{proxy}) {
702 if ($self->{trusted_env}) {
703 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy
not allowed
");
707 if ($host ne 'localhost' && $r->header('PVEDisableProxy')) {
708 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy
loop detected
");
712 $res->{proxy_params}->{tmpfilename} = $reqstate->{tmpfilename} if $upload_state;
714 $self->proxy_request($reqstate, $clientip, $host, $res->{proxynode}, $method,
715 $r->uri, $auth->{ticket}, $auth->{token}, $res->{proxy_params}, $res->{proxynode});
718 } elsif ($upgrade && ($method eq 'GET') && ($path =~ m|websocket$|)) {
719 die "unable to upgrade to protocol
'$upgrade'\n" if !$upgrade || ($upgrade ne 'websocket');
720 my $wsver = $r->header('sec-websocket-version');
721 die "unsupported websocket-version
'$wsver'\n" if !$wsver || ($wsver ne '13');
722 my $wsproto_str = $r->header('sec-websocket-protocol');
723 die "missing websocket-protocol header
" if !$wsproto_str;
725 foreach my $p (PVE::Tools::split_list($wsproto_str)) {
726 $wsproto = $p if !$wsproto && $p eq 'base64';
727 $wsproto = $p if $p eq 'binary';
729 die "unsupported websocket-protocol protocol
'$wsproto_str'\n" if !$wsproto;
730 my $wskey = $r->header('sec-websocket-key');
731 die "missing websocket-key
\n" if !$wskey;
732 # Note: Digest::SHA::sha1_base64 has wrong padding
733 my $wsaccept = Digest::SHA::sha1_base64("${wskey
}258EAFA5-E914-47DA-95CA-C5AB0DC85B11
") . "=";
734 if ($res->{status} == HTTP_OK) {
735 $self->websocket_proxy($reqstate, $wsaccept, $wsproto, $res->{data});
741 if ($res->{status} == HTTP_UNAUTHORIZED) {
742 # always delay unauthorized calls by 3 seconds
743 $delay = 3 - tv_interval($reqstate->{starttime});
744 $delay = 0 if $delay < 0;
747 my ($raw, $ct, $nocomp) = $formatter->($res, $res->{data}, $params, $path,
748 $auth, $self->{formatter_config});
751 if (ref($raw) && (ref($raw) eq 'HTTP::Response')) {
754 $resp = HTTP::Response->new($res->{status}, $res->{message});
755 $resp->header("Content-Type
" => $ct);
756 $resp->content($raw);
758 $self->response($reqstate, $resp, undef, $nocomp, $delay);
761 $self->error($reqstate, 501, $err);
765 sub handle_spice_proxy_request {
766 my ($self, $reqstate, $connect_str, $vmid, $node, $spiceport) = @_;
770 die "Port
$spiceport is not allowed
" if ($spiceport < 61000 || $spiceport > 61099);
772 my $clientip = $reqstate->{peer_host};
773 my $r = $reqstate->{request};
777 if ($node ne 'localhost' && PVE::INotify::nodename() !~ m/^$node$/i) {
778 $remip = $self->remote_node_ip($node);
779 print "REMOTE CONNECT
$vmid, $remip, $connect_str\n" if $self->{debug};
781 print "$$: CONNECT
$vmid, $node, $spiceport\n" if $self->{debug};
784 if ($remip && $r->header('PVEDisableProxy')) {
785 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy
loop detected
");
789 $reqstate->{hdl}->timeout(0);
790 $reqstate->{hdl}->wbuf_max(64*10*1024);
792 my $remhost = $remip ? $remip : "localhost
";
793 my $remport = $remip ? 3128 : $spiceport;
795 tcp_connect $remhost, $remport, sub {
797 or die "connect to
'$remhost:$remport' failed
: $!";
799 print "$$: CONNECTed to
'$remhost:$remport'\n" if $self->{debug};
800 $reqstate->{proxyhdl} = AnyEvent::Handle->new(
803 wbuf_max => 64*10*1024,
808 $self->log_aborted_request($reqstate);
809 $self->client_do_disconnect($reqstate);
811 if (my $err = $@) { syslog('err', $err); }
814 my ($hdl, $fatal, $message) = @_;
816 $self->log_aborted_request($reqstate, $message);
817 $self->client_do_disconnect($reqstate);
819 if (my $err = $@) { syslog('err', "$err"); }
823 my $proxyhdlreader = sub {
826 my $len = length($hdl->{rbuf});
827 my $data = substr($hdl->{rbuf}, 0, $len, '');
829 #print "READ1
$len\n";
830 $reqstate->{hdl}->push_write($data) if $reqstate->{hdl};
833 my $hdlreader = sub {
836 my $len = length($hdl->{rbuf});
837 my $data = substr($hdl->{rbuf}, 0, $len, '');
839 #print "READ0
$len\n";
840 $reqstate->{proxyhdl}->push_write($data) if $reqstate->{proxyhdl};
843 my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.0';
845 my $startproxy = sub {
846 $reqstate->{proxyhdl}->timeout(0);
847 $reqstate->{proxyhdl}->on_read($proxyhdlreader);
848 $reqstate->{hdl}->on_read($hdlreader);
850 # todo: use stop_read/start_read if write buffer grows to much
852 my $res = "$proto 200 OK
\015\012"; # hope this is the right answer?
853 $reqstate->{hdl}->push_write($res);
856 $reqstate->{log}->{code} = 200;
857 $self->log_request($reqstate);
861 my $header = "CONNECT
${connect_str
} $proto\015\012" .
862 "Host
: ${connect_str
}\015\012" .
863 "Proxy-Connection
: keep-alive
\015\012" .
864 "User-Agent
: spiceproxy
\015\012" .
865 "PVEDisableProxy
: true
\015\012" .
866 "PVEClientIP
: $clientip\015\012" .
869 $reqstate->{proxyhdl}->push_write($header);
870 $reqstate->{proxyhdl}->push_read(line => sub {
871 my ($hdl, $line) = @_;
873 if ($line =~ m!^$proto 200 OK$!) {
876 $reqstate->{hdl}->push_write($line);
877 $self->client_do_disconnect($reqstate);
888 $self->log_aborted_request($reqstate, $err);
889 $self->client_do_disconnect($reqstate);
894 my ($self, $reqstate, $auth, $method, $path) = @_;
896 my $base_uri = $self->{base_uri};
899 my $r = $reqstate->{request};
901 # disable timeout on handle (we already have all data we need)
902 # we re-enable timeout in response()
903 $reqstate->{hdl}->timeout(0);
905 if ($path =~ m/^\Q$base_uri\E/) {
906 $self->handle_api2_request($reqstate, $auth, $method, $path);
910 if ($self->{pages} && ($method eq 'GET') && (my $handler = $self->{pages}->{$path})) {
911 if (ref($handler) eq 'CODE') {
912 my $params = decode_urlencoded($r->url->query());
913 my ($resp, $userid) = &$handler($self, $reqstate->{request}, $params);
915 Net::SSLeay::ERR_clear_error();
916 $self->response($reqstate, $resp);
917 } elsif (ref($handler) eq 'HASH') {
918 if (my $filename = $handler->{file}) {
919 my $fh = IO::File->new($filename) ||
920 die "unable to
open file
'$filename' - $!\n";
921 send_file_start($self, $reqstate, $filename);
923 die "internal error
- no handler
";
926 die "internal error
- no handler
";
931 if ($self->{dirs} && ($method eq 'GET')) {
932 # we only allow simple names
933 if ($path =~ m!^(/\S+/)([a-zA-Z0-9\-\_\.]+)$!) {
934 my ($subdir, $file) = ($1, $2);
935 if (my $dir = $self->{dirs}->{$subdir}) {
936 my $filename = "$dir$file";
937 my $fh = IO::File->new($filename) ||
938 die "unable to
open file
'$filename' - $!\n";
939 send_file_start($self, $reqstate, $filename);
945 die "no such file
'$path'\n";
948 $self->error($reqstate, 501, $err);
952 sub file_upload_multipart {
953 my ($self, $reqstate, $auth, $method, $path, $rstate) = @_;
956 my $boundary = $rstate->{boundary};
957 my $hdl = $reqstate->{hdl};
959 my $startlen = length($hdl->{rbuf});
961 if ($rstate->{phase} == 0) { # skip everything until start
962 if ($hdl->{rbuf} =~ s/^.*?--\Q$boundary\E \015?\012
963 ((?:[^\015]+\015\012)* ) \015?\012//xs) {
965 my ($ct, $disp, $name, $filename);
966 foreach my $line (split(/\015?\012/, $header)) {
967 # assume we have single line headers
968 if ($line =~ m/^Content-Type\s*:\s*(.*)/i) {
969 $ct = parse_content_type($1);
970 } elsif ($line =~ m/^Content-Disposition\s*:\s*(.*)/i) {
971 ($disp, $name, $filename) = parse_content_disposition($1);
975 if (!($disp && $disp eq 'form-data' && $name)) {
976 syslog('err', "wrong content disposition
in multipart
- abort upload
");
977 $rstate->{phase} = -1;
980 $rstate->{fieldname} = $name;
983 if ($name eq 'filename') {
984 # found file upload data
985 $rstate->{phase} = 1;
986 $rstate->{filename} = $filename;
988 syslog('err', "wrong field name
for file upload
- abort upload
");
989 $rstate->{phase} = -1;
992 # found form data for field $name
993 $rstate->{phase} = 2;
997 my $len = length($hdl->{rbuf});
998 substr($hdl->{rbuf}, 0, $len - $rstate->{maxheader}, '')
999 if $len > $rstate->{maxheader}; # skip garbage
1001 } elsif ($rstate->{phase} == 1) { # inside file - dump until end marker
1002 if ($hdl->{rbuf} =~ s/^(.*?)\015?\012(--\Q$boundary\E(--)? \015?\012(.*))$/$2/xs) {
1003 my ($rest, $eof) = ($1, $3);
1004 my $len = length($rest);
1005 die "write to temporary file failed
- $!"
1006 if syswrite($rstate->{outfh}, $rest) != $len;
1007 $rstate->{ctx}->add($rest);
1008 $rstate->{params}->{filename} = $rstate->{filename};
1009 $rstate->{md5sum} = $rstate->{ctx}->hexdigest;
1010 $rstate->{bytes} += $len;
1011 $rstate->{phase} = $eof ? 100 : 0;
1013 my $len = length($hdl->{rbuf});
1014 my $wlen = $len - $rstate->{boundlen};
1016 my $data = substr($hdl->{rbuf}, 0, $wlen, '');
1017 die "write to temporary file failed
- $!"
1018 if syswrite($rstate->{outfh}, $data) != $wlen;
1019 $rstate->{bytes} += $wlen;
1020 $rstate->{ctx}->add($data);
1023 } elsif ($rstate->{phase} == 2) { # inside normal field
1025 if ($hdl->{rbuf} =~ s/^(.*?)\015?\012(--\Q$boundary\E(--)? \015?\012(.*))$/$2/xs) {
1026 my ($rest, $eof) = ($1, $3);
1027 my $len = length($rest);
1028 $rstate->{post_size} += $len;
1029 if ($rstate->{post_size} < $limit_max_post) {
1030 $rstate->{params}->{$rstate->{fieldname}} = $rest;
1031 $rstate->{phase} = $eof ? 100 : 0;
1033 syslog('err', "form data to large
- abort upload
");
1034 $rstate->{phase} = -1; # skip
1038 my $len = length($hdl->{rbuf});
1039 substr($hdl->{rbuf}, 0, $len, ''); # empty rbuf
1042 $rstate->{read} += ($startlen - length($hdl->{rbuf}));
1044 if (!$rstate->{done} && ($rstate->{read} + length($hdl->{rbuf})) >= $rstate->{size}) {
1045 $rstate->{done} = 1; # make sure we dont get called twice
1046 if ($rstate->{phase} < 0 || !$rstate->{md5sum}) {
1047 die "upload failed
\n";
1049 my $elapsed = tv_interval($rstate->{starttime});
1051 my $rate = int($rstate->{bytes}/($elapsed*1024*1024));
1052 syslog('info', "multipart upload complete
" .
1053 "(size
: %d time: %ds rate
: %.2fMiB
/s md5sum
: $rstate->{md5sum
})",
1054 $rstate->{bytes}, $elapsed, $rate);
1055 $self->handle_api2_request($reqstate, $auth, $method, $path, $rstate);
1060 syslog('err', $err);
1061 $self->error($reqstate, 501, $err);
1065 sub parse_content_type {
1068 my ($ct, @params) = split(/\s*[;,]\s*/o, $ctype);
1070 foreach my $v (@params) {
1071 if ($v =~ m/^\s*boundary\s*=\s*(\S+?)\s*$/o) {
1072 return wantarray ? ($ct, $1) : $ct;
1076 return wantarray ? ($ct) : $ct;
1079 sub parse_content_disposition {
1082 my ($disp, @params) = split(/\s*[;,]\s*/o, $line);
1086 foreach my $v (@params) {
1087 if ($v =~ m/^\s*name\s*=\s*(\S+?)\s*$/o) {
1089 $name =~ s/^"(.*)"$/$1/;
1090 } elsif ($v =~ m/^\s*filename\s*=\s*(.+?)\s*$/o) {
1092 $filename =~ s/^"(.*)"$/$1/;
1096 return wantarray ? ($disp, $name, $filename) : $disp;
1099 my $tmpfile_seq_no = 0;
1101 sub get_upload_filename {
1102 # choose unpredictable tmpfile name
1105 return "/var/tmp
/pveupload-
" . Digest::MD5::md5_hex($tmpfile_seq_no . time() . $$);
1108 sub unshift_read_header {
1109 my ($self, $reqstate, $state) = @_;
1111 $state = { size => 0, count => 0 } if !$state;
1113 $reqstate->{hdl}->unshift_read(line => sub {
1114 my ($hdl, $line) = @_;
1117 # print "$$: got header
: $line\n" if $self->{debug};
1119 die "to many http header lines
\n" if ++$state->{count} >= $limit_max_headers;
1120 die "http header too large
\n" if ($state->{size} += length($line)) >= $limit_max_header_size;
1122 my $r = $reqstate->{request};
1125 my $path = uri_unescape($r->uri->path());
1126 my $method = $r->method();
1128 $r->push_header($state->{key}, $state->{val})
1131 if (!$known_methods->{$method}) {
1132 my $resp = HTTP::Response->new(HTTP_NOT_IMPLEMENTED, "method '$method' not available
");
1133 $self->response($reqstate, $resp);
1137 my $conn = $r->header('Connection');
1138 my $accept_enc = $r->header('Accept-Encoding');
1139 $reqstate->{accept_gzip} = ($accept_enc && $accept_enc =~ m/gzip/) ? 1 : 0;
1142 $reqstate->{keep_alive} = 0 if $conn =~ m/close/oi;
1144 if ($reqstate->{proto}->{ver} < 1001) {
1145 $reqstate->{keep_alive} = 0;
1149 my $te = $r->header('Transfer-Encoding');
1150 if ($te && lc($te) eq 'chunked') {
1151 # Handle chunked transfer encoding
1152 $self->error($reqstate, 501, "chunked transfer encoding
not supported
");
1155 $self->error($reqstate, 501, "Unknown transfer encoding
'$te'");
1159 my $pveclientip = $r->header('PVEClientIP');
1160 my $base_uri = $self->{base_uri};
1162 # fixme: how can we make PVEClientIP header trusted?
1163 if ($self->{trusted_env} && $pveclientip) {
1164 $reqstate->{peer_host} = $pveclientip;
1166 $r->header('PVEClientIP', $reqstate->{peer_host});
1169 my $len = $r->header('Content-Length');
1171 # header processing complete - authenticate now
1174 if ($self->{spiceproxy}) {
1175 my $connect_str = $r->header('Host');
1176 my ($vmid, $node, $port) = $self->verify_spice_connect_url($connect_str);
1177 if (!(defined($vmid) && $node && $port)) {
1178 $self->error($reqstate, HTTP_UNAUTHORIZED, "invalid ticket
");
1181 $self->handle_spice_proxy_request($reqstate, $connect_str, $vmid, $node, $port);
1183 } elsif ($path =~ m/^\Q$base_uri\E/) {
1184 my $token = $r->header('CSRFPreventionToken');
1185 my $cookie = $r->header('Cookie');
1186 my $ticket = PVE::APIServer::Formatter::extract_auth_cookie($cookie, $self->{cookie_name});
1188 my ($rel_uri, $format) = &$split_abs_uri($path, $self->{base_uri});
1190 $self->error($reqstate, HTTP_NOT_IMPLEMENTED, "no such uri
");
1195 $auth = $self->auth_handler($method, $rel_uri, $ticket, $token,
1196 $reqstate->{peer_host});
1200 Net::SSLeay::ERR_clear_error();
1201 # always delay unauthorized calls by 3 seconds
1203 if (my $formatter = PVE::APIServer::Formatter::get_login_formatter($format)) {
1204 my ($raw, $ct, $nocomp) =
1205 $formatter->($path, $auth, $self->{formatter_config});
1207 if (ref($raw) && (ref($raw) eq 'HTTP::Response')) {
1210 $resp = HTTP::Response->new(HTTP_UNAUTHORIZED, "Login Required
");
1211 $resp->header("Content-Type
" => $ct);
1212 $resp->content($raw);
1214 $self->response($reqstate, $resp, undef, $nocomp, $delay);
1216 my $resp = HTTP::Response->new(HTTP_UNAUTHORIZED, $err);
1217 $self->response($reqstate, $resp, undef, 0, $delay);
1223 $reqstate->{log}->{userid} = $auth->{userid};
1227 if (!($method eq 'PUT' || $method eq 'POST')) {
1228 $self->error($reqstate, 501, "Unexpected content
for method '$method'");
1232 my $ctype = $r->header('Content-Type');
1233 my ($ct, $boundary) = parse_content_type($ctype) if $ctype;
1235 if ($auth->{isUpload} && !$self->{trusted_env}) {
1236 die "upload
'Content-Type '$ctype' not implemented\n"
1237 if !($boundary && $ct && ($ct eq 'multipart
/form-data
'));
1239 die "upload without content length header not supported" if !$len;
1241 die "upload without content length header not supported" if !$len;
1243 print "start upload $path $ct $boundary\n" if $self->{debug};
1245 my $tmpfilename = get_upload_filename();
1246 my $outfh = IO::File->new($tmpfilename, O_RDWR|O_CREAT|O_EXCL, 0600) ||
1247 die "unable to create temporary upload file '$tmpfilename'";
1249 $reqstate->{keep_alive} = 0;
1251 my $boundlen = length($boundary) + 8; # \015?\012--$boundary--\015?\012
1255 boundary => $boundary,
1256 ctx => Digest::MD5->new,
1257 boundlen => $boundlen,
1258 maxheader => 2048 + $boundlen, # should be large enough
1259 params => decode_urlencoded($r->url->query()),
1263 starttime => [gettimeofday],
1266 $reqstate->{tmpfilename} = $tmpfilename;
1267 $reqstate->{hdl}->on_read(sub { $self->file_upload_multipart($reqstate, $auth, $method, $path, $state); });
1271 if ($len > $limit_max_post) {
1272 $self->error($reqstate, 501, "for data too large");
1276 if (!$ct || $ct eq 'application
/x-www-form-urlencoded
') {
1277 $reqstate->{hdl}->unshift_read(chunk => $len, sub {
1278 my ($hdl, $data) = @_;
1280 $self->handle_request($reqstate, $auth, $method, $path);
1283 $self->error($reqstate, 506, "upload 'Content-Type
'$ctype' not implemented
");
1286 $self->handle_request($reqstate, $auth, $method, $path);
1288 } elsif ($line =~ /^([^:\s]+)\s*:\s*(.*)/) {
1289 $r->push_header($state->{key}, $state->{val}) if $state->{key};
1290 ($state->{key}, $state->{val}) = ($1, $2);
1291 $self->unshift_read_header($reqstate, $state);
1292 } elsif ($line =~ /^\s+(.*)/) {
1293 $state->{val} .= " $1";
1294 $self->unshift_read_header($reqstate, $state);
1296 $self->error($reqstate, 506, "unable to parse request header
");
1303 sub push_request_header {
1304 my ($self, $reqstate) = @_;
1307 $reqstate->{hdl}->push_read(line => sub {
1308 my ($hdl, $line) = @_;
1311 # print "got request header
: $line\n" if $self->{debug};
1313 $reqstate->{keep_alive}--;
1315 if ($line =~ /(\S+)\040(\S+)\040HTTP\/(\d+)\.(\d+)/o) {
1316 my ($method, $url, $maj, $min) = ($1, $2, $3, $4);
1319 $self->error($reqstate, 506, "http protocol version
$maj.$min not supported
");
1323 $self->{request_count}++; # only count valid request headers
1324 if ($self->{request_count} >= $self->{max_requests}) {
1325 $self->{end_loop} = 1;
1327 $reqstate->{log} = { requestline => $line };
1328 $reqstate->{proto}->{str} = "HTTP
/$maj.$min";
1329 $reqstate->{proto}->{maj} = $maj;
1330 $reqstate->{proto}->{min} = $min;
1331 $reqstate->{proto}->{ver} = $maj*1000+$min;
1332 $reqstate->{request} = HTTP::Request->new($method, $url);
1333 $reqstate->{starttime} = [gettimeofday],
1335 $self->unshift_read_header($reqstate);
1336 } elsif ($line eq '') {
1337 # ignore empty lines before requests (browser bugs?)
1338 $self->push_request_header($reqstate);
1340 $self->error($reqstate, 400, 'bad request');
1354 return if $self->{end_loop};
1356 # we need to m make sure that only one process calls accept
1357 while (!flock($self->{lockfh}, Fcntl::LOCK_EX())) {
1358 next if $! == EINTR;
1359 die "could
not get
lock on file
'$self->{lockfile}' - $!\n";
1365 while (!$self->{end_loop} &&
1366 !defined($clientfh = $self->{socket}->accept()) &&
1369 if ($self->{end_loop}) {
1372 $again = ($! == EAGAIN || $! == WSAEWOULDBLOCK);
1373 if (!defined($clientfh)) {
1374 $errmsg = "failed to
accept connection
: $!\n";
1380 flock($self->{lockfh}, Fcntl::LOCK_UN());
1382 if (!defined($clientfh)) {
1384 die $errmsg if $errmsg;
1387 fh_nonblocking $clientfh, 1;
1389 $self->{conn_count}++;
1397 $self->{end_loop} = 1;
1399 undef $self->{socket_watch};
1401 $0 = "$0 (shutdown)" if $0 !~ m/\(shutdown\)$/;
1403 if ($self->{conn_count} <= 0) {
1404 $self->{end_cond}->send(1);
1408 # fork and exit, so that parent starts a new worker
1413 # else we need to wait until all open connections gets closed
1414 my $w; $w = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1416 # todo: test for active connections instead (we can abort idle connections)
1417 if ($self->{conn_count} <= 0) {
1419 $self->{end_cond}->send(1);
1427 sub check_host_access {
1428 my ($self, $clientip) = @_;
1430 my $cip = Net::IP->new($clientip);
1432 my $match_allow = 0;
1435 if ($self->{allow_from}) {
1436 foreach my $t (@{$self->{allow_from}}) {
1437 if ($t->overlaps($cip)) {
1444 if ($self->{deny_from}) {
1445 foreach my $t (@{$self->{deny_from}}) {
1446 if ($t->overlaps($cip)) {
1453 if ($match_allow == $match_deny) {
1454 # match both allow and deny, or no match
1455 return $self->{policy} && $self->{policy} eq 'allow' ? 1 : 0;
1458 return $match_allow;
1461 sub accept_connections {
1466 while (my $clientfh = $self->accept()) {
1468 my $reqstate = { keep_alive => $self->{keep_alive} };
1470 # stop keep-alive when there are many open connections
1471 if ($self->{conn_count} >= $self->{max_conn_soft_limit}) {
1472 $reqstate->{keep_alive} = 0;
1475 if (my $sin = getpeername($clientfh)) {
1476 my ($pfamily, $pport, $phost) = PVE::Tools::unpack_sockaddr_in46($sin);
1477 ($reqstate->{peer_port}, $reqstate->{peer_host}) = ($pport, Socket::inet_ntop($pfamily, $phost));
1480 if (!$self->{trusted_env} && !$self->check_host_access($reqstate->{peer_host})) {
1481 print "$$: ABORT request from
$reqstate->{peer_host
} - access denied
\n" if $self->{debug};
1482 $reqstate->{log}->{code} = 403;
1483 $self->log_request($reqstate);
1487 $reqstate->{hdl} = AnyEvent::Handle->new(
1489 rbuf_max => 64*1024,
1490 timeout => $self->{timeout},
1491 linger => 0, # avoid problems with ssh - really needed ?
1495 $self->log_aborted_request($reqstate);
1496 $self->client_do_disconnect($reqstate);
1498 if (my $err = $@) { syslog('err', $err); }
1501 my ($hdl, $fatal, $message) = @_;
1503 $self->log_aborted_request($reqstate, $message);
1504 $self->client_do_disconnect($reqstate);
1506 if (my $err = $@) { syslog('err', "$err"); }
1508 ($self->{tls_ctx} ? (tls => "accept", tls_ctx => $self->{tls_ctx}) : ()));
1510 print "$$: ACCEPT FH
" . $clientfh->fileno() . " CONN
$self->{conn_count
}\n" if $self->{debug};
1512 $self->push_request_header($reqstate);
1517 syslog('err', $err);
1518 $self->{end_loop} = 1;
1521 $self->wait_end_loop() if $self->{end_loop};
1524 # Note: We can't open log file in non-blocking mode and use AnyEvent::Handle,
1525 # because we write from multiple processes, and that would arbitrarily mix output
1527 sub open_access_log {
1528 my ($self, $filename) = @_;
1530 my $old_mask = umask(0137);;
1531 my $logfh = IO::File->new($filename, ">>") ||
1532 die "unable to
open log file
'$filename' - $!\n";
1535 $logfh->autoflush(1);
1537 $self->{logfh} = $logfh;
1541 my ($self, $data) = @_;
1543 return if !defined($self->{logfh}) || !$data;
1545 my $res = $self->{logfh}->print($data);
1548 delete $self->{logfh};
1549 syslog('err', "error writing access
log");
1550 $self->{end_loop} = 1; # terminate asap
1554 sub atfork_handler {
1558 # something else do to ?
1559 close($self->{socket});
1567 $self->{end_cond}->recv;
1571 my ($this, %args) = @_;
1573 my $class = ref($this) || $this;
1575 foreach my $req (qw(socket lockfh lockfile)) {
1576 die "misssing required argument '$req'" if !defined($args{$req});
1579 my $self = bless { %args }, $class;
1581 $self->{cookie_name
} //= 'PVEAuthCookie';
1582 $self->{base_uri
} //= "/api2";
1583 $self->{dirs
} //= {};
1584 $self->{title
} //= 'API Inspector';
1586 # formatter_config: we pass some configuration values to the Formatter
1587 $self->{formatter_config
} = {};
1588 foreach my $p (qw(cookie_name base_uri title)) {
1589 $self->{formatter_config
}->{$p} = $self->{$p};
1591 $self->{formatter_config
}->{csrfgen_func
} =
1592 $self->can('generate_csrf_prevention_token');
1594 # add default dirs which includes jquery and bootstrap
1595 my $base = '/usr/share/libpve-http-server-perl';
1596 add_dirs
($self->{dirs
}, '/css/' => "$base/css/");
1597 add_dirs
($self->{dirs
}, '/js/' => "$base/js/");
1598 add_dirs
($self->{dirs
}, '/fonts/' => "$base/fonts/");
1601 PVE
::INotify
::inotify_init
();
1603 fh_nonblocking
($self->{socket}, 1);
1605 $self->{end_loop
} = 0;
1606 $self->{conn_count
} = 0;
1607 $self->{request_count
} = 0;
1608 $self->{timeout
} = 5 if !$self->{timeout
};
1609 $self->{keep_alive
} = 0 if !defined($self->{keep_alive
});
1610 $self->{max_conn
} = 800 if !$self->{max_conn
};
1611 $self->{max_requests
} = 8000 if !$self->{max_requests
};
1613 $self->{policy
} = 'allow' if !$self->{policy
};
1615 $self->{end_cond
} = AnyEvent-
>condvar;
1618 $self->{tls_ctx
} = AnyEvent
::TLS-
>new(%{$self->{ssl
}});
1619 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
);
1622 if ($self->{spiceproxy
}) {
1623 $known_methods = { CONNECT
=> 1 };
1626 $self->open_access_log($self->{logfile
}) if $self->{logfile
};
1628 $self->{max_conn_soft_limit
} = $self->{max_conn
} > 100 ?
$self->{max_conn
} - 20 : $self->{max_conn
};
1630 $self->{socket_watch
} = AnyEvent-
>io(fh
=> $self->{socket}, poll
=> 'r', cb
=> sub {
1632 if ($self->{conn_count
} >= $self->{max_conn
}) {
1633 my $w; $w = AnyEvent-
>timer (after
=> 1, interval
=> 1, cb
=> sub {
1634 if ($self->{conn_count
} < $self->{max_conn
}) {
1636 $self->accept_connections();
1640 $self->accept_connections();
1646 $self->{term_watch
} = AnyEvent-
>signal(signal
=> "TERM", cb
=> sub {
1647 undef $self->{term_watch
};
1648 $self->wait_end_loop();
1651 $self->{quit_watch
} = AnyEvent-
>signal(signal
=> "QUIT", cb
=> sub {
1652 undef $self->{quit_watch
};
1653 $self->wait_end_loop();
1656 $self->{inotify_poll
} = AnyEvent-
>timer(after
=> 5, interval
=> 5, cb
=> sub {
1657 PVE
::INotify
::poll
(); # read inotify events
1663 # static helper to add directory including all subdirs
1664 # This can be used to setup $self->{dirs}
1666 my ($result_hash, $alias, $subdir) = @_;
1668 $result_hash->{$alias} = $subdir;
1671 my $dir = $File::Find
::dir
;
1672 if ($dir =~m!^$subdir(.*)$!) {
1673 my $name = "$alias$1/";
1674 $result_hash->{$name} = "$dir/";
1678 find
({wanted
=> $wanted, follow
=> 0, no_chdir
=> 1}, $subdir);
1681 # abstract functions - subclass should overwrite/implement them
1683 sub verify_spice_connect_url
{
1684 my ($self, $connect_str) = @_;
1688 #return ($vmid, $node, $port);
1691 # formatters can call this when the generate a new page
1692 sub generate_csrf_prevention_token
{
1693 my ($username) = @_;
1695 return undef; # do nothing by default
1699 my ($self, $method, $rel_uri, $ticket, $token, $peer_host) = @_;
1704 # ticket => $ticket,
1706 # userid => $username,
1708 # isUpload => $isUpload,
1713 my ($self, $clientip, $method, $rel_uri, $auth, $params) = @_;
1715 # please do not raise exceptions here (always return a result).
1718 status
=> HTTP_NOT_IMPLEMENTED
,
1719 message
=> "Method '$method $rel_uri' not implemented",
1722 # this should return the following properties, which
1723 # are then passed to the Formatter
1725 # status: HTTP status code
1726 # message: Error message
1727 # errors: more detailed error hash (per parameter)
1728 # info: reference to JSON schema definition - useful to format output
1731 # total: additional info passed to output
1732 # changes: additional info passed to output
1734 # if you want to proxy the request to another node return this
1735 # { proxy => $remip, proxynode => $node, proxy_params => $params };
1737 # to pass the request to the local priviledged daemon use:
1738 # { proxy => 'localhost' , proxy_params => $params };
1741 sub check_cert_fingerprint
{
1742 my ($self, $cert) = @_;
1747 sub initialize_cert_cache
{
1748 my ($self, $node) = @_;
1753 sub remote_node_ip
{
1754 my ($self, $node) = @_;