Milestone 5: deliver embedded RDP sessions and lifecycle hardening

third_party/FreeRDP/channels/rail/client/CMakeLists.txt

@@ -0,0 +1,31 @@
+# FreeRDP: A Remote Desktop Protocol Implementation
+# FreeRDP cmake build script
+#
+# Copyright 2012 Marc-Andre Moreau <marcandre.moreau@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+define_channel_client("rail")
+
+set(${MODULE_PREFIX}_SRCS
+    ../rail_common.h
+    ../rail_common.c
+    client_rails.c
+    rail_main.c
+    rail_main.h
+    rail_orders.c
+    rail_orders.h
+)
+
+set(${MODULE_PREFIX}_LIBS freerdp)
+add_channel_client_library(${MODULE_PREFIX} ${MODULE_NAME} ${CHANNEL_NAME} FALSE "VirtualChannelEntryEx")

third_party/FreeRDP/channels/rail/client/client_rails.c

@@ -0,0 +1,104 @@
+
+#include <winpr/cast.h>
+
+#include <freerdp/freerdp.h>
+#include <freerdp/client/rail.h>
+
+#include "rail_main.h"
+
+UINT client_rail_server_start_cmd(RailClientContext* context)
+{
+	UINT status = 0;
+	char argsAndFile[520] = WINPR_C_ARRAY_INIT;
+	RAIL_EXEC_ORDER exec = WINPR_C_ARRAY_INIT;
+	RAIL_SYSPARAM_ORDER sysparam = WINPR_C_ARRAY_INIT;
+	RAIL_CLIENT_STATUS_ORDER clientStatus = WINPR_C_ARRAY_INIT;
+
+	WINPR_ASSERT(context);
+	railPlugin* rail = context->handle;
+	WINPR_ASSERT(rail);
+	WINPR_ASSERT(rail->rdpcontext);
+
+	const rdpSettings* settings = rail->rdpcontext->settings;
+	WINPR_ASSERT(settings);
+
+	clientStatus.flags = TS_RAIL_CLIENTSTATUS_ALLOWLOCALMOVESIZE;
+
+	if (freerdp_settings_get_bool(settings, FreeRDP_AutoReconnectionEnabled))
+		clientStatus.flags |= TS_RAIL_CLIENTSTATUS_AUTORECONNECT;
+
+	clientStatus.flags |= TS_RAIL_CLIENTSTATUS_ZORDER_SYNC;
+	clientStatus.flags |= TS_RAIL_CLIENTSTATUS_WINDOW_RESIZE_MARGIN_SUPPORTED;
+	clientStatus.flags |= TS_RAIL_CLIENTSTATUS_APPBAR_REMOTING_SUPPORTED;
+	clientStatus.flags |= TS_RAIL_CLIENTSTATUS_POWER_DISPLAY_REQUEST_SUPPORTED;
+	clientStatus.flags |= TS_RAIL_CLIENTSTATUS_BIDIRECTIONAL_CLOAK_SUPPORTED;
+	status = context->ClientInformation(context, &clientStatus);
+
+	if (status != CHANNEL_RC_OK)
+		return status;
+
+	if (freerdp_settings_get_bool(settings, FreeRDP_RemoteAppLanguageBarSupported))
+	{
+		RAIL_LANGBAR_INFO_ORDER langBarInfo;
+		langBarInfo.languageBarStatus = 0x00000008; /* TF_SFT_HIDDEN */
+		status = context->ClientLanguageBarInfo(context, &langBarInfo);
+
+		/* We want the language bar, but the server might not support it. */
+		switch (status)
+		{
+			case CHANNEL_RC_OK:
+			case ERROR_BAD_CONFIGURATION:
+				break;
+			default:
+				return status;
+		}
+	}
+
+	sysparam.params = 0;
+	sysparam.params |= SPI_MASK_SET_HIGH_CONTRAST;
+	sysparam.highContrast.colorScheme.string = nullptr;
+	sysparam.highContrast.colorScheme.length = 0;
+	sysparam.highContrast.flags = 0x7E;
+	sysparam.params |= SPI_MASK_SET_MOUSE_BUTTON_SWAP;
+	sysparam.mouseButtonSwap = FALSE;
+	sysparam.params |= SPI_MASK_SET_KEYBOARD_PREF;
+	sysparam.keyboardPref = FALSE;
+	sysparam.params |= SPI_MASK_SET_DRAG_FULL_WINDOWS;
+	sysparam.dragFullWindows = FALSE;
+	sysparam.params |= SPI_MASK_SET_KEYBOARD_CUES;
+	sysparam.keyboardCues = FALSE;
+	sysparam.params |= SPI_MASK_SET_WORK_AREA;
+	sysparam.workArea.left = 0;
+	sysparam.workArea.top = 0;
+
+	const UINT32 w = freerdp_settings_get_uint32(settings, FreeRDP_DesktopWidth);
+	const UINT32 h = freerdp_settings_get_uint32(settings, FreeRDP_DesktopHeight);
+
+	sysparam.workArea.right = WINPR_ASSERTING_INT_CAST(UINT16, w);
+	sysparam.workArea.bottom = WINPR_ASSERTING_INT_CAST(UINT16, h);
+	sysparam.dragFullWindows = FALSE;
+	status = context->ClientSystemParam(context, &sysparam);
+
+	if (status != CHANNEL_RC_OK)
+		return status;
+
+	const char* RemoteApplicationFile =
+	    freerdp_settings_get_string(settings, FreeRDP_RemoteApplicationFile);
+	const char* RemoteApplicationCmdLine =
+	    freerdp_settings_get_string(settings, FreeRDP_RemoteApplicationCmdLine);
+	if (RemoteApplicationFile && RemoteApplicationCmdLine)
+	{
+		(void)_snprintf(argsAndFile, ARRAYSIZE(argsAndFile), "%s %s", RemoteApplicationCmdLine,
+		                RemoteApplicationFile);
+		exec.RemoteApplicationArguments = argsAndFile;
+	}
+	else if (RemoteApplicationFile)
+		exec.RemoteApplicationArguments = RemoteApplicationFile;
+	else
+		exec.RemoteApplicationArguments = RemoteApplicationCmdLine;
+	exec.RemoteApplicationProgram =
+	    freerdp_settings_get_string(settings, FreeRDP_RemoteApplicationProgram);
+	exec.RemoteApplicationWorkingDir =
+	    freerdp_settings_get_string(settings, FreeRDP_ShellWorkingDirectory);
+	return context->ClientExecute(context, &exec);
+}

third_party/FreeRDP/channels/rail/client/rail_main.c

@@ -0,0 +1,761 @@
+/**
+ * FreeRDP: A Remote Desktop Protocol Implementation
+ * RAIL Virtual Channel Plugin
+ *
+ * Copyright 2011 Marc-Andre Moreau <marcandre.moreau@gmail.com>
+ * Copyright 2011 Roman Barabanov <romanbarabanov@gmail.com>
+ * Copyright 2011 Vic Lee
+ * Copyright 2015 Thincast Technologies GmbH
+ * Copyright 2015 DI (FH) Martin Haimberger <martin.haimberger@thincast.com>
+ * Copyright 2017 Armin Novak <armin.novak@thincast.com>
+ * Copyright 2017 Thincast Technologies GmbH
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include <freerdp/config.h>
+
+#include <winpr/crt.h>
+
+#include <freerdp/types.h>
+#include <freerdp/constants.h>
+#include <freerdp/freerdp.h>
+
+#include "rail_orders.h"
+#include "rail_main.h"
+
+#include "../../../channels/client/addin.h"
+
+RailClientContext* rail_get_client_interface(railPlugin* rail)
+{
+	RailClientContext* pInterface = nullptr;
+
+	if (!rail)
+		return nullptr;
+
+	pInterface = (RailClientContext*)rail->channelEntryPoints.pInterface;
+	return pInterface;
+}
+
+/**
+ * Function description
+ *
+ * @return 0 on success, otherwise a Win32 error code
+ */
+static UINT rail_send(railPlugin* rail, wStream* s)
+{
+	UINT status = 0;
+
+	if (!rail)
+	{
+		Stream_Free(s, TRUE);
+		return CHANNEL_RC_BAD_INIT_HANDLE;
+	}
+
+	status = rail->channelEntryPoints.pVirtualChannelWriteEx(
+	    rail->InitHandle, rail->OpenHandle, Stream_Buffer(s), (UINT32)Stream_GetPosition(s), s);
+
+	if (status != CHANNEL_RC_OK)
+	{
+		Stream_Free(s, TRUE);
+		WLog_ERR(TAG, "pVirtualChannelWriteEx failed with %s [%08" PRIX32 "]",
+		         WTSErrorToString(status), status);
+	}
+
+	return status;
+}
+
+/**
+ * Function description
+ *
+ * @return 0 on success, otherwise a Win32 error code
+ */
+UINT rail_send_channel_data(railPlugin* rail, wStream* src)
+{
+	if (!rail || !src)
+	{
+		Stream_Free(src, TRUE);
+		return ERROR_INVALID_PARAMETER;
+	}
+
+	return rail_send(rail, src);
+}
+
+/**
+ * Callback Interface
+ */
+
+/**
+ * Function description
+ *
+ * @return 0 on success, otherwise a Win32 error code
+ */
+static UINT rail_client_execute(RailClientContext* context, const RAIL_EXEC_ORDER* exec)
+{
+	const char* exeOrFile = nullptr;
+	UINT error = 0;
+	railPlugin* rail = nullptr;
+	UINT16 flags = 0;
+	RAIL_UNICODE_STRING ruExeOrFile = WINPR_C_ARRAY_INIT;
+	RAIL_UNICODE_STRING ruWorkingDir = WINPR_C_ARRAY_INIT;
+	RAIL_UNICODE_STRING ruArguments = WINPR_C_ARRAY_INIT;
+
+	if (!context || !exec)
+		return ERROR_INVALID_PARAMETER;
+
+	rail = (railPlugin*)context->handle;
+	exeOrFile = exec->RemoteApplicationProgram;
+	flags = exec->flags;
+
+	if (!exeOrFile)
+		return ERROR_INVALID_PARAMETER;
+
+	if (!utf8_string_to_rail_string(exec->RemoteApplicationProgram,
+	                                &ruExeOrFile) || /* RemoteApplicationProgram */
+	    !utf8_string_to_rail_string(exec->RemoteApplicationWorkingDir,
+	                                &ruWorkingDir) || /* ShellWorkingDirectory */
+	    !utf8_string_to_rail_string(exec->RemoteApplicationArguments,
+	                                &ruArguments)) /* RemoteApplicationCmdLine */
+		error = ERROR_INTERNAL_ERROR;
+	else
+		error = rail_send_client_exec_order(rail, flags, &ruExeOrFile, &ruWorkingDir, &ruArguments);
+
+	free(ruExeOrFile.string);
+	free(ruWorkingDir.string);
+	free(ruArguments.string);
+	return error;
+}
+
+/**
+ * Function description
+ *
+ * @return 0 on success, otherwise a Win32 error code
+ */
+static UINT rail_client_activate(RailClientContext* context, const RAIL_ACTIVATE_ORDER* activate)
+{
+	railPlugin* rail = nullptr;
+
+	if (!context || !activate)
+		return ERROR_INVALID_PARAMETER;
+
+	rail = (railPlugin*)context->handle;
+	return rail_send_client_activate_order(rail, activate);
+}
+
+/**
+ * Function description
+ *
+ * @return 0 on success, otherwise a Win32 error code
+ */
+static UINT rail_send_client_sysparam(RailClientContext* context, RAIL_SYSPARAM_ORDER* sysparam)
+{
+	wStream* s = nullptr;
+	size_t length = RAIL_SYSPARAM_ORDER_LENGTH;
+	railPlugin* rail = nullptr;
+	UINT error = 0;
+	BOOL extendedSpiSupported = 0;
+
+	if (!context || !sysparam)
+		return ERROR_INVALID_PARAMETER;
+
+	rail = (railPlugin*)context->handle;
+
+	switch (sysparam->param)
+	{
+		case SPI_SET_DRAG_FULL_WINDOWS:
+		case SPI_SET_KEYBOARD_CUES:
+		case SPI_SET_KEYBOARD_PREF:
+		case SPI_SET_MOUSE_BUTTON_SWAP:
+			length += 1;
+			break;
+
+		case SPI_SET_WORK_AREA:
+		case SPI_DISPLAY_CHANGE:
+		case SPI_TASKBAR_POS:
+			length += 8;
+			break;
+
+		case SPI_SET_HIGH_CONTRAST:
+			length += sysparam->highContrast.colorSchemeLength + 10;
+			break;
+
+		case SPI_SETFILTERKEYS:
+			length += 20;
+			break;
+
+		case SPI_SETSTICKYKEYS:
+		case SPI_SETCARETWIDTH:
+		case SPI_SETTOGGLEKEYS:
+			length += 4;
+			break;
+
+		default:
+			return ERROR_BAD_ARGUMENTS;
+	}
+
+	s = rail_pdu_init(length);
+
+	if (!s)
+	{
+		WLog_ERR(TAG, "rail_pdu_init failed!");
+		return CHANNEL_RC_NO_MEMORY;
+	}
+
+	extendedSpiSupported = rail_is_extended_spi_supported(rail->channelFlags);
+	if ((error = rail_write_sysparam_order(s, sysparam, extendedSpiSupported)))
+	{
+		WLog_ERR(TAG, "rail_write_client_sysparam_order failed with error %" PRIu32 "!", error);
+		Stream_Free(s, TRUE);
+		return error;
+	}
+
+	return rail_send_pdu(rail, s, TS_RAIL_ORDER_SYSPARAM);
+}
+
+/**
+ * Function description
+ *
+ * @return 0 on success, otherwise a Win32 error code
+ */
+static UINT rail_client_system_param(RailClientContext* context,
+                                     const RAIL_SYSPARAM_ORDER* sysInParam)
+{
+	UINT error = CHANNEL_RC_OK;
+	RAIL_SYSPARAM_ORDER sysparam;
+
+	if (!context || !sysInParam)
+		return ERROR_INVALID_PARAMETER;
+
+	sysparam = *sysInParam;
+
+	if (sysparam.params & SPI_MASK_SET_HIGH_CONTRAST)
+	{
+		sysparam.param = SPI_SET_HIGH_CONTRAST;
+
+		if ((error = rail_send_client_sysparam(context, &sysparam)))
+		{
+			WLog_ERR(TAG, "rail_send_client_sysparam failed with error %" PRIu32 "!", error);
+			return error;
+		}
+	}
+
+	if (sysparam.params & SPI_MASK_TASKBAR_POS)
+	{
+		sysparam.param = SPI_TASKBAR_POS;
+
+		if ((error = rail_send_client_sysparam(context, &sysparam)))
+		{
+			WLog_ERR(TAG, "rail_send_client_sysparam failed with error %" PRIu32 "!", error);
+			return error;
+		}
+	}
+
+	if (sysparam.params & SPI_MASK_SET_MOUSE_BUTTON_SWAP)
+	{
+		sysparam.param = SPI_SET_MOUSE_BUTTON_SWAP;
+
+		if ((error = rail_send_client_sysparam(context, &sysparam)))
+		{
+			WLog_ERR(TAG, "rail_send_client_sysparam failed with error %" PRIu32 "!", error);
+			return error;
+		}
+	}
+
+	if (sysparam.params & SPI_MASK_SET_KEYBOARD_PREF)
+	{
+		sysparam.param = SPI_SET_KEYBOARD_PREF;
+
+		if ((error = rail_send_client_sysparam(context, &sysparam)))
+		{
+			WLog_ERR(TAG, "rail_send_client_sysparam failed with error %" PRIu32 "!", error);
+			return error;
+		}
+	}
+
+	if (sysparam.params & SPI_MASK_SET_DRAG_FULL_WINDOWS)
+	{
+		sysparam.param = SPI_SET_DRAG_FULL_WINDOWS;
+
+		if ((error = rail_send_client_sysparam(context, &sysparam)))
+		{
+			WLog_ERR(TAG, "rail_send_client_sysparam failed with error %" PRIu32 "!", error);
+			return error;
+		}
+	}
+
+	if (sysparam.params & SPI_MASK_SET_KEYBOARD_CUES)
+	{
+		sysparam.param = SPI_SET_KEYBOARD_CUES;
+
+		if ((error = rail_send_client_sysparam(context, &sysparam)))
+		{
+			WLog_ERR(TAG, "rail_send_client_sysparam failed with error %" PRIu32 "!", error);
+			return error;
+		}
+	}
+
+	if (sysparam.params & SPI_MASK_SET_WORK_AREA)
+	{
+		sysparam.param = SPI_SET_WORK_AREA;
+
+		if ((error = rail_send_client_sysparam(context, &sysparam)))
+		{
+			WLog_ERR(TAG, "rail_send_client_sysparam failed with error %" PRIu32 "!", error);
+			return error;
+		}
+	}
+
+	return error;
+}
+
+/**
+ * Function description
+ *
+ * @return 0 on success, otherwise a Win32 error code
+ */
+static UINT rail_client_system_command(RailClientContext* context,
+                                       const RAIL_SYSCOMMAND_ORDER* syscommand)
+{
+	railPlugin* rail = nullptr;
+
+	if (!context || !syscommand)
+		return ERROR_INVALID_PARAMETER;
+
+	rail = (railPlugin*)context->handle;
+	return rail_send_client_syscommand_order(rail, syscommand);
+}
+
+/**
+ * Function description
+ *
+ * @return 0 on success, otherwise a Win32 error code
+ */
+static UINT rail_client_handshake(RailClientContext* context, const RAIL_HANDSHAKE_ORDER* handshake)
+{
+	railPlugin* rail = nullptr;
+
+	if (!context || !handshake)
+		return ERROR_INVALID_PARAMETER;
+
+	rail = (railPlugin*)context->handle;
+	return rail_send_handshake_order(rail, handshake);
+}
+
+/**
+ * Function description
+ *
+ * @return 0 on success, otherwise a Win32 error code
+ */
+static UINT rail_client_notify_event(RailClientContext* context,
+                                     const RAIL_NOTIFY_EVENT_ORDER* notifyEvent)
+{
+	railPlugin* rail = nullptr;
+
+	if (!context || !notifyEvent)
+		return ERROR_INVALID_PARAMETER;
+
+	rail = (railPlugin*)context->handle;
+	return rail_send_client_notify_event_order(rail, notifyEvent);
+}
+
+/**
+ * Function description
+ *
+ * @return 0 on success, otherwise a Win32 error code
+ */
+static UINT rail_client_window_move(RailClientContext* context,
+                                    const RAIL_WINDOW_MOVE_ORDER* windowMove)
+{
+	railPlugin* rail = nullptr;
+
+	if (!context || !windowMove)
+		return ERROR_INVALID_PARAMETER;
+
+	rail = (railPlugin*)context->handle;
+	return rail_send_client_window_move_order(rail, windowMove);
+}
+
+/**
+ * Function description
+ *
+ * @return 0 on success, otherwise a Win32 error code
+ */
+static UINT rail_client_information(RailClientContext* context,
+                                    const RAIL_CLIENT_STATUS_ORDER* clientStatus)
+{
+	railPlugin* rail = nullptr;
+
+	if (!context || !clientStatus)
+		return ERROR_INVALID_PARAMETER;
+
+	rail = (railPlugin*)context->handle;
+	return rail_send_client_status_order(rail, clientStatus);
+}
+
+/**
+ * Function description
+ *
+ * @return 0 on success, otherwise a Win32 error code
+ */
+static UINT rail_client_system_menu(RailClientContext* context, const RAIL_SYSMENU_ORDER* sysmenu)
+{
+	railPlugin* rail = nullptr;
+
+	if (!context || !sysmenu)
+		return ERROR_INVALID_PARAMETER;
+
+	rail = (railPlugin*)context->handle;
+	return rail_send_client_sysmenu_order(rail, sysmenu);
+}
+
+/**
+ * Function description
+ *
+ * @return 0 on success, otherwise a Win32 error code
+ */
+static UINT rail_client_language_bar_info(RailClientContext* context,
+                                          const RAIL_LANGBAR_INFO_ORDER* langBarInfo)
+{
+	railPlugin* rail = nullptr;
+
+	if (!context || !langBarInfo)
+		return ERROR_INVALID_PARAMETER;
+
+	rail = (railPlugin*)context->handle;
+	return rail_send_client_langbar_info_order(rail, langBarInfo);
+}
+
+static UINT rail_client_language_ime_info(RailClientContext* context,
+                                          const RAIL_LANGUAGEIME_INFO_ORDER* langImeInfo)
+{
+	railPlugin* rail = nullptr;
+
+	if (!context || !langImeInfo)
+		return ERROR_INVALID_PARAMETER;
+
+	rail = (railPlugin*)context->handle;
+	return rail_send_client_languageime_info_order(rail, langImeInfo);
+}
+
+/**
+ * Function description
+ *
+ * @return 0 on success, otherwise a Win32 error code
+ */
+static UINT rail_client_get_appid_request(RailClientContext* context,
+                                          const RAIL_GET_APPID_REQ_ORDER* getAppIdReq)
+{
+	railPlugin* rail = nullptr;
+
+	if (!context || !getAppIdReq || !context->handle)
+		return ERROR_INVALID_PARAMETER;
+
+	rail = (railPlugin*)context->handle;
+	return rail_send_client_get_appid_req_order(rail, getAppIdReq);
+}
+
+static UINT rail_client_compartment_info(RailClientContext* context,
+                                         const RAIL_COMPARTMENT_INFO_ORDER* compartmentInfo)
+{
+	railPlugin* rail = nullptr;
+
+	if (!context || !compartmentInfo || !context->handle)
+		return ERROR_INVALID_PARAMETER;
+
+	rail = (railPlugin*)context->handle;
+	return rail_send_client_compartment_info_order(rail, compartmentInfo);
+}
+
+static UINT rail_client_cloak(RailClientContext* context, const RAIL_CLOAK* cloak)
+{
+	railPlugin* rail = nullptr;
+
+	if (!context || !cloak || !context->handle)
+		return ERROR_INVALID_PARAMETER;
+
+	rail = (railPlugin*)context->handle;
+	return rail_send_client_cloak_order(rail, cloak);
+}
+
+static UINT rail_client_snap_arrange(RailClientContext* context, const RAIL_SNAP_ARRANGE* snap)
+{
+	railPlugin* rail = nullptr;
+
+	if (!context || !snap || !context->handle)
+		return ERROR_INVALID_PARAMETER;
+
+	rail = (railPlugin*)context->handle;
+	return rail_send_client_snap_arrange_order(rail, snap);
+}
+
+static UINT rail_client_text_scale(RailClientContext* context, UINT32 textScale)
+{
+	if (!context || !context->handle)
+		return ERROR_INVALID_PARAMETER;
+
+	railPlugin* rail = (railPlugin*)context->handle;
+	return rail_send_client_text_scale_order(rail, textScale);
+}
+
+static UINT rail_client_caret_blink_rate(RailClientContext* context, UINT32 rate)
+{
+	if (!context || !context->handle)
+		return ERROR_INVALID_PARAMETER;
+
+	railPlugin* rail = (railPlugin*)context->handle;
+	return rail_send_client_caret_blink_rate_order(rail, rate);
+}
+
+static VOID VCAPITYPE rail_virtual_channel_open_event_ex(LPVOID lpUserParam, DWORD openHandle,
+                                                         UINT event, LPVOID pData,
+                                                         UINT32 dataLength, UINT32 totalLength,
+                                                         UINT32 dataFlags)
+{
+	UINT error = CHANNEL_RC_OK;
+	railPlugin* rail = (railPlugin*)lpUserParam;
+
+	switch (event)
+	{
+		case CHANNEL_EVENT_DATA_RECEIVED:
+			if (!rail || (rail->OpenHandle != openHandle))
+			{
+				WLog_ERR(TAG, "error no match");
+				return;
+			}
+
+			if ((error = channel_client_post_message(rail->MsgsHandle, pData, dataLength,
+			                                         totalLength, dataFlags)))
+			{
+				WLog_ERR(TAG,
+				         "rail_virtual_channel_event_data_received"
+				         " failed with error %" PRIu32 "!",
+				         error);
+			}
+
+			break;
+
+		case CHANNEL_EVENT_WRITE_CANCELLED:
+		case CHANNEL_EVENT_WRITE_COMPLETE:
+		{
+			wStream* s = (wStream*)pData;
+			Stream_Free(s, TRUE);
+		}
+		break;
+
+		case CHANNEL_EVENT_USER:
+			break;
+		default:
+			break;
+	}
+
+	if (error && rail && rail->rdpcontext)
+		setChannelError(rail->rdpcontext, error,
+		                "rail_virtual_channel_open_event reported an error");
+}
+
+/**
+ * Function description
+ *
+ * @return 0 on success, otherwise a Win32 error code
+ */
+static UINT rail_virtual_channel_event_connected(railPlugin* rail, WINPR_ATTR_UNUSED LPVOID pData,
+                                                 WINPR_ATTR_UNUSED UINT32 dataLength)
+{
+	RailClientContext* context = rail_get_client_interface(rail);
+	UINT status = CHANNEL_RC_OK;
+
+	WINPR_ASSERT(rail);
+
+	if (context)
+	{
+		IFCALLRET(context->OnOpen, status, context, &rail->sendHandshake);
+
+		if (status != CHANNEL_RC_OK)
+			WLog_ERR(TAG, "context->OnOpen failed with %s [%08" PRIX32 "]",
+			         WTSErrorToString(status), status);
+	}
+	rail->MsgsHandle = channel_client_create_handler(rail->rdpcontext, rail, rail_order_recv,
+	                                                 RAIL_SVC_CHANNEL_NAME);
+	if (!rail->MsgsHandle)
+		return ERROR_INTERNAL_ERROR;
+
+	return rail->channelEntryPoints.pVirtualChannelOpenEx(rail->InitHandle, &rail->OpenHandle,
+	                                                      rail->channelDef.name,
+	                                                      rail_virtual_channel_open_event_ex);
+}
+
+/**
+ * Function description
+ *
+ * @return 0 on success, otherwise a Win32 error code
+ */
+static UINT rail_virtual_channel_event_disconnected(railPlugin* rail)
+{
+	UINT rc = 0;
+
+	channel_client_quit_handler(rail->MsgsHandle);
+	if (rail->OpenHandle == 0)
+		return CHANNEL_RC_OK;
+
+	WINPR_ASSERT(rail->channelEntryPoints.pVirtualChannelCloseEx);
+	rc = rail->channelEntryPoints.pVirtualChannelCloseEx(rail->InitHandle, rail->OpenHandle);
+
+	if (CHANNEL_RC_OK != rc)
+	{
+		WLog_ERR(TAG, "pVirtualChannelCloseEx failed with %s [%08" PRIX32 "]", WTSErrorToString(rc),
+		         rc);
+		return rc;
+	}
+
+	rail->OpenHandle = 0;
+
+	return CHANNEL_RC_OK;
+}
+
+static void rail_virtual_channel_event_terminated(railPlugin* rail)
+{
+	rail->InitHandle = nullptr;
+	free(rail->context);
+	free(rail);
+}
+
+static VOID VCAPITYPE rail_virtual_channel_init_event_ex(LPVOID lpUserParam, LPVOID pInitHandle,
+                                                         UINT event, LPVOID pData, UINT dataLength)
+{
+	UINT error = CHANNEL_RC_OK;
+	railPlugin* rail = (railPlugin*)lpUserParam;
+
+	if (!rail || (rail->InitHandle != pInitHandle))
+	{
+		WLog_ERR(TAG, "error no match");
+		return;
+	}
+
+	switch (event)
+	{
+		case CHANNEL_EVENT_CONNECTED:
+			if ((error = rail_virtual_channel_event_connected(rail, pData, dataLength)))
+				WLog_ERR(TAG, "rail_virtual_channel_event_connected failed with error %" PRIu32 "!",
+				         error);
+
+			break;
+
+		case CHANNEL_EVENT_DISCONNECTED:
+			if ((error = rail_virtual_channel_event_disconnected(rail)))
+				WLog_ERR(TAG,
+				         "rail_virtual_channel_event_disconnected failed with error %" PRIu32 "!",
+				         error);
+
+			break;
+
+		case CHANNEL_EVENT_TERMINATED:
+			rail_virtual_channel_event_terminated(rail);
+			break;
+
+		case CHANNEL_EVENT_ATTACHED:
+		case CHANNEL_EVENT_DETACHED:
+		default:
+			break;
+	}
+
+	if (error && rail->rdpcontext)
+		setChannelError(rail->rdpcontext, error,
+		                "rail_virtual_channel_init_event_ex reported an error");
+}
+
+/* rail is always built-in */
+#define VirtualChannelEntryEx rail_VirtualChannelEntryEx
+
+FREERDP_ENTRY_POINT(BOOL VCAPITYPE VirtualChannelEntryEx(PCHANNEL_ENTRY_POINTS_EX pEntryPoints,
+                                                         PVOID pInitHandle))
+{
+	UINT rc = 0;
+	railPlugin* rail = nullptr;
+	RailClientContext* context = nullptr;
+	CHANNEL_ENTRY_POINTS_FREERDP_EX* pEntryPointsEx = nullptr;
+	BOOL isFreerdp = FALSE;
+	rail = (railPlugin*)calloc(1, sizeof(railPlugin));
+
+	if (!rail)
+	{
+		WLog_ERR(TAG, "calloc failed!");
+		return FALSE;
+	}
+
+	/* Default to automatically replying to server handshakes */
+	rail->sendHandshake = TRUE;
+	rail->channelDef.options = CHANNEL_OPTION_INITIALIZED | CHANNEL_OPTION_ENCRYPT_RDP |
+	                           CHANNEL_OPTION_COMPRESS_RDP | CHANNEL_OPTION_SHOW_PROTOCOL;
+	(void)sprintf_s(rail->channelDef.name, ARRAYSIZE(rail->channelDef.name), RAIL_SVC_CHANNEL_NAME);
+	pEntryPointsEx = (CHANNEL_ENTRY_POINTS_FREERDP_EX*)pEntryPoints;
+
+	if ((pEntryPointsEx->cbSize >= sizeof(CHANNEL_ENTRY_POINTS_FREERDP_EX)) &&
+	    (pEntryPointsEx->MagicNumber == FREERDP_CHANNEL_MAGIC_NUMBER))
+	{
+		context = (RailClientContext*)calloc(1, sizeof(RailClientContext));
+
+		if (!context)
+		{
+			WLog_ERR(TAG, "calloc failed!");
+			free(rail);
+			return FALSE;
+		}
+
+		context->handle = (void*)rail;
+		context->custom = nullptr;
+		context->ClientExecute = rail_client_execute;
+		context->ClientActivate = rail_client_activate;
+		context->ClientSystemParam = rail_client_system_param;
+		context->ClientSystemCommand = rail_client_system_command;
+		context->ClientHandshake = rail_client_handshake;
+		context->ClientNotifyEvent = rail_client_notify_event;
+		context->ClientWindowMove = rail_client_window_move;
+		context->ClientInformation = rail_client_information;
+		context->ClientSystemMenu = rail_client_system_menu;
+		context->ClientLanguageBarInfo = rail_client_language_bar_info;
+		context->ClientLanguageIMEInfo = rail_client_language_ime_info;
+		context->ClientGetAppIdRequest = rail_client_get_appid_request;
+		context->ClientSnapArrange = rail_client_snap_arrange;
+		context->ClientCloak = rail_client_cloak;
+		context->ClientCompartmentInfo = rail_client_compartment_info;
+		context->ClientTextScale = rail_client_text_scale;
+		context->ClientCaretBlinkRate = rail_client_caret_blink_rate;
+		rail->rdpcontext = pEntryPointsEx->context;
+		rail->context = context;
+		isFreerdp = TRUE;
+	}
+
+	rail->log = WLog_Get("com.freerdp.channels.rail.client");
+	WLog_Print(rail->log, WLOG_DEBUG, "VirtualChannelEntryEx");
+	CopyMemory(&(rail->channelEntryPoints), pEntryPoints, sizeof(CHANNEL_ENTRY_POINTS_FREERDP_EX));
+	rail->InitHandle = pInitHandle;
+	rc = rail->channelEntryPoints.pVirtualChannelInitEx(
+	    rail, context, pInitHandle, &rail->channelDef, 1, VIRTUAL_CHANNEL_VERSION_WIN2000,
+	    rail_virtual_channel_init_event_ex);
+
+	if (CHANNEL_RC_OK != rc)
+	{
+		WLog_ERR(TAG, "failed with %s [%08" PRIX32 "]", WTSErrorToString(rc), rc);
+		goto error_out;
+	}
+
+	rail->channelEntryPoints.pInterface = context;
+	return TRUE;
+error_out:
+
+	if (isFreerdp)
+		free(rail->context);
+
+	free(rail);
+	return FALSE;
+}

third_party/FreeRDP/channels/rail/client/rail_main.h

@@ -0,0 +1,61 @@
+/**
+ * FreeRDP: A Remote Desktop Protocol Implementation
+ * RAIL Virtual Channel Plugin
+ *
+ * Copyright 2011 Marc-Andre Moreau <marcandre.moreau@gmail.com>
+ * Copyright 2011 Roman Barabanov <romanbarabanov@gmail.com>
+ * Copyright 2011 Vic Lee
+ * Copyright 2015 Thincast Technologies GmbH
+ * Copyright 2015 DI (FH) Martin Haimberger <martin.haimberger@thincast.com>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef FREERDP_CHANNEL_RAIL_CLIENT_MAIN_H
+#define FREERDP_CHANNEL_RAIL_CLIENT_MAIN_H
+
+#include <freerdp/rail.h>
+#include <freerdp/svc.h>
+#include <freerdp/addin.h>
+#include <freerdp/settings.h>
+#include <freerdp/client/rail.h>
+
+#include <winpr/crt.h>
+#include <winpr/wlog.h>
+#include <winpr/stream.h>
+
+#include "../rail_common.h"
+
+typedef struct
+{
+	CHANNEL_DEF channelDef;
+	CHANNEL_ENTRY_POINTS_FREERDP_EX channelEntryPoints;
+
+	RailClientContext* context;
+
+	wLog* log;
+	void* InitHandle;
+	DWORD OpenHandle;
+	void* MsgsHandle;
+	rdpContext* rdpcontext;
+	DWORD channelBuildNumber;
+	DWORD channelFlags;
+	RAIL_CLIENT_STATUS_ORDER clientStatus;
+	BOOL sendHandshake;
+} railPlugin;
+
+WINPR_ATTR_NODISCARD FREERDP_LOCAL RailClientContext* rail_get_client_interface(railPlugin* rail);
+
+WINPR_ATTR_NODISCARD FREERDP_LOCAL UINT rail_send_channel_data(railPlugin* rail, wStream* s);
+
+#endif /* FREERDP_CHANNEL_RAIL_CLIENT_MAIN_H */

third_party/FreeRDP/channels/rail/client/rail_orders.h

@@ -0,0 +1,89 @@
+/**
+ * FreeRDP: A Remote Desktop Protocol Implementation
+ * Remote Applications Integrated Locally (RAIL)
+ *
+ * Copyright 2009 Marc-Andre Moreau <marcandre.moreau@gmail.com>
+ * Copyright 2011 Roman Barabanov <romanbarabanov@gmail.com>
+ * Copyright 2015 Thincast Technologies GmbH
+ * Copyright 2015 DI (FH) Martin Haimberger <martin.haimberger@thincast.com>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef FREERDP_CHANNEL_RAIL_CLIENT_ORDERS_H
+#define FREERDP_CHANNEL_RAIL_CLIENT_ORDERS_H
+
+#include <freerdp/channels/log.h>
+
+#include "rail_main.h"
+
+#define TAG CHANNELS_TAG("rail.client")
+
+WINPR_ATTR_NODISCARD FREERDP_LOCAL UINT rail_order_recv(LPVOID userdata, wStream* s);
+
+WINPR_ATTR_NODISCARD FREERDP_LOCAL UINT rail_send_pdu(railPlugin* rail, wStream* s,
+                                                      UINT16 orderType);
+
+WINPR_ATTR_NODISCARD FREERDP_LOCAL UINT
+rail_send_handshake_order(railPlugin* rail, const RAIL_HANDSHAKE_ORDER* handshake);
+
+WINPR_ATTR_NODISCARD FREERDP_LOCAL UINT
+rail_send_handshake_ex_order(railPlugin* rail, const RAIL_HANDSHAKE_EX_ORDER* handshakeEx);
+
+WINPR_ATTR_NODISCARD FREERDP_LOCAL UINT
+rail_send_client_status_order(railPlugin* rail, const RAIL_CLIENT_STATUS_ORDER* clientStatus);
+
+WINPR_ATTR_NODISCARD FREERDP_LOCAL UINT rail_send_client_exec_order(
+    railPlugin* rail, UINT16 flags, const RAIL_UNICODE_STRING* exeOrFile,
+    const RAIL_UNICODE_STRING* workingDir, const RAIL_UNICODE_STRING* arguments);
+
+WINPR_ATTR_NODISCARD FREERDP_LOCAL UINT
+rail_send_client_activate_order(railPlugin* rail, const RAIL_ACTIVATE_ORDER* activate);
+
+WINPR_ATTR_NODISCARD FREERDP_LOCAL UINT
+rail_send_client_sysmenu_order(railPlugin* rail, const RAIL_SYSMENU_ORDER* sysmenu);
+
+WINPR_ATTR_NODISCARD FREERDP_LOCAL UINT
+rail_send_client_syscommand_order(railPlugin* rail, const RAIL_SYSCOMMAND_ORDER* syscommand);
+
+WINPR_ATTR_NODISCARD FREERDP_LOCAL UINT
+rail_send_client_notify_event_order(railPlugin* rail, const RAIL_NOTIFY_EVENT_ORDER* notifyEvent);
+
+WINPR_ATTR_NODISCARD FREERDP_LOCAL UINT
+rail_send_client_window_move_order(railPlugin* rail, const RAIL_WINDOW_MOVE_ORDER* windowMove);
+
+WINPR_ATTR_NODISCARD FREERDP_LOCAL UINT
+rail_send_client_get_appid_req_order(railPlugin* rail, const RAIL_GET_APPID_REQ_ORDER* getAppIdReq);
+
+WINPR_ATTR_NODISCARD FREERDP_LOCAL UINT
+rail_send_client_langbar_info_order(railPlugin* rail, const RAIL_LANGBAR_INFO_ORDER* langBarInfo);
+
+WINPR_ATTR_NODISCARD FREERDP_LOCAL UINT rail_send_client_languageime_info_order(
+    railPlugin* rail, const RAIL_LANGUAGEIME_INFO_ORDER* langImeInfo);
+
+WINPR_ATTR_NODISCARD FREERDP_LOCAL UINT rail_send_client_cloak_order(railPlugin* rail,
+                                                                     const RAIL_CLOAK* cloak);
+
+WINPR_ATTR_NODISCARD FREERDP_LOCAL UINT
+rail_send_client_snap_arrange_order(railPlugin* rail, const RAIL_SNAP_ARRANGE* snap);
+
+WINPR_ATTR_NODISCARD FREERDP_LOCAL UINT rail_send_client_compartment_info_order(
+    railPlugin* rail, const RAIL_COMPARTMENT_INFO_ORDER* compartmentInfo);
+
+WINPR_ATTR_NODISCARD FREERDP_LOCAL UINT rail_send_client_text_scale_order(railPlugin* rail,
+                                                                          UINT32 textScale);
+
+WINPR_ATTR_NODISCARD FREERDP_LOCAL UINT rail_send_client_caret_blink_rate_order(railPlugin* rail,
+                                                                                UINT32 rate);
+
+#endif /* FREERDP_CHANNEL_RAIL_CLIENT_ORDERS_H */