PVE/APIClient/Commands/lxc.pm

   1 package PVE::APIClient::Commands::lxc;
   2
   3 use strict;
   4 use warnings;
   5 use JSON;
   6 use URI::Escape;
   7 use IO::Select;
   8 use IO::Socket::SSL;
   9 use MIME::Base64;
  10 use Digest::SHA;
  11 use HTTP::Response;
  12
  13 use PVE::Tools;
  14 use PVE::JSONSchema qw(get_standard_option);
  15 use PVE::CLIHandler;
  16
  17 use base qw(PVE::CLIHandler);
  18 use PVE::APIClient::Config;
  19
  20 my $CRLF = "\x0D\x0A";
  21 my $max_payload_size = 65536;
  22
  23 my $build_web_socket_request = sub {
  24     my ($path, $ticket, $termproxy) = @_;
  25
  26     my $key = '';
  27     $key .= chr(int(rand(256))) for 1 .. 16;
  28     my $enckey = MIME::Base64::encode_base64($key, '');
  29
  30     my $encticket = uri_escape($ticket);
  31     my $cookie = "PVEAuthCookie=$encticket; path=/; secure;";
  32
  33     $path .= "?port=$termproxy->{port}" .
  34         "&vncticket=" . uri_escape($termproxy->{ticket});
  35
  36     my $request = "GET $path HTTP/1.1$CRLF"
  37         . "Upgrade: WebSocket$CRLF"
  38         . "Connection: Upgrade$CRLF"
  39         . "Sec-WebSocket-Key: $enckey$CRLF"
  40         . "Sec-WebSocket-Version: 13$CRLF"
  41         . "Sec-WebSocket-Protocol: binary$CRLF"
  42         . "Cookie: $cookie$CRLF"
  43         . "$CRLF";
  44
  45     return ($request, $enckey);
  46 };
  47
  48 my $create_websockt_frame = sub {
  49     my ($payload) = @_;
  50
  51     my $string = "\x82"; # binary frame
  52     my $payload_len = length($payload);
  53     if ($payload_len <= 125) {
  54         $string .= pack 'C', $payload_len | 128;
  55     } elsif ($payload_len <= 0xffff) {
  56         $string .= pack 'C', 126 | 128;
  57         $string .= pack 'n', $payload_len;
  58     } else {
  59         $string .= pack 'C', 127 | 128;
  60         $string .= pack 'Q>', $payload_len;
  61     }
  62
  63     $string .= pack 'N', 0; # we simply use 0 as mask
  64     $string .= $payload;
  65
  66     return $string;
  67 };
  68
  69 my $parse_web_socket_frame = sub  {
  70     my ($wsbuf_ref) = @_;
  71
  72     my $wsbuf = $$wsbuf_ref;
  73
  74     my $payload;
  75     my $req_close = 0;
  76
  77     while (my $len = length($wsbuf)) {
  78         last if $len < 2;
  79
  80         my $hdr = unpack('C', substr($wsbuf, 0, 1));
  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
  89         my $payload_len = unpack 'C', substr($wsbuf, 1, 1);
  90
  91         my $masked = $payload_len & 0b10000000;
  92         die "received masked websocket frame from server\n" if $masked;
  93
  94         my $offset = 2;
  95         $payload_len = $payload_len & 0b01111111;
  96         if ($payload_len == 126) {
  97             last if $len < 4;
  98             $payload_len = unpack('n', substr($wsbuf, $offset, 2));
  99             $offset += 2;
 100         } elsif ($payload_len == 127) {
 101             last if $len < 10;
 102             $payload_len = unpack('Q>', substr($wsbuf, $offset, 8));
 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
 109         last if $len < ($offset + $payload_len);
 110
 111         my $data = substr($wsbuf, 0, $offset + $payload_len, ''); # now consume data
 112
 113         my $frame_data = substr($data, $offset, $payload_len);
 114
 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
 131 __PACKAGE__->register_method ({
 132     name => 'enter',
 133     path => 'enter',
 134     method => 'POST',
 135     description => "Enter container console.",
 136     parameters => {
 137         additionalProperties => 0,
 138         properties => {
 139             remote => get_standard_option('pveclient-remote-name'),
 140             vmid => {
 141                 description => "The container ID",
 142                 type => 'string',
 143             },
 144         },
 145     },
 146     returns => { type => 'null'},
 147     code => sub {
 148         my ($param) = @_;
 149
 150         my $config = PVE::APIClient::Config->load();
 151         my $conn = PVE::APIClient::Config->remote_conn($config, $param->{remote});
 152
 153         # Get the real node from the resources endpoint
 154         my $resource_list = $conn->get("api2/json/cluster/resources", { type => 'vm'});
 155         my ($resource) = grep { $_->{type} eq "lxc" && $_->{vmid} eq $param->{vmid}} @$resource_list;
 156
 157         die "container '$param->{vmid}' does not exist\n"
 158             if !(defined($resource) && defined($resource->{node}));
 159
 160         my $node = $resource->{node};
 161
 162         my $api_path = "api2/json/nodes/$node/lxc/$param->{vmid}";
 163
 164         my $termproxy = $conn->post("${api_path}/termproxy", {});
 165
 166         my $web_socket =  IO::Socket::SSL->new(
 167             PeerHost => $conn->{host},
 168             PeerPort => $conn->{port},
 169             SSL_verify_mode => SSL_VERIFY_NONE, # fixme: ???
 170             timeout => 30) ||
 171             die "failed to connect: $!\n";
 172
 173         # WebSocket Handshake
 174
 175         my ($request, $wskey) = $build_web_socket_request->(
 176             "/$api_path/vncwebsocket", $conn->{ticket}, $termproxy);
 177
 178         $web_socket->syswrite($request);
 179
 180         my $wsbuf = '';
 181
 182         my $wb_socket_read_available_bytes = sub {
 183             my $nr = $web_socket->sysread($wsbuf, $max_payload_size, length($wsbuf));
 184             die "web socket read error - $!\n" if $nr < 0;
 185             return $nr;
 186         };
 187
 188         my $raw_response = '';
 189
 190         while(1) {
 191             my $nr = $wb_socket_read_available_bytes->();
 192             if ($wsbuf =~ s/^(.*?)$CRLF$CRLF//s) {
 193                 $raw_response = $1;
 194                 last;
 195             }
 196             last if !$nr;
 197         };
 198
 199         # Note: we keep any remaining data in $wsbuf
 200
 201         my $response = HTTP::Response->parse($raw_response);
 202
 203         # Note: Digest::SHA::sha1_base64 has wrong padding
 204         my $wsaccept = Digest::SHA::sha1_base64("${wskey}258EAFA5-E914-47DA-95CA-C5AB0DC85B11") . "=";
 205
 206         die "got invalid websocket reponse: $raw_response\n"
 207             if !(($response->code == 101) &&
 208                  ($response->header('connection') eq 'upgrade') &&
 209                  ($response->header('upgrade') eq 'websocket') &&
 210                  ($response->header('sec-websocket-protocol') eq 'binary') &&
 211                  ($response->header('sec-websocket-accept') eq $wsaccept));
 212
 213         # send auth again...
 214         my $frame = $create_websockt_frame->($termproxy->{user} . ":" . $termproxy->{ticket} . "\n");
 215         $web_socket->syswrite($frame);
 216
 217         my $select = IO::Select->new;
 218
 219         $web_socket->blocking(0);
 220         $select->add($web_socket);
 221
 222         while(my @ready = $select->can_read) {
 223             foreach my $fh (@ready) {
 224                 if ($fh == $web_socket) {
 225                     my $nr = $wb_socket_read_available_bytes->();
 226                     my ($payload, $req_close) = $parse_web_socket_frame->(\$wsbuf);
 227                     print "GOT: $payload\n" if defined($payload);
 228                     last if $req_close;
 229                     last if !$nr; # eos
 230                 } else {
 231                     die "internal error - unknown handle";
 232                 }
 233             }
 234         }
 235
 236     }});
 237
 238 __PACKAGE__->register_method ({
 239     name => 'list',
 240     path => 'list',
 241     method => 'GET',
 242     description => "List containers.",
 243     parameters => {
 244         additionalProperties => 0,
 245         properties => {
 246             remote => get_standard_option('pveclient-remote-name'),
 247         },
 248     },
 249     returns => { type => 'null'},
 250     code => sub {
 251         my ($param) = @_;
 252
 253         die "implement me";
 254
 255     }});
 256
 257
 258 our $cmddef = {
 259     enter => [ __PACKAGE__, 'enter', ['remote', 'vmid']],
 260     list => [ __PACKAGE__, 'list', ['remote']],
 261 };
 262
 263 1;