1 package PVE
::HTTPServer
;
5 use Socket
qw(IPPROTO_TCP TCP_NODELAY SOMAXCONN);
6 use POSIX
qw(strftime EINTR EAGAIN);
10 use AnyEvent
::Util
qw(guard fh_nonblocking WSAEWOULDBLOCK WSAEINPROGRESS);
19 use PVE
::RPCEnvironment
;
23 use HTTP
::Status
qw(:constants);
27 use CGI
; # fixme: remove this!
28 # DOS attack prevention
29 # fixme: remove CGI.pm
30 $CGI::DISABLE_UPLOADS
= 1; # no uploads
31 $CGI::POST_MAX
= 1024 * 10; # max 10K posts
33 use Scalar
::Util qw
/weaken/; # fixme: remove?
34 use Data
::Dumper
; # fixme: remove
44 my ($self, $reqstate) = @_;
46 my $loginfo = $reqstate->{log};
48 # like apache2 common log format
49 # LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\""
51 my $peerip = $reqstate->{peer_host
} || '-';
52 my $userid = $loginfo->{userid
} || '-';
53 my $content_length = defined($loginfo->{content_length
}) ?
$loginfo->{content_length
} : '-';
54 my $code = $loginfo->{code
} || 500;
55 my $requestline = $loginfo->{requestline
} || '-';
56 my $timestr = strftime
("%d/%b/%Y:%H:%M:%S %z", localtime());
58 my $msg = "$peerip - $userid [$timestr] \"$requestline\" $code $content_length\n";
60 $self->write_log($msg);
63 sub log_aborted_request {
64 my ($self, $reqstate, $error) = @_;
66 my $r = $reqstate->{request};
67 return if !$r; # no active request
70 syslog("err
", "problem with client
$reqstate->{peer_host
}; $error");
73 $self->log_request($reqstate);
76 sub client_do_disconnect {
77 my ($self, $reqstate) = @_;
79 my $hdl = delete $reqstate->{hdl};
82 syslog('err', "detected empty handle
");
86 #print "close connection
$hdl\n";
88 shutdown($hdl->{fh}, 1);
90 $hdl->on_drain(undef);
93 $self->{conn_count}--;
95 #print "$$: client_do_disconnect
$self->{conn_count
} $hdl\n";
99 my ($self, $reqstate) = @_;
101 my $hdl = $reqstate->{hdl};
103 delete $reqstate->{log};
104 delete $reqstate->{request};
105 delete $reqstate->{proto};
107 if (!$self->{end_loop} && $reqstate->{keep_alive} > 0) {
108 # print "KEEPALIVE
$reqstate->{keep_alive
}\n";
110 eval { $self->push_request_header($reqstate); };
114 $hdl->on_drain (sub {
116 $self->client_do_disconnect($reqstate);
124 my ($self, $reqstate, $resp, $mtime, $nocomp) = @_;
126 #print "$$: send response
: " . Dumper($resp);
128 my $code = $resp->code;
129 my $msg = $resp->message || HTTP::Status::status_message($code);
130 ($msg) = $msg =~m/^(.*)$/m;
131 my $content = $resp->content;
133 if ($code =~ /^(1\d\d|[23]04)$/) {
134 # make sure content we have no content
138 $reqstate->{keep_alive} = 0 if ($code >= 300) || $self->{end_loop};
140 $reqstate->{log}->{code} = $code;
142 my $res = "HTTP
/1.0 $code $msg\015\012";
145 my $date = HTTP::Date::time2str($ctime);
146 $resp->header('Date' => $date);
148 $resp->header('Last-Modified' => HTTP::Date::time2str($mtime));
150 $resp->header('Expires' => $date);
151 $resp->header('Cache-Control' => "max-age
=0");
152 $resp->header("Pragma
", "no-cache
");
155 $resp->header('Server' => "pve-api-daemon
/3.0");
158 if (ref($content) eq "CODE
") {
159 $reqstate->{keep_alive} = 0;
165 $content_length = length($content);
167 if (!$nocomp && ($content_length > 1024)) {
168 my $comp = Compress::Zlib::memGzip($content);
169 $resp->header('Content-Encoding', 'gzip');
171 $content_length = length($content);
173 $resp->header("Content-Length
" => $content_length);
174 $reqstate->{log}->{content_length} = $content_length;
176 $resp->remove_header("Content-Length
");
179 if ($reqstate->{keep_alive} > 0) {
180 $resp->push_header('Connection' => 'Keep-Alive');
182 $resp->header('Connection' => 'close');
185 $res .= $resp->headers_as_string("\015\012");
186 #print "SEND
(supress content
) $res\n";
191 $self->log_request($reqstate, $reqstate->{request});
193 $reqstate->{hdl}->push_write($res);
194 $self->finish_response($reqstate);
198 my ($self, $reqstate, $code, $msg, $hdr, $content) = @_;
201 my $resp = HTTP::Response->new($code, $msg, $hdr, $content);
202 $self->response($reqstate, $resp);
207 sub send_file_start {
208 my ($self, $reqstate, $filename) = @_;
211 # print "SEND FILE
$filename\n";
212 # Note: aio_load() this is not really async unless we use IO::AIO!
215 my $fh = IO::File->new($filename, '<') ||
217 my $stat = File::stat::stat($fh) ||
221 my $len = sysread($fh, $data, $stat->size);
222 die "got short file
\n" if !defined($len) || $len != $stat->size;
225 if ($filename =~ m/\.css$/) {
227 } elsif ($filename =~ m/\.js$/) {
228 $ct = 'application/javascript';
229 } elsif ($filename =~ m/\.png$/) {
231 } elsif ($filename =~ m/\.gif$/) {
233 } elsif ($filename =~ m/\.jar$/) {
234 $ct = 'application/java-archive';
236 die "unable to detect content type
";
239 my $header = HTTP::Headers->new(Content_Type => $ct);
240 my $resp = HTTP::Response->new(200, "OK
", $header, $data);
241 $self->response($reqstate, $resp, $stat->mtime);
244 $self->error($reqstate, 501, $err);
252 my ($self, $reqstate, $r, $clientip, $host, $method, $abs_uri, $ticket, $token, $params) = @_;
256 if ($host eq 'localhost') {
257 $target = "http
://$host:85$abs_uri";
259 $target = "https
://$host:8006$abs_uri";
263 PVEDisableProxy => 'true',
264 PVEClientIP => $clientip,
267 my $cookie_name = 'PVEAuthCookie';
269 $headers->{'cookie'} = PVE::REST::create_auth_cookie($ticket) if $ticket;
270 $headers->{'CSRFPreventionToken'} = $token if $token;
274 if ($method eq 'POST' || $method eq 'PUT') {
275 $headers->{'Content-Type'} = 'application/x-www-form-urlencoded';
276 # We use a temporary URI object to format
277 # the application/x-www-form-urlencoded content.
278 my $url = URI->new('http:');
279 $url->query_form(%$params);
280 $content = $url->query;
281 if (defined($content)) {
282 $headers->{'Content-Length'} = length($content);
288 my $w; $w = http_request(
295 my ($body, $hdr) = @_;
300 my $code = delete $hdr->{Status};
301 my $msg = delete $hdr->{Reason};
303 delete $hdr->{HTTPVersion};
304 my $header = HTTP::Headers->new(%$hdr);
305 my $resp = HTTP::Response->new($code, $msg, $header, $body);
306 $self->response($reqstate, $resp, undef, 1);
314 my $extract_params = sub {
315 my ($r, $method) = @_;
317 # NOTE: HTTP::Request::Params return undef instead of ''
318 #my $parser = HTTP::Request::Params->new({req => $r});
319 #my $params = $parser->params;
321 my $post_params = {};
323 if ($method eq 'PUT' || $method eq 'POST') {
324 $post_params = CGI->new($r->content())->Vars;
327 my $query_params = CGI->new($r->url->query)->Vars;
328 my $params = $post_params || {};
330 foreach my $k (keys %{$query_params}) {
331 $params->{$k} = $query_params->{$k};
334 return PVE::Tools::decode_utf8_parameters($params);
337 sub handle_api2_request {
338 my ($self, $reqstate) = @_;
341 my $r = $reqstate->{request};
342 my $method = $r->method();
343 my $path = $r->uri->path();
345 my ($rel_uri, $format) = PVE::REST::split_abs_uri($path);
347 $self->error($reqstate, HTTP_NOT_IMPLEMENTED, "no such uri
");
351 my $rpcenv = $self->{rpcenv};
352 my $headers = $r->headers;
354 my $token = $headers->header('CSRFPreventionToken');
356 my $cookie = $headers->header('Cookie');
358 my $ticket = PVE::REST::extract_auth_cookie($cookie);
360 my $params = &$extract_params($r, $method);
362 my $clientip = $headers->header('PVEClientIP');
364 $rpcenv->init_request(params => $params);
366 my $res = PVE::REST::rest_handler($rpcenv, $clientip, $method, $path, $rel_uri, $ticket, $token);
368 # fixme: eval { $userid = $rpcenv->get_user(); };
369 my $userid = $rpcenv->{user}; # this is faster
370 $rpcenv->set_user(undef); # clear after request
372 $reqstate->{log}->{userid} = $userid;
376 if ($self->{trusted_env}) {
377 $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy
not allowed
");
381 $self->proxy_request($reqstate, $r, $clientip, $res->{proxy}, $method,
382 $r->uri, $ticket, $token, $res->{proxy_params});
387 PVE::REST::prepare_response_data($format, $res);
388 my ($raw, $ct) = PVE::REST::format_response_data($format, $res, $path);
390 my $resp = HTTP::Response->new($res->{status}, $res->{message});
391 $resp->header("Content-Type
" => $ct);
392 $resp->content($raw);
393 $self->response($reqstate, $resp);
401 my ($self, $reqstate) = @_;
403 #print "REQUEST
" . Dumper($reqstate->{request});
406 my $r = $reqstate->{request};
407 my $method = $r->method();
408 my $path = $r->uri->path();
410 # print "REQUEST
$path\n";
412 if (!$known_methods->{$method}) {
413 my $resp = HTTP::Response->new(HTTP_NOT_IMPLEMENTED, "method '$method' not available
");
414 $self->response($reqstate, $resp);
418 if ($path =~ m!/api2!) {
419 $self->handle_api2_request($reqstate);
423 if ($self->{pages} && ($method eq 'GET') && (my $handler = $self->{pages}->{$path})) {
424 if (ref($handler) eq 'CODE') {
425 my ($resp, $userid) = &$handler($self, $reqstate->{request});
426 $self->response($reqstate, $resp);
427 } elsif (ref($handler) eq 'HASH') {
428 if (my $filename = $handler->{file}) {
429 my $fh = IO::File->new($filename) ||
430 die "unable to
open file
'$filename' - $!\n";
431 send_file_start($self, $reqstate, $filename);
433 die "internal error
- no handler
";
436 die "internal error
- no handler
";
441 if ($self->{dirs} && ($method eq 'GET')) {
442 # we only allow simple names
443 if ($path =~ m!^(/\S+/)([a-zA-Z0-9\-\_\.]+)$!) {
444 my ($subdir, $file) = ($1, $2);
445 if (my $dir = $self->{dirs}->{$subdir}) {
446 my $filename = "$dir$file";
447 my $fh = IO::File->new($filename) ||
448 die "unable to
open file
'$filename' - $!\n";
449 send_file_start($self, $reqstate, $filename);
455 die "no such file
'$path'";
458 $self->error($reqstate, 501, $err);
462 sub unshift_read_header {
463 my ($self, $reqstate, $state) = @_;
465 $state = {} if !$state;
467 $reqstate->{hdl}->unshift_read(line => sub {
468 my ($hdl, $line) = @_;
471 #print "$$: got header
: $line\n";
473 my $r = $reqstate->{request};
476 $r->push_header($state->{key}, $state->{val})
479 my $conn = $r->header('Connection');
482 $reqstate->{keep_alive} = 0 if $conn =~ m/close/oi;
484 if ($reqstate->{proto}->{ver} < 1001) {
485 $reqstate->{keep_alive} = 0;
489 # how much content to read?
490 my $te = $r->header('Transfer-Encoding');
491 my $len = $r->header('Content-Length');
492 my $pveclientip = $r->header('PVEClientIP');
495 if ($self->{trusted_env} && $pveclientip) {
496 $reqstate->{peer_host} = $pveclientip;
498 $r->header('PVEClientIP', $reqstate->{peer_host});
501 if ($te && lc($te) eq 'chunked') {
502 # Handle chunked transfer encoding
503 $self->error($reqstate, 501, "chunked transfer encoding
not supported
");
505 $self->error($reqstate, 501, "Unknown transfer encoding
'$te'");
506 } elsif (defined($len)) {
507 $reqstate->{hdl}->unshift_read (chunk => $len, sub {
508 my ($hdl, $data) = @_;
510 $self->handle_request($reqstate);
513 $self->handle_request($reqstate);
515 } elsif ($line =~ /^([^:\s]+)\s*:\s*(.*)/) {
516 $r->push_header($state->{key}, $state->{val}) if $state->{key};
517 ($state->{key}, $state->{val}) = ($1, $2);
518 $self->unshift_read_header($reqstate, $state);
519 } elsif ($line =~ /^\s+(.*)/) {
520 $state->{val} .= " $1";
521 $self->unshift_read_header($reqstate, $state);
523 $self->error($reqstate, 506, "unable to parse request header
");
530 sub push_request_header {
531 my ($self, $reqstate) = @_;
534 $reqstate->{hdl}->push_read(line => sub {
535 my ($hdl, $line) = @_;
538 #print "got request header
: $line\n";
540 $reqstate->{keep_alive}--;
542 if ($line =~ /(\S+)\040(\S+)\040HTTP\/(\d+)\.(\d+)/o) {
543 my ($method, $uri, $maj, $min) = ($1, $2, $3, $4);
546 $self->error($reqstate, 506, "http protocol version
$maj.$min not supported
");
550 $self->{request_count}++; # only count valid request headers
551 if ($self->{request_count} >= $self->{max_requests}) {
552 $self->{end_loop} = 1;
554 $reqstate->{log} = { requestline => $line };
555 $reqstate->{proto}->{maj} = $maj;
556 $reqstate->{proto}->{min} = $min;
557 $reqstate->{proto}->{ver} = $maj*1000+$min;
558 $reqstate->{request} = HTTP::Request->new($method, $uri);
560 $self->unshift_read_header($reqstate);
561 } elsif ($line eq '') {
562 # ignore empty lines before requests (browser bugs?)
563 $self->push_request_header($reqstate);
565 $self->error($reqstate, 400, 'bad request');
579 return if $self->{end_loop};
581 # we need to m make sure that only one process calls accept
582 while (!flock($self->{lockfh}, Fcntl::LOCK_EX())) {
584 die "could
not get
lock on file
'$self->{lockfile}' - $!\n";
590 while (!$self->{end_loop} &&
591 !defined($clientfh = $self->{socket}->accept()) &&
594 if ($self->{end_loop}) {
597 $again = ($! == EAGAIN || $! == WSAEWOULDBLOCK);
598 if (!defined($clientfh)) {
599 $errmsg = "failed to
accept connection
: $!\n";
605 flock($self->{lockfh}, Fcntl::LOCK_UN());
607 if (!defined($clientfh)) {
609 die $errmsg if $errmsg;
612 fh_nonblocking $clientfh, 1;
614 $self->{conn_count}++;
616 print "$$: ACCEPT OK
$self->{conn_count
} FH
" . $clientfh->fileno() . "\n";
624 $self->{end_loop} = 1;
626 undef $self->{socket_watch};
628 if ($self->{conn_count} <= 0) {
629 $self->{end_cond}->send(1);
633 # else we need to wait until all open connections gets closed
634 my $w; $w = AnyEvent->timer (after => 1, interval => 1, cb => sub {
636 # fixme: test for active connections instead?
637 if ($self->{conn_count} <= 0) {
639 $self->{end_cond}->send(1);
646 sub accept_connections {
651 while (my $clientfh = $self->accept()) {
653 my $reqstate = { keep_alive => $self->{keep_alive} };
655 if (my $sin = getpeername($clientfh)) {
656 my ($pport, $phost) = Socket::unpack_sockaddr_in($sin);
657 ($reqstate->{peer_port}, $reqstate->{peer_host}) = ($pport, Socket::inet_ntoa($phost));
660 $reqstate->{hdl} = AnyEvent::Handle->new(
662 rbuf_max => 32768, # fixme: set smaller max read buffer ?
663 timeout => $self->{timeout},
664 linger => 0, # avoid problems with ssh - really needed ?
668 $self->log_aborted_request($reqstate);
669 $self->client_do_disconnect($reqstate);
671 if (my $err = $@) { syslog('err', $err); }
674 my ($hdl, $fatal, $message) = @_;
676 $self->log_aborted_request($reqstate, $message);
677 $self->client_do_disconnect($reqstate);
679 if (my $err = $@) { syslog('err', "$err"); }
681 ($self->{tls_ctx} ? (tls => "accept", tls_ctx => $self->{tls_ctx}) : ()));
683 print "$$: ACCEPT OK
$reqstate->{hdl
} $self->{conn_count
}\n";
685 $self->push_request_header($reqstate);
691 $self->{end_loop} = 1;
694 $self->wait_end_loop() if $self->{end_loop};
697 # Note: We can't open log file in non-blocking mode and use AnyEvent::Handle,
698 # because we write from multiple processes, and that would arbitrarily mix output
700 sub open_access_log {
701 my ($self, $filename) = @_;
703 my $old_mask = umask(0137);;
704 my $logfh = IO::File->new($filename, ">>") ||
705 die "unable to
open log file
'$filename' - $!\n";
708 $logfh->autoflush(1);
710 $self->{logfh} = $logfh;
714 my ($self, $data) = @_;
716 return if !defined($self->{logfh}) || !$data;
718 my $res = $self->{logfh}->print($data);
721 delete $self->{logfh};
722 syslog('err', "error writing access
log");
723 $self->{end_loop} = 1; # terminate asap
728 my ($this, %args) = @_;
730 my $class = ref($this) || $this;
732 foreach my $req (qw(rpcenv socket lockfh lockfile)) {
733 die "misssing required argument '$req'" if !defined($args{$req});
736 my $self = bless { %args }, $class;
738 fh_nonblocking
($self->{socket}, 1);
740 $self->{end_loop
} = 0;
741 $self->{conn_count
} = 0;
742 $self->{request_count
} = 0;
743 $self->{timeout
} = 5 if !$self->{timeout
};
744 $self->{keep_alive
} = 0 if !defined($self->{keep_alive
});
745 $self->{max_conn
} = 800 if !$self->{max_conn
};
746 $self->{max_requests
} = 8000 if !$self->{max_requests
};
748 $self->{end_cond
} = AnyEvent-
>condvar;
751 $self->{tls_ctx
} = AnyEvent
::TLS-
>new(%{$self->{ssl
}});
754 $self->open_access_log($self->{logfile
}) if $self->{logfile
};
756 $self->{socket_watch
} = AnyEvent-
>io(fh
=> $self->{socket}, poll
=> 'r', cb
=> sub {
758 if ($self->{conn_count
} >= $self->{max_conn
}) {
759 my $w; $w = AnyEvent-
>timer (after
=> 1, interval
=> 1, cb
=> sub {
760 if ($self->{conn_count
} < $self->{max_conn
}) {
762 $self->accept_connections();
766 $self->accept_connections();
772 $self->{term_watch
} = AnyEvent-
>signal(signal
=> "TERM", cb
=> sub {
773 undef $self->{term_watch
};
774 $self->wait_end_loop();
777 $self->{quit_watch
} = AnyEvent-
>signal(signal
=> "QUIT", cb
=> sub {
778 undef $self->{quit_watch
};
779 $self->wait_end_loop();
788 $self->{end_cond
}->recv;