]>
Commit | Line | Data |
---|---|---|
d08808bc | 1 | package PVE::APIServer::AnyEvent; |
d8218001 | 2 | |
8d88baec DM |
3 | # Note 1: interactions with Crypt::OpenSSL::RSA |
4 | # | |
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(); | |
9 | ||
d8218001 DM |
10 | use strict; |
11 | use warnings; | |
5cef57de TL |
12 | |
13 | use AnyEvent::HTTP; | |
d8218001 | 14 | use AnyEvent::Handle; |
d8218001 | 15 | use AnyEvent::IO; |
5cef57de TL |
16 | use AnyEvent::Socket; |
17 | # use AnyEvent::Strict; # only use this for debugging | |
18 | use AnyEvent::TLS; | |
19 | use AnyEvent::Util qw(guard fh_nonblocking WSAEWOULDBLOCK WSAEINPROGRESS); | |
20 | ||
d8218001 | 21 | use Compress::Zlib; |
5cef57de TL |
22 | use Digest::MD5; |
23 | use Digest::SHA; | |
256da581 | 24 | use Encode; |
5cef57de TL |
25 | use Fcntl (); |
26 | use Fcntl; | |
27 | use File::Find; | |
28 | use File::stat qw(); | |
29 | use IO::File; | |
30 | use MIME::Base64; | |
31 | use Net::SSLeay; | |
32 | use POSIX qw(strftime EINTR EAGAIN); | |
33 | use Socket qw(IPPROTO_TCP TCP_NODELAY SOMAXCONN); | |
34 | use Time::HiRes qw(usleep ualarm gettimeofday tv_interval); | |
d8218001 | 35 | |
5cef57de | 36 | #use Data::Dumper; # FIXME: remove, just use: print to_json([$var], {pretty => 1}) ."\n"; |
d8218001 DM |
37 | use HTTP::Date; |
38 | use HTTP::Headers; | |
39 | use HTTP::Request; | |
40 | use HTTP::Response; | |
5cef57de | 41 | use HTTP::Status qw(:constants); |
3e05f166 | 42 | use JSON; |
5cef57de TL |
43 | use Net::IP; |
44 | use URI::Escape; | |
45 | use URI; | |
46 | ||
47 | use PVE::INotify; | |
48 | use PVE::SafeSyslog; | |
a66b77d8 | 49 | use PVE::Tools qw(trim); |
5cef57de TL |
50 | |
51 | use PVE::APIServer::Formatter; | |
52 | use PVE::APIServer::Utils; | |
d8218001 | 53 | |
e7ee5e3f | 54 | my $limit_max_headers = 64; |
d8218001 | 55 | my $limit_max_header_size = 8*1024; |
967dcb76 | 56 | my $limit_max_post = 64*1024; |
d8218001 | 57 | |
d8218001 DM |
58 | my $known_methods = { |
59 | GET => 1, | |
60 | POST => 1, | |
61 | PUT => 1, | |
62 | DELETE => 1, | |
63 | }; | |
64 | ||
65 | my $split_abs_uri = sub { | |
66 | my ($abs_uri, $base_uri) = @_; | |
67 | ||
68 | my ($format, $rel_uri) = $abs_uri =~ m/^\Q$base_uri\E\/+([a-z][a-z0-9]+)(\/.*)?$/; | |
69 | $rel_uri = '/' if !$rel_uri; | |
70 | ||
71 | return wantarray ? ($rel_uri, $format) : $rel_uri; | |
72 | }; | |
73 | ||
26e73e6b SI |
74 | sub dprint { |
75 | my ($self, $message) = @_; | |
76 | ||
77 | return if !$self->{debug}; | |
78 | ||
79 | my ($pkg, $pkgfile, $line, $sub) = caller(1); | |
80 | $sub =~ s/^(?:.+::)+//; | |
81 | print "worker[$$]: $pkg +$line: $sub: $message\n"; | |
82 | } | |
83 | ||
d8218001 DM |
84 | sub log_request { |
85 | my ($self, $reqstate) = @_; | |
86 | ||
87 | my $loginfo = $reqstate->{log}; | |
88 | ||
89 | # like apache2 common log format | |
90 | # LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\"" | |
91 | ||
92 | return if $loginfo->{written}; # avoid duplicate logs | |
93 | $loginfo->{written} = 1; | |
94 | ||
95 | my $peerip = $reqstate->{peer_host} || '-'; | |
96 | my $userid = $loginfo->{userid} || '-'; | |
97 | my $content_length = defined($loginfo->{content_length}) ? $loginfo->{content_length} : '-'; | |
98 | my $code = $loginfo->{code} || 500; | |
99 | my $requestline = $loginfo->{requestline} || '-'; | |
2fd728c9 | 100 | my $timestr = strftime("%d/%m/%Y:%H:%M:%S %z", localtime()); |
d8218001 DM |
101 | |
102 | my $msg = "$peerip - $userid [$timestr] \"$requestline\" $code $content_length\n"; | |
103 | ||
104 | $self->write_log($msg); | |
105 | } | |
106 | ||
107 | sub log_aborted_request { | |
108 | my ($self, $reqstate, $error) = @_; | |
109 | ||
110 | my $r = $reqstate->{request}; | |
111 | return if !$r; # no active request | |
112 | ||
113 | if ($error) { | |
114 | syslog("err", "problem with client $reqstate->{peer_host}; $error"); | |
115 | } | |
116 | ||
117 | $self->log_request($reqstate); | |
118 | } | |
119 | ||
d8218001 | 120 | sub cleanup_reqstate { |
7fb356b7 | 121 | my ($reqstate, $deletetmpfile) = @_; |
d8218001 DM |
122 | |
123 | delete $reqstate->{log}; | |
124 | delete $reqstate->{request}; | |
125 | delete $reqstate->{proto}; | |
126 | delete $reqstate->{accept_gzip}; | |
127 | delete $reqstate->{starttime}; | |
128 | ||
129 | if ($reqstate->{tmpfilename}) { | |
7fb356b7 | 130 | unlink $reqstate->{tmpfilename} if $deletetmpfile; |
d8218001 DM |
131 | delete $reqstate->{tmpfilename}; |
132 | } | |
133 | } | |
134 | ||
135 | sub client_do_disconnect { | |
136 | my ($self, $reqstate) = @_; | |
137 | ||
7fb356b7 | 138 | cleanup_reqstate($reqstate, 1); |
d8218001 DM |
139 | |
140 | my $shutdown_hdl = sub { | |
141 | my $hdl = shift; | |
142 | ||
143 | shutdown($hdl->{fh}, 1); | |
144 | # clear all handlers | |
145 | $hdl->on_drain(undef); | |
146 | $hdl->on_read(undef); | |
147 | $hdl->on_eof(undef); | |
148 | }; | |
149 | ||
150 | if (my $proxyhdl = delete $reqstate->{proxyhdl}) { | |
b1364a3c FG |
151 | &$shutdown_hdl($proxyhdl) |
152 | if !$proxyhdl->{block_disconnect}; | |
d8218001 DM |
153 | } |
154 | ||
155 | my $hdl = delete $reqstate->{hdl}; | |
156 | ||
157 | if (!$hdl) { | |
158 | syslog('err', "detected empty handle"); | |
159 | return; | |
160 | } | |
161 | ||
26e73e6b | 162 | $self->dprint("close connection $hdl"); |
d8218001 DM |
163 | |
164 | &$shutdown_hdl($hdl); | |
165 | ||
c82d1707 SI |
166 | warn "connection count <= 0!\n" if $self->{conn_count} <= 0; |
167 | ||
d8218001 DM |
168 | $self->{conn_count}--; |
169 | ||
26e73e6b | 170 | $self->dprint("CLOSE FH" . $hdl->{fh}->fileno() . " CONN$self->{conn_count}"); |
d8218001 DM |
171 | } |
172 | ||
173 | sub finish_response { | |
174 | my ($self, $reqstate) = @_; | |
175 | ||
7fb356b7 | 176 | cleanup_reqstate($reqstate, 0); |
d8218001 | 177 | |
133e0586 DM |
178 | my $hdl = $reqstate->{hdl}; |
179 | return if !$hdl; # already disconnected | |
180 | ||
d8218001 DM |
181 | if (!$self->{end_loop} && $reqstate->{keep_alive} > 0) { |
182 | # print "KEEPALIVE $reqstate->{keep_alive}\n" if $self->{debug}; | |
183 | $hdl->on_read(sub { | |
184 | eval { $self->push_request_header($reqstate); }; | |
185 | warn $@ if $@; | |
186 | }); | |
187 | } else { | |
188 | $hdl->on_drain (sub { | |
189 | eval { | |
190 | $self->client_do_disconnect($reqstate); | |
191 | }; | |
192 | warn $@ if $@; | |
193 | }); | |
194 | } | |
195 | } | |
196 | ||
389ad881 SR |
197 | sub response_stream { |
198 | my ($self, $reqstate, $stream_fh) = @_; | |
199 | ||
200 | # disable timeout, we don't know how big the data is | |
201 | $reqstate->{hdl}->timeout(0); | |
202 | ||
203 | my $buf_size = 4*1024*1024; | |
204 | ||
205 | my $on_read; | |
206 | $on_read = sub { | |
207 | my ($hdl) = @_; | |
208 | my $reqhdl = $reqstate->{hdl}; | |
209 | return if !$reqhdl; | |
210 | ||
211 | my $wbuf_len = length($reqhdl->{wbuf}); | |
212 | my $rbuf_len = length($hdl->{rbuf}); | |
213 | # TODO: Take into account $reqhdl->{wbuf_max} ? Right now | |
214 | # that's unbounded, so just assume $buf_size | |
215 | my $to_read = $buf_size - $wbuf_len; | |
216 | $to_read = $rbuf_len if $rbuf_len < $to_read; | |
217 | if ($to_read > 0) { | |
218 | my $data = substr($hdl->{rbuf}, 0, $to_read, ''); | |
219 | $reqhdl->push_write($data); | |
220 | $rbuf_len -= $to_read; | |
221 | } elsif ($hdl->{_eof}) { | |
222 | # workaround: AnyEvent gives us a fake EPIPE if we don't consume | |
223 | # any data when called at EOF, so unregister ourselves - data is | |
224 | # flushed by on_eof anyway | |
225 | # see: https://sources.debian.org/src/libanyevent-perl/7.170-2/lib/AnyEvent/Handle.pm/#L1329 | |
226 | $hdl->on_read(); | |
227 | return; | |
228 | } | |
229 | ||
230 | # apply backpressure so we don't accept any more data into | |
231 | # buffer if the client isn't downloading fast enough | |
232 | # note: read_size can double upon read, and we also need to | |
233 | # account for one more read after start_read, so *4 | |
234 | if ($rbuf_len + $hdl->{read_size}*4 > $buf_size) { | |
235 | # stop reading until write buffer is empty | |
236 | $hdl->on_read(); | |
237 | my $prev_on_drain = $reqhdl->{on_drain}; | |
238 | $reqhdl->on_drain(sub { | |
239 | my ($wrhdl) = @_; | |
240 | # on_drain called because write buffer is empty, continue reading | |
241 | $hdl->on_read($on_read); | |
242 | if ($prev_on_drain) { | |
243 | $wrhdl->on_drain($prev_on_drain); | |
244 | $prev_on_drain->($wrhdl); | |
245 | } | |
246 | }); | |
247 | } | |
248 | }; | |
249 | ||
250 | $reqstate->{proxyhdl} = AnyEvent::Handle->new( | |
251 | fh => $stream_fh, | |
252 | rbuf_max => $buf_size, | |
253 | timeout => 0, | |
254 | on_read => $on_read, | |
255 | on_eof => sub { | |
256 | my ($hdl) = @_; | |
257 | eval { | |
258 | if (my $reqhdl = $reqstate->{hdl}) { | |
259 | $self->log_aborted_request($reqstate); | |
260 | # write out any remaining data | |
261 | $reqhdl->push_write($hdl->{rbuf}) if length($hdl->{rbuf}) > 0; | |
262 | $hdl->{rbuf} = ""; | |
263 | $reqhdl->push_shutdown(); | |
264 | $self->finish_response($reqstate); | |
265 | } | |
266 | }; | |
267 | if (my $err = $@) { syslog('err', "$err"); } | |
268 | $on_read = undef; | |
269 | }, | |
270 | on_error => sub { | |
271 | my ($hdl, $fatal, $message) = @_; | |
272 | eval { | |
273 | $self->log_aborted_request($reqstate, $message); | |
274 | $self->client_do_disconnect($reqstate); | |
275 | }; | |
276 | if (my $err = $@) { syslog('err', "$err"); } | |
277 | $on_read = undef; | |
278 | }, | |
279 | ); | |
280 | } | |
281 | ||
d8218001 | 282 | sub response { |
389ad881 | 283 | my ($self, $reqstate, $resp, $mtime, $nocomp, $delay, $stream_fh) = @_; |
d8218001 DM |
284 | |
285 | #print "$$: send response: " . Dumper($resp); | |
286 | ||
287 | # activate timeout | |
288 | $reqstate->{hdl}->timeout_reset(); | |
289 | $reqstate->{hdl}->timeout($self->{timeout}); | |
290 | ||
025b3038 | 291 | $nocomp = 1 if !$self->{compression}; |
d8218001 DM |
292 | $nocomp = 1 if !$reqstate->{accept_gzip}; |
293 | ||
294 | my $code = $resp->code; | |
295 | my $msg = $resp->message || HTTP::Status::status_message($code); | |
d8218001 DM |
296 | my $content = $resp->content; |
297 | ||
936007ae TL |
298 | # multiline mode only checks \n for $, so explicitly check for any \n or \r afterwards |
299 | ($msg) = $msg =~ m/^(.*)$/m; | |
300 | if ($msg =~ /[\r\n]/) { | |
301 | $code = 400; # bad request from user | |
302 | $msg = HTTP::Status::status_message($code); | |
303 | $content = ''; | |
304 | } | |
305 | ||
d8218001 | 306 | if ($code =~ /^(1\d\d|[23]04)$/) { |
b9a7fd54 | 307 | # make sure informational, no content and not modified response send no content |
d8218001 DM |
308 | $content = ""; |
309 | } | |
310 | ||
311 | $reqstate->{keep_alive} = 0 if ($code >= 400) || $self->{end_loop}; | |
312 | ||
313 | $reqstate->{log}->{code} = $code; | |
314 | ||
315 | my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.0'; | |
316 | my $res = "$proto $code $msg\015\012"; | |
317 | ||
318 | my $ctime = time(); | |
319 | my $date = HTTP::Date::time2str($ctime); | |
320 | $resp->header('Date' => $date); | |
321 | if ($mtime) { | |
322 | $resp->header('Last-Modified' => HTTP::Date::time2str($mtime)); | |
323 | } else { | |
324 | $resp->header('Expires' => $date); | |
325 | $resp->header('Cache-Control' => "max-age=0"); | |
326 | $resp->header("Pragma", "no-cache"); | |
327 | } | |
328 | ||
329 | $resp->header('Server' => "pve-api-daemon/3.0"); | |
330 | ||
331 | my $content_length; | |
389ad881 | 332 | if ($content && !$stream_fh) { |
d8218001 DM |
333 | |
334 | $content_length = length($content); | |
335 | ||
336 | if (!$nocomp && ($content_length > 1024)) { | |
337 | my $comp = Compress::Zlib::memGzip($content); | |
338 | $resp->header('Content-Encoding', 'gzip'); | |
339 | $content = $comp; | |
340 | $content_length = length($content); | |
341 | } | |
342 | $resp->header("Content-Length" => $content_length); | |
343 | $reqstate->{log}->{content_length} = $content_length; | |
344 | ||
345 | } else { | |
346 | $resp->remove_header("Content-Length"); | |
347 | } | |
348 | ||
349 | if ($reqstate->{keep_alive} > 0) { | |
350 | $resp->push_header('Connection' => 'Keep-Alive'); | |
351 | } else { | |
352 | $resp->header('Connection' => 'close'); | |
353 | } | |
354 | ||
355 | $res .= $resp->headers_as_string("\015\012"); | |
356 | #print "SEND(without content) $res\n" if $self->{debug}; | |
357 | ||
358 | $res .= "\015\012"; | |
389ad881 | 359 | $res .= $content if $content && !$stream_fh; |
d8218001 DM |
360 | |
361 | $self->log_request($reqstate, $reqstate->{request}); | |
5f14e56e | 362 | |
389ad881 SR |
363 | if ($stream_fh) { |
364 | # write headers and preamble... | |
365 | $reqstate->{hdl}->push_write($res); | |
366 | # ...then stream data via an AnyEvent::Handle | |
367 | $self->response_stream($reqstate, $stream_fh); | |
368 | } elsif ($delay && $delay > 0) { | |
d8218001 DM |
369 | my $w; $w = AnyEvent->timer(after => $delay, cb => sub { |
370 | undef $w; # delete reference | |
e12e46c9 | 371 | return if !$reqstate->{hdl}; # already disconnected |
d8218001 DM |
372 | $reqstate->{hdl}->push_write($res); |
373 | $self->finish_response($reqstate); | |
374 | }); | |
375 | } else { | |
376 | $reqstate->{hdl}->push_write($res); | |
377 | $self->finish_response($reqstate); | |
378 | } | |
379 | } | |
380 | ||
381 | sub error { | |
382 | my ($self, $reqstate, $code, $msg, $hdr, $content) = @_; | |
383 | ||
384 | eval { | |
385 | my $resp = HTTP::Response->new($code, $msg, $hdr, $content); | |
386 | $self->response($reqstate, $resp); | |
387 | }; | |
388 | warn $@ if $@; | |
389 | } | |
390 | ||
391 | my $file_extension_info = { | |
392 | css => { ct => 'text/css' }, | |
393 | html => { ct => 'text/html' }, | |
394 | js => { ct => 'application/javascript' }, | |
3d12de14 | 395 | json => { ct => 'application/json' }, |
b1e84aa3 | 396 | map => { ct => 'application/json' }, |
d8218001 DM |
397 | png => { ct => 'image/png' , nocomp => 1 }, |
398 | ico => { ct => 'image/x-icon', nocomp => 1}, | |
399 | gif => { ct => 'image/gif', nocomp => 1}, | |
3d12de14 | 400 | svg => { ct => 'image/svg+xml' }, |
d8218001 DM |
401 | jar => { ct => 'application/java-archive', nocomp => 1}, |
402 | woff => { ct => 'application/font-woff', nocomp => 1}, | |
403 | woff2 => { ct => 'application/font-woff2', nocomp => 1}, | |
404 | ttf => { ct => 'application/font-snft', nocomp => 1}, | |
405 | pdf => { ct => 'application/pdf', nocomp => 1}, | |
406 | epub => { ct => 'application/epub+zip', nocomp => 1}, | |
3d12de14 DC |
407 | mp3 => { ct => 'audio/mpeg', nocomp => 1}, |
408 | oga => { ct => 'audio/ogg', nocomp => 1}, | |
80d61dd6 | 409 | tgz => { ct => 'application/x-compressed-tar', nocomp => 1}, |
d8218001 DM |
410 | }; |
411 | ||
412 | sub send_file_start { | |
05e777bc | 413 | my ($self, $reqstate, $download) = @_; |
d8218001 DM |
414 | |
415 | eval { | |
416 | # print "SEND FILE $filename\n"; | |
417 | # Note: aio_load() this is not really async unless we use IO::AIO! | |
418 | eval { | |
419 | ||
420 | my $r = $reqstate->{request}; | |
421 | ||
05e777bc DC |
422 | my $fh; |
423 | my $nocomp; | |
424 | my $mime; | |
425 | ||
426 | if (ref($download) eq 'HASH') { | |
05e777bc | 427 | $mime = $download->{'content-type'}; |
127dbe7c | 428 | my $encoding = $download->{'content-encoding'}; |
9c1388da | 429 | my $disposition = $download->{'content-disposition'}; |
389ad881 | 430 | |
51841e98 SR |
431 | if ($download->{path} && $download->{stream} && |
432 | $reqstate->{request}->header('PVEDisableProxy')) | |
433 | { | |
434 | # avoid double stream from a file, let the proxy handle it | |
435 | die "internal error: file proxy streaming only available for pvedaemon\n" | |
436 | if !$self->{trusted_env}; | |
437 | my $header = HTTP::Headers->new( | |
438 | pvestreamfile => $download->{path}, | |
439 | Content_Type => $mime, | |
440 | ); | |
127dbe7c | 441 | $header->header('Content-Encoding' => $encoding) if defined($encoding); |
9c1388da | 442 | $header->header('Content-Disposition' => $disposition) if defined($disposition); |
51841e98 SR |
443 | # we need some data so Content-Length gets set correctly and |
444 | # the proxy doesn't wait for more data - place a canary | |
445 | my $resp = HTTP::Response->new(200, "OK", $header, "error canary"); | |
446 | $self->response($reqstate, $resp); | |
447 | return; | |
448 | } | |
449 | ||
450 | if (!($fh = $download->{fh})) { | |
451 | my $path = $download->{path}; | |
452 | die "internal error: {download} returned but neither fh not path given\n" | |
453 | if !$path; | |
454 | sysopen($fh, "$path", O_NONBLOCK | O_RDONLY) | |
455 | or die "open stream path '$path' for reading failed: $!\n"; | |
456 | } | |
457 | ||
389ad881 SR |
458 | if ($download->{stream}) { |
459 | my $header = HTTP::Headers->new(Content_Type => $mime); | |
127dbe7c | 460 | $header->header('Content-Encoding' => $encoding) if defined($encoding); |
9c1388da | 461 | $header->header('Content-Disposition' => $disposition) if defined($disposition); |
389ad881 SR |
462 | my $resp = HTTP::Response->new(200, "OK", $header); |
463 | $self->response($reqstate, $resp, undef, 1, 0, $fh); | |
464 | return; | |
465 | } | |
05e777bc DC |
466 | } else { |
467 | my $filename = $download; | |
468 | $fh = IO::File->new($filename, '<') || | |
469 | die "unable to open file '$filename' - $!\n"; | |
470 | ||
471 | my ($ext) = $filename =~ m/\.([^.]*)$/; | |
472 | my $ext_info = $file_extension_info->{$ext}; | |
473 | ||
474 | die "unable to detect content type" if !$ext_info; | |
475 | $mime = $ext_info->{ct}; | |
476 | $nocomp = $ext_info->{nocomp}; | |
477 | } | |
478 | ||
d8218001 DM |
479 | my $stat = File::stat::stat($fh) || |
480 | die "$!\n"; | |
5f14e56e | 481 | |
d8218001 DM |
482 | my $mtime = $stat->mtime; |
483 | ||
484 | if (my $ifmod = $r->header('if-modified-since')) { | |
485 | my $iftime = HTTP::Date::str2time($ifmod); | |
486 | if ($mtime <= $iftime) { | |
487 | my $resp = HTTP::Response->new(304, "NOT MODIFIED"); | |
488 | $self->response($reqstate, $resp, $mtime); | |
489 | return; | |
490 | } | |
491 | } | |
492 | ||
493 | my $data; | |
494 | my $len = sysread($fh, $data, $stat->size); | |
495 | die "got short file\n" if !defined($len) || $len != $stat->size; | |
496 | ||
05e777bc | 497 | my $header = HTTP::Headers->new(Content_Type => $mime); |
d8218001 | 498 | my $resp = HTTP::Response->new(200, "OK", $header, $data); |
05e777bc | 499 | $self->response($reqstate, $resp, $mtime, $nocomp); |
d8218001 DM |
500 | }; |
501 | if (my $err = $@) { | |
502 | $self->error($reqstate, 501, $err); | |
503 | } | |
504 | }; | |
505 | ||
506 | warn $@ if $@; | |
507 | } | |
508 | ||
509 | sub websocket_proxy { | |
510 | my ($self, $reqstate, $wsaccept, $wsproto, $param) = @_; | |
511 | ||
512 | eval { | |
513 | my $remhost; | |
514 | my $remport; | |
515 | ||
ed8d2557 | 516 | my $max_payload_size = 128*1024; |
d8218001 | 517 | |
d8218001 DM |
518 | if ($param->{port}) { |
519 | $remhost = 'localhost'; | |
520 | $remport = $param->{port}; | |
521 | } elsif ($param->{socket}) { | |
522 | $remhost = 'unix/'; | |
523 | $remport = $param->{socket}; | |
524 | } else { | |
525 | die "websocket_proxy: missing port or socket\n"; | |
526 | } | |
527 | ||
c3bd22ec FG |
528 | my $encode = sub { |
529 | my ($data, $opcode) = @_; | |
530 | ||
531 | my $string; | |
532 | my $payload; | |
12014359 DC |
533 | |
534 | $string = $opcode ? $opcode : "\x82"; # binary frame | |
535 | $payload = $$data; | |
c3bd22ec FG |
536 | |
537 | my $payload_len = length($payload); | |
538 | if ($payload_len <= 125) { | |
539 | $string .= pack 'C', $payload_len; | |
540 | } elsif ($payload_len <= 0xffff) { | |
541 | $string .= pack 'C', 126; | |
542 | $string .= pack 'n', $payload_len; | |
543 | } else { | |
544 | $string .= pack 'C', 127; | |
545 | $string .= pack 'Q>', $payload_len; | |
546 | } | |
547 | $string .= $payload; | |
548 | return $string; | |
549 | }; | |
550 | ||
d8218001 | 551 | tcp_connect $remhost, $remport, sub { |
5f14e56e | 552 | my ($fh) = @_ |
d8218001 | 553 | or die "connect to '$remhost:$remport' failed: $!"; |
5f14e56e | 554 | |
26e73e6b | 555 | $self->dprint("CONNECTed to '$remhost:$remport'"); |
d8218001 DM |
556 | |
557 | $reqstate->{proxyhdl} = AnyEvent::Handle->new( | |
558 | fh => $fh, | |
cdb69327 | 559 | rbuf_max => $max_payload_size, |
ed8d2557 | 560 | wbuf_max => $max_payload_size*5, |
d8218001 DM |
561 | timeout => 5, |
562 | on_eof => sub { | |
563 | my ($hdl) = @_; | |
564 | eval { | |
565 | $self->log_aborted_request($reqstate); | |
566 | $self->client_do_disconnect($reqstate); | |
567 | }; | |
568 | if (my $err = $@) { syslog('err', $err); } | |
569 | }, | |
570 | on_error => sub { | |
571 | my ($hdl, $fatal, $message) = @_; | |
572 | eval { | |
573 | $self->log_aborted_request($reqstate, $message); | |
574 | $self->client_do_disconnect($reqstate); | |
575 | }; | |
576 | if (my $err = $@) { syslog('err', "$err"); } | |
577 | }); | |
578 | ||
579 | my $proxyhdlreader = sub { | |
580 | my ($hdl) = @_; | |
5f14e56e | 581 | |
d8218001 | 582 | my $len = length($hdl->{rbuf}); |
cdb69327 | 583 | my $data = substr($hdl->{rbuf}, 0, $len > $max_payload_size ? $max_payload_size : $len, ''); |
d8218001 | 584 | |
c3bd22ec | 585 | my $string = $encode->(\$data); |
d8218001 DM |
586 | |
587 | $reqstate->{hdl}->push_write($string) if $reqstate->{hdl}; | |
588 | }; | |
589 | ||
590 | my $hdlreader = sub { | |
591 | my ($hdl) = @_; | |
592 | ||
ed979f7a RJ |
593 | while (my $len = length($hdl->{rbuf})) { |
594 | return if $len < 2; | |
d8218001 | 595 | |
ed979f7a RJ |
596 | my $hdr = unpack('C', substr($hdl->{rbuf}, 0, 1)); |
597 | my $opcode = $hdr & 0b00001111; | |
598 | my $fin = $hdr & 0b10000000; | |
d8218001 | 599 | |
ed979f7a | 600 | die "received fragmented websocket frame\n" if !$fin; |
d8218001 | 601 | |
ed979f7a RJ |
602 | my $rsv = $hdr & 0b01110000; |
603 | die "received websocket frame with RSV flags\n" if $rsv; | |
d8218001 | 604 | |
ed979f7a | 605 | my $payload_len = unpack 'C', substr($hdl->{rbuf}, 1, 1); |
d8218001 | 606 | |
ed979f7a RJ |
607 | my $masked = $payload_len & 0b10000000; |
608 | die "received unmasked websocket frame from client\n" if !$masked; | |
d8218001 | 609 | |
ed979f7a RJ |
610 | my $offset = 2; |
611 | $payload_len = $payload_len & 0b01111111; | |
612 | if ($payload_len == 126) { | |
613 | return if $len < 4; | |
614 | $payload_len = unpack('n', substr($hdl->{rbuf}, $offset, 2)); | |
615 | $offset += 2; | |
616 | } elsif ($payload_len == 127) { | |
617 | return if $len < 10; | |
618 | $payload_len = unpack('Q>', substr($hdl->{rbuf}, $offset, 8)); | |
619 | $offset += 8; | |
620 | } | |
d8218001 | 621 | |
ed979f7a RJ |
622 | die "received too large websocket frame (len = $payload_len)\n" |
623 | if ($payload_len > $max_payload_size) || ($payload_len < 0); | |
d8218001 | 624 | |
ed979f7a | 625 | return if $len < ($offset + 4 + $payload_len); |
d8218001 | 626 | |
ed979f7a | 627 | my $data = substr($hdl->{rbuf}, 0, $offset + 4 + $payload_len, ''); # now consume data |
5f14e56e | 628 | |
c55702c3 | 629 | my $mask = substr($data, $offset, 4); |
ed979f7a | 630 | $offset += 4; |
d8218001 | 631 | |
ed979f7a | 632 | my $payload = substr($data, $offset, $payload_len); |
d8218001 | 633 | |
c55702c3 FG |
634 | # NULL-mask might be used over TLS, skip to increase performance |
635 | if ($mask ne pack('N', 0)) { | |
636 | # repeat 4 byte mask to payload length + up to 4 byte | |
637 | $mask = $mask x (int($payload_len / 4) + 1); | |
638 | # truncate mask to payload length | |
639 | substr($mask, $payload_len) = ""; | |
640 | # (un-)apply mask | |
641 | $payload ^= $mask; | |
ed979f7a | 642 | } |
d8218001 | 643 | |
ed979f7a RJ |
644 | if ($opcode == 1 || $opcode == 2) { |
645 | $reqstate->{proxyhdl}->push_write($payload) if $reqstate->{proxyhdl}; | |
646 | } elsif ($opcode == 8) { | |
647 | my $statuscode = unpack ("n", $payload); | |
26e73e6b | 648 | $self->dprint("websocket received close. status code: '$statuscode'"); |
b1364a3c | 649 | if (my $proxyhdl = $reqstate->{proxyhdl}) { |
6277311e FG |
650 | $proxyhdl->{block_disconnect} = 1 if length $proxyhdl->{wbuf}; |
651 | ||
b1364a3c FG |
652 | $proxyhdl->push_shutdown(); |
653 | } | |
ed979f7a | 654 | $hdl->push_shutdown(); |
e6cb79b5 FG |
655 | } elsif ($opcode == 9) { |
656 | # ping received, schedule pong | |
657 | $reqstate->{hdl}->push_write($encode->(\$payload, "\x8A")) if $reqstate->{hdl}; | |
658 | } elsif ($opcode == 0xA) { | |
659 | # pong received, continue | |
ed979f7a RJ |
660 | } else { |
661 | die "received unhandled websocket opcode $opcode\n"; | |
d8218001 | 662 | } |
d8218001 DM |
663 | } |
664 | }; | |
665 | ||
666 | my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.1'; | |
667 | ||
668 | $reqstate->{proxyhdl}->timeout(0); | |
669 | $reqstate->{proxyhdl}->on_read($proxyhdlreader); | |
670 | $reqstate->{hdl}->on_read($hdlreader); | |
671 | ||
672 | # todo: use stop_read/start_read if write buffer grows to much | |
673 | ||
1d7da936 FG |
674 | # FIXME: remove protocol in PVE/PMG 8.x |
675 | # | |
e7eb7165 DC |
676 | # for backwards, compatibility, we have to reply with the websocket |
677 | # subprotocol from the request | |
d8218001 DM |
678 | my $res = "$proto 101 Switching Protocols\015\012" . |
679 | "Upgrade: websocket\015\012" . | |
680 | "Connection: upgrade\015\012" . | |
681 | "Sec-WebSocket-Accept: $wsaccept\015\012" . | |
e7eb7165 | 682 | ($wsproto ne "" ? "Sec-WebSocket-Protocol: $wsproto\015\012" : "") . |
d8218001 DM |
683 | "\015\012"; |
684 | ||
26e73e6b | 685 | $self->dprint($res); |
d8218001 DM |
686 | |
687 | $reqstate->{hdl}->push_write($res); | |
688 | ||
689 | # log early | |
690 | $reqstate->{log}->{code} = 101; | |
691 | $self->log_request($reqstate); | |
692 | }; | |
693 | ||
694 | }; | |
695 | if (my $err = $@) { | |
696 | warn $err; | |
697 | $self->log_aborted_request($reqstate, $err); | |
698 | $self->client_do_disconnect($reqstate); | |
699 | } | |
700 | } | |
701 | ||
702 | sub proxy_request { | |
362dd8eb | 703 | my ($self, $reqstate, $clientip, $host, $node, $method, $uri, $auth, $params) = @_; |
d8218001 DM |
704 | |
705 | eval { | |
706 | my $target; | |
707 | my $keep_alive = 1; | |
580d540e TL |
708 | |
709 | # stringify URI object and verify it starts with a slash | |
710 | $uri = "$uri"; | |
711 | if ($uri !~ m@^/@) { | |
712 | $self->error($reqstate, 400, "invalid proxy uri"); | |
713 | return; | |
714 | } | |
715 | ||
e9df8a6e | 716 | my $may_stream_file; |
d8218001 DM |
717 | if ($host eq 'localhost') { |
718 | $target = "http://$host:85$uri"; | |
719 | # keep alive for localhost is not worth (connection setup is about 0.2ms) | |
720 | $keep_alive = 0; | |
e9df8a6e | 721 | $may_stream_file = 1; |
d8218001 DM |
722 | } elsif (Net::IP::ip_is_ipv6($host)) { |
723 | $target = "https://[$host]:8006$uri"; | |
724 | } else { | |
725 | $target = "https://$host:8006$uri"; | |
726 | } | |
727 | ||
728 | my $headers = { | |
729 | PVEDisableProxy => 'true', | |
730 | PVEClientIP => $clientip, | |
731 | }; | |
732 | ||
362dd8eb FG |
733 | $headers->{'cookie'} = PVE::APIServer::Formatter::create_auth_cookie($auth->{ticket}, $self->{cookie_name}) |
734 | if $auth->{ticket}; | |
735 | $headers->{'Authorization'} = PVE::APIServer::Formatter::create_auth_header($auth->{api_token}, $self->{apitoken_name}) | |
736 | if $auth->{api_token}; | |
737 | $headers->{'CSRFPreventionToken'} = $auth->{token} | |
738 | if $auth->{token}; | |
23dfd1b7 | 739 | $headers->{'Accept-Encoding'} = 'gzip' if ($reqstate->{accept_gzip} && $self->{compression}); |
d8218001 | 740 | |
090019fa WB |
741 | if (defined(my $host = $reqstate->{request}->header('Host'))) { |
742 | $headers->{Host} = $host; | |
743 | } | |
744 | ||
d8218001 DM |
745 | my $content; |
746 | ||
747 | if ($method eq 'POST' || $method eq 'PUT') { | |
748 | $headers->{'Content-Type'} = 'application/x-www-form-urlencoded'; | |
749 | # use URI object to format application/x-www-form-urlencoded content. | |
750 | my $url = URI->new('http:'); | |
751 | $url->query_form(%$params); | |
752 | $content = $url->query; | |
753 | if (defined($content)) { | |
754 | $headers->{'Content-Length'} = length($content); | |
755 | } | |
756 | } | |
757 | ||
758 | my $tls = { | |
759 | # TLS 1.x only, with certificate pinning | |
760 | method => 'any', | |
761 | sslv2 => 0, | |
762 | sslv3 => 0, | |
763 | verify => 1, | |
764 | verify_cb => sub { | |
765 | my (undef, undef, undef, $depth, undef, undef, $cert) = @_; | |
766 | # we don't care about intermediate or root certificates | |
767 | return 1 if $depth != 0; | |
768 | # check server certificate against cache of pinned FPs | |
769 | return $self->check_cert_fingerprint($cert); | |
770 | }, | |
771 | }; | |
772 | ||
773 | # load and cache cert fingerprint if first time we proxy to this node | |
774 | $self->initialize_cert_cache($node); | |
775 | ||
776 | my $w; $w = http_request( | |
777 | $method => $target, | |
778 | headers => $headers, | |
779 | timeout => 30, | |
780 | recurse => 0, | |
781 | proxy => undef, # avoid use of $ENV{HTTP_PROXY} | |
782 | keepalive => $keep_alive, | |
783 | body => $content, | |
784 | tls_ctx => AnyEvent::TLS->new(%{$tls}), | |
785 | sub { | |
786 | my ($body, $hdr) = @_; | |
787 | ||
788 | undef $w; | |
789 | ||
790 | if (!$reqstate->{hdl}) { | |
791 | warn "proxy detected vanished client connection\n"; | |
792 | return; | |
793 | } | |
794 | ||
795 | eval { | |
796 | my $code = delete $hdr->{Status}; | |
797 | my $msg = delete $hdr->{Reason}; | |
51841e98 | 798 | my $stream = delete $hdr->{pvestreamfile}; |
d8218001 DM |
799 | delete $hdr->{URL}; |
800 | delete $hdr->{HTTPVersion}; | |
801 | my $header = HTTP::Headers->new(%$hdr); | |
802 | if (my $location = $header->header('Location')) { | |
803 | $location =~ s|^http://localhost:85||; | |
804 | $header->header(Location => $location); | |
805 | } | |
51841e98 | 806 | if ($stream) { |
e9df8a6e TL |
807 | if (!$may_stream_file) { |
808 | $self->error($reqstate, 403, 'streaming denied'); | |
809 | return; | |
810 | } | |
51841e98 SR |
811 | sysopen(my $fh, "$stream", O_NONBLOCK | O_RDONLY) |
812 | or die "open stream path '$stream' for forwarding failed: $!\n"; | |
813 | my $resp = HTTP::Response->new($code, $msg, $header, undef); | |
814 | $self->response($reqstate, $resp, undef, 1, 0, $fh); | |
815 | } else { | |
816 | my $resp = HTTP::Response->new($code, $msg, $header, $body); | |
817 | # Note: disable compression, because body is already compressed | |
818 | $self->response($reqstate, $resp, undef, 1); | |
819 | } | |
d8218001 DM |
820 | }; |
821 | warn $@ if $@; | |
822 | }); | |
823 | }; | |
824 | warn $@ if $@; | |
825 | } | |
826 | ||
827 | # return arrays as \0 separated strings (like CGI.pm) | |
256da581 | 828 | # assume data is UTF8 encoded |
d8218001 DM |
829 | sub decode_urlencoded { |
830 | my ($data) = @_; | |
831 | ||
832 | my $res = {}; | |
833 | ||
834 | return $res if !$data; | |
835 | ||
836 | foreach my $kv (split(/[\&\;]/, $data)) { | |
837 | my ($k, $v) = split(/=/, $kv); | |
838 | $k =~s/\+/ /g; | |
839 | $k =~ s/%([0-9a-fA-F][0-9a-fA-F])/chr(hex($1))/eg; | |
d8218001 | 840 | |
4a09623b TL |
841 | if (defined($v)) { |
842 | $v =~s/\+/ /g; | |
843 | $v =~ s/%([0-9a-fA-F][0-9a-fA-F])/chr(hex($1))/eg; | |
256da581 | 844 | |
4a09623b TL |
845 | $v = Encode::decode('utf8', $v); |
846 | ||
847 | if (defined(my $old = $res->{$k})) { | |
848 | $v = "$old\0$v"; | |
849 | } | |
5f14e56e | 850 | } |
4a09623b TL |
851 | |
852 | $res->{$k} = $v; | |
d8218001 DM |
853 | } |
854 | return $res; | |
855 | } | |
856 | ||
857 | sub extract_params { | |
858 | my ($r, $method) = @_; | |
859 | ||
860 | my $params = {}; | |
861 | ||
862 | if ($method eq 'PUT' || $method eq 'POST') { | |
3e05f166 DC |
863 | my $ct; |
864 | if (my $ctype = $r->header('Content-Type')) { | |
865 | $ct = parse_content_type($ctype); | |
866 | } | |
867 | if (defined($ct) && $ct eq 'application/json') { | |
868 | $params = decode_json($r->content); | |
869 | } else { | |
870 | $params = decode_urlencoded($r->content); | |
871 | } | |
d8218001 DM |
872 | } |
873 | ||
874 | my $query_params = decode_urlencoded($r->url->query()); | |
875 | ||
876 | foreach my $k (keys %{$query_params}) { | |
877 | $params->{$k} = $query_params->{$k}; | |
878 | } | |
879 | ||
256da581 | 880 | return $params; |
d8218001 DM |
881 | } |
882 | ||
883 | sub handle_api2_request { | |
884 | my ($self, $reqstate, $auth, $method, $path, $upload_state) = @_; | |
885 | ||
886 | eval { | |
887 | my $r = $reqstate->{request}; | |
888 | ||
889 | my ($rel_uri, $format) = &$split_abs_uri($path, $self->{base_uri}); | |
890 | ||
c7154375 | 891 | my $formatter = PVE::APIServer::Formatter::get_formatter($format, $method, $rel_uri); |
d8218001 DM |
892 | |
893 | if (!defined($formatter)) { | |
555a5ab3 | 894 | $self->error($reqstate, HTTP_NOT_IMPLEMENTED, "no formatter for uri $rel_uri, $format"); |
d8218001 DM |
895 | return; |
896 | } | |
897 | ||
898 | #print Dumper($upload_state) if $upload_state; | |
899 | ||
d8218001 DM |
900 | my $params; |
901 | ||
902 | if ($upload_state) { | |
903 | $params = $upload_state->{params}; | |
904 | } else { | |
905 | $params = extract_params($r, $method); | |
906 | } | |
907 | ||
d9b3838f | 908 | delete $params->{_dc} if $params; # remove disable cache parameter |
d8218001 DM |
909 | |
910 | my $clientip = $reqstate->{peer_host}; | |
911 | ||
66a7a3a3 | 912 | my $res = $self->rest_handler($clientip, $method, $rel_uri, $auth, $params, $format); |
d8218001 | 913 | |
8d88baec DM |
914 | # HACK: see Note 1 |
915 | Net::SSLeay::ERR_clear_error(); | |
916 | ||
d8218001 DM |
917 | AnyEvent->now_update(); # in case somebody called sleep() |
918 | ||
d8218001 DM |
919 | my $upgrade = $r->header('upgrade'); |
920 | $upgrade = lc($upgrade) if $upgrade; | |
921 | ||
922 | if (my $host = $res->{proxy}) { | |
923 | ||
924 | if ($self->{trusted_env}) { | |
925 | $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy not allowed"); | |
926 | return; | |
927 | } | |
928 | ||
929 | if ($host ne 'localhost' && $r->header('PVEDisableProxy')) { | |
930 | $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy loop detected"); | |
931 | return; | |
932 | } | |
933 | ||
934 | $res->{proxy_params}->{tmpfilename} = $reqstate->{tmpfilename} if $upload_state; | |
935 | ||
936 | $self->proxy_request($reqstate, $clientip, $host, $res->{proxynode}, $method, | |
362dd8eb | 937 | $r->uri, $auth, $res->{proxy_params}); |
d8218001 DM |
938 | return; |
939 | ||
940 | } elsif ($upgrade && ($method eq 'GET') && ($path =~ m|websocket$|)) { | |
941 | die "unable to upgrade to protocol '$upgrade'\n" if !$upgrade || ($upgrade ne 'websocket'); | |
942 | my $wsver = $r->header('sec-websocket-version'); | |
943 | die "unsupported websocket-version '$wsver'\n" if !$wsver || ($wsver ne '13'); | |
e7eb7165 | 944 | my $wsproto = $r->header('sec-websocket-protocol') // ""; |
d8218001 DM |
945 | my $wskey = $r->header('sec-websocket-key'); |
946 | die "missing websocket-key\n" if !$wskey; | |
947 | # Note: Digest::SHA::sha1_base64 has wrong padding | |
948 | my $wsaccept = Digest::SHA::sha1_base64("${wskey}258EAFA5-E914-47DA-95CA-C5AB0DC85B11") . "="; | |
949 | if ($res->{status} == HTTP_OK) { | |
950 | $self->websocket_proxy($reqstate, $wsaccept, $wsproto, $res->{data}); | |
951 | return; | |
952 | } | |
953 | } | |
954 | ||
955 | my $delay = 0; | |
956 | if ($res->{status} == HTTP_UNAUTHORIZED) { | |
957 | # always delay unauthorized calls by 3 seconds | |
958 | $delay = 3 - tv_interval($reqstate->{starttime}); | |
959 | $delay = 0 if $delay < 0; | |
960 | } | |
961 | ||
6d832dbc SR |
962 | my $download = $res->{download}; |
963 | $download //= $res->{data}->{download} | |
964 | if defined($res->{data}) && ref($res->{data}) eq 'HASH'; | |
965 | if (defined($download)) { | |
05e777bc | 966 | send_file_start($self, $reqstate, $download); |
20a61215 DM |
967 | return; |
968 | } | |
969 | ||
ca304f91 DM |
970 | my ($raw, $ct, $nocomp) = $formatter->($res, $res->{data}, $params, $path, |
971 | $auth, $self->{formatter_config}); | |
d8218001 DM |
972 | |
973 | my $resp; | |
974 | if (ref($raw) && (ref($raw) eq 'HTTP::Response')) { | |
975 | $resp = $raw; | |
976 | } else { | |
977 | $resp = HTTP::Response->new($res->{status}, $res->{message}); | |
978 | $resp->header("Content-Type" => $ct); | |
979 | $resp->content($raw); | |
980 | } | |
981 | $self->response($reqstate, $resp, undef, $nocomp, $delay); | |
982 | }; | |
983 | if (my $err = $@) { | |
984 | $self->error($reqstate, 501, $err); | |
985 | } | |
986 | } | |
987 | ||
988 | sub handle_spice_proxy_request { | |
989 | my ($self, $reqstate, $connect_str, $vmid, $node, $spiceport) = @_; | |
990 | ||
991 | eval { | |
992 | ||
542f4c3a | 993 | my ($minport, $maxport) = PVE::Tools::spice_port_range(); |
9789c451 TL |
994 | if ($spiceport < $minport || $spiceport > $maxport) { |
995 | die "SPICE Port $spiceport is not in allowed range ($minport, $maxport)\n"; | |
996 | } | |
d8218001 | 997 | |
d8218001 DM |
998 | my $clientip = $reqstate->{peer_host}; |
999 | my $r = $reqstate->{request}; | |
1000 | ||
1001 | my $remip; | |
1002 | ||
1003 | if ($node ne 'localhost' && PVE::INotify::nodename() !~ m/^$node$/i) { | |
1004 | $remip = $self->remote_node_ip($node); | |
26e73e6b | 1005 | $self->dprint("REMOTE CONNECT $vmid, $remip, $connect_str"); |
d8218001 | 1006 | } else { |
26e73e6b | 1007 | $self->dprint("CONNECT $vmid, $node, $spiceport"); |
d8218001 DM |
1008 | } |
1009 | ||
1010 | if ($remip && $r->header('PVEDisableProxy')) { | |
1011 | $self->error($reqstate, HTTP_INTERNAL_SERVER_ERROR, "proxy loop detected"); | |
1012 | return; | |
1013 | } | |
1014 | ||
1015 | $reqstate->{hdl}->timeout(0); | |
1016 | $reqstate->{hdl}->wbuf_max(64*10*1024); | |
1017 | ||
1018 | my $remhost = $remip ? $remip : "localhost"; | |
1019 | my $remport = $remip ? 3128 : $spiceport; | |
1020 | ||
1021 | tcp_connect $remhost, $remport, sub { | |
5f14e56e | 1022 | my ($fh) = @_ |
d8218001 DM |
1023 | or die "connect to '$remhost:$remport' failed: $!"; |
1024 | ||
26e73e6b | 1025 | $self->dprint("CONNECTed to '$remhost:$remport'"); |
d8218001 DM |
1026 | $reqstate->{proxyhdl} = AnyEvent::Handle->new( |
1027 | fh => $fh, | |
1028 | rbuf_max => 64*1024, | |
1029 | wbuf_max => 64*10*1024, | |
1030 | timeout => 5, | |
1031 | on_eof => sub { | |
1032 | my ($hdl) = @_; | |
1033 | eval { | |
1034 | $self->log_aborted_request($reqstate); | |
1035 | $self->client_do_disconnect($reqstate); | |
1036 | }; | |
1037 | if (my $err = $@) { syslog('err', $err); } | |
1038 | }, | |
1039 | on_error => sub { | |
1040 | my ($hdl, $fatal, $message) = @_; | |
1041 | eval { | |
1042 | $self->log_aborted_request($reqstate, $message); | |
1043 | $self->client_do_disconnect($reqstate); | |
1044 | }; | |
1045 | if (my $err = $@) { syslog('err', "$err"); } | |
1046 | }); | |
1047 | ||
1048 | ||
1049 | my $proxyhdlreader = sub { | |
1050 | my ($hdl) = @_; | |
1051 | ||
1052 | my $len = length($hdl->{rbuf}); | |
1053 | my $data = substr($hdl->{rbuf}, 0, $len, ''); | |
1054 | ||
1055 | #print "READ1 $len\n"; | |
1056 | $reqstate->{hdl}->push_write($data) if $reqstate->{hdl}; | |
1057 | }; | |
1058 | ||
1059 | my $hdlreader = sub { | |
1060 | my ($hdl) = @_; | |
1061 | ||
1062 | my $len = length($hdl->{rbuf}); | |
1063 | my $data = substr($hdl->{rbuf}, 0, $len, ''); | |
1064 | ||
1065 | #print "READ0 $len\n"; | |
1066 | $reqstate->{proxyhdl}->push_write($data) if $reqstate->{proxyhdl}; | |
1067 | }; | |
1068 | ||
1069 | my $proto = $reqstate->{proto} ? $reqstate->{proto}->{str} : 'HTTP/1.0'; | |
1070 | ||
1071 | my $startproxy = sub { | |
1072 | $reqstate->{proxyhdl}->timeout(0); | |
1073 | $reqstate->{proxyhdl}->on_read($proxyhdlreader); | |
1074 | $reqstate->{hdl}->on_read($hdlreader); | |
1075 | ||
1076 | # todo: use stop_read/start_read if write buffer grows to much | |
1077 | ||
a4d8bbaf DC |
1078 | # a response must be followed by an empty line |
1079 | my $res = "$proto 200 OK\015\012\015\012"; | |
d8218001 DM |
1080 | $reqstate->{hdl}->push_write($res); |
1081 | ||
1082 | # log early | |
1083 | $reqstate->{log}->{code} = 200; | |
1084 | $self->log_request($reqstate); | |
1085 | }; | |
1086 | ||
1087 | if ($remip) { | |
1088 | my $header = "CONNECT ${connect_str} $proto\015\012" . | |
1089 | "Host: ${connect_str}\015\012" . | |
1090 | "Proxy-Connection: keep-alive\015\012" . | |
1091 | "User-Agent: spiceproxy\015\012" . | |
1092 | "PVEDisableProxy: true\015\012" . | |
1093 | "PVEClientIP: $clientip\015\012" . | |
1094 | "\015\012"; | |
1095 | ||
1096 | $reqstate->{proxyhdl}->push_write($header); | |
1097 | $reqstate->{proxyhdl}->push_read(line => sub { | |
1098 | my ($hdl, $line) = @_; | |
5f14e56e | 1099 | |
d8218001 | 1100 | if ($line =~ m!^$proto 200 OK$!) { |
6c31d13e DC |
1101 | # read the empty line after the 200 OK |
1102 | $reqstate->{proxyhdl}->unshift_read(line => sub{ | |
1103 | &$startproxy(); | |
1104 | }); | |
d8218001 DM |
1105 | } else { |
1106 | $reqstate->{hdl}->push_write($line); | |
1107 | $self->client_do_disconnect($reqstate); | |
1108 | } | |
1109 | }); | |
1110 | } else { | |
1111 | &$startproxy(); | |
1112 | } | |
1113 | ||
1114 | }; | |
1115 | }; | |
1116 | if (my $err = $@) { | |
1117 | warn $err; | |
1118 | $self->log_aborted_request($reqstate, $err); | |
1119 | $self->client_do_disconnect($reqstate); | |
1120 | } | |
1121 | } | |
1122 | ||
1123 | sub handle_request { | |
1124 | my ($self, $reqstate, $auth, $method, $path) = @_; | |
1125 | ||
1126 | my $base_uri = $self->{base_uri}; | |
1127 | ||
1128 | eval { | |
1129 | my $r = $reqstate->{request}; | |
5f14e56e | 1130 | |
d8218001 DM |
1131 | # disable timeout on handle (we already have all data we need) |
1132 | # we re-enable timeout in response() | |
1133 | $reqstate->{hdl}->timeout(0); | |
1134 | ||
1135 | if ($path =~ m/^\Q$base_uri\E/) { | |
1136 | $self->handle_api2_request($reqstate, $auth, $method, $path); | |
1137 | return; | |
1138 | } | |
1139 | ||
1140 | if ($self->{pages} && ($method eq 'GET') && (my $handler = $self->{pages}->{$path})) { | |
1141 | if (ref($handler) eq 'CODE') { | |
1142 | my $params = decode_urlencoded($r->url->query()); | |
1143 | my ($resp, $userid) = &$handler($self, $reqstate->{request}, $params); | |
8d88baec DM |
1144 | # HACK: see Note 1 |
1145 | Net::SSLeay::ERR_clear_error(); | |
d8218001 DM |
1146 | $self->response($reqstate, $resp); |
1147 | } elsif (ref($handler) eq 'HASH') { | |
1148 | if (my $filename = $handler->{file}) { | |
1149 | my $fh = IO::File->new($filename) || | |
1150 | die "unable to open file '$filename' - $!\n"; | |
1151 | send_file_start($self, $reqstate, $filename); | |
1152 | } else { | |
1153 | die "internal error - no handler"; | |
1154 | } | |
1155 | } else { | |
1156 | die "internal error - no handler"; | |
1157 | } | |
1158 | return; | |
1159 | } | |
1160 | ||
1161 | if ($self->{dirs} && ($method eq 'GET')) { | |
1162 | # we only allow simple names | |
1163 | if ($path =~ m!^(/\S+/)([a-zA-Z0-9\-\_\.]+)$!) { | |
1164 | my ($subdir, $file) = ($1, $2); | |
1165 | if (my $dir = $self->{dirs}->{$subdir}) { | |
1166 | my $filename = "$dir$file"; | |
1167 | my $fh = IO::File->new($filename) || | |
1168 | die "unable to open file '$filename' - $!\n"; | |
1169 | send_file_start($self, $reqstate, $filename); | |
1170 | return; | |
1171 | } | |
1172 | } | |
1173 | } | |
1174 | ||
666d3ae1 | 1175 | die "no such file '$path'\n"; |
d8218001 DM |
1176 | }; |
1177 | if (my $err = $@) { | |
1178 | $self->error($reqstate, 501, $err); | |
1179 | } | |
1180 | } | |
1181 | ||
59128f6b TL |
1182 | my sub assert_form_disposition { |
1183 | die "wrong Content-Disposition '$_[0]' in multipart, expected 'form-data'\n" if $_[0] ne 'form-data'; | |
1184 | } | |
1185 | ||
d8218001 DM |
1186 | sub file_upload_multipart { |
1187 | my ($self, $reqstate, $auth, $method, $path, $rstate) = @_; | |
1188 | ||
1189 | eval { | |
1190 | my $boundary = $rstate->{boundary}; | |
1191 | my $hdl = $reqstate->{hdl}; | |
d8218001 DM |
1192 | my $startlen = length($hdl->{rbuf}); |
1193 | ||
59128f6b TL |
1194 | my $newline_re = qr/\015?\012/; |
1195 | my $delim_re = qr/--\Q$boundary\E${newline_re}/; | |
44791210 | 1196 | my $close_delim_re = qr/--\Q$boundary\E--/; |
d8218001 | 1197 | |
0fbcbc26 | 1198 | # Phase 0 - preserve boundary, but remove everything before |
59128f6b | 1199 | if ($rstate->{phase} == 0 && $hdl->{rbuf} =~ s/^.*?($delim_re)/$1/s) { |
0fbcbc26 MH |
1200 | $rstate->{read} += $startlen - length($hdl->{rbuf}); |
1201 | $rstate->{phase} = 1; | |
1202 | } | |
d8218001 | 1203 | |
e3295acc MH |
1204 | my $remove_until_data = sub { |
1205 | my ($hdl) = @_; | |
1206 | # remove any remaining multipart "headers" like Content-Type | |
1207 | $hdl->{rbuf} =~ s/^.*?${newline_re}{2}//s; | |
1208 | }; | |
1209 | ||
59128f6b TL |
1210 | my $extract_form_disposition = sub { |
1211 | my ($name) = @_; | |
e3295acc | 1212 | if ($hdl->{rbuf} =~ s/^${delim_re}.*?Content-Disposition: (.*?); name="$name"(.*?${delim_re})/$2/s) { |
59128f6b | 1213 | assert_form_disposition($1); |
e3295acc MH |
1214 | $remove_until_data->($hdl); |
1215 | $hdl->{rbuf} =~ s/^(.*?)(${delim_re})/$2/s; | |
1216 | $rstate->{params}->{$name} = trim($1); | |
d8218001 | 1217 | } |
59128f6b | 1218 | }; |
0fbcbc26 | 1219 | |
59128f6b TL |
1220 | if ($rstate->{phase} == 1) { # Phase 1 - parse payload without file data |
1221 | $extract_form_disposition->('content'); | |
1222 | $extract_form_disposition->('checksum-algorithm'); | |
1223 | $extract_form_disposition->('checksum'); | |
0fbcbc26 | 1224 | |
0b6b3b37 | 1225 | if ($hdl->{rbuf} =~ s/^${delim_re}Content-Disposition: (.*?); name="(.*?)"; filename="([^"]+)"${newline_re}//s) { |
59128f6b | 1226 | assert_form_disposition($1); |
aad755eb | 1227 | die "wrong field name '$2' for file upload, expected 'filename'" if $2 ne "filename"; |
0fbcbc26 | 1228 | $rstate->{phase} = 2; |
a66b77d8 | 1229 | $rstate->{params}->{filename} = trim($3); |
435dbe0c | 1230 | $remove_until_data->($hdl); # any remaining multipart "headers" like Content-Type |
0fbcbc26 MH |
1231 | } |
1232 | } | |
1233 | ||
aad755eb | 1234 | if ($rstate->{phase} == 2) { # Phase 2 - dump content into file |
dafe4416 | 1235 | my ($data, $write_length); |
59128f6b | 1236 | if ($hdl->{rbuf} =~ s/^(.*?)${newline_re}?+${close_delim_re}.*$//s) { |
dafe4416 TL |
1237 | $data = $1; |
1238 | $write_length = length($data); | |
0fbcbc26 | 1239 | $rstate->{phase} = 100; |
d8218001 | 1240 | } else { |
dafe4416 TL |
1241 | $write_length = length($hdl->{rbuf}) - $rstate->{boundlen}; |
1242 | $data = substr($hdl->{rbuf}, 0, $write_length, '') if $write_length > 0; | |
1243 | } | |
1244 | ||
1245 | if ($write_length > 0) { | |
1246 | syswrite($rstate->{outfh}, $data) == $write_length or die "write to temporary file failed - $!\n"; | |
1247 | $rstate->{bytes} += $write_length; | |
1248 | $rstate->{ctx}->add($data); | |
d8218001 | 1249 | } |
0fbcbc26 | 1250 | } |
d8218001 | 1251 | |
aad755eb | 1252 | if ($rstate->{phase} == 100) { # Phase 100 - transfer finished |
dafe4416 | 1253 | $rstate->{md5sum} = $rstate->{ctx}->hexdigest; |
0fbcbc26 | 1254 | my $elapsed = tv_interval($rstate->{starttime}); |
32163b8e | 1255 | syslog('info', "multipart upload complete (size: %dB time: %.3fs rate: %.2fMiB/s md5sum: %s)", |
aad755eb | 1256 | $rstate->{bytes}, $elapsed, $rstate->{bytes} / ($elapsed * 1024 * 1024), $rstate->{md5sum} |
0fbcbc26 MH |
1257 | ); |
1258 | $self->handle_api2_request($reqstate, $auth, $method, $path, $rstate); | |
d8218001 DM |
1259 | } |
1260 | ||
91b86f4e | 1261 | $rstate->{read} += $startlen - length($hdl->{rbuf}); |
d8218001 | 1262 | |
aad755eb | 1263 | if ($rstate->{read} + length($hdl->{rbuf}) >= $rstate->{size} && $rstate->{phase} != 100) { |
0fbcbc26 | 1264 | die "upload failed"; |
d8218001 DM |
1265 | } |
1266 | }; | |
1267 | if (my $err = $@) { | |
1268 | syslog('err', $err); | |
1269 | $self->error($reqstate, 501, $err); | |
1270 | } | |
1271 | } | |
1272 | ||
1273 | sub parse_content_type { | |
1274 | my ($ctype) = @_; | |
1275 | ||
1276 | my ($ct, @params) = split(/\s*[;,]\s*/o, $ctype); | |
5f14e56e | 1277 | |
d8218001 DM |
1278 | foreach my $v (@params) { |
1279 | if ($v =~ m/^\s*boundary\s*=\s*(\S+?)\s*$/o) { | |
1280 | return wantarray ? ($ct, $1) : $ct; | |
1281 | } | |
1282 | } | |
5f14e56e | 1283 | |
d8218001 DM |
1284 | return wantarray ? ($ct) : $ct; |
1285 | } | |
1286 | ||
d8218001 DM |
1287 | my $tmpfile_seq_no = 0; |
1288 | ||
1289 | sub get_upload_filename { | |
1290 | # choose unpredictable tmpfile name | |
5f14e56e | 1291 | |
d8218001 DM |
1292 | $tmpfile_seq_no++; |
1293 | return "/var/tmp/pveupload-" . Digest::MD5::md5_hex($tmpfile_seq_no . time() . $$); | |
1294 | } | |
1295 | ||
1296 | sub unshift_read_header { | |
1297 | my ($self, $reqstate, $state) = @_; | |
1298 | ||
1299 | $state = { size => 0, count => 0 } if !$state; | |
1300 | ||
1301 | $reqstate->{hdl}->unshift_read(line => sub { | |
1302 | my ($hdl, $line) = @_; | |
1303 | ||
1304 | eval { | |
1305 | # print "$$: got header: $line\n" if $self->{debug}; | |
1306 | ||
e7ee5e3f | 1307 | die "too many http header lines (> $limit_max_headers)\n" if ++$state->{count} >= $limit_max_headers; |
d8218001 DM |
1308 | die "http header too large\n" if ($state->{size} += length($line)) >= $limit_max_header_size; |
1309 | ||
1310 | my $r = $reqstate->{request}; | |
1311 | if ($line eq '') { | |
1312 | ||
d8218001 DM |
1313 | $r->push_header($state->{key}, $state->{val}) |
1314 | if $state->{key}; | |
1315 | ||
bda48641 | 1316 | $self->process_header($reqstate) or return; |
933a4dbb | 1317 | $self->ensure_tls_connection($reqstate) or return; |
f2e54bb7 | 1318 | $self->authenticate_and_handle_request($reqstate) or return; |
d8218001 | 1319 | |
d8218001 DM |
1320 | } elsif ($line =~ /^([^:\s]+)\s*:\s*(.*)/) { |
1321 | $r->push_header($state->{key}, $state->{val}) if $state->{key}; | |
1322 | ($state->{key}, $state->{val}) = ($1, $2); | |
1323 | $self->unshift_read_header($reqstate, $state); | |
1324 | } elsif ($line =~ /^\s+(.*)/) { | |
1325 | $state->{val} .= " $1"; | |
1326 | $self->unshift_read_header($reqstate, $state); | |
1327 | } else { | |
1328 | $self->error($reqstate, 506, "unable to parse request header"); | |
1329 | } | |
1330 | }; | |
1331 | warn $@ if $@; | |
1332 | }); | |
1333 | }; | |
1334 | ||
bda48641 MC |
1335 | sub process_header { |
1336 | my ($self, $reqstate) = @_; | |
1337 | ||
1338 | my $request = $reqstate->{request}; | |
1339 | ||
1340 | my $path = uri_unescape($request->uri->path()); | |
1341 | my $method = $request->method(); | |
1342 | ||
1343 | if (!$known_methods->{$method}) { | |
1344 | my $resp = HTTP::Response->new(HTTP_NOT_IMPLEMENTED, "method '$method' not available"); | |
1345 | $self->response($reqstate, $resp); | |
1346 | return; | |
1347 | } | |
1348 | ||
1349 | my $conn = $request->header('Connection'); | |
1350 | my $accept_enc = $request->header('Accept-Encoding'); | |
1351 | $reqstate->{accept_gzip} = ($accept_enc && $accept_enc =~ m/gzip/) ? 1 : 0; | |
1352 | ||
1353 | if ($conn) { | |
1354 | $reqstate->{keep_alive} = 0 if $conn =~ m/close/oi; | |
1355 | } else { | |
1356 | if ($reqstate->{proto}->{ver} < 1001) { | |
1357 | $reqstate->{keep_alive} = 0; | |
1358 | } | |
1359 | } | |
1360 | ||
1361 | my $te = $request->header('Transfer-Encoding'); | |
1362 | if ($te && lc($te) eq 'chunked') { | |
1363 | # Handle chunked transfer encoding | |
1364 | $self->error($reqstate, 501, "chunked transfer encoding not supported"); | |
1365 | return; | |
1366 | } elsif ($te) { | |
1367 | $self->error($reqstate, 501, "Unknown transfer encoding '$te'"); | |
1368 | return; | |
1369 | } | |
1370 | ||
1371 | my $pveclientip = $request->header('PVEClientIP'); | |
1372 | ||
1373 | # fixme: how can we make PVEClientIP header trusted? | |
1374 | if ($self->{trusted_env} && $pveclientip) { | |
1375 | $reqstate->{peer_host} = $pveclientip; | |
1376 | } else { | |
1377 | $request->header('PVEClientIP', $reqstate->{peer_host}); | |
1378 | } | |
1379 | ||
1380 | if (my $rpcenv = $self->{rpcenv}) { | |
1381 | $rpcenv->set_request_host($request->header('Host')); | |
1382 | } | |
1383 | ||
1384 | return 1; | |
1385 | } | |
1386 | ||
933a4dbb MC |
1387 | sub ensure_tls_connection { |
1388 | my ($self, $reqstate) = @_; | |
1389 | ||
1390 | # Skip if server doesn't use TLS | |
1391 | if (!$self->{tls_ctx}) { | |
1392 | return 1; | |
1393 | } | |
1394 | ||
1395 | # TLS session exists, so the handshake has succeeded | |
1396 | if ($reqstate->{hdl}->{tls}) { | |
1397 | return 1; | |
1398 | } | |
1399 | ||
1400 | my $request = $reqstate->{request}; | |
1401 | my $method = $request->method(); | |
1402 | ||
1403 | my $h_host = $reqstate->{request}->header('Host'); | |
1404 | ||
1405 | die "Header field 'Host' not found in request\n" | |
1406 | if !$h_host; | |
1407 | ||
1408 | my $secure_host = "https://" . ($h_host =~ s/^http(s)?:\/\///r); | |
1409 | ||
1410 | my $header = HTTP::Headers->new('Location' => $secure_host . $request->uri()); | |
1411 | ||
1412 | if ($method eq 'GET' || $method eq 'HEAD') { | |
1413 | $self->error($reqstate, 301, 'Moved Permanently', $header); | |
1414 | } else { | |
1415 | $self->error($reqstate, 308, 'Permanent Redirect', $header); | |
1416 | } | |
1417 | ||
1418 | # disconnect the client so they may immediately connect again via HTTPS | |
1419 | $self->client_do_disconnect($reqstate); | |
1420 | ||
1421 | return; | |
1422 | } | |
1423 | ||
f2e54bb7 MC |
1424 | sub authenticate_and_handle_request { |
1425 | my ($self, $reqstate) = @_; | |
1426 | ||
1427 | my $request = $reqstate->{request}; | |
1428 | my $method = $request->method(); | |
1429 | ||
1430 | my $path = uri_unescape($request->uri->path()); | |
1431 | my $base_uri = $self->{base_uri}; | |
1432 | ||
1433 | my $auth = {}; | |
1434 | ||
1435 | if ($self->{spiceproxy}) { | |
1436 | my $connect_str = $request->header('Host'); | |
1437 | my ($vmid, $node, $port) = $self->verify_spice_connect_url($connect_str); | |
1438 | ||
1439 | if (!(defined($vmid) && $node && $port)) { | |
1440 | $self->error($reqstate, HTTP_UNAUTHORIZED, "invalid ticket"); | |
1441 | return; | |
1442 | } | |
1443 | ||
1444 | $self->handle_spice_proxy_request($reqstate, $connect_str, $vmid, $node, $port); | |
1445 | return; | |
1446 | ||
1447 | } elsif ($path =~ m/^\Q$base_uri\E/) { | |
1448 | my $token = $request->header('CSRFPreventionToken'); | |
1449 | my $cookie = $request->header('Cookie'); | |
1450 | my $auth_header = $request->header('Authorization'); | |
1451 | ||
1452 | # prefer actual cookie | |
1453 | my $ticket = PVE::APIServer::Formatter::extract_auth_value( | |
1454 | $cookie, | |
1455 | $self->{cookie_name} | |
1456 | ); | |
1457 | ||
1458 | # fallback to cookie in 'Authorization' header | |
1459 | if (!$ticket) { | |
1460 | $ticket = PVE::APIServer::Formatter::extract_auth_value( | |
1461 | $auth_header, | |
1462 | $self->{cookie_name} | |
1463 | ); | |
1464 | } | |
1465 | ||
1466 | # finally, fallback to API token if no ticket has been provided so far | |
1467 | my $api_token; | |
1468 | if (!$ticket) { | |
1469 | $api_token = PVE::APIServer::Formatter::extract_auth_value( | |
1470 | $auth_header, | |
1471 | $self->{apitoken_name} | |
1472 | ); | |
1473 | } | |
1474 | ||
1475 | my ($rel_uri, $format) = &$split_abs_uri($path, $self->{base_uri}); | |
1476 | if (!$format) { | |
1477 | $self->error($reqstate, HTTP_NOT_IMPLEMENTED, "no such uri"); | |
1478 | return; | |
1479 | } | |
1480 | ||
1481 | eval { | |
1482 | $auth = $self->auth_handler( | |
1483 | $method, | |
1484 | $rel_uri, | |
1485 | $ticket, | |
1486 | $token, | |
1487 | $api_token, | |
1488 | $reqstate->{peer_host} | |
1489 | ); | |
1490 | }; | |
1491 | if (my $err = $@) { | |
1492 | # HACK: see Note 1 | |
1493 | Net::SSLeay::ERR_clear_error(); | |
1494 | # always delay unauthorized calls by 3 seconds | |
1495 | my $delay = 3; | |
1496 | ||
1497 | if (ref($err) eq "PVE::Exception") { | |
1498 | ||
1499 | $err->{code} ||= HTTP_INTERNAL_SERVER_ERROR, | |
1500 | my $resp = HTTP::Response->new($err->{code}, $err->{msg}); | |
1501 | $self->response($reqstate, $resp, undef, 0, $delay); | |
1502 | ||
1503 | } elsif (my $formatter = PVE::APIServer::Formatter::get_login_formatter($format)) { | |
1504 | my ($raw, $ct, $nocomp) = | |
1505 | $formatter->($path, $auth, $self->{formatter_config}); | |
1506 | ||
1507 | my $resp; | |
1508 | if (ref($raw) && (ref($raw) eq 'HTTP::Response')) { | |
1509 | $resp = $raw; | |
1510 | ||
1511 | } else { | |
1512 | $resp = HTTP::Response->new(HTTP_UNAUTHORIZED, "Login Required"); | |
1513 | $resp->header("Content-Type" => $ct); | |
1514 | $resp->content($raw); | |
1515 | } | |
1516 | ||
1517 | $self->response($reqstate, $resp, undef, $nocomp, $delay); | |
1518 | ||
1519 | } else { | |
1520 | my $resp = HTTP::Response->new(HTTP_UNAUTHORIZED, $err); | |
1521 | $self->response($reqstate, $resp, undef, 0, $delay); | |
1522 | } | |
1523 | ||
1524 | return; | |
1525 | } | |
1526 | } | |
1527 | ||
1528 | $reqstate->{log}->{userid} = $auth->{userid}; | |
1529 | my $len = $request->header('Content-Length'); | |
1530 | ||
1531 | if ($len) { | |
1532 | ||
1533 | if (!($method eq 'PUT' || $method eq 'POST')) { | |
1534 | $self->error($reqstate, 501, "Unexpected content for method '$method'"); | |
1535 | return; | |
1536 | } | |
1537 | ||
1538 | my $ctype = $request->header('Content-Type'); | |
1539 | my ($ct, $boundary) = $ctype ? parse_content_type($ctype) : (); | |
1540 | ||
1541 | if ($auth->{isUpload} && !$self->{trusted_env}) { | |
1542 | die "upload 'Content-Type '$ctype' not implemented\n" | |
1543 | if !($boundary && $ct && ($ct eq 'multipart/form-data')); | |
1544 | ||
1545 | die "upload without content length header not supported" if !$len; | |
1546 | ||
1547 | die "upload without content length header not supported" if !$len; | |
1548 | ||
1549 | $self->dprint("start upload $path $ct $boundary"); | |
1550 | ||
1551 | my $tmpfilename = get_upload_filename(); | |
1552 | my $outfh = IO::File->new($tmpfilename, O_RDWR|O_CREAT|O_EXCL, 0600) || | |
1553 | die "unable to create temporary upload file '$tmpfilename'"; | |
1554 | ||
1555 | $reqstate->{keep_alive} = 0; | |
1556 | ||
1557 | my $boundlen = length($boundary) + 8; # \015?\012--$boundary--\015?\012 | |
1558 | ||
1559 | my $state = { | |
1560 | size => $len, | |
1561 | boundary => $boundary, | |
1562 | ctx => Digest::MD5->new, | |
1563 | boundlen => $boundlen, | |
1564 | maxheader => 2048 + $boundlen, # should be large enough | |
1565 | params => decode_urlencoded($request->url->query()), | |
1566 | phase => 0, | |
1567 | read => 0, | |
1568 | post_size => 0, | |
1569 | starttime => [gettimeofday], | |
1570 | outfh => $outfh, | |
1571 | }; | |
1572 | $reqstate->{tmpfilename} = $tmpfilename; | |
1573 | $reqstate->{hdl}->on_read(sub { | |
1574 | $self->file_upload_multipart($reqstate, $auth, $method, $path, $state); | |
1575 | }); | |
1576 | ||
1577 | return; | |
1578 | } | |
1579 | ||
1580 | if ($len > $limit_max_post) { | |
1581 | $self->error($reqstate, 501, "for data too large"); | |
1582 | return; | |
1583 | } | |
1584 | ||
1585 | if (!$ct || $ct eq 'application/x-www-form-urlencoded' || $ct eq 'application/json') { | |
1586 | $reqstate->{hdl}->unshift_read(chunk => $len, sub { | |
1587 | my ($hdl, $data) = @_; | |
1588 | $request->content($data); | |
1589 | $self->handle_request($reqstate, $auth, $method, $path); | |
1590 | }); | |
1591 | ||
1592 | } else { | |
1593 | $self->error($reqstate, 506, "upload 'Content-Type '$ctype' not implemented"); | |
1594 | } | |
1595 | ||
1596 | } else { | |
1597 | $self->handle_request($reqstate, $auth, $method, $path); | |
1598 | } | |
1599 | ||
1600 | return 1; | |
1601 | } | |
1602 | ||
d8218001 DM |
1603 | sub push_request_header { |
1604 | my ($self, $reqstate) = @_; | |
1605 | ||
1606 | eval { | |
1607 | $reqstate->{hdl}->push_read(line => sub { | |
1608 | my ($hdl, $line) = @_; | |
1609 | ||
1610 | eval { | |
1611 | # print "got request header: $line\n" if $self->{debug}; | |
1612 | ||
1613 | $reqstate->{keep_alive}--; | |
1614 | ||
1615 | if ($line =~ /(\S+)\040(\S+)\040HTTP\/(\d+)\.(\d+)/o) { | |
1616 | my ($method, $url, $maj, $min) = ($1, $2, $3, $4); | |
1617 | ||
1618 | if ($maj != 1) { | |
1619 | $self->error($reqstate, 506, "http protocol version $maj.$min not supported"); | |
1620 | return; | |
1621 | } | |
c2bd69c7 TL |
1622 | if ($url =~ m|^[^/]*@|) { |
1623 | # if an '@' comes before the first slash proxy forwarding might consider | |
1624 | # the frist part of the url to be part of an authority... | |
1625 | $self->error($reqstate, 400, "invalid url"); | |
4099febe | 1626 | return; |
c2bd69c7 | 1627 | } |
d8218001 DM |
1628 | |
1629 | $self->{request_count}++; # only count valid request headers | |
1630 | if ($self->{request_count} >= $self->{max_requests}) { | |
1631 | $self->{end_loop} = 1; | |
1632 | } | |
1633 | $reqstate->{log} = { requestline => $line }; | |
1634 | $reqstate->{proto}->{str} = "HTTP/$maj.$min"; | |
1635 | $reqstate->{proto}->{maj} = $maj; | |
1636 | $reqstate->{proto}->{min} = $min; | |
1637 | $reqstate->{proto}->{ver} = $maj*1000+$min; | |
1638 | $reqstate->{request} = HTTP::Request->new($method, $url); | |
1639 | $reqstate->{starttime} = [gettimeofday], | |
1640 | ||
1641 | $self->unshift_read_header($reqstate); | |
1642 | } elsif ($line eq '') { | |
1643 | # ignore empty lines before requests (browser bugs?) | |
1644 | $self->push_request_header($reqstate); | |
1645 | } else { | |
1646 | $self->error($reqstate, 400, 'bad request'); | |
1647 | } | |
1648 | }; | |
1649 | warn $@ if $@; | |
1650 | }); | |
1651 | }; | |
1652 | warn $@ if $@; | |
1653 | } | |
1654 | ||
1655 | sub accept { | |
1656 | my ($self) = @_; | |
1657 | ||
1658 | my $clientfh; | |
1659 | ||
1660 | return if $self->{end_loop}; | |
1661 | ||
1662 | # we need to m make sure that only one process calls accept | |
1663 | while (!flock($self->{lockfh}, Fcntl::LOCK_EX())) { | |
1664 | next if $! == EINTR; | |
1665 | die "could not get lock on file '$self->{lockfile}' - $!\n"; | |
1666 | } | |
1667 | ||
1668 | my $again = 0; | |
1669 | my $errmsg; | |
1670 | eval { | |
1671 | while (!$self->{end_loop} && | |
1672 | !defined($clientfh = $self->{socket}->accept()) && | |
1673 | ($! == EINTR)) {}; | |
1674 | ||
1675 | if ($self->{end_loop}) { | |
1676 | $again = 0; | |
1677 | } else { | |
1678 | $again = ($! == EAGAIN || $! == WSAEWOULDBLOCK); | |
1679 | if (!defined($clientfh)) { | |
1680 | $errmsg = "failed to accept connection: $!\n"; | |
1681 | } | |
1682 | } | |
1683 | }; | |
1684 | warn $@ if $@; | |
1685 | ||
1686 | flock($self->{lockfh}, Fcntl::LOCK_UN()); | |
1687 | ||
1688 | if (!defined($clientfh)) { | |
1689 | return if $again; | |
1690 | die $errmsg if $errmsg; | |
1691 | } | |
1692 | ||
1693 | fh_nonblocking $clientfh, 1; | |
1694 | ||
d8218001 DM |
1695 | return $clientfh; |
1696 | } | |
1697 | ||
1698 | sub wait_end_loop { | |
1699 | my ($self) = @_; | |
1700 | ||
1701 | $self->{end_loop} = 1; | |
1702 | ||
1703 | undef $self->{socket_watch}; | |
1704 | ||
1705 | $0 = "$0 (shutdown)" if $0 !~ m/\(shutdown\)$/; | |
1706 | ||
1707 | if ($self->{conn_count} <= 0) { | |
1708 | $self->{end_cond}->send(1); | |
1709 | return; | |
1710 | } | |
1711 | ||
1712 | # fork and exit, so that parent starts a new worker | |
1713 | if (fork()) { | |
1714 | exit(0); | |
1715 | } | |
1716 | ||
1717 | # else we need to wait until all open connections gets closed | |
1718 | my $w; $w = AnyEvent->timer (after => 1, interval => 1, cb => sub { | |
1719 | eval { | |
1720 | # todo: test for active connections instead (we can abort idle connections) | |
1721 | if ($self->{conn_count} <= 0) { | |
1722 | undef $w; | |
1723 | $self->{end_cond}->send(1); | |
1724 | } | |
1725 | }; | |
1726 | warn $@ if $@; | |
1727 | }); | |
1728 | } | |
1729 | ||
1730 | ||
1731 | sub check_host_access { | |
1732 | my ($self, $clientip) = @_; | |
5f14e56e | 1733 | |
c6de5b3f | 1734 | $clientip = PVE::APIServer::Utils::normalize_v4_in_v6($clientip); |
d8218001 DM |
1735 | my $cip = Net::IP->new($clientip); |
1736 | ||
ebcaaf46 SI |
1737 | if (!$cip) { |
1738 | $self->dprint("client IP not parsable: $@"); | |
1739 | return 0; | |
1740 | } | |
1741 | ||
d8218001 DM |
1742 | my $match_allow = 0; |
1743 | my $match_deny = 0; | |
1744 | ||
1745 | if ($self->{allow_from}) { | |
1746 | foreach my $t (@{$self->{allow_from}}) { | |
1747 | if ($t->overlaps($cip)) { | |
1748 | $match_allow = 1; | |
1e169242 | 1749 | $self->dprint("client IP allowed: ". $t->prefix()); |
d8218001 DM |
1750 | last; |
1751 | } | |
1752 | } | |
1753 | } | |
1754 | ||
1755 | if ($self->{deny_from}) { | |
1756 | foreach my $t (@{$self->{deny_from}}) { | |
1757 | if ($t->overlaps($cip)) { | |
1e169242 | 1758 | $self->dprint("client IP denied: ". $t->prefix()); |
d8218001 DM |
1759 | $match_deny = 1; |
1760 | last; | |
1761 | } | |
1762 | } | |
1763 | } | |
1764 | ||
1765 | if ($match_allow == $match_deny) { | |
1766 | # match both allow and deny, or no match | |
1767 | return $self->{policy} && $self->{policy} eq 'allow' ? 1 : 0; | |
1768 | } | |
1769 | ||
1770 | return $match_allow; | |
1771 | } | |
1772 | ||
1773 | sub accept_connections { | |
1774 | my ($self) = @_; | |
1775 | ||
ebcaaf46 | 1776 | my ($clientfh, $handle_creation); |
d8218001 DM |
1777 | eval { |
1778 | ||
ebcaaf46 | 1779 | while ($clientfh = $self->accept()) { |
d8218001 DM |
1780 | |
1781 | my $reqstate = { keep_alive => $self->{keep_alive} }; | |
1782 | ||
1783 | # stop keep-alive when there are many open connections | |
c82d1707 | 1784 | if ($self->{conn_count} + 1 >= $self->{max_conn_soft_limit}) { |
d8218001 DM |
1785 | $reqstate->{keep_alive} = 0; |
1786 | } | |
1787 | ||
1788 | if (my $sin = getpeername($clientfh)) { | |
1789 | my ($pfamily, $pport, $phost) = PVE::Tools::unpack_sockaddr_in46($sin); | |
1790 | ($reqstate->{peer_port}, $reqstate->{peer_host}) = ($pport, Socket::inet_ntop($pfamily, $phost)); | |
ebcaaf46 | 1791 | } else { |
1e169242 | 1792 | $self->dprint("getpeername failed: $!"); |
ebcaaf46 SI |
1793 | close($clientfh); |
1794 | next; | |
d8218001 DM |
1795 | } |
1796 | ||
1797 | if (!$self->{trusted_env} && !$self->check_host_access($reqstate->{peer_host})) { | |
26e73e6b | 1798 | $self->dprint("ABORT request from $reqstate->{peer_host} - access denied"); |
d8218001 DM |
1799 | $reqstate->{log}->{code} = 403; |
1800 | $self->log_request($reqstate); | |
ebcaaf46 | 1801 | close($clientfh); |
d8218001 DM |
1802 | next; |
1803 | } | |
1804 | ||
c82d1707 SI |
1805 | # Increment conn_count before creating new handle, since creation |
1806 | # triggers callbacks, which can potentialy decrement (e.g. | |
1807 | # on_error) conn_count before AnyEvent::Handle->new() returns. | |
1808 | $handle_creation = 1; | |
1809 | $self->{conn_count}++; | |
d8218001 DM |
1810 | $reqstate->{hdl} = AnyEvent::Handle->new( |
1811 | fh => $clientfh, | |
1812 | rbuf_max => 64*1024, | |
1813 | timeout => $self->{timeout}, | |
1814 | linger => 0, # avoid problems with ssh - really needed ? | |
1815 | on_eof => sub { | |
1816 | my ($hdl) = @_; | |
1817 | eval { | |
1818 | $self->log_aborted_request($reqstate); | |
1819 | $self->client_do_disconnect($reqstate); | |
1820 | }; | |
1821 | if (my $err = $@) { syslog('err', $err); } | |
1822 | }, | |
1823 | on_error => sub { | |
1824 | my ($hdl, $fatal, $message) = @_; | |
1825 | eval { | |
1826 | $self->log_aborted_request($reqstate, $message); | |
1827 | $self->client_do_disconnect($reqstate); | |
1828 | }; | |
1829 | if (my $err = $@) { syslog('err', "$err"); } | |
1830 | }, | |
933a4dbb | 1831 | ); |
c82d1707 | 1832 | $handle_creation = 0; |
d8218001 | 1833 | |
26e73e6b | 1834 | $self->dprint("ACCEPT FH" . $clientfh->fileno() . " CONN$self->{conn_count}"); |
d8218001 | 1835 | |
933a4dbb MC |
1836 | if ($self->{tls_ctx}) { |
1837 | $self->dprint("Setting TLS to autostart"); | |
1838 | $reqstate->{hdl}->unshift_read(tls_autostart => $self->{tls_ctx}, "accept"); | |
1839 | } | |
1840 | ||
d8218001 DM |
1841 | $self->push_request_header($reqstate); |
1842 | } | |
1843 | }; | |
1844 | ||
1845 | if (my $err = $@) { | |
1846 | syslog('err', $err); | |
1e169242 | 1847 | $self->dprint("connection accept error: $err"); |
ebcaaf46 | 1848 | close($clientfh); |
c82d1707 SI |
1849 | if ($handle_creation) { |
1850 | if ($self->{conn_count} <= 0) { | |
1851 | warn "connection count <= 0 not decrementing!\n"; | |
1852 | } else { | |
1853 | $self->{conn_count}--; | |
1854 | } | |
1855 | } | |
d8218001 DM |
1856 | $self->{end_loop} = 1; |
1857 | } | |
1858 | ||
1859 | $self->wait_end_loop() if $self->{end_loop}; | |
1860 | } | |
1861 | ||
1862 | # Note: We can't open log file in non-blocking mode and use AnyEvent::Handle, | |
1863 | # because we write from multiple processes, and that would arbitrarily mix output | |
1864 | # of all processes. | |
1865 | sub open_access_log { | |
1866 | my ($self, $filename) = @_; | |
1867 | ||
1868 | my $old_mask = umask(0137);; | |
1869 | my $logfh = IO::File->new($filename, ">>") || | |
1870 | die "unable to open log file '$filename' - $!\n"; | |
1871 | umask($old_mask); | |
1872 | ||
1873 | $logfh->autoflush(1); | |
1874 | ||
1875 | $self->{logfh} = $logfh; | |
1876 | } | |
1877 | ||
1878 | sub write_log { | |
1879 | my ($self, $data) = @_; | |
1880 | ||
1881 | return if !defined($self->{logfh}) || !$data; | |
1882 | ||
1883 | my $res = $self->{logfh}->print($data); | |
1884 | ||
1885 | if (!$res) { | |
1886 | delete $self->{logfh}; | |
1887 | syslog('err', "error writing access log"); | |
1888 | $self->{end_loop} = 1; # terminate asap | |
1889 | } | |
1890 | } | |
1891 | ||
1892 | sub atfork_handler { | |
1893 | my ($self) = @_; | |
1894 | ||
1895 | eval { | |
1896 | # something else do to ? | |
1897 | close($self->{socket}); | |
1898 | }; | |
1899 | warn $@ if $@; | |
1900 | } | |
1901 | ||
fbc42b33 DM |
1902 | sub run { |
1903 | my ($self) = @_; | |
1904 | ||
1905 | $self->{end_cond}->recv; | |
1906 | } | |
1907 | ||
d8218001 DM |
1908 | sub new { |
1909 | my ($this, %args) = @_; | |
1910 | ||
1911 | my $class = ref($this) || $this; | |
1912 | ||
af76fd78 | 1913 | foreach my $req (qw(socket lockfh lockfile)) { |
d8218001 DM |
1914 | die "misssing required argument '$req'" if !defined($args{$req}); |
1915 | } | |
1916 | ||
1917 | my $self = bless { %args }, $class; | |
1918 | ||
1919 | $self->{cookie_name} //= 'PVEAuthCookie'; | |
362dd8eb | 1920 | $self->{apitoken_name} //= 'PVEAPIToken'; |
d8218001 | 1921 | $self->{base_uri} //= "/api2"; |
911ede9b | 1922 | $self->{dirs} //= {}; |
fc87cd5e | 1923 | $self->{title} //= 'API Inspector'; |
23dfd1b7 | 1924 | $self->{compression} //= 1; |
d8218001 | 1925 | |
ca304f91 DM |
1926 | # formatter_config: we pass some configuration values to the Formatter |
1927 | $self->{formatter_config} = {}; | |
362dd8eb | 1928 | foreach my $p (qw(apitoken_name cookie_name base_uri title)) { |
ca304f91 DM |
1929 | $self->{formatter_config}->{$p} = $self->{$p}; |
1930 | } | |
1931 | $self->{formatter_config}->{csrfgen_func} = | |
1932 | $self->can('generate_csrf_prevention_token'); | |
1933 | ||
1934 | # add default dirs which includes jquery and bootstrap | |
e52d9400 TL |
1935 | my $jsbase = '/usr/share/javascript'; |
1936 | add_dirs($self->{dirs}, '/js/' => "$jsbase/"); | |
1937 | # libjs-bootstrap uses symlinks for this, which we do not want to allow.. | |
1938 | my $glyphicons = '/usr/share/fonts/truetype/glyphicons/'; | |
1939 | add_dirs($self->{dirs}, '/js/bootstrap/fonts/' => "$glyphicons"); | |
6edb39f6 | 1940 | |
d8218001 DM |
1941 | # init inotify |
1942 | PVE::INotify::inotify_init(); | |
1943 | ||
d8218001 DM |
1944 | fh_nonblocking($self->{socket}, 1); |
1945 | ||
1946 | $self->{end_loop} = 0; | |
1947 | $self->{conn_count} = 0; | |
1948 | $self->{request_count} = 0; | |
1949 | $self->{timeout} = 5 if !$self->{timeout}; | |
1950 | $self->{keep_alive} = 0 if !defined($self->{keep_alive}); | |
1951 | $self->{max_conn} = 800 if !$self->{max_conn}; | |
1952 | $self->{max_requests} = 8000 if !$self->{max_requests}; | |
1953 | ||
1954 | $self->{policy} = 'allow' if !$self->{policy}; | |
1955 | ||
1956 | $self->{end_cond} = AnyEvent->condvar; | |
1957 | ||
1958 | if ($self->{ssl}) { | |
fac83ab2 SI |
1959 | my $ssl_defaults = { |
1960 | # Note: older versions are considered insecure, for example | |
1961 | # search for "Poodle"-Attack | |
1962 | method => 'any', | |
1963 | sslv2 => 0, | |
1964 | sslv3 => 0, | |
1965 | cipher_list => 'ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256', | |
1966 | honor_cipher_order => 1, | |
1967 | }; | |
1968 | ||
95fde1f7 FG |
1969 | # workaround until anyevent supports TLS 1.3 ciphersuites directly |
1970 | my $ciphersuites = delete $self->{ssl}->{ciphersuites}; | |
1971 | ||
fac83ab2 SI |
1972 | foreach my $k (keys %$ssl_defaults) { |
1973 | $self->{ssl}->{$k} //= $ssl_defaults->{$k}; | |
1974 | } | |
1975 | ||
1976 | if (!defined($self->{ssl}->{dh_file})) { | |
1977 | $self->{ssl}->{dh} = 'skip2048'; | |
1978 | } | |
1979 | ||
7599c478 TL |
1980 | my $tls_ctx_flags = 0; |
1981 | $tls_ctx_flags |= &Net::SSLeay::OP_NO_COMPRESSION; | |
1982 | $tls_ctx_flags |= &Net::SSLeay::OP_SINGLE_ECDH_USE; | |
1983 | $tls_ctx_flags |= &Net::SSLeay::OP_SINGLE_DH_USE; | |
1984 | $tls_ctx_flags |= &Net::SSLeay::OP_NO_RENEGOTIATION; | |
1985 | if (delete $self->{ssl}->{honor_cipher_order}) { | |
54c0ead9 SI |
1986 | $tls_ctx_flags |= &Net::SSLeay::OP_CIPHER_SERVER_PREFERENCE; |
1987 | } | |
e9022485 FG |
1988 | # workaround until anyevent supports disabling TLS 1.3 directly |
1989 | if (exists($self->{ssl}->{tlsv1_3}) && !$self->{ssl}->{tlsv1_3}) { | |
1990 | $tls_ctx_flags |= &Net::SSLeay::OP_NO_TLSv1_3; | |
1991 | } | |
1992 | ||
54c0ead9 | 1993 | |
d8218001 | 1994 | $self->{tls_ctx} = AnyEvent::TLS->new(%{$self->{ssl}}); |
54c0ead9 | 1995 | Net::SSLeay::CTX_set_options($self->{tls_ctx}->{ctx}, $tls_ctx_flags); |
34f20af2 FG |
1996 | if (defined($ciphersuites)) { |
1997 | warn "Failed to set TLS 1.3 ciphersuites '$ciphersuites'\n" | |
1998 | if !Net::SSLeay::CTX_set_ciphersuites($self->{tls_ctx}->{ctx}, $ciphersuites); | |
1999 | } | |
d8218001 DM |
2000 | } |
2001 | ||
2002 | if ($self->{spiceproxy}) { | |
2003 | $known_methods = { CONNECT => 1 }; | |
2004 | } | |
2005 | ||
2006 | $self->open_access_log($self->{logfile}) if $self->{logfile}; | |
2007 | ||
2008 | $self->{max_conn_soft_limit} = $self->{max_conn} > 100 ? $self->{max_conn} - 20 : $self->{max_conn}; | |
2009 | ||
2010 | $self->{socket_watch} = AnyEvent->io(fh => $self->{socket}, poll => 'r', cb => sub { | |
2011 | eval { | |
2012 | if ($self->{conn_count} >= $self->{max_conn}) { | |
2013 | my $w; $w = AnyEvent->timer (after => 1, interval => 1, cb => sub { | |
2014 | if ($self->{conn_count} < $self->{max_conn}) { | |
2015 | undef $w; | |
2016 | $self->accept_connections(); | |
2017 | } | |
2018 | }); | |
2019 | } else { | |
2020 | $self->accept_connections(); | |
2021 | } | |
2022 | }; | |
2023 | warn $@ if $@; | |
2024 | }); | |
2025 | ||
2026 | $self->{term_watch} = AnyEvent->signal(signal => "TERM", cb => sub { | |
2027 | undef $self->{term_watch}; | |
2028 | $self->wait_end_loop(); | |
2029 | }); | |
2030 | ||
2031 | $self->{quit_watch} = AnyEvent->signal(signal => "QUIT", cb => sub { | |
2032 | undef $self->{quit_watch}; | |
2033 | $self->wait_end_loop(); | |
2034 | }); | |
2035 | ||
2036 | $self->{inotify_poll} = AnyEvent->timer(after => 5, interval => 5, cb => sub { | |
2037 | PVE::INotify::poll(); # read inotify events | |
2038 | }); | |
2039 | ||
2040 | return $self; | |
2041 | } | |
2042 | ||
911ede9b DM |
2043 | # static helper to add directory including all subdirs |
2044 | # This can be used to setup $self->{dirs} | |
2045 | sub add_dirs { | |
2046 | my ($result_hash, $alias, $subdir) = @_; | |
2047 | ||
2048 | $result_hash->{$alias} = $subdir; | |
2049 | ||
2050 | my $wanted = sub { | |
2051 | my $dir = $File::Find::dir; | |
2052 | if ($dir =~m!^$subdir(.*)$!) { | |
2053 | my $name = "$alias$1/"; | |
2054 | $result_hash->{$name} = "$dir/"; | |
2055 | } | |
2056 | }; | |
2057 | ||
2058 | find({wanted => $wanted, follow => 0, no_chdir => 1}, $subdir); | |
2059 | } | |
2060 | ||
fbc42b33 DM |
2061 | # abstract functions - subclass should overwrite/implement them |
2062 | ||
403964f2 DM |
2063 | sub verify_spice_connect_url { |
2064 | my ($self, $connect_str) = @_; | |
2065 | ||
2066 | die "implement me"; | |
2067 | ||
2068 | #return ($vmid, $node, $port); | |
2069 | } | |
2070 | ||
a3bb6070 DM |
2071 | # formatters can call this when the generate a new page |
2072 | sub generate_csrf_prevention_token { | |
2073 | my ($username) = @_; | |
2074 | ||
2075 | return undef; # do nothing by default | |
2076 | } | |
2077 | ||
d8218001 | 2078 | sub auth_handler { |
362dd8eb | 2079 | my ($self, $method, $rel_uri, $ticket, $token, $api_token, $peer_host) = @_; |
d8218001 | 2080 | |
b639f458 | 2081 | die "implement me"; |
d8218001 | 2082 | |
b639f458 DM |
2083 | # return { |
2084 | # ticket => $ticket, | |
2085 | # token => $token, | |
2086 | # userid => $username, | |
2087 | # age => $age, | |
2088 | # isUpload => $isUpload, | |
362dd8eb | 2089 | # api_token => $api_token, |
b639f458 | 2090 | #}; |
d8218001 DM |
2091 | } |
2092 | ||
d8218001 | 2093 | sub rest_handler { |
66a7a3a3 | 2094 | my ($self, $clientip, $method, $rel_uri, $auth, $params, $format) = @_; |
d8218001 | 2095 | |
c5f0a96f DM |
2096 | # please do not raise exceptions here (always return a result). |
2097 | ||
b639f458 DM |
2098 | return { |
2099 | status => HTTP_NOT_IMPLEMENTED, | |
2100 | message => "Method '$method $rel_uri' not implemented", | |
d8218001 | 2101 | }; |
c5f0a96f DM |
2102 | |
2103 | # this should return the following properties, which | |
2104 | # are then passed to the Formatter | |
2105 | ||
2106 | # status: HTTP status code | |
2107 | # message: Error message | |
2108 | # errors: more detailed error hash (per parameter) | |
2109 | # info: reference to JSON schema definition - useful to format output | |
2110 | # data: result data | |
2111 | ||
2112 | # total: additional info passed to output | |
2113 | # changes: additional info passed to output | |
2114 | ||
2115 | # if you want to proxy the request to another node return this | |
2116 | # { proxy => $remip, proxynode => $node, proxy_params => $params }; | |
2117 | ||
2118 | # to pass the request to the local priviledged daemon use: | |
2119 | # { proxy => 'localhost' , proxy_params => $params }; | |
20a61215 DM |
2120 | |
2121 | # to download aspecific file use: | |
2122 | # { download => "/path/to/file" }; | |
d8218001 DM |
2123 | } |
2124 | ||
2125 | sub check_cert_fingerprint { | |
2126 | my ($self, $cert) = @_; | |
2127 | ||
b639f458 DM |
2128 | die "implement me"; |
2129 | } | |
d8218001 DM |
2130 | |
2131 | sub initialize_cert_cache { | |
2132 | my ($self, $node) = @_; | |
2133 | ||
b639f458 | 2134 | die "implement me"; |
d8218001 DM |
2135 | } |
2136 | ||
2137 | sub remote_node_ip { | |
2138 | my ($self, $node) = @_; | |
2139 | ||
b639f458 | 2140 | die "implement me"; |
d8218001 | 2141 | |
b639f458 | 2142 | # return $remip; |
d8218001 DM |
2143 | } |
2144 | ||
d8218001 DM |
2145 | |
2146 | 1; |