/src/FreeRDP/channels/encomsp/client/encomsp_main.c

Source
/**
 * FreeRDP: A Remote Desktop Protocol Implementation
 * Multiparty Virtual Channel
 *
 * Copyright 2014 Marc-Andre Moreau <marcandre.moreau@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.
 */

#include <freerdp/config.h>

#include <winpr/crt.h>
#include <winpr/assert.h>
#include <winpr/print.h>

#include <freerdp/freerdp.h>
#include <freerdp/channels/log.h>
#include <freerdp/client/encomsp.h>

#include "encomsp_main.h"

struct encomsp_plugin
{
  CHANNEL_DEF channelDef;
  CHANNEL_ENTRY_POINTS_FREERDP_EX channelEntryPoints;

  EncomspClientContext* context;

  HANDLE thread;
  wStream* data_in;
  void* InitHandle;
  DWORD OpenHandle;
  wMessageQueue* queue;
  rdpContext* rdpcontext;
  BOOL firstFlagReceived;
  UINT32 totalLength;
};

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT encomsp_read_header(wStream* s, ENCOMSP_ORDER_HEADER* header)
{
  WINPR_ASSERT(header);
  if (!Stream_CheckAndLogRequiredLength(TAG, s, ENCOMSP_ORDER_HEADER_SIZE))
    return ERROR_INVALID_DATA;

  Stream_Read_UINT16(s, header->Type);   /* Type (2 bytes) */
  Stream_Read_UINT16(s, header->Length); /* Length (2 bytes) */
  return CHANNEL_RC_OK;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT encomsp_write_header(wStream* s, const ENCOMSP_ORDER_HEADER* header)
{
  WINPR_ASSERT(header);
  Stream_Write_UINT16(s, header->Type);   /* Type (2 bytes) */
  Stream_Write_UINT16(s, header->Length); /* Length (2 bytes) */
  return CHANNEL_RC_OK;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT encomsp_read_unicode_string(wStream* s, ENCOMSP_UNICODE_STRING* str)
{
  WINPR_ASSERT(str);
  const ENCOMSP_UNICODE_STRING empty = WINPR_C_ARRAY_INIT;
  *str = empty;

  if (!Stream_CheckAndLogRequiredLength(TAG, s, 2))
    return ERROR_INVALID_DATA;

  Stream_Read_UINT16(s, str->cchString); /* cchString (2 bytes) */

  if (str->cchString > 1024)
  {
    WLog_ERR(TAG, "cchString was %" PRIu16 " but has to be < 1025!", str->cchString);
    return ERROR_INVALID_DATA;
  }

  if (!Stream_CheckAndLogRequiredLengthOfSize(TAG, s, str->cchString, sizeof(WCHAR)))
    return ERROR_INVALID_DATA;

  Stream_Read(s, &(str->wString), (sizeof(WCHAR) * str->cchString)); /* String (variable) */
  return CHANNEL_RC_OK;
}

static EncomspClientContext* encomsp_get_client_interface(encomspPlugin* encomsp)
{
  WINPR_ASSERT(encomsp);
  return (EncomspClientContext*)encomsp->channelEntryPoints.pInterface;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT encomsp_virtual_channel_write(encomspPlugin* encomsp, wStream* s)
{
  if (!encomsp)
  {
    Stream_Free(s, TRUE);
    return ERROR_INVALID_HANDLE;
  }

  const UINT status = encomsp->channelEntryPoints.pVirtualChannelWriteEx(
      encomsp->InitHandle, encomsp->OpenHandle, Stream_Buffer(s), (UINT32)Stream_Length(s), s);

  if (status != CHANNEL_RC_OK)
  {
    Stream_Free(s, TRUE);
    WLog_ERR(TAG, "VirtualChannelWriteEx failed with %s [%08" PRIX32 "]",
             WTSErrorToString(status), status);
  }
  return status;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT encomsp_recv_filter_updated_pdu(encomspPlugin* encomsp, wStream* s,
                                            const ENCOMSP_ORDER_HEADER* header)
{
  ENCOMSP_FILTER_UPDATED_PDU pdu = WINPR_C_ARRAY_INIT;
  UINT error = CHANNEL_RC_OK;
  EncomspClientContext* context = encomsp_get_client_interface(encomsp);

  if (!context)
    return ERROR_INVALID_HANDLE;

  WINPR_ASSERT(header);
  const size_t pos = Stream_GetPosition(s);
  if (pos < ENCOMSP_ORDER_HEADER_SIZE)
    return ERROR_INVALID_DATA;
  const size_t beg = pos - ENCOMSP_ORDER_HEADER_SIZE;
  pdu.Length = header->Length;
  pdu.Type = header->Type;

  if (!Stream_CheckAndLogRequiredLength(TAG, s, 1))
    return ERROR_INVALID_DATA;

  Stream_Read_UINT8(s, pdu.Flags); /* Flags (1 byte) */
  const size_t end = Stream_GetPosition(s);
  const size_t body = beg + header->Length;

  if (body < end)
  {
    WLog_ERR(TAG, "Not enough data!");
    return ERROR_INVALID_DATA;
  }

  if (body > end)
  {
    if (!Stream_CheckAndLogRequiredLength(TAG, s, (size_t)(body - end)))
      return ERROR_INVALID_DATA;

    if (!Stream_SetPosition(s, body))
      return ERROR_INVALID_DATA;
  }

  IFCALLRET(context->FilterUpdated, error, context, &pdu);

  if (error)
    WLog_ERR(TAG, "context->FilterUpdated failed with error %" PRIu32 "", error);

  return error;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT encomsp_recv_application_created_pdu(encomspPlugin* encomsp, wStream* s,
                                                 const ENCOMSP_ORDER_HEADER* header)
{
  ENCOMSP_APPLICATION_CREATED_PDU pdu = WINPR_C_ARRAY_INIT;
  EncomspClientContext* context = encomsp_get_client_interface(encomsp);

  if (!context)
    return ERROR_INVALID_HANDLE;

  if (!Stream_CheckAndLogRequiredLength(TAG, s, 6))
    return ERROR_INVALID_DATA;

  const size_t pos = Stream_GetPosition(s);
  if (pos < ENCOMSP_ORDER_HEADER_SIZE)
    return ERROR_INVALID_DATA;
  const size_t beg = pos - ENCOMSP_ORDER_HEADER_SIZE;

  WINPR_ASSERT(header);
  pdu.Length = header->Length;
  pdu.Type = header->Type;

  Stream_Read_UINT16(s, pdu.Flags); /* Flags (2 bytes) */
  Stream_Read_UINT32(s, pdu.AppId); /* AppId (4 bytes) */

  UINT error = encomsp_read_unicode_string(s, &(pdu.Name));
  if (error != CHANNEL_RC_OK)
  {
    WLog_ERR(TAG, "encomsp_read_unicode_string failed with error %" PRIu32 "", error);
    return error;
  }

  const size_t end = Stream_GetPosition(s);
  const size_t body = beg + header->Length;

  if (body < end)
  {
    WLog_ERR(TAG, "Not enough data!");
    return ERROR_INVALID_DATA;
  }

  if (body > end)
  {
    if (!Stream_CheckAndLogRequiredLength(TAG, s, (size_t)(body - end)))
      return ERROR_INVALID_DATA;

    if (!Stream_SetPosition(s, body))
      return ERROR_INVALID_DATA;
  }

  IFCALLRET(context->ApplicationCreated, error, context, &pdu);

  if (error)
    WLog_ERR(TAG, "context->ApplicationCreated failed with error %" PRIu32 "", error);

  return error;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT encomsp_recv_application_removed_pdu(encomspPlugin* encomsp, wStream* s,
                                                 const ENCOMSP_ORDER_HEADER* header)
{
  ENCOMSP_APPLICATION_REMOVED_PDU pdu = WINPR_C_ARRAY_INIT;
  UINT error = CHANNEL_RC_OK;
  EncomspClientContext* context = encomsp_get_client_interface(encomsp);

  if (!context)
    return ERROR_INVALID_HANDLE;

  const size_t pos = Stream_GetPosition(s);
  if (pos < ENCOMSP_ORDER_HEADER_SIZE)
    return ERROR_INVALID_DATA;
  const size_t beg = pos - ENCOMSP_ORDER_HEADER_SIZE;

  WINPR_ASSERT(header);
  pdu.Length = header->Length;
  pdu.Type = header->Type;

  if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
    return ERROR_INVALID_DATA;

  Stream_Read_UINT32(s, pdu.AppId); /* AppId (4 bytes) */
  const size_t end = Stream_GetPosition(s);
  const size_t body = beg + header->Length;

  if (body < end)
  {
    WLog_ERR(TAG, "Not enough data!");
    return ERROR_INVALID_DATA;
  }

  if (body > end)
  {
    if (!Stream_CheckAndLogRequiredLength(TAG, s, (size_t)(body - end)))
      return ERROR_INVALID_DATA;

    if (!Stream_SetPosition(s, body))
      return ERROR_INVALID_DATA;
  }

  IFCALLRET(context->ApplicationRemoved, error, context, &pdu);

  if (error)
    WLog_ERR(TAG, "context->ApplicationRemoved failed with error %" PRIu32 "", error);

  return error;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT encomsp_recv_window_created_pdu(encomspPlugin* encomsp, wStream* s,
                                            const ENCOMSP_ORDER_HEADER* header)
{
  ENCOMSP_WINDOW_CREATED_PDU pdu = WINPR_C_ARRAY_INIT;
  UINT error = CHANNEL_RC_OK;
  EncomspClientContext* context = encomsp_get_client_interface(encomsp);

  if (!context)
    return ERROR_INVALID_HANDLE;

  const size_t pos = Stream_GetPosition(s);
  if (pos < ENCOMSP_ORDER_HEADER_SIZE)
    return ERROR_INVALID_DATA;
  const size_t beg = pos - ENCOMSP_ORDER_HEADER_SIZE;

  WINPR_ASSERT(header);
  pdu.Length = header->Length;
  pdu.Type = header->Type;

  if (!Stream_CheckAndLogRequiredLength(TAG, s, 10))
    return ERROR_INVALID_DATA;

  Stream_Read_UINT16(s, pdu.Flags); /* Flags (2 bytes) */
  Stream_Read_UINT32(s, pdu.AppId); /* AppId (4 bytes) */
  Stream_Read_UINT32(s, pdu.WndId); /* WndId (4 bytes) */

  if ((error = encomsp_read_unicode_string(s, &(pdu.Name))))
  {
    WLog_ERR(TAG, "encomsp_read_unicode_string failed with error %" PRIu32 "", error);
    return error;
  }

  const size_t end = Stream_GetPosition(s);
  const size_t body = beg + header->Length;

  if (body < end)
  {
    WLog_ERR(TAG, "Not enough data!");
    return ERROR_INVALID_DATA;
  }

  if (body > end)
  {
    if (!Stream_CheckAndLogRequiredLength(TAG, s, (size_t)(body - end)))
      return ERROR_INVALID_DATA;

    if (!Stream_SetPosition(s, body))
      return ERROR_INVALID_DATA;
  }

  IFCALLRET(context->WindowCreated, error, context, &pdu);

  if (error)
    WLog_ERR(TAG, "context->WindowCreated failed with error %" PRIu32 "", error);

  return error;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT encomsp_recv_window_removed_pdu(encomspPlugin* encomsp, wStream* s,
                                            const ENCOMSP_ORDER_HEADER* header)
{
  ENCOMSP_WINDOW_REMOVED_PDU pdu = WINPR_C_ARRAY_INIT;
  UINT error = CHANNEL_RC_OK;
  EncomspClientContext* context = encomsp_get_client_interface(encomsp);

  if (!context)
    return ERROR_INVALID_HANDLE;

  const size_t pos = Stream_GetPosition(s);
  if (pos < ENCOMSP_ORDER_HEADER_SIZE)
    return ERROR_INVALID_DATA;
  const size_t beg = pos - ENCOMSP_ORDER_HEADER_SIZE;

  WINPR_ASSERT(header);
  pdu.Length = header->Length;
  pdu.Type = header->Type;

  if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
    return ERROR_INVALID_DATA;

  Stream_Read_UINT32(s, pdu.WndId); /* WndId (4 bytes) */
  const size_t end = Stream_GetPosition(s);
  const size_t body = beg + header->Length;

  if (body < end)
  {
    WLog_ERR(TAG, "Not enough data!");
    return ERROR_INVALID_DATA;
  }

  if (body > end)
  {
    if (!Stream_CheckAndLogRequiredLength(TAG, s, (size_t)(body - end)))
      return ERROR_INVALID_DATA;

    if (!Stream_SetPosition(s, body))
      return ERROR_INVALID_DATA;
  }

  IFCALLRET(context->WindowRemoved, error, context, &pdu);

  if (error)
    WLog_ERR(TAG, "context->WindowRemoved failed with error %" PRIu32 "", error);

  return error;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT encomsp_recv_show_window_pdu(encomspPlugin* encomsp, wStream* s,
                                         const ENCOMSP_ORDER_HEADER* header)
{
  ENCOMSP_SHOW_WINDOW_PDU pdu = WINPR_C_ARRAY_INIT;
  UINT error = CHANNEL_RC_OK;
  EncomspClientContext* context = encomsp_get_client_interface(encomsp);

  if (!context)
    return ERROR_INVALID_HANDLE;

  const size_t pos = Stream_GetPosition(s);
  if (pos < ENCOMSP_ORDER_HEADER_SIZE)
    return ERROR_INVALID_DATA;
  const size_t beg = pos - ENCOMSP_ORDER_HEADER_SIZE;

  WINPR_ASSERT(header);
  pdu.Length = header->Length;
  pdu.Type = header->Type;

  if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
    return ERROR_INVALID_DATA;

  Stream_Read_UINT32(s, pdu.WndId); /* WndId (4 bytes) */
  const size_t end = Stream_GetPosition(s);
  const size_t body = beg + header->Length;

  if (body < end)
  {
    WLog_ERR(TAG, "Not enough data!");
    return ERROR_INVALID_DATA;
  }

  if (body > end)
  {
    if (!Stream_CheckAndLogRequiredLength(TAG, s, (size_t)(body - end)))
      return ERROR_INVALID_DATA;

    if (!Stream_SetPosition(s, body))
      return ERROR_INVALID_DATA;
  }

  IFCALLRET(context->ShowWindow, error, context, &pdu);

  if (error)
    WLog_ERR(TAG, "context->ShowWindow failed with error %" PRIu32 "", error);

  return error;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT encomsp_recv_participant_created_pdu(encomspPlugin* encomsp, wStream* s,
                                                 const ENCOMSP_ORDER_HEADER* header)
{
  ENCOMSP_PARTICIPANT_CREATED_PDU pdu = WINPR_C_ARRAY_INIT;
  EncomspClientContext* context = encomsp_get_client_interface(encomsp);

  if (!context)
    return ERROR_INVALID_HANDLE;

  const size_t pos = Stream_GetPosition(s);
  if (pos < ENCOMSP_ORDER_HEADER_SIZE)
    return ERROR_INVALID_DATA;
  const size_t beg = pos - ENCOMSP_ORDER_HEADER_SIZE;

  WINPR_ASSERT(header);
  pdu.Length = header->Length;
  pdu.Type = header->Type;

  if (!Stream_CheckAndLogRequiredLength(TAG, s, 10))
    return ERROR_INVALID_DATA;

  Stream_Read_UINT32(s, pdu.ParticipantId); /* ParticipantId (4 bytes) */
  Stream_Read_UINT32(s, pdu.GroupId);       /* GroupId (4 bytes) */
  Stream_Read_UINT16(s, pdu.Flags);         /* Flags (2 bytes) */

  UINT error = encomsp_read_unicode_string(s, &(pdu.FriendlyName));
  if (error != CHANNEL_RC_OK)
  {
    WLog_ERR(TAG, "encomsp_read_unicode_string failed with error %" PRIu32 "", error);
    return error;
  }

  const size_t end = Stream_GetPosition(s);
  const size_t body = beg + header->Length;

  if (body < end)
  {
    WLog_ERR(TAG, "Not enough data!");
    return ERROR_INVALID_DATA;
  }

  if (body > end)
  {
    if (!Stream_CheckAndLogRequiredLength(TAG, s, (size_t)(body - end)))
      return ERROR_INVALID_DATA;

    if (!Stream_SetPosition(s, body))
      return ERROR_INVALID_DATA;
  }

  IFCALLRET(context->ParticipantCreated, error, context, &pdu);

  if (error)
    WLog_ERR(TAG, "context->ParticipantCreated failed with error %" PRIu32 "", error);

  return error;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT encomsp_recv_participant_removed_pdu(encomspPlugin* encomsp, wStream* s,
                                                 const ENCOMSP_ORDER_HEADER* header)
{
  ENCOMSP_PARTICIPANT_REMOVED_PDU pdu = WINPR_C_ARRAY_INIT;
  UINT error = CHANNEL_RC_OK;
  EncomspClientContext* context = encomsp_get_client_interface(encomsp);

  if (!context)
    return ERROR_INVALID_HANDLE;

  if (!Stream_CheckAndLogRequiredLength(TAG, s, 12))
    return ERROR_INVALID_DATA;

  const size_t beg = (Stream_GetPosition(s)) - ENCOMSP_ORDER_HEADER_SIZE;

  WINPR_ASSERT(header);
  pdu.Length = header->Length;
  pdu.Type = header->Type;

  Stream_Read_UINT32(s, pdu.ParticipantId); /* ParticipantId (4 bytes) */
  Stream_Read_UINT32(s, pdu.DiscType);      /* DiscType (4 bytes) */
  Stream_Read_UINT32(s, pdu.DiscCode);      /* DiscCode (4 bytes) */
  const size_t end = Stream_GetPosition(s);
  const size_t body = beg + header->Length;

  if (body < end)
  {
    WLog_ERR(TAG, "Not enough data!");
    return ERROR_INVALID_DATA;
  }

  if (body > end)
  {
    if (!Stream_CheckAndLogRequiredLength(TAG, s, (size_t)(body - end)))
      return ERROR_INVALID_DATA;

    if (!Stream_SetPosition(s, body))
      return ERROR_INVALID_DATA;
  }

  IFCALLRET(context->ParticipantRemoved, error, context, &pdu);

  if (error)
    WLog_ERR(TAG, "context->ParticipantRemoved failed with error %" PRIu32 "", error);

  return error;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT encomsp_recv_change_participant_control_level_pdu(encomspPlugin* encomsp, wStream* s,
                                                              const ENCOMSP_ORDER_HEADER* header)
{
  ENCOMSP_CHANGE_PARTICIPANT_CONTROL_LEVEL_PDU pdu = WINPR_C_ARRAY_INIT;
  UINT error = CHANNEL_RC_OK;
  EncomspClientContext* context = encomsp_get_client_interface(encomsp);

  if (!context)
    return ERROR_INVALID_HANDLE;

  const size_t pos = Stream_GetPosition(s);
  if (pos < ENCOMSP_ORDER_HEADER_SIZE)
    return ERROR_INVALID_DATA;
  const size_t beg = pos - ENCOMSP_ORDER_HEADER_SIZE;

  WINPR_ASSERT(header);
  pdu.Length = header->Length;
  pdu.Type = header->Type;

  if (!Stream_CheckAndLogRequiredLength(TAG, s, 6))
    return ERROR_INVALID_DATA;

  Stream_Read_UINT16(s, pdu.Flags);         /* Flags (2 bytes) */
  Stream_Read_UINT32(s, pdu.ParticipantId); /* ParticipantId (4 bytes) */
  const size_t end = Stream_GetPosition(s);
  const size_t body = beg + header->Length;

  if (body < end)
  {
    WLog_ERR(TAG, "Not enough data!");
    return ERROR_INVALID_DATA;
  }

  if (body > end)
  {
    if (!Stream_CheckAndLogRequiredLength(TAG, s, (size_t)(body - end)))
      return ERROR_INVALID_DATA;

    if (!Stream_SetPosition(s, body))
      return ERROR_INVALID_DATA;
  }

  IFCALLRET(context->ChangeParticipantControlLevel, error, context, &pdu);

  if (error)
    WLog_ERR(TAG, "context->ChangeParticipantControlLevel failed with error %" PRIu32 "",
             error);

  return error;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT encomsp_send_change_participant_control_level_pdu(
    EncomspClientContext* context, const ENCOMSP_CHANGE_PARTICIPANT_CONTROL_LEVEL_PDU* pdu)
{
  ENCOMSP_ORDER_HEADER header = WINPR_C_ARRAY_INIT;

  WINPR_ASSERT(context);
  encomspPlugin* encomsp = (encomspPlugin*)context->handle;

  header.Type = ODTYPE_PARTICIPANT_CTRL_CHANGED;
  header.Length = ENCOMSP_ORDER_HEADER_SIZE + 6;

  wStream* s = Stream_New(nullptr, header.Length);

  if (!s)
  {
    WLog_ERR(TAG, "Stream_New failed!");
    return CHANNEL_RC_NO_MEMORY;
  }

  const UINT error = encomsp_write_header(s, &header);
  if (error != CHANNEL_RC_OK)
  {
    WLog_ERR(TAG, "encomsp_write_header failed with error %" PRIu32 "!", error);
    return error;
  }

  Stream_Write_UINT16(s, pdu->Flags);         /* Flags (2 bytes) */
  Stream_Write_UINT32(s, pdu->ParticipantId); /* ParticipantId (4 bytes) */
  Stream_SealLength(s);
  return encomsp_virtual_channel_write(encomsp, s);
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT encomsp_recv_graphics_stream_paused_pdu(encomspPlugin* encomsp, wStream* s,
                                                    const ENCOMSP_ORDER_HEADER* header)
{
  ENCOMSP_GRAPHICS_STREAM_PAUSED_PDU pdu = WINPR_C_ARRAY_INIT;
  UINT error = CHANNEL_RC_OK;
  EncomspClientContext* context = encomsp_get_client_interface(encomsp);

  if (!context)
    return ERROR_INVALID_HANDLE;

  const size_t pos = Stream_GetPosition(s);
  if (pos < ENCOMSP_ORDER_HEADER_SIZE)
    return ERROR_INVALID_DATA;
  const size_t beg = pos - ENCOMSP_ORDER_HEADER_SIZE;

  WINPR_ASSERT(header);
  pdu.Length = header->Length;
  pdu.Type = header->Type;

  const size_t end = Stream_GetPosition(s);
  const size_t body = beg + header->Length;

  if (body < end)
  {
    WLog_ERR(TAG, "Not enough data!");
    return ERROR_INVALID_DATA;
  }

  if (body > end)
  {
    if (!Stream_CheckAndLogRequiredLength(TAG, s, (size_t)(body - end)))
      return ERROR_INVALID_DATA;

    if (!Stream_SetPosition(s, body))
      return ERROR_INVALID_DATA;
  }

  IFCALLRET(context->GraphicsStreamPaused, error, context, &pdu);

  if (error)
    WLog_ERR(TAG, "context->GraphicsStreamPaused failed with error %" PRIu32 "", error);

  return error;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT encomsp_recv_graphics_stream_resumed_pdu(encomspPlugin* encomsp, wStream* s,
                                                     const ENCOMSP_ORDER_HEADER* header)
{
  ENCOMSP_GRAPHICS_STREAM_RESUMED_PDU pdu = WINPR_C_ARRAY_INIT;
  UINT error = CHANNEL_RC_OK;
  EncomspClientContext* context = encomsp_get_client_interface(encomsp);

  if (!context)
    return ERROR_INVALID_HANDLE;

  const size_t pos = Stream_GetPosition(s);
  if (pos < ENCOMSP_ORDER_HEADER_SIZE)
    return ERROR_INVALID_DATA;
  const size_t beg = pos - ENCOMSP_ORDER_HEADER_SIZE;

  WINPR_ASSERT(header);
  pdu.Length = header->Length;
  pdu.Type = header->Type;

  const size_t end = Stream_GetPosition(s);
  const size_t body = beg + header->Length;

  if (body < end)
  {
    WLog_ERR(TAG, "Not enough data!");
    return ERROR_INVALID_DATA;
  }

  if (body > end)
  {
    if (!Stream_CheckAndLogRequiredLength(TAG, s, (size_t)(body - end)))
      return ERROR_INVALID_DATA;

    if (!Stream_SetPosition(s, body))
      return ERROR_INVALID_DATA;
  }

  IFCALLRET(context->GraphicsStreamResumed, error, context, &pdu);

  if (error)
    WLog_ERR(TAG, "context->GraphicsStreamResumed failed with error %" PRIu32 "", error);

  return error;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT encomsp_process_receive(encomspPlugin* encomsp, wStream* s)
{
  UINT error = CHANNEL_RC_OK;
  ENCOMSP_ORDER_HEADER header = WINPR_C_ARRAY_INIT;

  WINPR_ASSERT(encomsp);
  while (Stream_GetRemainingLength(s) > 0)
  {
    if ((error = encomsp_read_header(s, &header)))
    {
      WLog_ERR(TAG, "encomsp_read_header failed with error %" PRIu32 "!", error);
      return error;
    }

    // WLog_DBG(TAG, "EncomspReceive: Type: %"PRIu16" Length: %"PRIu16"", header.Type,
    // header.Length);

    switch (header.Type)
    {
      case ODTYPE_FILTER_STATE_UPDATED:
        if ((error = encomsp_recv_filter_updated_pdu(encomsp, s, &header)))
        {
          WLog_ERR(TAG, "encomsp_recv_filter_updated_pdu failed with error %" PRIu32 "!",
                   error);
          return error;
        }

        break;

      case ODTYPE_APP_REMOVED:
        if ((error = encomsp_recv_application_removed_pdu(encomsp, s, &header)))
        {
          WLog_ERR(TAG,
                   "encomsp_recv_application_removed_pdu failed with error %" PRIu32 "!",
                   error);
          return error;
        }

        break;

      case ODTYPE_APP_CREATED:
        if ((error = encomsp_recv_application_created_pdu(encomsp, s, &header)))
        {
          WLog_ERR(TAG,
                   "encomsp_recv_application_removed_pdu failed with error %" PRIu32 "!",
                   error);
          return error;
        }

        break;

      case ODTYPE_WND_REMOVED:
        if ((error = encomsp_recv_window_removed_pdu(encomsp, s, &header)))
        {
          WLog_ERR(TAG, "encomsp_recv_window_removed_pdu failed with error %" PRIu32 "!",
                   error);
          return error;
        }

        break;

      case ODTYPE_WND_CREATED:
        if ((error = encomsp_recv_window_created_pdu(encomsp, s, &header)))
        {
          WLog_ERR(TAG, "encomsp_recv_window_created_pdu failed with error %" PRIu32 "!",
                   error);
          return error;
        }

        break;

      case ODTYPE_WND_SHOW:
        if ((error = encomsp_recv_show_window_pdu(encomsp, s, &header)))
        {
          WLog_ERR(TAG, "encomsp_recv_show_window_pdu failed with error %" PRIu32 "!",
                   error);
          return error;
        }

        break;

      case ODTYPE_PARTICIPANT_REMOVED:
        if ((error = encomsp_recv_participant_removed_pdu(encomsp, s, &header)))
        {
          WLog_ERR(TAG,
                   "encomsp_recv_participant_removed_pdu failed with error %" PRIu32 "!",
                   error);
          return error;
        }

        break;

      case ODTYPE_PARTICIPANT_CREATED:
        if ((error = encomsp_recv_participant_created_pdu(encomsp, s, &header)))
        {
          WLog_ERR(TAG,
                   "encomsp_recv_participant_created_pdu failed with error %" PRIu32 "!",
                   error);
          return error;
        }

        break;

      case ODTYPE_PARTICIPANT_CTRL_CHANGED:
        if ((error =
                 encomsp_recv_change_participant_control_level_pdu(encomsp, s, &header)))
        {
          WLog_ERR(TAG,
                   "encomsp_recv_change_participant_control_level_pdu failed with error "
                   "%" PRIu32 "!",
                   error);
          return error;
        }

        break;

      case ODTYPE_GRAPHICS_STREAM_PAUSED:
        if ((error = encomsp_recv_graphics_stream_paused_pdu(encomsp, s, &header)))
        {
          WLog_ERR(TAG,
                   "encomsp_recv_graphics_stream_paused_pdu failed with error %" PRIu32
                   "!",
                   error);
          return error;
        }

        break;

      case ODTYPE_GRAPHICS_STREAM_RESUMED:
        if ((error = encomsp_recv_graphics_stream_resumed_pdu(encomsp, s, &header)))
        {
          WLog_ERR(TAG,
                   "encomsp_recv_graphics_stream_resumed_pdu failed with error %" PRIu32
                   "!",
                   error);
          return error;
        }

        break;

      default:
        WLog_ERR(TAG, "header.Type %" PRIu16 " not found", header.Type);
        return ERROR_INVALID_DATA;
    }
  }

  return error;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT encomsp_virtual_channel_event_data_received(encomspPlugin* encomsp, const void* pData,
                                                        UINT32 dataLength, UINT32 totalLength,
                                                        UINT32 dataFlags)
{
  WINPR_ASSERT(encomsp);

  if ((dataFlags & CHANNEL_FLAG_SUSPEND) || (dataFlags & CHANNEL_FLAG_RESUME))
    return CHANNEL_RC_OK;

  if (dataFlags & CHANNEL_FLAG_FIRST)
  {
    if (encomsp->firstFlagReceived)
      return ERROR_INVALID_DATA;
    encomsp->firstFlagReceived = TRUE;
    if (encomsp->data_in)
      Stream_Free(encomsp->data_in, TRUE);

    encomsp->data_in = Stream_New(nullptr, dataLength);

    if (!encomsp->data_in)
    {
      WLog_ERR(TAG, "Stream_New failed!");
      return CHANNEL_RC_NO_MEMORY;
    }
    encomsp->totalLength = totalLength;
  }

  wStream* data_in = encomsp->data_in;
  if (!data_in)
    return ERROR_INVALID_DATA;

  if (!Stream_EnsureRemainingCapacity(data_in, dataLength))
  {
    WLog_ERR(TAG, "Stream_EnsureRemainingCapacity failed!");
    return ERROR_INTERNAL_ERROR;
  }

  Stream_Write(data_in, pData, dataLength);

  if ((Stream_GetPosition(data_in) > totalLength) || (encomsp->totalLength != totalLength))
    return ERROR_INVALID_DATA;

  if (dataFlags & CHANNEL_FLAG_LAST)
  {
    if (!encomsp->firstFlagReceived)
      return ERROR_INVALID_DATA;
    encomsp->firstFlagReceived = FALSE;

    if (Stream_Capacity(data_in) != Stream_GetPosition(data_in))
    {
      WLog_ERR(TAG, "encomsp_plugin_process_received: read error");
      return ERROR_INVALID_DATA;
    }

    encomsp->totalLength = 0;
    encomsp->data_in = nullptr;
    Stream_SealLength(data_in);
    Stream_ResetPosition(data_in);

    if (!MessageQueue_Post(encomsp->queue, nullptr, 0, (void*)data_in, nullptr))
    {
      WLog_ERR(TAG, "MessageQueue_Post failed!");
      return ERROR_INTERNAL_ERROR;
    }
  }

  return CHANNEL_RC_OK;
}

static VOID VCAPITYPE encomsp_virtual_channel_open_event_ex(LPVOID lpUserParam, DWORD openHandle,
                                                            UINT event, LPVOID pData,
                                                            UINT32 dataLength, UINT32 totalLength,
                                                            UINT32 dataFlags)
{
  UINT error = CHANNEL_RC_OK;
  encomspPlugin* encomsp = (encomspPlugin*)lpUserParam;

  switch (event)
  {
    case CHANNEL_EVENT_DATA_RECEIVED:
      if (!encomsp || (encomsp->OpenHandle != openHandle))
      {
        WLog_ERR(TAG, "error no match");
        return;
      }
      if ((error = encomsp_virtual_channel_event_data_received(encomsp, pData, dataLength,
                                                               totalLength, dataFlags)))
        WLog_ERR(TAG,
                 "encomsp_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 && encomsp && encomsp->rdpcontext)
    setChannelError(encomsp->rdpcontext, error,
                    "encomsp_virtual_channel_open_event reported an error");
}

static DWORD WINAPI encomsp_virtual_channel_client_thread(LPVOID arg)
{
  wStream* data = nullptr;
  wMessage message = WINPR_C_ARRAY_INIT;
  encomspPlugin* encomsp = (encomspPlugin*)arg;
  UINT error = CHANNEL_RC_OK;

  WINPR_ASSERT(encomsp);
  while (1)
  {
    if (!MessageQueue_Wait(encomsp->queue))
    {
      WLog_ERR(TAG, "MessageQueue_Wait failed!");
      error = ERROR_INTERNAL_ERROR;
      break;
    }

    if (!MessageQueue_Peek(encomsp->queue, &message, TRUE))
    {
      WLog_ERR(TAG, "MessageQueue_Peek failed!");
      error = ERROR_INTERNAL_ERROR;
      break;
    }

    if (message.id == WMQ_QUIT)
      break;

    if (message.id == 0)
    {
      data = (wStream*)message.wParam;

      if ((error = encomsp_process_receive(encomsp, data)))
      {
        WLog_ERR(TAG, "encomsp_process_receive failed with error %" PRIu32 "!", error);
        Stream_Free(data, TRUE);
        break;
      }

      Stream_Free(data, TRUE);
    }
  }

  if (error && encomsp->rdpcontext)
    setChannelError(encomsp->rdpcontext, error,
                    "encomsp_virtual_channel_client_thread reported an error");

  ExitThread(error);
  return error;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT encomsp_virtual_channel_event_connected(encomspPlugin* encomsp,
                                                    WINPR_ATTR_UNUSED LPVOID pData,
                                                    WINPR_ATTR_UNUSED UINT32 dataLength)
{
  WINPR_ASSERT(encomsp);

  encomsp->queue = MessageQueue_New(nullptr);

  if (!encomsp->queue)
  {
    WLog_ERR(TAG, "MessageQueue_New failed!");
    return CHANNEL_RC_NO_MEMORY;
  }

  if (!(encomsp->thread = CreateThread(nullptr, 0, encomsp_virtual_channel_client_thread,
                                       (void*)encomsp, 0, nullptr)))
  {
    WLog_ERR(TAG, "CreateThread failed!");
    MessageQueue_Free(encomsp->queue);
    return ERROR_INTERNAL_ERROR;
  }

  return encomsp->channelEntryPoints.pVirtualChannelOpenEx(
      encomsp->InitHandle, &encomsp->OpenHandle, encomsp->channelDef.name,
      encomsp_virtual_channel_open_event_ex);
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT encomsp_virtual_channel_event_disconnected(encomspPlugin* encomsp)
{
  WINPR_ASSERT(encomsp);
  if (encomsp->OpenHandle == 0)
    return CHANNEL_RC_OK;

  if (encomsp->queue && encomsp->thread)
  {
    if (MessageQueue_PostQuit(encomsp->queue, 0) &&
        (WaitForSingleObject(encomsp->thread, INFINITE) == WAIT_FAILED))
    {
      const UINT rc = GetLastError();
      WLog_ERR(TAG, "WaitForSingleObject failed with error %" PRIu32 "", rc);
      return rc;
    }
  }

  MessageQueue_Free(encomsp->queue);
  (void)CloseHandle(encomsp->thread);
  encomsp->queue = nullptr;
  encomsp->thread = nullptr;

  WINPR_ASSERT(encomsp->channelEntryPoints.pVirtualChannelCloseEx);
  const UINT rc = encomsp->channelEntryPoints.pVirtualChannelCloseEx(encomsp->InitHandle,
                                                                     encomsp->OpenHandle);

  if (CHANNEL_RC_OK != rc)
  {
    WLog_ERR(TAG, "pVirtualChannelClose failed with %s [%08" PRIX32 "]", WTSErrorToString(rc),
             rc);
    return rc;
  }

  encomsp->OpenHandle = 0;

  if (encomsp->data_in)
  {
    Stream_Free(encomsp->data_in, TRUE);
    encomsp->data_in = nullptr;
  }

  return CHANNEL_RC_OK;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT encomsp_virtual_channel_event_terminated(encomspPlugin* encomsp)
{
  WINPR_ASSERT(encomsp);

  encomsp->InitHandle = nullptr;
  free(encomsp->context);
  free(encomsp);
  return CHANNEL_RC_OK;
}

static VOID VCAPITYPE encomsp_virtual_channel_init_event_ex(LPVOID lpUserParam, LPVOID pInitHandle,
                                                            UINT event, LPVOID pData,
                                                            UINT dataLength)
{
  UINT error = CHANNEL_RC_OK;
  encomspPlugin* encomsp = (encomspPlugin*)lpUserParam;

  if (!encomsp || (encomsp->InitHandle != pInitHandle))
  {
    WLog_ERR(TAG, "error no match");
    return;
  }

  switch (event)
  {
    case CHANNEL_EVENT_INITIALIZED:
      break;

    case CHANNEL_EVENT_CONNECTED:
      if ((error = encomsp_virtual_channel_event_connected(encomsp, pData, dataLength)))
        WLog_ERR(TAG,
                 "encomsp_virtual_channel_event_connected failed with error %" PRIu32 "",
                 error);

      break;

    case CHANNEL_EVENT_DISCONNECTED:
      if ((error = encomsp_virtual_channel_event_disconnected(encomsp)))
        WLog_ERR(TAG,
                 "encomsp_virtual_channel_event_disconnected failed with error %" PRIu32 "",
                 error);

      break;

    case CHANNEL_EVENT_TERMINATED:
      encomsp_virtual_channel_event_terminated(encomsp);
      break;

    default:
      break;
  }

  if (error && encomsp->rdpcontext)
    setChannelError(encomsp->rdpcontext, error,
                    "encomsp_virtual_channel_init_event reported an error");
}

/* encomsp is always built-in */
#define VirtualChannelEntryEx encomsp_VirtualChannelEntryEx

FREERDP_ENTRY_POINT(BOOL VCAPITYPE VirtualChannelEntryEx(PCHANNEL_ENTRY_POINTS_EX pEntryPoints,
                                                         PVOID pInitHandle))
{
  BOOL isFreerdp = FALSE;
  encomspPlugin* encomsp = (encomspPlugin*)calloc(1, sizeof(encomspPlugin));

  if (!encomsp)
  {
    WLog_ERR(TAG, "calloc failed!");
    return FALSE;
  }

  encomsp->channelDef.options = CHANNEL_OPTION_INITIALIZED | CHANNEL_OPTION_ENCRYPT_RDP |
                                CHANNEL_OPTION_COMPRESS_RDP | CHANNEL_OPTION_SHOW_PROTOCOL;
  (void)sprintf_s(encomsp->channelDef.name, ARRAYSIZE(encomsp->channelDef.name),
                  ENCOMSP_SVC_CHANNEL_NAME);
  CHANNEL_ENTRY_POINTS_FREERDP_EX* pEntryPointsEx =
      (CHANNEL_ENTRY_POINTS_FREERDP_EX*)pEntryPoints;
  WINPR_ASSERT(pEntryPointsEx);

  EncomspClientContext* context = nullptr;
  if ((pEntryPointsEx->cbSize >= sizeof(CHANNEL_ENTRY_POINTS_FREERDP_EX)) &&
      (pEntryPointsEx->MagicNumber == FREERDP_CHANNEL_MAGIC_NUMBER))
  {
    context = (EncomspClientContext*)calloc(1, sizeof(EncomspClientContext));

    if (!context)
    {
      WLog_ERR(TAG, "calloc failed!");
      goto error_out;
    }

    context->handle = (void*)encomsp;
    context->FilterUpdated = nullptr;
    context->ApplicationCreated = nullptr;
    context->ApplicationRemoved = nullptr;
    context->WindowCreated = nullptr;
    context->WindowRemoved = nullptr;
    context->ShowWindow = nullptr;
    context->ParticipantCreated = nullptr;
    context->ParticipantRemoved = nullptr;
    context->ChangeParticipantControlLevel = encomsp_send_change_participant_control_level_pdu;
    context->GraphicsStreamPaused = nullptr;
    context->GraphicsStreamResumed = nullptr;
    encomsp->context = context;
    encomsp->rdpcontext = pEntryPointsEx->context;
    isFreerdp = TRUE;
  }

  CopyMemory(&(encomsp->channelEntryPoints), pEntryPoints,
             sizeof(CHANNEL_ENTRY_POINTS_FREERDP_EX));
  encomsp->InitHandle = pInitHandle;

  {
    const UINT rc = encomsp->channelEntryPoints.pVirtualChannelInitEx(
        encomsp, context, pInitHandle, &encomsp->channelDef, 1, VIRTUAL_CHANNEL_VERSION_WIN2000,
        encomsp_virtual_channel_init_event_ex);

    if (CHANNEL_RC_OK != rc)
    {
      WLog_ERR(TAG, "failed with %s [%08" PRIX32 "]", WTSErrorToString(rc), rc);
      goto error_out;
    }
  }

  encomsp->channelEntryPoints.pInterface = context;
  return TRUE;
error_out:

  if (isFreerdp)
    free(encomsp->context);

  free(encomsp);
  return FALSE;
}

Coverage Report

Created: 2026-10-15 06:27