1 package PVE
::APIClient
::Commands
::lxc
;
5 use Errno
qw(EINTR EAGAIN);
15 use PVE
::JSONSchema
qw(get_standard_option);
19 use base
qw(PVE::CLIHandler);
20 use PVE
::APIClient
::Config
;
22 my $CRLF = "\x0D\x0A";
23 my $max_payload_size = 128*1024;
25 my $build_web_socket_request = sub {
26 my ($host, $path, $ticket, $termproxy) = @_;
29 $key .= chr(int(rand(256))) for 1 .. 16;
30 my $enckey = MIME
::Base64
::encode_base64
($key, '');
32 my $encticket = uri_escape
($ticket);
33 my $cookie = "PVEAuthCookie=$encticket; path=/; secure;";
35 $path .= "?port=$termproxy->{port}" .
36 "&vncticket=" . uri_escape
($termproxy->{ticket
});
38 my $request = "GET $path HTTP/1.1$CRLF"
39 . "Upgrade: WebSocket$CRLF"
40 . "Connection: Upgrade$CRLF"
42 . "Sec-WebSocket-Key: $enckey$CRLF"
43 . "Sec-WebSocket-Version: 13$CRLF"
44 . "Sec-WebSocket-Protocol: binary$CRLF"
45 . "Cookie: $cookie$CRLF"
48 return ($request, $enckey);
51 my $create_websockt_frame = sub {
54 my $string = "\x82"; # binary frame
55 my $payload_len = length($payload);
56 if ($payload_len <= 125) {
57 $string .= pack 'C', $payload_len | 128;
58 } elsif ($payload_len <= 0xffff) {
59 $string .= pack 'C', 126 | 128;
60 $string .= pack 'n', $payload_len;
62 $string .= pack 'C', 127 | 128;
63 $string .= pack 'Q>', $payload_len;
66 $string .= pack 'N', 0; # we simply use 0 as mask
72 my $parse_web_socket_frame = sub {
78 while (my $len = length($$wsbuf_ref)) {
81 my $hdr = unpack('C', substr($$wsbuf_ref, 0, 1));
82 my $opcode = $hdr & 0b00001111;
83 my $fin = $hdr & 0b10000000;
85 die "received fragmented websocket frame\n" if !$fin;
87 my $rsv = $hdr & 0b01110000;
88 die "received websocket frame with RSV flags\n" if $rsv;
90 my $payload_len = unpack 'C', substr($$wsbuf_ref, 1, 1);
92 my $masked = $payload_len & 0b10000000;
93 die "received masked websocket frame from server\n" if $masked;
96 $payload_len = $payload_len & 0b01111111;
97 if ($payload_len == 126) {
99 $payload_len = unpack('n', substr($$wsbuf_ref, $offset, 2));
101 } elsif ($payload_len == 127) {
103 $payload_len = unpack('Q>', substr($$wsbuf_ref, $offset, 8));
107 die "received too large websocket frame (len = $payload_len)\n"
108 if ($payload_len > $max_payload_size) || ($payload_len < 0);
110 last if $len < ($offset + $payload_len);
112 my $data = substr($$wsbuf_ref, 0, $offset + $payload_len, ''); # now consume data
114 my $frame_data = substr($data, $offset, $payload_len);
116 $payload = '' if !defined($payload);
117 $payload .= $frame_data;
119 if ($opcode == 1 || $opcode == 2) {
121 } elsif ($opcode == 8) {
122 my $statuscode = unpack ("n", $frame_data);
125 die "received unhandled websocket opcode $opcode\n";
129 return ($payload, $req_close);
132 my $full_write = sub {
133 my ($fh, $data) = @_;
135 my $len = length($data);
139 my $nr = syswrite($fh, $data, $todo, $offset);
141 next if $! == EINTR
|| $! == EAGAIN
;
142 die "console write error - $!\n"
152 # Takes an escape character with an optional '^' prefix and returns an escape
154 my $escapekey_to_char = sub {
156 if ($def =~ /^\^?([a-zA-Z])$/) {
157 return 1 + ord(lc($1)) - ord('a');
159 die "bad escape key definition: $def\n";
162 __PACKAGE__-
>register_method ({
166 description
=> "Enter container console.",
168 additionalProperties
=> 0,
170 remote
=> get_standard_option
('pveclient-remote-name'),
171 vmid
=> get_standard_option
('pve-vmid')
174 returns
=> { type
=> 'null'},
178 my $config = PVE
::APIClient
::Config-
>load();
179 my $conn = PVE
::APIClient
::Config-
>remote_conn($config, $param->{remote
});
181 # FIXME: This should come from $config
182 my $escape_char = $escapekey_to_char->('a');
184 # Get the real node from the resources endpoint
185 my $resource_list = $conn->get("api2/json/cluster/resources", { type
=> 'vm'});
186 my ($resource) = grep { $_->{type
} eq "lxc" && $_->{vmid
} eq $param->{vmid
}} @$resource_list;
188 die "container '$param->{vmid}' does not exist\n"
189 if !(defined($resource) && defined($resource->{node
}));
191 my $node = $resource->{node
};
193 my $api_path = "api2/json/nodes/$node/lxc/$param->{vmid}";
195 my $termproxy = $conn->post("${api_path}/termproxy", {});
197 my $web_socket = IO
::Socket
::SSL-
>new(
198 PeerHost
=> $conn->{host
},
199 PeerPort
=> $conn->{port
},
200 SSL_verify_mode
=> SSL_VERIFY_NONE
, # fixme: ???
202 die "failed to connect: $!\n";
204 # WebSocket Handshake
206 my ($request, $wskey) = $build_web_socket_request->(
207 $conn->{host
}, "/$api_path/vncwebsocket", $conn->{ticket
}, $termproxy);
209 $full_write->($web_socket, $request);
213 my $wb_socket_read_available_bytes = sub {
214 my $nr = $web_socket->sysread($wsbuf, $max_payload_size, length($wsbuf));
215 if (!defined($nr) && !($! == EINTR
|| $! == EAGAIN
)) {
216 die "web socket read error - $!\n";
221 my $raw_response = '';
224 my $nr = $wb_socket_read_available_bytes->();
225 if ($wsbuf =~ s/^(.*?)$CRLF$CRLF//s) {
232 # Note: we keep any remaining data in $wsbuf
234 my $response = HTTP
::Response-
>parse($raw_response);
236 # Note: Digest::SHA::sha1_base64 has wrong padding
237 my $wsaccept = Digest
::SHA
::sha1_base64
("${wskey}258EAFA5-E914-47DA-95CA-C5AB0DC85B11") . "=";
239 die "got invalid websocket reponse: $raw_response\n"
240 if !(($response->code == 101) &&
241 (lc $response->header('connection') eq 'upgrade') &&
242 (lc $response->header('upgrade') eq 'websocket') &&
243 ($response->header('sec-websocket-protocol') eq 'binary') &&
244 ($response->header('sec-websocket-accept') eq $wsaccept));
247 my $frame = $create_websockt_frame->($termproxy->{user
} . ":" . $termproxy->{ticket
} . "\n");
248 $full_write->($web_socket, $frame);
250 # Send resize command
251 my ($columns, $rows) = PVE
::PTY
::tcgetsize
(*STDIN
);
252 $frame = $create_websockt_frame->("1:$columns:$rows:");
253 $full_write->($web_socket, $frame);
255 # Set STDIN to "raw -echo" mode
256 my $old_termios = PVE
::PTY
::tcgetattr
(*STDIN
);
257 my $raw_termios = {%$old_termios};
259 my $read_select = IO
::Select-
>new;
260 my $write_select = IO
::Select-
>new;
262 my $output_buffer = ''; # write buffer for STDOUT
263 my $websock_buffer = ''; # write buffer for $web_socket
266 $SIG{TERM
} = $SIG{INT
} = $SIG{KILL
} = sub { die "received interrupt\n"; };
268 PVE
::PTY
::cfmakeraw
($raw_termios);
269 PVE
::PTY
::tcsetattr
(*STDIN
, $raw_termios);
271 # And set it to non-blocking so we can every char with IO::Select.
274 $web_socket->blocking(0);
275 $read_select->add($web_socket);
276 my $input_fh = \
*STDIN
;
277 $read_select->add($input_fh);
279 my $output_fh = \
*STDOUT
;
281 my $in_escape_sequence;
283 my $winch_received = 0;
284 $SIG{WINCH
} = sub { $winch_received = 1; };
286 my $check_terminal_size = sub {
287 my ($ncols, $nrows) = PVE
::PTY
::tcgetsize
(*STDIN
);
288 if ($ncols != $columns or $nrows != $rows) {
291 $websock_buffer .= $create_websockt_frame->("1:$columns:$rows:");
292 $write_select->add($web_socket);
297 my $max_buffer_len = 256*1024;
299 my $drain_buffer = sub {
300 my ($fh, $buffer_ref) = @_;
302 my $len = length($$buffer_ref);
303 my $nr = syswrite($fh, $$buffer_ref);
305 return if $! == EINTR
|| $! == EAGAIN
;
306 die "drain buffer - write error - $!\n";
309 substr($$buffer_ref, 0, $nr, '');
310 $len = length($$buffer_ref);
311 $write_select->remove($fh) if !$len;
315 while(my ($readable, $writable) = IO
::Select-
>select($read_select, $write_select, undef, 3)) {
316 $check_terminal_size->() if $winch_received;
318 foreach my $fh (@$writable) {
319 if ($fh == $output_fh) {
320 $drain_buffer->($output_fh, \
$output_buffer);
321 $read_select->add($web_socket) if length($output_buffer) <= $max_buffer_len;
322 } elsif ($fh == $web_socket) {
323 $drain_buffer->($web_socket, \
$websock_buffer);
327 foreach my $fh (@$readable) {
329 if ($fh == $web_socket) {
330 # Read from WebSocket
332 my $nr = $wb_socket_read_available_bytes->();
338 my ($payload, $req_close) = $parse_web_socket_frame->(\
$wsbuf);
339 if (defined($payload) && length($payload)) {
340 $output_buffer .= $payload;
341 $write_select->add($output_fh);
342 if (length($output_buffer) > $max_buffer_len) {
343 $read_select->remove($web_socket);
346 return if $req_close;
349 } elsif ($fh == $input_fh) {
352 my $nr = sysread($input_fh, my $buff, 4096);
353 return if !$nr; # EOF or error
355 my $char = ord($buff);
357 # Handle escape sequences:
358 if ($in_escape_sequence) {
359 $in_escape_sequence = 0;
363 } elsif ($char == $escape_char) {
365 # Pass this one through as a single escapekey
367 # Unknown escape sequence
368 # We could generate a bell or something...
369 # but for now just skip it
372 } elsif ($char == $escape_char) {
373 $in_escape_sequence = 1;
377 # Pass the key through:
378 $websock_buffer .= $create_websockt_frame->("0:" . $nr . ":" . $buff);
379 $write_select->add($web_socket);
383 $check_terminal_size->() if $winch_received;
386 $websock_buffer .= $create_websockt_frame->("2"); # ping server to keep connection alive
387 $write_select->add($web_socket);
394 # switch back to blocking mode (else later shell commands will fail).
397 if ($web_socket->connected) {
399 $websock_buffer .= "\x88" . pack('N', 0) . pack('n', 0); # Opcode, mask, statuscode
400 $full_write->($web_socket, $websock_buffer);
401 $websock_buffer = '';
405 # Reset the terminal parameters.
406 $output_buffer .= "\e[24H\r\n";
407 $full_write->(\
*STDOUT
, $output_buffer);
410 PVE
::PTY
::tcsetattr
(*STDIN
, $old_termios);
412 warn $@ if $@; # show cleanup errors
414 print STDERR
"\nERROR: $err" if $err;
420 enter
=> [ __PACKAGE__
, 'enter', ['remote', 'vmid']],