src/client.c

   1
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is libguac-client-rdp.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Michael Jumper.
  19  * Portions created by the Initial Developer are Copyright (C) 2011
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  * Matt Hortman
  24  * David PHAM-VAN <d.pham-van@ulteo.com> Ulteo SAS - http://www.ulteo.com
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #include <stdlib.h>
  41 #include <string.h>
  42
  43 #include <sys/select.h>
  44 #include <errno.h>
  45
  46 #include <freerdp/freerdp.h>
  47 #include <freerdp/utils/memory.h>
  48 #include <freerdp/cache/bitmap.h>
  49 #include <freerdp/cache/brush.h>
  50 #include <freerdp/cache/glyph.h>
  51 #include <freerdp/cache/palette.h>
  52 #include <freerdp/cache/pointer.h>
  53 #include <freerdp/cache/offscreen.h>
  54 #include <freerdp/channels/channels.h>
  55 #include <freerdp/input.h>
  56 #include <freerdp/constants.h>
  57
  58 #include <guacamole/socket.h>
  59 #include <guacamole/protocol.h>
  60 #include <guacamole/client.h>
  61 #include <guacamole/error.h>
  62
  63 #include "client.h"
  64 #include "guac_handlers.h"
  65 #include "rdp_keymap.h"
  66 #include "rdp_bitmap.h"
  67 #include "rdp_glyph.h"
  68 #include "rdp_pointer.h"
  69 #include "rdp_gdi.h"
  70 #include "default_pointer.h"
  71
  72 /* Client plugin arguments */
  73 const char* GUAC_CLIENT_ARGS[] = {
  74     "hostname",
  75     "port",
  76     "domain",
  77     "username",
  78     "password",
  79     "width",
  80     "height",
  81     "initial-program",
  82     "color-depth",
  83     NULL
  84 };
  85
  86 enum ARGS_IDX {
  87     IDX_HOSTNAME,
  88     IDX_PORT,
  89     IDX_DOMAIN,
  90     IDX_USERNAME,
  91     IDX_PASSWORD,
  92     IDX_WIDTH,
  93     IDX_HEIGHT,
  94     IDX_INITIAL_PROGRAM,
  95     IDX_COLOR_DEPTH
  96 };
  97
  98 int __guac_receive_channel_data(freerdp* rdp_inst, int channelId, uint8* data, int size, int flags, int total_size) {
  99     return freerdp_channels_data(rdp_inst, channelId, data, size, flags, total_size);
 100 }
 101
 102 boolean rdp_freerdp_pre_connect(freerdp* instance) {
 103
 104     rdpContext* context = instance->context;
 105     guac_client* client = ((rdp_freerdp_context*) context)->client;
 106     rdpChannels* channels = context->channels;
 107     rdpBitmap* bitmap;
 108     rdpGlyph* glyph;
 109     rdpPointer* pointer;
 110     rdpPrimaryUpdate* primary;
 111     CLRCONV* clrconv;
 112
 113     /* Load clipboard plugin */
 114     freerdp_channels_load_plugin(channels, instance->settings, "cliprdr", NULL);
 115
 116     /* Init color conversion structure */
 117     clrconv = xnew(CLRCONV);
 118     clrconv->alpha = 1;
 119     clrconv->invert = 0;
 120     clrconv->rgb555 = 0;
 121     clrconv->palette = xnew(rdpPalette);
 122     ((rdp_freerdp_context*) context)->clrconv = clrconv;
 123
 124     /* Init FreeRDP cache */
 125     instance->context->cache = cache_new(instance->settings);
 126
 127     /* Set up bitmap handling */
 128     bitmap = xnew(rdpBitmap);
 129     bitmap->size = sizeof(guac_rdp_bitmap);
 130     bitmap->New = guac_rdp_bitmap_new;
 131     bitmap->Free = guac_rdp_bitmap_free;
 132     bitmap->Paint = guac_rdp_bitmap_paint;
 133     bitmap->Decompress = guac_rdp_bitmap_decompress;
 134     bitmap->SetSurface = guac_rdp_bitmap_setsurface;
 135     graphics_register_bitmap(context->graphics, bitmap);
 136     xfree(bitmap);
 137
 138     /* Set up glyph handling */
 139     glyph = xnew(rdpGlyph);
 140     glyph->size = sizeof(guac_rdp_glyph);
 141     glyph->New = guac_rdp_glyph_new;
 142     glyph->Free = guac_rdp_glyph_free;
 143     glyph->Draw = guac_rdp_glyph_draw;
 144     glyph->BeginDraw = guac_rdp_glyph_begindraw;
 145     glyph->EndDraw = guac_rdp_glyph_enddraw;
 146     graphics_register_glyph(context->graphics, glyph);
 147     xfree(glyph);
 148
 149     /* Set up pointer handling */
 150     pointer = xnew(rdpPointer);
 151     pointer->size = sizeof(guac_rdp_pointer);
 152     pointer->New = guac_rdp_pointer_new;
 153     pointer->Free = guac_rdp_pointer_free;
 154     pointer->Set = guac_rdp_pointer_set;
 155     pointer->SetNull = guac_rdp_pointer_set_null;
 156     pointer->SetDefault = guac_rdp_pointer_set_default;
 157     graphics_register_pointer(context->graphics, pointer);
 158     xfree(pointer);
 159
 160     /* Set up GDI */
 161     instance->update->EndPaint = guac_rdp_gdi_end_paint;
 162     instance->update->Palette = guac_rdp_gdi_palette_update;
 163     instance->update->SetBounds = guac_rdp_gdi_set_bounds;
 164
 165     primary = instance->update->primary;
 166     primary->DstBlt = guac_rdp_gdi_dstblt;
 167     primary->PatBlt = guac_rdp_gdi_patblt;
 168     primary->ScrBlt = guac_rdp_gdi_scrblt;
 169     primary->MemBlt = guac_rdp_gdi_memblt;
 170     primary->OpaqueRect = guac_rdp_gdi_opaquerect;
 171
 172     pointer_cache_register_callbacks(instance->update);
 173     glyph_cache_register_callbacks(instance->update);
 174     brush_cache_register_callbacks(instance->update);
 175     bitmap_cache_register_callbacks(instance->update);
 176     offscreen_cache_register_callbacks(instance->update);
 177     palette_cache_register_callbacks(instance->update);
 178
 179     /* Init channels (pre-connect) */
 180     if (freerdp_channels_pre_connect(channels, instance)) {
 181         guac_protocol_send_error(client->socket, "Error initializing RDP client channel manager");
 182         guac_socket_flush(client->socket);
 183         return false;
 184     }
 185
 186     return true;
 187
 188 }
 189
 190 boolean rdp_freerdp_post_connect(freerdp* instance) {
 191
 192     rdpContext* context = instance->context;
 193     guac_client* client = ((rdp_freerdp_context*) context)->client;
 194     rdpChannels* channels = instance->context->channels;
 195
 196     /* Init channels (post-connect) */
 197     if (freerdp_channels_post_connect(channels, instance)) {
 198         guac_protocol_send_error(client->socket, "Error initializing RDP client channel manager");
 199         guac_socket_flush(client->socket);
 200         return false;
 201     }
 202
 203     /* Client handlers */
 204     client->free_handler = rdp_guac_client_free_handler;
 205     client->handle_messages = rdp_guac_client_handle_messages;
 206     client->mouse_handler = rdp_guac_client_mouse_handler;
 207     client->key_handler = rdp_guac_client_key_handler;
 208     client->clipboard_handler = rdp_guac_client_clipboard_handler;
 209
 210     return true;
 211
 212 }
 213
 214 void rdp_freerdp_context_new(freerdp* instance, rdpContext* context) {
 215     context->channels = freerdp_channels_new();
 216 }
 217
 218 void rdp_freerdp_context_free(freerdp* instance, rdpContext* context) {
 219     /* EMPTY */
 220 }
 221
 222 void __guac_rdp_client_load_keymap(guac_client* client,
 223         const guac_rdp_keymap* keymap) {
 224
 225     rdp_guac_client_data* guac_client_data =
 226         (rdp_guac_client_data*) client->data;
 227
 228     /* Get mapping */
 229     const guac_rdp_keysym_desc* mapping = keymap->mapping;
 230
 231     /* If parent exists, load parent first */
 232     if (keymap->parent != NULL)
 233         __guac_rdp_client_load_keymap(client, keymap->parent);
 234
 235     /* Log load */
 236     guac_client_log_info(client, "Loading keymap \"%s\"", keymap->name);
 237
 238     /* Load mapping into keymap */
 239     while (mapping->keysym != 0) {
 240
 241         /* Copy mapping */
 242         GUAC_RDP_KEYSYM_LOOKUP(guac_client_data->keymap, mapping->keysym) =
 243             *mapping;
 244
 245         /* Next keysym */
 246         mapping++;
 247
 248     }
 249
 250 }
 251
 252 int guac_client_init(guac_client* client, int argc, char** argv) {
 253
 254     rdp_guac_client_data* guac_client_data;
 255
 256     freerdp* rdp_inst;
 257     rdpSettings* settings;
 258
 259     char* hostname;
 260     int port = RDP_DEFAULT_PORT;
 261     boolean bitmap_cache;
 262
 263     /**
 264      * Selected server-side keymap. Client will be assumed to also use this
 265      * keymap. Keys will be sent to server based on client input on a
 266      * best-effort basis.
 267      *
 268      * Currently hard-coded to en-us-qwerty.
 269      */
 270     const guac_rdp_keymap* chosen_keymap = &guac_rdp_keymap_en_us;
 271
 272     if (argc < 9) {
 273
 274         guac_protocol_send_error(client->socket,
 275                 "Wrong argument count received.");
 276         guac_socket_flush(client->socket);
 277
 278         guac_error = GUAC_STATUS_BAD_ARGUMENT;
 279         guac_error_message = "Wrong argument count received";
 280
 281         return 1;
 282     }
 283
 284     /* If port specified, use it */
 285     if (argv[IDX_PORT][0] != '\0')
 286         port = atoi(argv[IDX_PORT]);
 287
 288     hostname = argv[IDX_HOSTNAME];
 289
 290     /* Allocate client data */
 291     guac_client_data = malloc(sizeof(rdp_guac_client_data));
 292
 293     /* Init client */
 294     freerdp_channels_global_init();
 295     rdp_inst = freerdp_new();
 296     rdp_inst->PreConnect = rdp_freerdp_pre_connect;
 297     rdp_inst->PostConnect = rdp_freerdp_post_connect;
 298     rdp_inst->ReceiveChannelData = __guac_receive_channel_data;
 299
 300     /* Allocate FreeRDP context */
 301     rdp_inst->context_size = sizeof(rdp_freerdp_context);
 302     rdp_inst->ContextNew  = (pContextNew) rdp_freerdp_context_new;
 303     rdp_inst->ContextFree = (pContextFree) rdp_freerdp_context_free;
 304     freerdp_context_new(rdp_inst);
 305
 306     /* Set settings */
 307     settings = rdp_inst->settings;
 308
 309     /* --no-auth */
 310     settings->authentication = false;
 311
 312     /* --sec rdp */
 313     settings->rdp_security = true;
 314     settings->tls_security = false;
 315     settings->nla_security = false;
 316     settings->encryption = true;
 317     settings->encryption_method = ENCRYPTION_METHOD_40BIT | ENCRYPTION_METHOD_128BIT | ENCRYPTION_METHOD_FIPS;
 318     settings->encryption_level = ENCRYPTION_LEVEL_CLIENT_COMPATIBLE;
 319
 320     /* session width */
 321     settings->width = 1024;
 322     if (argv[IDX_WIDTH][0] != '\0')
 323         settings->width = atoi(argv[IDX_WIDTH]);
 324     if (settings->width == 0)
 325         settings->width = 1024;
 326
 327     /* session height */
 328     settings->height = 768;
 329     if (argv[IDX_HEIGHT][0] != '\0')
 330         settings->height = atoi(argv[IDX_HEIGHT]);
 331     if (settings->height == 0)
 332         settings->height = 768;
 333
 334     /* Set hostname */
 335     settings->hostname = strdup(hostname);
 336     settings->port = port;
 337     settings->window_title = strdup(hostname);
 338
 339     /* Domain */
 340     if (argv[IDX_DOMAIN][0] != '\0')
 341         settings->domain = strdup(argv[IDX_DOMAIN]);
 342
 343     /* Username */
 344     if (argv[IDX_USERNAME][0] != '\0')
 345         settings->username = strdup(argv[IDX_USERNAME]);
 346
 347     /* Password */
 348     if (argv[IDX_PASSWORD][0] != '\0') {
 349         settings->password = strdup(argv[IDX_PASSWORD]);
 350         settings->autologon = 1;
 351     }
 352
 353     /* Initial program */
 354     if (argv[IDX_INITIAL_PROGRAM][0] != '\0')
 355         settings->shell = strdup(argv[IDX_INITIAL_PROGRAM]);
 356
 357     /* Order support */
 358     bitmap_cache = settings->bitmap_cache;
 359     settings->os_major_type = OSMAJORTYPE_UNSPECIFIED;
 360     settings->os_minor_type = OSMINORTYPE_UNSPECIFIED;
 361     settings->order_support[NEG_DSTBLT_INDEX] = true;
 362     settings->order_support[NEG_PATBLT_INDEX] = false; /* PATBLT not yet supported */
 363     settings->order_support[NEG_SCRBLT_INDEX] = true;
 364     settings->order_support[NEG_OPAQUE_RECT_INDEX] = true;
 365     settings->order_support[NEG_DRAWNINEGRID_INDEX] = false;
 366     settings->order_support[NEG_MULTIDSTBLT_INDEX] = false;
 367     settings->order_support[NEG_MULTIPATBLT_INDEX] = false;
 368     settings->order_support[NEG_MULTISCRBLT_INDEX] = false;
 369     settings->order_support[NEG_MULTIOPAQUERECT_INDEX] = false;
 370     settings->order_support[NEG_MULTI_DRAWNINEGRID_INDEX] = false;
 371     settings->order_support[NEG_LINETO_INDEX] = false;
 372     settings->order_support[NEG_POLYLINE_INDEX] = false;
 373     settings->order_support[NEG_MEMBLT_INDEX] = bitmap_cache;
 374     settings->order_support[NEG_MEM3BLT_INDEX] = false;
 375     settings->order_support[NEG_MEMBLT_V2_INDEX] = bitmap_cache;
 376     settings->order_support[NEG_MEM3BLT_V2_INDEX] = false;
 377     settings->order_support[NEG_SAVEBITMAP_INDEX] = false;
 378     settings->order_support[NEG_GLYPH_INDEX_INDEX] = true;
 379     settings->order_support[NEG_FAST_INDEX_INDEX] = true;
 380     settings->order_support[NEG_FAST_GLYPH_INDEX] = true;
 381     settings->order_support[NEG_POLYGON_SC_INDEX] = false;
 382     settings->order_support[NEG_POLYGON_CB_INDEX] = false;
 383     settings->order_support[NEG_ELLIPSE_SC_INDEX] = false;
 384     settings->order_support[NEG_ELLIPSE_CB_INDEX] = false;
 385
 386     /* Store client data */
 387     guac_client_data->rdp_inst = rdp_inst;
 388     guac_client_data->mouse_button_mask = 0;
 389     guac_client_data->current_surface = GUAC_DEFAULT_LAYER;
 390     guac_client_data->clipboard = NULL;
 391
 392     /* Clear keysym state mapping and keymap */
 393     memset(guac_client_data->keysym_state, 0,
 394             sizeof(guac_rdp_keysym_state_map));
 395
 396     memset(guac_client_data->keymap, 0,
 397             sizeof(guac_rdp_static_keymap));
 398
 399     client->data = guac_client_data;
 400     ((rdp_freerdp_context*) rdp_inst->context)->client = client;
 401
 402     /* Load keymap into client */
 403     __guac_rdp_client_load_keymap(client, chosen_keymap);
 404
 405     /* Set server-side keymap */
 406     settings->kbd_layout = chosen_keymap->freerdp_keyboard_layout;
 407
 408     /* Connect to RDP server */
 409     if (!freerdp_connect(rdp_inst)) {
 410
 411         guac_protocol_send_error(client->socket,
 412                 "Error connecting to RDP server");
 413         guac_socket_flush(client->socket);
 414
 415         guac_error = GUAC_STATUS_BAD_STATE;
 416         guac_error_message = "Error connecting to RDP server";
 417
 418         return 1;
 419     }
 420
 421     /* Send connection name */
 422     guac_protocol_send_name(client->socket, settings->window_title);
 423
 424     /* Send size */
 425     guac_protocol_send_size(client->socket, GUAC_DEFAULT_LAYER,
 426             settings->width, settings->height);
 427
 428     /* Create glyph surfaces */
 429     guac_client_data->opaque_glyph_surface = cairo_image_surface_create(
 430             CAIRO_FORMAT_RGB24, settings->width, settings->height);
 431
 432     guac_client_data->trans_glyph_surface = cairo_image_surface_create(
 433             CAIRO_FORMAT_ARGB32, settings->width, settings->height);
 434
 435     /* Set default pointer */
 436     guac_rdp_pointer_set_default(client);
 437
 438     /* Success */
 439     return 0;
 440
 441 }
 442