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