]>
Commit | Line | Data |
---|---|---|
adf285bf DM |
1 | package PVE::APIClient::Commands::lxc; |
2 | ||
3 | use strict; | |
4 | use warnings; | |
678b245c | 5 | use Errno qw(EINTR EAGAIN); |
aa570b38 | 6 | use JSON; |
1824383b DM |
7 | use URI::Escape; |
8 | use IO::Select; | |
9 | use IO::Socket::SSL; | |
10 | use MIME::Base64; | |
11 | use Digest::SHA; | |
2779eec9 | 12 | use HTTP::Response; |
adf285bf | 13 | |
c9138c03 DM |
14 | use PVE::APIClient::JSONSchema qw(get_standard_option); |
15 | use PVE::APIClient::CLIHandler; | |
16 | use PVE::APIClient::PTY; | |
adf285bf | 17 | |
c9138c03 | 18 | use base qw(PVE::APIClient::CLIHandler); |
3454a319 | 19 | use PVE::APIClient::Config; |
84ba32e5 | 20 | |
1824383b | 21 | my $CRLF = "\x0D\x0A"; |
962d470a | 22 | my $max_payload_size = 128*1024; |
1824383b DM |
23 | |
24 | my $build_web_socket_request = sub { | |
6bb43016 | 25 | my ($host, $path, $ticket, $termproxy) = @_; |
1824383b DM |
26 | |
27 | my $key = ''; | |
28 | $key .= chr(int(rand(256))) for 1 .. 16; | |
29 | my $enckey = MIME::Base64::encode_base64($key, ''); | |
30 | ||
31 | my $encticket = uri_escape($ticket); | |
32 | my $cookie = "PVEAuthCookie=$encticket; path=/; secure;"; | |
33 | ||
34 | $path .= "?port=$termproxy->{port}" . | |
35 | "&vncticket=" . uri_escape($termproxy->{ticket}); | |
36 | ||
37 | my $request = "GET $path HTTP/1.1$CRLF" | |
38 | . "Upgrade: WebSocket$CRLF" | |
39 | . "Connection: Upgrade$CRLF" | |
6bb43016 | 40 | . "Host: $host$CRLF" |
1824383b DM |
41 | . "Sec-WebSocket-Key: $enckey$CRLF" |
42 | . "Sec-WebSocket-Version: 13$CRLF" | |
43 | . "Sec-WebSocket-Protocol: binary$CRLF" | |
44 | . "Cookie: $cookie$CRLF" | |
45 | . "$CRLF"; | |
46 | ||
47 | return ($request, $enckey); | |
48 | }; | |
49 | ||
1824383b DM |
50 | my $create_websockt_frame = sub { |
51 | my ($payload) = @_; | |
52 | ||
53 | my $string = "\x82"; # binary frame | |
54 | my $payload_len = length($payload); | |
55 | if ($payload_len <= 125) { | |
56 | $string .= pack 'C', $payload_len | 128; | |
57 | } elsif ($payload_len <= 0xffff) { | |
58 | $string .= pack 'C', 126 | 128; | |
59 | $string .= pack 'n', $payload_len; | |
60 | } else { | |
61 | $string .= pack 'C', 127 | 128; | |
62 | $string .= pack 'Q>', $payload_len; | |
63 | } | |
64 | ||
65 | $string .= pack 'N', 0; # we simply use 0 as mask | |
66 | $string .= $payload; | |
67 | ||
68 | return $string; | |
69 | }; | |
70 | ||
1824383b | 71 | my $parse_web_socket_frame = sub { |
84d4c3e2 | 72 | my ($wsbuf_ref) = @_; |
1824383b | 73 | |
1824383b DM |
74 | my $payload; |
75 | my $req_close = 0; | |
76 | ||
1334102e | 77 | while (my $len = length($$wsbuf_ref)) { |
1824383b DM |
78 | last if $len < 2; |
79 | ||
1334102e | 80 | my $hdr = unpack('C', substr($$wsbuf_ref, 0, 1)); |
1824383b DM |
81 | my $opcode = $hdr & 0b00001111; |
82 | my $fin = $hdr & 0b10000000; | |
83 | ||
84 | die "received fragmented websocket frame\n" if !$fin; | |
85 | ||
86 | my $rsv = $hdr & 0b01110000; | |
87 | die "received websocket frame with RSV flags\n" if $rsv; | |
88 | ||
1334102e | 89 | my $payload_len = unpack 'C', substr($$wsbuf_ref, 1, 1); |
1824383b DM |
90 | |
91 | my $masked = $payload_len & 0b10000000; | |
84d4c3e2 | 92 | die "received masked websocket frame from server\n" if $masked; |
1824383b DM |
93 | |
94 | my $offset = 2; | |
95 | $payload_len = $payload_len & 0b01111111; | |
96 | if ($payload_len == 126) { | |
97 | last if $len < 4; | |
1334102e | 98 | $payload_len = unpack('n', substr($$wsbuf_ref, $offset, 2)); |
1824383b DM |
99 | $offset += 2; |
100 | } elsif ($payload_len == 127) { | |
101 | last if $len < 10; | |
1334102e | 102 | $payload_len = unpack('Q>', substr($$wsbuf_ref, $offset, 8)); |
1824383b DM |
103 | $offset += 8; |
104 | } | |
105 | ||
106 | die "received too large websocket frame (len = $payload_len)\n" | |
107 | if ($payload_len > $max_payload_size) || ($payload_len < 0); | |
108 | ||
1824383b DM |
109 | last if $len < ($offset + $payload_len); |
110 | ||
1334102e | 111 | my $data = substr($$wsbuf_ref, 0, $offset + $payload_len, ''); # now consume data |
1824383b DM |
112 | |
113 | my $frame_data = substr($data, $offset, $payload_len); | |
114 | ||
1824383b DM |
115 | $payload = '' if !defined($payload); |
116 | $payload .= $frame_data; | |
117 | ||
118 | if ($opcode == 1 || $opcode == 2) { | |
119 | # continue | |
120 | } elsif ($opcode == 8) { | |
121 | my $statuscode = unpack ("n", $frame_data); | |
122 | $req_close = 1; | |
123 | } else { | |
124 | die "received unhandled websocket opcode $opcode\n"; | |
125 | } | |
126 | } | |
127 | ||
128 | return ($payload, $req_close); | |
129 | }; | |
130 | ||
678b245c DM |
131 | my $full_write = sub { |
132 | my ($fh, $data) = @_; | |
133 | ||
134 | my $len = length($data); | |
135 | my $todo = $len; | |
136 | my $offset = 0; | |
137 | while(1) { | |
138 | my $nr = syswrite($fh, $data, $todo, $offset); | |
139 | if (!defined($nr)) { | |
140 | next if $! == EINTR || $! == EAGAIN; | |
141 | die "console write error - $!\n" | |
142 | } | |
143 | $offset += $nr; | |
144 | $todo -= $nr; | |
145 | last if $todo <= 0; | |
146 | } | |
147 | ||
148 | return $len; | |
149 | }; | |
150 | ||
83a7ab4c WB |
151 | # Takes an escape character with an optional '^' prefix and returns an escape |
152 | # character code. | |
153 | my $escapekey_to_char = sub { | |
154 | my ($def) = @_; | |
155 | if ($def =~ /^\^?([a-zA-Z])$/) { | |
156 | return 1 + ord(lc($1)) - ord('a'); | |
157 | } | |
158 | die "bad escape key definition: $def\n"; | |
159 | }; | |
160 | ||
adf285bf DM |
161 | __PACKAGE__->register_method ({ |
162 | name => 'enter', | |
163 | path => 'enter', | |
164 | method => 'POST', | |
165 | description => "Enter container console.", | |
166 | parameters => { | |
167 | additionalProperties => 0, | |
168 | properties => { | |
3454a319 | 169 | remote => get_standard_option('pveclient-remote-name'), |
7acede20 | 170 | vmid => get_standard_option('pve-vmid') |
adf285bf DM |
171 | }, |
172 | }, | |
173 | returns => { type => 'null'}, | |
174 | code => sub { | |
175 | my ($param) = @_; | |
176 | ||
69aa81b3 DM |
177 | my $config = PVE::APIClient::Config->load(); |
178 | my $conn = PVE::APIClient::Config->remote_conn($config, $param->{remote}); | |
1824383b | 179 | |
83a7ab4c WB |
180 | # FIXME: This should come from $config |
181 | my $escape_char = $escapekey_to_char->('a'); | |
182 | ||
1824383b DM |
183 | # Get the real node from the resources endpoint |
184 | my $resource_list = $conn->get("api2/json/cluster/resources", { type => 'vm'}); | |
185 | my ($resource) = grep { $_->{type} eq "lxc" && $_->{vmid} eq $param->{vmid}} @$resource_list; | |
186 | ||
187 | die "container '$param->{vmid}' does not exist\n" | |
188 | if !(defined($resource) && defined($resource->{node})); | |
189 | ||
190 | my $node = $resource->{node}; | |
84ba32e5 DM |
191 | |
192 | my $api_path = "api2/json/nodes/$node/lxc/$param->{vmid}"; | |
193 | ||
1824383b | 194 | my $termproxy = $conn->post("${api_path}/termproxy", {}); |
84ba32e5 | 195 | |
1824383b DM |
196 | my $web_socket = IO::Socket::SSL->new( |
197 | PeerHost => $conn->{host}, | |
198 | PeerPort => $conn->{port}, | |
199 | SSL_verify_mode => SSL_VERIFY_NONE, # fixme: ??? | |
200 | timeout => 30) || | |
201 | die "failed to connect: $!\n"; | |
202 | ||
203 | # WebSocket Handshake | |
204 | ||
205 | my ($request, $wskey) = $build_web_socket_request->( | |
6bb43016 | 206 | $conn->{host}, "/$api_path/vncwebsocket", $conn->{ticket}, $termproxy); |
1824383b | 207 | |
678b245c | 208 | $full_write->($web_socket, $request); |
1824383b DM |
209 | |
210 | my $wsbuf = ''; | |
211 | ||
212 | my $wb_socket_read_available_bytes = sub { | |
213 | my $nr = $web_socket->sysread($wsbuf, $max_payload_size, length($wsbuf)); | |
bf705a1e DM |
214 | if (!defined($nr) && !($! == EINTR || $! == EAGAIN)) { |
215 | die "web socket read error - $!\n"; | |
216 | } | |
1824383b DM |
217 | return $nr; |
218 | }; | |
219 | ||
220 | my $raw_response = ''; | |
221 | ||
222 | while(1) { | |
223 | my $nr = $wb_socket_read_available_bytes->(); | |
224 | if ($wsbuf =~ s/^(.*?)$CRLF$CRLF//s) { | |
225 | $raw_response = $1; | |
226 | last; | |
227 | } | |
228 | last if !$nr; | |
229 | }; | |
230 | ||
231 | # Note: we keep any remaining data in $wsbuf | |
232 | ||
233 | my $response = HTTP::Response->parse($raw_response); | |
234 | ||
235 | # Note: Digest::SHA::sha1_base64 has wrong padding | |
236 | my $wsaccept = Digest::SHA::sha1_base64("${wskey}258EAFA5-E914-47DA-95CA-C5AB0DC85B11") . "="; | |
237 | ||
238 | die "got invalid websocket reponse: $raw_response\n" | |
239 | if !(($response->code == 101) && | |
6bb43016 RJ |
240 | (lc $response->header('connection') eq 'upgrade') && |
241 | (lc $response->header('upgrade') eq 'websocket') && | |
1824383b DM |
242 | ($response->header('sec-websocket-protocol') eq 'binary') && |
243 | ($response->header('sec-websocket-accept') eq $wsaccept)); | |
244 | ||
245 | # send auth again... | |
246 | my $frame = $create_websockt_frame->($termproxy->{user} . ":" . $termproxy->{ticket} . "\n"); | |
678b245c | 247 | $full_write->($web_socket, $frame); |
1824383b | 248 | |
95b87dd3 RJ |
249 | # Send resize command |
250 | my ($columns, $rows) = PVE::PTY::tcgetsize(*STDIN); | |
251 | $frame = $create_websockt_frame->("1:$columns:$rows:"); | |
678b245c | 252 | $full_write->($web_socket, $frame); |
95b87dd3 RJ |
253 | |
254 | # Set STDIN to "raw -echo" mode | |
255 | my $old_termios = PVE::PTY::tcgetattr(*STDIN); | |
256 | my $raw_termios = {%$old_termios}; | |
95b87dd3 | 257 | |
1ec5788c DM |
258 | my $read_select = IO::Select->new; |
259 | my $write_select = IO::Select->new; | |
260 | ||
261 | my $output_buffer = ''; # write buffer for STDOUT | |
262 | my $websock_buffer = ''; # write buffer for $web_socket | |
1824383b | 263 | |
e9d84865 DM |
264 | eval { |
265 | $SIG{TERM} = $SIG{INT} = $SIG{KILL} = sub { die "received interrupt\n"; }; | |
95b87dd3 | 266 | |
e9d84865 DM |
267 | PVE::PTY::cfmakeraw($raw_termios); |
268 | PVE::PTY::tcsetattr(*STDIN, $raw_termios); | |
95b87dd3 | 269 | |
e9d84865 DM |
270 | # And set it to non-blocking so we can every char with IO::Select. |
271 | STDIN->blocking(0); | |
d956d618 | 272 | STDOUT->blocking(0); |
48e35b78 | 273 | $web_socket->blocking(0); |
1ec5788c | 274 | $read_select->add($web_socket); |
8a58c001 | 275 | my $input_fh = \*STDIN; |
1ec5788c DM |
276 | $read_select->add($input_fh); |
277 | ||
8a58c001 | 278 | my $output_fh = \*STDOUT; |
95b87dd3 | 279 | |
83a7ab4c | 280 | my $in_escape_sequence; |
95b87dd3 | 281 | |
9657c731 RJ |
282 | my $winch_received = 0; |
283 | $SIG{WINCH} = sub { $winch_received = 1; }; | |
284 | ||
285 | my $check_terminal_size = sub { | |
286 | my ($ncols, $nrows) = PVE::PTY::tcgetsize(*STDIN); | |
287 | if ($ncols != $columns or $nrows != $rows) { | |
288 | $columns = $ncols; | |
289 | $rows = $nrows; | |
1ec5788c DM |
290 | $websock_buffer .= $create_websockt_frame->("1:$columns:$rows:"); |
291 | $write_select->add($web_socket); | |
9657c731 RJ |
292 | } |
293 | $winch_received = 0; | |
294 | }; | |
295 | ||
032dc44c DM |
296 | my $max_buffer_len = 256*1024; |
297 | ||
1ec5788c DM |
298 | my $drain_buffer = sub { |
299 | my ($fh, $buffer_ref) = @_; | |
300 | ||
301 | my $len = length($$buffer_ref); | |
302 | my $nr = syswrite($fh, $$buffer_ref); | |
303 | if (!defined($nr)) { | |
83a7ab4c | 304 | return if $! == EINTR || $! == EAGAIN; |
1ec5788c DM |
305 | die "drain buffer - write error - $!\n"; |
306 | } | |
307 | return $nr if !$nr; | |
308 | substr($$buffer_ref, 0, $nr, ''); | |
032dc44c DM |
309 | $len = length($$buffer_ref); |
310 | $write_select->remove($fh) if !$len; | |
1ec5788c DM |
311 | }; |
312 | ||
e9d84865 | 313 | while (1) { |
1ec5788c | 314 | while(my ($readable, $writable) = IO::Select->select($read_select, $write_select, undef, 3)) { |
9657c731 RJ |
315 | $check_terminal_size->() if $winch_received; |
316 | ||
1ec5788c DM |
317 | foreach my $fh (@$writable) { |
318 | if ($fh == $output_fh) { | |
8a58c001 | 319 | $drain_buffer->($output_fh, \$output_buffer); |
032dc44c | 320 | $read_select->add($web_socket) if length($output_buffer) <= $max_buffer_len; |
1ec5788c DM |
321 | } elsif ($fh == $web_socket) { |
322 | $drain_buffer->($web_socket, \$websock_buffer); | |
323 | } | |
324 | } | |
325 | ||
e4c01635 | 326 | foreach my $fh (@$readable) { |
e9d84865 DM |
327 | |
328 | if ($fh == $web_socket) { | |
329 | # Read from WebSocket | |
330 | ||
331 | my $nr = $wb_socket_read_available_bytes->(); | |
332 | if (!defined($nr)) { | |
bf705a1e | 333 | # wait |
e9d84865 DM |
334 | } elsif ($nr == 0) { |
335 | return; # EOF | |
336 | } else { | |
337 | my ($payload, $req_close) = $parse_web_socket_frame->(\$wsbuf); | |
032dc44c | 338 | if (defined($payload) && length($payload)) { |
1ec5788c DM |
339 | $output_buffer .= $payload; |
340 | $write_select->add($output_fh); | |
032dc44c DM |
341 | if (length($output_buffer) > $max_buffer_len) { |
342 | $read_select->remove($web_socket); | |
343 | } | |
e9d84865 DM |
344 | } |
345 | return if $req_close; | |
346 | } | |
95b87dd3 | 347 | |
e9d84865 DM |
348 | } elsif ($fh == $input_fh) { |
349 | # Read from STDIN | |
95b87dd3 | 350 | |
8a58c001 | 351 | my $nr = sysread($input_fh, my $buff, 4096); |
e9d84865 | 352 | return if !$nr; # EOF or error |
95b87dd3 | 353 | |
e9d84865 | 354 | my $char = ord($buff); |
95b87dd3 | 355 | |
83a7ab4c WB |
356 | # Handle escape sequences: |
357 | if ($in_escape_sequence) { | |
358 | $in_escape_sequence = 0; | |
359 | if ($char == 0x71) { | |
360 | # (escape, 'q') | |
361 | return; | |
362 | } elsif ($char == $escape_char) { | |
363 | # (escape, escape) | |
364 | # Pass this one through as a single escapekey | |
365 | } else { | |
366 | # Unknown escape sequence | |
367 | # We could generate a bell or something... | |
368 | # but for now just skip it | |
369 | next; | |
370 | } | |
371 | } elsif ($char == $escape_char) { | |
372 | $in_escape_sequence = 1; | |
373 | next; | |
374 | } | |
95b87dd3 | 375 | |
83a7ab4c | 376 | # Pass the key through: |
1ec5788c DM |
377 | $websock_buffer .= $create_websockt_frame->("0:" . $nr . ":" . $buff); |
378 | $write_select->add($web_socket); | |
95b87dd3 | 379 | } |
95b87dd3 | 380 | } |
1824383b | 381 | } |
9657c731 RJ |
382 | $check_terminal_size->() if $winch_received; |
383 | ||
e9d84865 | 384 | # got timeout |
1ec5788c DM |
385 | $websock_buffer .= $create_websockt_frame->("2"); # ping server to keep connection alive |
386 | $write_select->add($web_socket); | |
e9d84865 DM |
387 | } |
388 | }; | |
389 | my $err = $@; | |
390 | ||
391 | eval { # cleanup | |
392 | ||
393 | # switch back to blocking mode (else later shell commands will fail). | |
394 | STDIN->blocking(1); | |
395 | ||
396 | if ($web_socket->connected) { | |
397 | # close connection | |
1ec5788c DM |
398 | $websock_buffer .= "\x88" . pack('N', 0) . pack('n', 0); # Opcode, mask, statuscode |
399 | $full_write->($web_socket, $websock_buffer); | |
400 | $websock_buffer = ''; | |
e9d84865 | 401 | close($web_socket); |
1824383b | 402 | } |
e9d84865 DM |
403 | |
404 | # Reset the terminal parameters. | |
1ec5788c DM |
405 | $output_buffer .= "\e[24H\r\n"; |
406 | $full_write->(\*STDOUT, $output_buffer); | |
407 | $output_buffer = ''; | |
408 | ||
e9d84865 | 409 | PVE::PTY::tcsetattr(*STDIN, $old_termios); |
95b87dd3 | 410 | }; |
e9d84865 | 411 | warn $@ if $@; # show cleanup errors |
95b87dd3 | 412 | |
e9d84865 | 413 | print STDERR "\nERROR: $err" if $err; |
adf285bf | 414 | |
e9d84865 | 415 | return undef; |
adf285bf DM |
416 | }}); |
417 | ||
adf285bf | 418 | our $cmddef = { |
84ba32e5 | 419 | enter => [ __PACKAGE__, 'enter', ['remote', 'vmid']], |
adf285bf DM |
420 | }; |
421 | ||
422 | 1; |