2 /* ***** BEGIN LICENSE BLOCK *****
3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
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/
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
15 * The Original Code is libguac-client-rdp.
17 * The Initial Developer of the Original Code is
19 * Portions created by the Initial Developer are Copyright (C) 2011
20 * the Initial Developer. All Rights Reserved.
25 * Alternatively, the contents of this file may be used under the terms of
26 * either the GNU General Public License Version 2 or later (the "GPL"), or
27 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
28 * in which case the provisions of the GPL or the LGPL are applicable instead
29 * of those above. If you wish to allow use of your version of this file only
30 * under the terms of either the GPL or the LGPL, and not to allow others to
31 * use your version of this file under the terms of the MPL, indicate your
32 * decision by deleting the provisions above and replace them with the notice
33 * and other provisions required by the GPL or the LGPL. If you do not delete
34 * the provisions above, a recipient may use your version of this file under
35 * the terms of any one of the MPL, the GPL or the LGPL.
37 * ***** END LICENSE BLOCK ***** */
42 #include <sys/select.h>
45 #include <freerdp/freerdp.h>
46 #include <freerdp/utils/memory.h>
47 #include <freerdp/cache/bitmap.h>
48 #include <freerdp/cache/brush.h>
49 #include <freerdp/cache/glyph.h>
50 #include <freerdp/cache/palette.h>
51 #include <freerdp/cache/pointer.h>
52 #include <freerdp/cache/offscreen.h>
53 #include <freerdp/channels/channels.h>
54 #include <freerdp/input.h>
55 #include <freerdp/constants.h>
57 #include <guacamole/socket.h>
58 #include <guacamole/protocol.h>
59 #include <guacamole/client.h>
60 #include <guacamole/error.h>
63 #include "guac_handlers.h"
64 #include "rdp_keymap.h"
65 #include "rdp_bitmap.h"
66 #include "rdp_glyph.h"
67 #include "rdp_pointer.h"
70 /* Client plugin arguments */
71 const char* GUAC_CLIENT_ARGS[] = {
94 int __guac_receive_channel_data(freerdp* rdp_inst, int channelId, uint8* data, int size, int flags, int total_size) {
95 return freerdp_channels_data(rdp_inst, channelId, data, size, flags, total_size);
98 boolean rdp_freerdp_pre_connect(freerdp* instance) {
100 rdpContext* context = instance->context;
101 guac_client* client = ((rdp_freerdp_context*) context)->client;
102 rdpChannels* channels = context->channels;
106 rdpPrimaryUpdate* primary;
109 /* Load clipboard plugin */
110 freerdp_channels_load_plugin(channels, instance->settings, "cliprdr", NULL);
112 /* Init color conversion structure */
113 clrconv = xnew(CLRCONV);
117 clrconv->palette = xnew(rdpPalette);
118 ((rdp_freerdp_context*) context)->clrconv = clrconv;
120 /* Init FreeRDP cache */
121 instance->context->cache = cache_new(instance->settings);
123 /* Set up bitmap handling */
124 bitmap = xnew(rdpBitmap);
125 bitmap->size = sizeof(guac_rdp_bitmap);
126 bitmap->New = guac_rdp_bitmap_new;
127 bitmap->Free = guac_rdp_bitmap_free;
128 bitmap->Paint = guac_rdp_bitmap_paint;
129 bitmap->Decompress = guac_rdp_bitmap_decompress;
130 bitmap->SetSurface = guac_rdp_bitmap_setsurface;
131 graphics_register_bitmap(context->graphics, bitmap);
134 /* Set up glyph handling */
135 glyph = xnew(rdpGlyph);
136 glyph->size = sizeof(guac_rdp_glyph);
137 glyph->New = guac_rdp_glyph_new;
138 glyph->Free = guac_rdp_glyph_free;
139 glyph->Draw = guac_rdp_glyph_draw;
140 glyph->BeginDraw = guac_rdp_glyph_begindraw;
141 glyph->EndDraw = guac_rdp_glyph_enddraw;
142 graphics_register_glyph(context->graphics, glyph);
145 /* Set up pointer handling */
146 pointer = xnew(rdpPointer);
147 pointer->size = sizeof(guac_rdp_pointer);
148 pointer->New = guac_rdp_pointer_new;
149 pointer->Free = guac_rdp_pointer_free;
150 pointer->Set = guac_rdp_pointer_set;
151 graphics_register_pointer(context->graphics, pointer);
155 instance->update->Palette = guac_rdp_gdi_palette_update;
156 instance->update->SetBounds = guac_rdp_gdi_set_bounds;
158 primary = instance->update->primary;
159 primary->DstBlt = guac_rdp_gdi_dstblt;
160 primary->PatBlt = guac_rdp_gdi_patblt;
161 primary->ScrBlt = guac_rdp_gdi_scrblt;
162 primary->MemBlt = guac_rdp_gdi_memblt;
163 primary->OpaqueRect = guac_rdp_gdi_opaquerect;
165 pointer_cache_register_callbacks(instance->update);
166 glyph_cache_register_callbacks(instance->update);
167 brush_cache_register_callbacks(instance->update);
168 bitmap_cache_register_callbacks(instance->update);
169 offscreen_cache_register_callbacks(instance->update);
170 palette_cache_register_callbacks(instance->update);
172 /* Init channels (pre-connect) */
173 if (freerdp_channels_pre_connect(channels, instance)) {
174 guac_protocol_send_error(client->socket, "Error initializing RDP client channel manager");
175 guac_socket_flush(client->socket);
183 boolean rdp_freerdp_post_connect(freerdp* instance) {
185 rdpContext* context = instance->context;
186 guac_client* client = ((rdp_freerdp_context*) context)->client;
187 rdpChannels* channels = instance->context->channels;
189 /* Init channels (post-connect) */
190 if (freerdp_channels_post_connect(channels, instance)) {
191 guac_protocol_send_error(client->socket, "Error initializing RDP client channel manager");
192 guac_socket_flush(client->socket);
196 /* Client handlers */
197 client->free_handler = rdp_guac_client_free_handler;
198 client->handle_messages = rdp_guac_client_handle_messages;
199 client->mouse_handler = rdp_guac_client_mouse_handler;
200 client->key_handler = rdp_guac_client_key_handler;
203 guac_protocol_send_size(client->socket, GUAC_DEFAULT_LAYER,
204 instance->settings->width, instance->settings->height);
210 void rdp_freerdp_context_new(freerdp* instance, rdpContext* context) {
211 context->channels = freerdp_channels_new();
214 void rdp_freerdp_context_free(freerdp* instance, rdpContext* context) {
218 void __guac_rdp_client_load_keymap(guac_client* client,
219 const guac_rdp_keymap* keymap) {
221 rdp_guac_client_data* guac_client_data =
222 (rdp_guac_client_data*) client->data;
224 const guac_rdp_keysym_desc* mapping = keymap->mapping;
226 /* If parent exists, load parent first */
227 if (keymap->parent != NULL)
228 __guac_rdp_client_load_keymap(client, keymap->parent);
231 guac_client_log_info(client, "Loading keymap \"%s\"", keymap->name);
233 /* Load mapping into keymap */
234 while (mapping->keysym != 0) {
237 GUAC_RDP_KEYSYM_LOOKUP(guac_client_data->keymap, mapping->keysym) =
247 int guac_client_init(guac_client* client, int argc, char** argv) {
249 rdp_guac_client_data* guac_client_data;
252 rdpSettings* settings;
255 int port = RDP_DEFAULT_PORT;
256 boolean bitmap_cache;
260 guac_protocol_send_error(client->socket,
261 "Wrong argument count received.");
262 guac_socket_flush(client->socket);
264 guac_error = GUAC_STATUS_BAD_ARGUMENT;
265 guac_error_message = "Wrong argument count received";
270 /* If port specified, use it */
271 if (argv[IDX_PORT][0] != '\0')
272 port = atoi(argv[IDX_PORT]);
274 hostname = argv[IDX_HOSTNAME];
276 /* Allocate client data */
277 guac_client_data = malloc(sizeof(rdp_guac_client_data));
280 freerdp_channels_global_init();
281 rdp_inst = freerdp_new();
282 rdp_inst->PreConnect = rdp_freerdp_pre_connect;
283 rdp_inst->PostConnect = rdp_freerdp_post_connect;
284 rdp_inst->ReceiveChannelData = __guac_receive_channel_data;
286 /* Allocate FreeRDP context */
287 rdp_inst->context_size = sizeof(rdp_freerdp_context);
288 rdp_inst->ContextNew = (pContextNew) rdp_freerdp_context_new;
289 rdp_inst->ContextFree = (pContextFree) rdp_freerdp_context_free;
290 freerdp_context_new(rdp_inst);
293 settings = rdp_inst->settings;
296 settings->authentication = false;
299 settings->rdp_security = true;
300 settings->tls_security = false;
301 settings->nla_security = false;
302 settings->encryption = true;
303 settings->encryption_method = ENCRYPTION_METHOD_40BIT | ENCRYPTION_METHOD_128BIT | ENCRYPTION_METHOD_FIPS;
304 settings->encryption_level = ENCRYPTION_LEVEL_CLIENT_COMPATIBLE;
307 settings->width = 1024;
308 if (argv[IDX_WIDTH][0] != '\0')
309 settings->width = atoi(argv[IDX_WIDTH]);
310 if (settings->width == 0)
311 settings->width = 1024;
314 settings->height = 768;
315 if (argv[IDX_HEIGHT][0] != '\0')
316 settings->height = atoi(argv[IDX_HEIGHT]);
317 if (settings->height == 0)
318 settings->height = 768;
321 settings->hostname = strdup(hostname);
322 settings->port = port;
323 settings->window_title = strdup(hostname);
326 settings->username = "guest";
327 if (argv[IDX_USERNAME][0] != '\0')
328 settings->username = strdup (argv[IDX_USERNAME]);
331 if (argv[IDX_PASSWORD][0] != '\0') {
332 settings->password = strdup (argv[IDX_PASSWORD]);
333 settings->autologon = 1;
336 /* initial program */
337 if (argv[IDX_INITIAL_PROGRAM][0] != '\0')
338 settings->shell = strdup (argv[IDX_INITIAL_PROGRAM]);
341 bitmap_cache = settings->bitmap_cache;
342 settings->os_major_type = OSMAJORTYPE_UNSPECIFIED;
343 settings->os_minor_type = OSMINORTYPE_UNSPECIFIED;
344 settings->order_support[NEG_DSTBLT_INDEX] = true;
345 settings->order_support[NEG_PATBLT_INDEX] = false; /* PATBLT not yet supported */
346 settings->order_support[NEG_SCRBLT_INDEX] = true;
347 settings->order_support[NEG_OPAQUE_RECT_INDEX] = true;
348 settings->order_support[NEG_DRAWNINEGRID_INDEX] = false;
349 settings->order_support[NEG_MULTIDSTBLT_INDEX] = false;
350 settings->order_support[NEG_MULTIPATBLT_INDEX] = false;
351 settings->order_support[NEG_MULTISCRBLT_INDEX] = false;
352 settings->order_support[NEG_MULTIOPAQUERECT_INDEX] = false;
353 settings->order_support[NEG_MULTI_DRAWNINEGRID_INDEX] = false;
354 settings->order_support[NEG_LINETO_INDEX] = false;
355 settings->order_support[NEG_POLYLINE_INDEX] = false;
356 settings->order_support[NEG_MEMBLT_INDEX] = bitmap_cache;
357 settings->order_support[NEG_MEM3BLT_INDEX] = false;
358 settings->order_support[NEG_MEMBLT_V2_INDEX] = bitmap_cache;
359 settings->order_support[NEG_MEM3BLT_V2_INDEX] = false;
360 settings->order_support[NEG_SAVEBITMAP_INDEX] = false;
361 settings->order_support[NEG_GLYPH_INDEX_INDEX] = true;
362 settings->order_support[NEG_FAST_INDEX_INDEX] = true;
363 settings->order_support[NEG_FAST_GLYPH_INDEX] = true;
364 settings->order_support[NEG_POLYGON_SC_INDEX] = false;
365 settings->order_support[NEG_POLYGON_CB_INDEX] = false;
366 settings->order_support[NEG_ELLIPSE_SC_INDEX] = false;
367 settings->order_support[NEG_ELLIPSE_CB_INDEX] = false;
369 /* Store client data */
370 guac_client_data->rdp_inst = rdp_inst;
371 guac_client_data->mouse_button_mask = 0;
372 guac_client_data->current_surface = GUAC_DEFAULT_LAYER;
374 /* Clear keysym state mapping and keymap */
375 memset(guac_client_data->keysym_state, 0,
376 sizeof(guac_rdp_keysym_state_map));
378 memset(guac_client_data->keymap, 0,
379 sizeof(guac_rdp_static_keymap));
381 client->data = guac_client_data;
382 ((rdp_freerdp_context*) rdp_inst->context)->client = client;
384 /* Load keymap into client */
385 __guac_rdp_client_load_keymap(client, &guac_rdp_keymap_en_us);
387 /* Connect to RDP server */
388 if (!freerdp_connect(rdp_inst)) {
390 guac_protocol_send_error(client->socket,
391 "Error connecting to RDP server");
392 guac_socket_flush(client->socket);
394 guac_error = GUAC_STATUS_BAD_STATE;
395 guac_error_message = "Error connecting to RDP server";
400 /* Send connection name */
401 guac_protocol_send_name(client->socket, settings->window_title);