/src/FreeRDP/libfreerdp/core/rdp.c

Source
/**
 * FreeRDP: A Remote Desktop Protocol Implementation
 * RDP Core
 *
 * Copyright 2011 Marc-Andre Moreau <marcandre.moreau@gmail.com>
 * Copyright 2014 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 "settings.h"

#include <winpr/crt.h>
#include <winpr/string.h>
#include <winpr/synch.h>
#include <winpr/assert.h>
#include <winpr/cast.h>
#include <winpr/json.h>
#include <winpr/ssl.h>

#include "rdp.h"

#include "state.h"
#include "info.h"
#include "utils.h"
#include "mcs.h"
#include "redirection.h"

#include <freerdp/codec/bulk.h>
#include <freerdp/crypto/per.h>
#include <freerdp/log.h>
#include <freerdp/buildflags.h>

#define RDP_TAG FREERDP_TAG("core.rdp")

typedef struct
{
  const char* file;
  const char* fkt;
  size_t line;
  DWORD level;
} log_line_t;

static const char* DATA_PDU_TYPE_STRINGS[80] = {
  "?",
  "?",      /* 0x00 - 0x01 */
  "Update", /* 0x02 */
  "?",
  "?",
  "?",
  "?",
  "?",
  "?",
  "?",
  "?", /* 0x03 - 0x0A */
  "?",
  "?",
  "?",
  "?",
  "?",
  "?",
  "?",
  "?",
  "?",       /* 0x0B - 0x13 */
  "Control", /* 0x14 */
  "?",
  "?",
  "?",
  "?",
  "?",
  "?",       /* 0x15 - 0x1A */
  "Pointer", /* 0x1B */
  "Input",   /* 0x1C */
  "?",
  "?",                            /* 0x1D - 0x1E */
  "Synchronize",                  /* 0x1F */
  "?",                            /* 0x20 */
  "Refresh Rect",                 /* 0x21 */
  "Play Sound",                   /* 0x22 */
  "Suppress Output",              /* 0x23 */
  "Shutdown Request",             /* 0x24 */
  "Shutdown Denied",              /* 0x25 */
  "Save Session Info",            /* 0x26 */
  "Font List",                    /* 0x27 */
  "Font Map",                     /* 0x28 */
  "Set Keyboard Indicators",      /* 0x29 */
  "?",                            /* 0x2A */
  "Bitmap Cache Persistent List", /* 0x2B */
  "Bitmap Cache Error",           /* 0x2C */
  "Set Keyboard IME Status",      /* 0x2D */
  "Offscreen Cache Error",        /* 0x2E */
  "Set Error Info",               /* 0x2F */
  "Draw Nine Grid Error",         /* 0x30 */
  "Draw GDI+ Error",              /* 0x31 */
  "ARC Status",                   /* 0x32 */
  "?",
  "?",
  "?",              /* 0x33 - 0x35 */
  "Status Info",    /* 0x36 */
  "Monitor Layout", /* 0x37 */
  "FrameAcknowledge",
  "?",
  "?", /* 0x38 - 0x40 */
  "?",
  "?",
  "?",
  "?",
  "?",
  "?" /* 0x41 - 0x46 */
};

#define rdp_check_monitor_layout_pdu_state(rdp, expected) \
  rdp_check_monitor_layout_pdu_state_(rdp, expected, __FILE__, __func__, __LINE__)

WINPR_ATTR_NODISCARD
static BOOL rdp_check_monitor_layout_pdu_state_(const rdpRdp* rdp, BOOL expected, const char* file,
                                                const char* fkt, size_t line)
{
  WINPR_ASSERT(rdp);
  if (expected != rdp->monitor_layout_pdu)
  {
    const DWORD log_level = WLOG_ERROR;
    if (WLog_IsLevelActive(rdp->log, log_level))
    {
      WLog_PrintTextMessage(rdp->log, log_level, line, file, fkt,
                            "Expected rdp->monitor_layout_pdu == %s",
                            expected ? "TRUE" : "FALSE");
    }
    return FALSE;
  }
  return TRUE;
}

#define rdp_set_monitor_layout_pdu_state(rdp, expected) \
  rdp_set_monitor_layout_pdu_state_(rdp, expected, __FILE__, __func__, __LINE__)
WINPR_ATTR_NODISCARD
static BOOL rdp_set_monitor_layout_pdu_state_(rdpRdp* rdp, BOOL value, const char* file,
                                              const char* fkt, size_t line)
{

  WINPR_ASSERT(rdp);
  if (value && (value == rdp->monitor_layout_pdu))
  {
    const DWORD log_level = WLOG_WARN;
    if (WLog_IsLevelActive(rdp->log, log_level))
    {
      WLog_PrintTextMessage(rdp->log, log_level, line, file, fkt,
                            "rdp->monitor_layout_pdu == TRUE, expected FALSE");
    }
    return FALSE;
  }
  rdp->monitor_layout_pdu = value;
  return TRUE;
}

const char* data_pdu_type_to_string(UINT8 type)
{
  if (type >= ARRAYSIZE(DATA_PDU_TYPE_STRINGS))
    return "???";
  return DATA_PDU_TYPE_STRINGS[type];
}

WINPR_ATTR_NODISCARD
static BOOL rdp_read_flow_control_pdu(rdpRdp* rdp, wStream* s, UINT16* type, UINT16* channel_id);

WINPR_ATTR_NODISCARD
static BOOL rdp_write_share_control_header(rdpRdp* rdp, wStream* s, size_t length, UINT16 type,
                                           UINT16 channel_id);

WINPR_ATTR_NODISCARD
static BOOL rdp_write_share_data_header(rdpRdp* rdp, wStream* s, size_t length, BYTE type,
                                        UINT32 share_id);

/**
 * @brief Read RDP Security Header.
 * msdn{cc240579}
 *
 * @param s stream
 * @param flags security flags
 *
 * @return \b TRUE for success, \b FALSE otherwise
 */

BOOL rdp_read_security_header(rdpRdp* rdp, wStream* s, UINT16* flags, UINT16* length)
{
  char buffer[256] = WINPR_C_ARRAY_INIT;
  WINPR_ASSERT(s);
  WINPR_ASSERT(flags);
  WINPR_ASSERT(rdp);

  /* Basic Security Header */
  if ((length && (*length < 4)))
  {
    WLog_Print(rdp->log, WLOG_WARN,
               "invalid security header length, have %" PRIu16 ", must be >= 4", *length);
    return FALSE;
  }
  if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
    return FALSE;

  *flags = Stream_Get_UINT16(s);                 /* flags */
  const uint16_t flagsHi = Stream_Get_UINT16(s); /* flagsHi (unused) */
  if ((*flags & SEC_FLAGSHI_VALID) != 0)
  {
    WLog_Print(rdp->log, WLOG_WARN,
               "[MS-RDPBCGR] 2.2.8.1.1.2.1 Basic (TS_SECURITY_HEADER) SEC_FLAGSHI_VALID field "
               "set: flagsHi=0x%04" PRIx16,
               flagsHi);
  }
  WLog_Print(rdp->log, WLOG_TRACE, "%s",
             rdp_security_flag_string(*flags, buffer, sizeof(buffer)));
  if (length)
    *length -= 4;

  return TRUE;
}

/**
 * Write RDP Security Header.
 * msdn{cc240579}
 * @param s stream
 * @param flags security flags
 *
 * @return \b TRUE for success, \b FALSE otherwise
 */

BOOL rdp_write_security_header(rdpRdp* rdp, wStream* s, UINT16 flags)
{
  char buffer[256] = WINPR_C_ARRAY_INIT;
  WINPR_ASSERT(s);
  WINPR_ASSERT(rdp);

  if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, (s), 4))
    return FALSE;

  WLog_Print(rdp->log, WLOG_TRACE, "%s", rdp_security_flag_string(flags, buffer, sizeof(buffer)));
  /* Basic Security Header */
  WINPR_ASSERT((flags & SEC_FLAGSHI_VALID) == 0); /* SEC_FLAGSHI_VALID is unsupported */
  Stream_Write_UINT16(s, flags);                  /* flags */
  Stream_Write_UINT16(s, 0);                      /* flagsHi (unused) */
  return TRUE;
}

BOOL rdp_read_share_control_header(rdpRdp* rdp, wStream* s, UINT16* tpktLength,
                                   UINT16* remainingLength, UINT16* type, UINT16* channel_id)
{
  UINT16 len = 0;
  UINT16 tmp = 0;

  WINPR_ASSERT(rdp);
  WINPR_ASSERT(s);
  WINPR_ASSERT(type);
  WINPR_ASSERT(channel_id);

  if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 2))
    return FALSE;

  /* Share Control Header */
  Stream_Read_UINT16(s, len); /* totalLength */

  /* If length is 0x8000 then we actually got a flow control PDU that we should ignore
   http://msdn.microsoft.com/en-us/library/cc240576.aspx */
  if (len == 0x8000)
  {
    if (!rdp_read_flow_control_pdu(rdp, s, type, channel_id))
      return FALSE;
    *channel_id = 0;
    if (tpktLength)
      *tpktLength = 8; /* Flow control PDU is 8 bytes */
    if (remainingLength)
      *remainingLength = 0;

    char buffer[128] = WINPR_C_ARRAY_INIT;
    WLog_Print(rdp->log, WLOG_DEBUG,
               "[Flow control PDU] type=%s, tpktLength=%" PRIu16 ", remainingLength=%" PRIu16,
               pdu_type_to_str(*type, buffer, sizeof(buffer)), tpktLength ? *tpktLength : 0u,
               remainingLength ? *remainingLength : 0u);
    return TRUE;
  }

  if (len < 4U)
  {
    WLog_Print(rdp->log, WLOG_ERROR,
               "Invalid share control header, length is %" PRIu16 ", must be >4", len);
    return FALSE;
  }

  if (tpktLength)
    *tpktLength = len;

  if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 2))
    return FALSE;

  Stream_Read_UINT16(s, tmp); /* pduType */
  *type = tmp & 0x0F;         /* type is in the 4 least significant bits */

  size_t remLen = len - 4;
  if (len > 5)
  {
    if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 2))
      return FALSE;

    Stream_Read_UINT16(s, *channel_id); /* pduSource */
    remLen = len - 6;
  }
  else
    *channel_id = 0; /* Windows XP can send such short DEACTIVATE_ALL PDUs. */

  char buffer[128] = WINPR_C_ARRAY_INIT;
  WLog_Print(rdp->log, WLOG_DEBUG, "type=%s, tpktLength=%" PRIu16 ", remainingLength=%" PRIuz,
             pdu_type_to_str(*type, buffer, sizeof(buffer)), len, remLen);
  if (remainingLength)
  {
    WINPR_ASSERT(remLen <= UINT16_MAX);
    *remainingLength = (UINT16)remLen;
  }
  return Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, remLen);
}

BOOL rdp_write_share_control_header(rdpRdp* rdp, wStream* s, size_t length, UINT16 type,
                                    UINT16 channel_id)
{
  WINPR_ASSERT(s);
  WINPR_ASSERT(rdp);
  if (length > UINT16_MAX)
    return FALSE;

  if (length < RDP_PACKET_HEADER_MAX_LENGTH)
    return FALSE;
  if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, (s), 6))
    return FALSE;
  length -= RDP_PACKET_HEADER_MAX_LENGTH;
  /* Share Control Header */
  Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, length));      /* totalLength */
  Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, type | 0x10)); /* pduType */
  Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, channel_id));  /* pduSource */
  return TRUE;
}

BOOL rdp_read_share_data_header(rdpRdp* rdp, wStream* s, UINT16* length, BYTE* type,
                                UINT32* shareId, BYTE* compressedType, UINT16* compressedLength)
{
  WINPR_ASSERT(s);
  WINPR_ASSERT(rdp);

  if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 12))
    return FALSE;

  /* Share Data Header */
  Stream_Read_UINT32(s, *shareId);          /* shareId (4 bytes) */
  Stream_Seek_UINT8(s);                     /* pad1 (1 byte) */
  Stream_Seek_UINT8(s);                     /* streamId (1 byte) */
  Stream_Read_UINT16(s, *length);           /* uncompressedLength (2 bytes) */
  Stream_Read_UINT8(s, *type);              /* pduType2, Data PDU Type (1 byte) */
  Stream_Read_UINT8(s, *compressedType);    /* compressedType (1 byte) */
  Stream_Read_UINT16(s, *compressedLength); /* compressedLength (2 bytes) */
  return TRUE;
}

BOOL rdp_write_share_data_header(rdpRdp* rdp, wStream* s, size_t length, BYTE type, UINT32 share_id)
{
  const size_t headerLen = RDP_PACKET_HEADER_MAX_LENGTH + RDP_SHARE_CONTROL_HEADER_LENGTH +
                           RDP_SHARE_DATA_HEADER_LENGTH;

  WINPR_ASSERT(s);
  WINPR_ASSERT(rdp);
  if (length > UINT16_MAX)
    return FALSE;

  if (length < headerLen)
    return FALSE;
  length -= headerLen;
  if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, (s), 12))
    return FALSE;

  /* Share Data Header */
  Stream_Write_UINT32(s, share_id);  /* shareId (4 bytes) */
  Stream_Write_UINT8(s, 0);          /* pad1 (1 byte) */
  Stream_Write_UINT8(s, STREAM_LOW); /* streamId (1 byte) */
  Stream_Write_UINT16(
      s, WINPR_ASSERTING_INT_CAST(uint16_t, length)); /* uncompressedLength (2 bytes) */
  Stream_Write_UINT8(s, type);                        /* pduType2, Data PDU Type (1 byte) */
  Stream_Write_UINT8(s, 0);                           /* compressedType (1 byte) */
  Stream_Write_UINT16(s, 0);                          /* compressedLength (2 bytes) */
  return TRUE;
}

WINPR_ATTR_NODISCARD
static BOOL rdp_security_stream_init(rdpRdp* rdp, wStream* s, BOOL sec_header, UINT16* sec_flags)
{
  WINPR_ASSERT(rdp);
  WINPR_ASSERT(s);
  WINPR_ASSERT(sec_flags);

  if (rdp->do_crypt)
  {
    if (!Stream_SafeZero(s, 12))
      return FALSE;

    if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
    {
      if (!Stream_SafeZero(s, 4))
        return FALSE;
    }

    *sec_flags |= SEC_ENCRYPT;

    if (rdp->do_secure_checksum)
      *sec_flags |= SEC_SECURE_CHECKSUM;
  }
  else if (*sec_flags != 0 || sec_header)
  {
    if (!Stream_SafeZero(s, 4))
      return FALSE;
  }

  return TRUE;
}

wStream* rdp_send_stream_init(rdpRdp* rdp, UINT16* sec_flags)
{
  wStream* s = nullptr;

  WINPR_ASSERT(rdp);
  WINPR_ASSERT(rdp->transport);

  s = transport_send_stream_init(rdp->transport, 4096);

  if (!s)
    return nullptr;

  if (!Stream_SafeZero(s, RDP_PACKET_HEADER_MAX_LENGTH))
    goto fail;

  if (!rdp_security_stream_init(rdp, s, FALSE, sec_flags))
    goto fail;

  return s;
fail:
  Stream_Release(s);
  return nullptr;
}

wStream* rdp_send_stream_pdu_init(rdpRdp* rdp, UINT16* sec_flags)
{
  wStream* s = rdp_send_stream_init(rdp, sec_flags);

  if (!s)
    return nullptr;

  if (!Stream_SafeZero(s, RDP_SHARE_CONTROL_HEADER_LENGTH))
    goto fail;

  return s;
fail:
  Stream_Release(s);
  return nullptr;
}

wStream* rdp_data_pdu_init(rdpRdp* rdp, UINT16* sec_flags)
{
  wStream* s = rdp_send_stream_pdu_init(rdp, sec_flags);

  if (!s)
    return nullptr;

  if (!Stream_SafeZero(s, RDP_SHARE_DATA_HEADER_LENGTH))
    goto fail;

  return s;
fail:
  Stream_Release(s);
  return nullptr;
}

BOOL rdp_set_error_info(rdpRdp* rdp, UINT32 errorInfo)
{
  BOOL rc = TRUE;
  WINPR_ASSERT(rdp);

  rdp->errorInfo = errorInfo;

  if (rdp->errorInfo != ERRINFO_SUCCESS)
  {
    rdpContext* context = rdp->context;
    WINPR_ASSERT(context);

    rdp_print_errinfo(rdp->errorInfo);

    if (context)
    {
      freerdp_set_last_error_log(context, MAKE_FREERDP_ERROR(ERRINFO, errorInfo));

      if (context->pubSub)
      {
        ErrorInfoEventArgs e = WINPR_C_ARRAY_INIT;
        EventArgsInit(&e, "freerdp");
        e.code = rdp->errorInfo;
        rc = PubSub_OnErrorInfo(context->pubSub, context, &e) >= 0;
      }
    }
    else
      WLog_Print(rdp->log, WLOG_ERROR, "missing context=%p", (void*)context);
  }
  else
  {
    freerdp_set_last_error_log(rdp->context, FREERDP_ERROR_SUCCESS);
  }

  return rc;
}

wStream* rdp_message_channel_pdu_init(rdpRdp* rdp, UINT16* sec_flags)
{
  wStream* s = nullptr;

  WINPR_ASSERT(rdp);

  s = transport_send_stream_init(rdp->transport, 4096);

  if (!s)
    return nullptr;

  if (!Stream_SafeZero(s, RDP_PACKET_HEADER_MAX_LENGTH))
    goto fail;

  if (!rdp_security_stream_init(rdp, s, TRUE, sec_flags))
    goto fail;

  return s;
fail:
  Stream_Release(s);
  return nullptr;
}

/**
 * Read an RDP packet header.
 * @param rdp rdp module
 * @param s stream
 * @param length RDP packet length
 * @param channelId channel id
 *
 * @return \b TRUE for success, \b FALSE otherwise
 */

BOOL rdp_read_header(rdpRdp* rdp, wStream* s, UINT16* length, UINT16* channelId)
{
  BYTE li = 0;
  BYTE code = 0;
  BYTE choice = 0;
  UINT16 initiator = 0;

  WINPR_ASSERT(rdp);
  WINPR_ASSERT(rdp->settings);
  WINPR_ASSERT(s);
  DomainMCSPDU MCSPDU = (rdp->settings->ServerMode) ? DomainMCSPDU_SendDataRequest
                                                    : DomainMCSPDU_SendDataIndication;

  *channelId = 0; /* Initialize in case of early abort */
  if (!tpkt_read_header(s, length))
    return FALSE;

  if (!tpdu_read_header(s, &code, &li, *length))
    return FALSE;

  if (code != X224_TPDU_DATA)
  {
    if (code == X224_TPDU_DISCONNECT_REQUEST)
    {
      WLog_Print(rdp->log, WLOG_WARN, "Received X224_TPDU_DISCONNECT_REQUEST, terminating");
      utils_abort_connect(rdp);
      return TRUE;
    }

    WLog_Print(rdp->log, WLOG_WARN,
               "Unexpected X224 TPDU type %s [%08" PRIx32 "] instead of %s",
               tpdu_type_to_string(code), code, tpdu_type_to_string(X224_TPDU_DATA));
    return FALSE;
  }

  if (!per_read_choice(s, &choice))
    return FALSE;

  const DomainMCSPDU domainMCSPDU = (DomainMCSPDU)(choice >> 2);

  if (domainMCSPDU != MCSPDU)
  {
    if (domainMCSPDU != DomainMCSPDU_DisconnectProviderUltimatum)
    {
      WLog_Print(rdp->log, WLOG_WARN, "Received %s instead of %s",
                 mcs_domain_pdu_string(domainMCSPDU), mcs_domain_pdu_string(MCSPDU));
      return FALSE;
    }
  }

  MCSPDU = domainMCSPDU;

  if (*length < 8U)
  {
    WLog_Print(rdp->log, WLOG_WARN, "TPDU invalid length, got %" PRIu16 ", expected at least 8",
               *length);
    return FALSE;
  }

  if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, *length - 8))
    return FALSE;

  if (MCSPDU == DomainMCSPDU_DisconnectProviderUltimatum)
  {
    int reason = 0;
    TerminateEventArgs e = WINPR_C_ARRAY_INIT;

    if (!mcs_recv_disconnect_provider_ultimatum(rdp->mcs, s, &reason))
      return FALSE;

    rdpContext* context = rdp->context;
    WINPR_ASSERT(context);
    context->disconnectUltimatum = reason;

    if (rdp->errorInfo == ERRINFO_SUCCESS)
    {
      /**
       * Some servers like Windows Server 2008 R2 do not send the error info pdu
       * when the user logs off like they should. Map DisconnectProviderUltimatum
       * to a ERRINFO_LOGOFF_BY_USER when the errinfo code is ERRINFO_SUCCESS.
       */
      UINT32 errorInfo = ERRINFO_RPC_INITIATED_DISCONNECT;
      if (reason == Disconnect_Ultimatum_provider_initiated)
        errorInfo = ERRINFO_RPC_INITIATED_DISCONNECT;
      else if (reason == Disconnect_Ultimatum_user_requested)
        errorInfo = ERRINFO_LOGOFF_BY_USER;

      if (!rdp_set_error_info(rdp, errorInfo))
        return FALSE;
    }

    WLog_Print(rdp->log, WLOG_DEBUG, "DisconnectProviderUltimatum: reason: %d", reason);
    utils_abort_connect(rdp);
    EventArgsInit(&e, "freerdp");
    e.code = 0;
    return PubSub_OnTerminate(rdp->pubSub, context, &e) >= 0;
  }

  if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 5))
    return FALSE;

  if (!per_read_integer16(s, &initiator, MCS_BASE_CHANNEL_ID)) /* initiator (UserId) */
    return FALSE;

  if (!per_read_integer16(s, channelId, 0)) /* channelId */
    return FALSE;

  const uint8_t dataPriority = Stream_Get_UINT8(s); /* dataPriority + Segmentation (0x70) */
  WLog_Print(rdp->log, WLOG_TRACE, "dataPriority=%" PRIu8, dataPriority);

  if (!per_read_length(s, length)) /* userData (OCTET_STRING) */
    return FALSE;

  if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, *length))
    return FALSE;

  return TRUE;
}

/**
 * Write an RDP packet header.
 * @param rdp rdp module
 * @param s stream
 * @param length RDP packet length
 * @param channelId channel id
 *
 * @return \b TRUE for success, \b FALSE otherwise
 */

BOOL rdp_write_header(rdpRdp* rdp, wStream* s, size_t length, UINT16 channelId, UINT16 sec_flags)
{
  WINPR_ASSERT(rdp);
  WINPR_ASSERT(rdp->settings);
  WINPR_ASSERT(s);
  WINPR_ASSERT(length >= RDP_PACKET_HEADER_MAX_LENGTH);
  if (length > UINT16_MAX)
    return FALSE;

  DomainMCSPDU MCSPDU = (rdp->settings->ServerMode) ? DomainMCSPDU_SendDataIndication
                                                    : DomainMCSPDU_SendDataRequest;

  if ((sec_flags & SEC_ENCRYPT) && (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS))
  {
    const UINT16 body_length = (UINT16)length - RDP_PACKET_HEADER_MAX_LENGTH;
    const UINT16 pad = 8 - (body_length % 8);

    if (pad != 8)
      length += pad;
  }

  if (!mcs_write_domain_mcspdu_header(s, MCSPDU, (UINT16)length, 0))
    return FALSE;
  if (!per_write_integer16(s, rdp->mcs->userId, MCS_BASE_CHANNEL_ID)) /* initiator */
    return FALSE;
  if (!per_write_integer16(s, channelId, 0)) /* channelId */
    return FALSE;
  if (!Stream_EnsureRemainingCapacity(s, 3))
    return FALSE;
  Stream_Write_UINT8(s, 0x70); /* dataPriority + segmentation */
  /*
   * We always encode length in two bytes, even though we could use
   * only one byte if length <= 0x7F. It is just easier that way,
   * because we can leave room for fixed-length header, store all
   * the data first and then store the header.
   */
  length = (length - RDP_PACKET_HEADER_MAX_LENGTH) | 0x8000;
  Stream_Write_UINT16_BE(
      s, WINPR_ASSERTING_INT_CAST(uint16_t, length)); /* userData (OCTET_STRING) */
  return TRUE;
}

WINPR_ATTR_NODISCARD
static BOOL rdp_security_stream_out(rdpRdp* rdp, wStream* s, size_t length, UINT16 sec_flags,
                                    UINT32* pad)
{
  BOOL status = 0;
  WINPR_ASSERT(rdp);
  if (length > UINT16_MAX)
    return FALSE;

  *pad = 0;

  if (sec_flags != 0)
  {
    WINPR_ASSERT(sec_flags <= UINT16_MAX);
    if (!rdp_write_security_header(rdp, s, sec_flags))
      return FALSE;

    if (sec_flags & SEC_ENCRYPT)
    {
      if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
      {
        BYTE* data = Stream_PointerAs(s, BYTE) + 12;
        const size_t size = WINPR_ASSERTING_INT_CAST(size_t, (data - Stream_Buffer(s)));
        if (size > length)
          return FALSE;

        length -= size;

        Stream_Write_UINT16(s, 0x10); /* length */
        Stream_Write_UINT8(s, 0x1);   /* TSFIPS_VERSION 1*/
        /* handle padding */
        *pad = 8 - (length % 8);

        if (*pad == 8)
          *pad = 0;

        if (*pad)
          memset(data + length, 0, *pad);

        Stream_Write_UINT8(s, WINPR_ASSERTING_INT_CAST(uint8_t, *pad));

        if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, s, 8))
          return FALSE;
        if (!security_hmac_signature(data, length, Stream_Pointer(s), 8, rdp))
          return FALSE;

        Stream_Seek(s, 8);
        if (!security_fips_encrypt(data, length + *pad, rdp))
          return FALSE;
      }
      else
      {
        const BYTE* data = Stream_PointerAs(s, const BYTE) + 8;
        const size_t diff = Stream_GetPosition(s) + 8ULL;
        if (diff > length)
          return FALSE;
        length -= diff;

        if (!Stream_CheckAndLogRequiredCapacityWLog(rdp->log, s, 8))
          return FALSE;
        if (sec_flags & SEC_SECURE_CHECKSUM)
          status = security_salted_mac_signature(rdp, data, (UINT32)length, TRUE,
                                                 Stream_Pointer(s), 8);
        else
          status = security_mac_signature(rdp, data, (UINT32)length,
                                          Stream_PointerAs(s, BYTE), 8);

        if (!status)
          return FALSE;

        Stream_Seek(s, 8);

        if (!security_encrypt(Stream_Pointer(s), length, rdp))
          return FALSE;
      }
    }
  }

  return TRUE;
}

WINPR_ATTR_NODISCARD
static UINT32 rdp_get_sec_bytes(rdpRdp* rdp, UINT16 sec_flags)
{
  UINT32 sec_bytes = 0;

  if (sec_flags & SEC_ENCRYPT)
  {
    sec_bytes = 12;

    if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
      sec_bytes += 4;
  }
  else if (sec_flags != 0)
  {
    sec_bytes = 4;
  }
  else
  {
    sec_bytes = 0;
  }

  return sec_bytes;
}

BOOL rdp_send(rdpRdp* rdp, wStream* s, UINT16 channelId, UINT16 sec_flags)
{
  BOOL rc = FALSE;
  UINT32 pad = 0;
  BOOL should_unlock = FALSE;

  if (!s)
    return FALSE;

  if (!rdp)
    goto fail;

  if (sec_flags & SEC_ENCRYPT)
  {
    security_lock(rdp);
    should_unlock = TRUE;
  }

  {
    size_t length = Stream_GetPosition(s);
    Stream_ResetPosition(s);
    if (!rdp_write_header(rdp, s, length, channelId, sec_flags))
      goto fail;

    if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
      goto fail;

    length += pad;
    if (!Stream_SetPosition(s, length))
      goto fail;
    Stream_SealLength(s);
  }

  if (transport_write(rdp->transport, s) < 0)
    goto fail;

  rc = TRUE;
fail:
  if (should_unlock)
    security_unlock(rdp);
  Stream_Release(s);
  return rc;
}

BOOL rdp_send_pdu(rdpRdp* rdp, wStream* s, UINT16 type, UINT16 channel_id, UINT16 sec_flags)
{
  BOOL rc = FALSE;
  UINT32 sec_bytes = 0;
  size_t sec_hold = 0;
  UINT32 pad = 0;
  BOOL should_unlock = FALSE;

  if (!s)
    return FALSE;

  if (!rdp)
    goto fail;

  if (sec_flags & SEC_ENCRYPT)
  {
    security_lock(rdp);
    should_unlock = TRUE;
  }

  {
    size_t length = Stream_GetPosition(s);
    Stream_ResetPosition(s);
    if (!rdp_write_header(rdp, s, length, MCS_GLOBAL_CHANNEL_ID, sec_flags))
      goto fail;
    sec_bytes = rdp_get_sec_bytes(rdp, sec_flags);
    sec_hold = Stream_GetPosition(s);
    Stream_Seek(s, sec_bytes);
    if (!rdp_write_share_control_header(rdp, s, length - sec_bytes, type, channel_id))
      goto fail;
    if (!Stream_SetPosition(s, sec_hold))
      goto fail;

    if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
      goto fail;

    length += pad;
    if (!Stream_SetPosition(s, length))
      goto fail;
    Stream_SealLength(s);
  }

  if (transport_write(rdp->transport, s) < 0)
    goto fail;

  rc = TRUE;
fail:
  if (should_unlock)
    security_unlock(rdp);
  return rc;
}

BOOL rdp_send_data_pdu(rdpRdp* rdp, wStream* s, BYTE type, UINT16 channel_id, UINT16 sec_flags)
{
  BOOL rc = FALSE;
  UINT32 sec_bytes = 0;
  size_t sec_hold = 0;
  UINT32 pad = 0;
  BOOL should_unlock = FALSE;

  if (!s)
    return FALSE;

  if (!rdp)
    goto fail;

  if (sec_flags & SEC_ENCRYPT)
  {
    security_lock(rdp);
    should_unlock = TRUE;
  }

  {
    size_t length = Stream_GetPosition(s);
    Stream_ResetPosition(s);
    if (!rdp_write_header(rdp, s, length, MCS_GLOBAL_CHANNEL_ID, sec_flags))
      goto fail;
    sec_bytes = rdp_get_sec_bytes(rdp, sec_flags);
    sec_hold = Stream_GetPosition(s);
    Stream_Seek(s, sec_bytes);
    if (!rdp_write_share_control_header(rdp, s, length - sec_bytes, PDU_TYPE_DATA, channel_id))
      goto fail;
    if (!rdp_write_share_data_header(rdp, s, length - sec_bytes, type, rdp->settings->ShareId))
      goto fail;
    if (!Stream_SetPosition(s, sec_hold))
      goto fail;

    if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
      goto fail;

    length += pad;
    if (!Stream_SetPosition(s, length))
      goto fail;
    Stream_SealLength(s);
  }
  WLog_Print(rdp->log, WLOG_DEBUG,
             "sending data (type=0x%x size=%" PRIuz " channelId=%" PRIu16 ")", type,
             Stream_Length(s), channel_id);

  rdp->outPackets++;
  if (transport_write(rdp->transport, s) < 0)
    goto fail;

  rc = TRUE;
fail:
  if (should_unlock)
    security_unlock(rdp);
  Stream_Release(s);
  return rc;
}

BOOL rdp_send_message_channel_pdu(rdpRdp* rdp, wStream* s, UINT16 sec_flags)
{
  BOOL rc = FALSE;
  UINT32 pad = 0;
  BOOL should_unlock = FALSE;

  WINPR_ASSERT(rdp);
  WINPR_ASSERT(s);

  if (sec_flags & SEC_ENCRYPT)
  {
    security_lock(rdp);
    should_unlock = TRUE;
  }

  {
    size_t length = Stream_GetPosition(s);
    Stream_ResetPosition(s);
    if (!rdp_write_header(rdp, s, length, rdp->mcs->messageChannelId, sec_flags))
      goto fail;

    if (!rdp_security_stream_out(rdp, s, length, sec_flags, &pad))
      goto fail;

    length += pad;
    if (!Stream_SetPosition(s, length))
      goto fail;
  }
  Stream_SealLength(s);

  if (transport_write(rdp->transport, s) < 0)
    goto fail;

  rc = TRUE;
fail:
  if (should_unlock)
    security_unlock(rdp);

  Stream_Release(s);
  return rc;
}

WINPR_ATTR_NODISCARD
static BOOL rdp_recv_server_shutdown_denied_pdu(WINPR_ATTR_UNUSED rdpRdp* rdp,
                                                WINPR_ATTR_UNUSED wStream* s)
{
  return TRUE;
}

WINPR_ATTR_NODISCARD
static BOOL rdp_recv_server_set_keyboard_indicators_pdu(rdpRdp* rdp, wStream* s)
{
  WINPR_ASSERT(rdp);
  WINPR_ASSERT(s);

  rdpContext* context = rdp->context;
  WINPR_ASSERT(context);
  WINPR_ASSERT(context->update);

  if (!rdp_has_reached_state(rdp, CONNECTION_STATE_ACTIVE))
    return FALSE;

  if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
    return FALSE;

  const uint16_t unitId = Stream_Get_UINT16(s); /* unitId (2 bytes) */
  if (unitId != 0)
  {
    WLog_Print(rdp->log, WLOG_WARN,
               "[MS-RDPBCGR] 2.2.8.2.1.1 Set Keyboard Indicators PDU Data "
               "(TS_SET_KEYBOARD_INDICATORS_PDU)::unitId should be 0, is %" PRIu16,
               unitId);
  }
  const UINT16 ledFlags = Stream_Get_UINT16(s); /* ledFlags (2 bytes) */
  return IFCALLRESULT(TRUE, context->update->SetKeyboardIndicators, context, ledFlags);
}

WINPR_ATTR_NODISCARD
static BOOL rdp_recv_server_set_keyboard_ime_status_pdu(rdpRdp* rdp, wStream* s)
{
  if (!rdp || !rdp->input)
    return FALSE;

  if (!rdp_has_reached_state(rdp, CONNECTION_STATE_ACTIVE))
    return FALSE;

  if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 10))
    return FALSE;

  const uint16_t unitId = Stream_Get_UINT16(s); /* unitId (2 bytes) */
  if (unitId != 0)
  {
    WLog_Print(rdp->log, WLOG_WARN,
               "[MS-RDPBCGR] 2.2.8.2.2.1 Set Keyboard IME Status PDU Data "
               "(TS_SET_KEYBOARD_IME_STATUS_PDU)::unitId should be 0, is %" PRIu16,
               unitId);
  }
  const uint32_t imeState = Stream_Get_UINT32(s);    /* imeState (4 bytes) */
  const uint32_t imeConvMode = Stream_Get_UINT32(s); /* imeConvMode (4 bytes) */
  return IFCALLRESULT(TRUE, rdp->update->SetKeyboardImeStatus, rdp->context, unitId, imeState,
                      imeConvMode);
}

WINPR_ATTR_NODISCARD
static BOOL rdp_recv_set_error_info_data_pdu(rdpRdp* rdp, wStream* s)
{
  UINT32 errorInfo = 0;

  if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
    return FALSE;

  Stream_Read_UINT32(s, errorInfo); /* errorInfo (4 bytes) */
  return rdp_set_error_info(rdp, errorInfo);
}

WINPR_ATTR_NODISCARD
static BOOL rdp_recv_server_auto_reconnect_status_pdu(rdpRdp* rdp, wStream* s)
{
  UINT32 arcStatus = 0;

  if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
    return FALSE;

  Stream_Read_UINT32(s, arcStatus); /* arcStatus (4 bytes) */
  WLog_Print(rdp->log, WLOG_WARN, "AutoReconnectStatus: 0x%08" PRIX32 "", arcStatus);
  return TRUE;
}

WINPR_ATTR_NODISCARD
static BOOL rdp_recv_server_status_info_pdu(rdpRdp* rdp, wStream* s)
{
  UINT32 statusCode = 0;

  if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
    return FALSE;

  Stream_Read_UINT32(s, statusCode); /* statusCode (4 bytes) */

  if (rdp->update->ServerStatusInfo)
    return rdp->update->ServerStatusInfo(rdp->context, statusCode);

  return TRUE;
}

static void log_monitor(size_t idx, const MONITOR_DEF* monitor, wLog* log, DWORD level)
{
  WINPR_ASSERT(monitor);

  WLog_Print(log, level, "[%" PRIuz "] {%dx%d-%dx%d} [0x%08" PRIx32 "]", idx, monitor->left,
             monitor->top, monitor->right, monitor->bottom, monitor->flags);
}

static void log_monitor_configuration(wLog* log, const MONITOR_DEF* monitors, size_t count)
{
  const DWORD level = WLOG_DEBUG;
  WLog_Print(log, level, "[BEGIN] RemoteMonitors[%" PRIuz "]", count);
  for (size_t x = 0; x < count; x++)
  {
    const MONITOR_DEF* monitor = &monitors[x];
    log_monitor(x, monitor, log, level);
  }
  WLog_Print(log, level, "[END] RemoteMonitors[%" PRIuz "]", count);
}

WINPR_ATTR_NODISCARD
static BOOL rdp_recv_monitor_layout_pdu(rdpRdp* rdp, wStream* s)
{
  BOOL ret = TRUE;

  WINPR_ASSERT(rdp);

  if (!rdp_has_reached_state(rdp, CONNECTION_STATE_CAPABILITIES_EXCHANGE_MONITOR_LAYOUT))
    return FALSE;

  if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 4))
    return FALSE;

  const UINT32 monitorCount = Stream_Get_UINT32(s); /* monitorCount (4 bytes) */

  if (!Stream_CheckAndLogRequiredLengthOfSizeWLog(rdp->log, s, monitorCount, 20ull))
    return FALSE;

  MONITOR_DEF* monitorDefArray = (MONITOR_DEF*)calloc(monitorCount, sizeof(MONITOR_DEF));

  if (!monitorDefArray)
    return FALSE;

  for (UINT32 index = 0; index < monitorCount; index++)
  {
    MONITOR_DEF* monitor = &monitorDefArray[index];
    Stream_Read_INT32(s, monitor->left);   /* left (4 bytes) */
    Stream_Read_INT32(s, monitor->top);    /* top (4 bytes) */
    Stream_Read_INT32(s, monitor->right);  /* right (4 bytes) */
    Stream_Read_INT32(s, monitor->bottom); /* bottom (4 bytes) */
    Stream_Read_UINT32(s, monitor->flags); /* flags (4 bytes) */
  }

  log_monitor_configuration(rdp->log, monitorDefArray, monitorCount);
  IFCALLRET(rdp->update->RemoteMonitors, ret, rdp->context, monitorCount, monitorDefArray);
  free(monitorDefArray);
  if (!ret)
    return FALSE;
  return rdp_set_monitor_layout_pdu_state(rdp, TRUE);
}

state_run_t rdp_recv_data_pdu(rdpRdp* rdp, wStream* s)
{
  BYTE type = 0;
  wStream* cs = nullptr;
  UINT16 length = 0;
  UINT32 shareId = 0;
  BYTE compressedType = 0;
  UINT16 compressedLength = 0;

  WINPR_ASSERT(rdp);
  if (!rdp_read_share_data_header(rdp, s, &length, &type, &shareId, &compressedType,
                                  &compressedLength))
  {
    WLog_Print(rdp->log, WLOG_ERROR, "rdp_read_share_data_header() failed");
    return STATE_RUN_FAILED;
  }

  cs = s;

  if (compressedType & PACKET_COMPRESSED)
  {
    if (compressedLength < 18)
    {
      WLog_Print(rdp->log, WLOG_ERROR,
                 "bulk_decompress: not enough bytes for compressedLength %" PRIu16 "",
                 compressedLength);
      return STATE_RUN_FAILED;
    }

    UINT32 DstSize = 0;
    const BYTE* pDstData = nullptr;
    UINT16 SrcSize = compressedLength - 18;

    if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, SrcSize))
    {
      WLog_Print(rdp->log, WLOG_ERROR,
                 "bulk_decompress: not enough bytes for compressedLength %" PRIu16 "",
                 compressedLength);
      return STATE_RUN_FAILED;
    }

    if (bulk_decompress(rdp->bulk, Stream_ConstPointer(s), SrcSize, &pDstData, &DstSize,
                        compressedType))
    {
      cs = transport_take_from_pool(rdp->transport, DstSize);
      if (!cs)
      {
        WLog_Print(rdp->log, WLOG_ERROR, "Couldn't take stream from pool");
        return STATE_RUN_FAILED;
      }

      Stream_ResetPosition(cs);
      Stream_Write(cs, pDstData, DstSize);
      Stream_SealLength(cs);
      Stream_ResetPosition(cs);
    }
    else
    {
      WLog_Print(rdp->log, WLOG_ERROR, "bulk_decompress() failed");
      return STATE_RUN_FAILED;
    }

    Stream_Seek(s, SrcSize);
  }

  WLog_Print(rdp->log, WLOG_DEBUG, "recv %s Data PDU (0x%02" PRIX8 "), length: %" PRIu16 "",
             data_pdu_type_to_string(type), type, length);

  switch (type)
  {
    case DATA_PDU_TYPE_UPDATE:
      if (!update_recv(rdp->update, cs))
      {
        WLog_Print(rdp->log, WLOG_ERROR, "DATA_PDU_TYPE_UPDATE - update_recv() failed");
        goto out_fail;
      }

      break;

    case DATA_PDU_TYPE_CONTROL:
      if (!rdp_recv_server_control_pdu(rdp, cs))
      {
        WLog_Print(rdp->log, WLOG_ERROR,
                   "DATA_PDU_TYPE_CONTROL - rdp_recv_server_control_pdu() failed");
        goto out_fail;
      }

      break;

    case DATA_PDU_TYPE_POINTER:
      if (!update_recv_pointer(rdp->update, cs))
      {
        WLog_Print(rdp->log, WLOG_ERROR,
                   "DATA_PDU_TYPE_POINTER - update_recv_pointer() failed");
        goto out_fail;
      }

      break;

    case DATA_PDU_TYPE_SYNCHRONIZE:
      if (!rdp_recv_server_synchronize_pdu(rdp, cs))
      {
        WLog_Print(rdp->log, WLOG_ERROR,
                   "DATA_PDU_TYPE_SYNCHRONIZE - rdp_recv_synchronize_pdu() failed");
        goto out_fail;
      }

      break;

    case DATA_PDU_TYPE_PLAY_SOUND:
      if (!update_recv_play_sound(rdp->update, cs))
      {
        WLog_Print(rdp->log, WLOG_ERROR,
                   "DATA_PDU_TYPE_PLAY_SOUND - update_recv_play_sound() failed");
        goto out_fail;
      }

      break;

    case DATA_PDU_TYPE_SHUTDOWN_DENIED:
      if (!rdp_recv_server_shutdown_denied_pdu(rdp, cs))
      {
        WLog_Print(
            rdp->log, WLOG_ERROR,
            "DATA_PDU_TYPE_SHUTDOWN_DENIED - rdp_recv_server_shutdown_denied_pdu() failed");
        goto out_fail;
      }

      break;

    case DATA_PDU_TYPE_SAVE_SESSION_INFO:
      if (!rdp_recv_save_session_info(rdp, cs))
      {
        WLog_Print(rdp->log, WLOG_ERROR,
                   "DATA_PDU_TYPE_SAVE_SESSION_INFO - rdp_recv_save_session_info() failed");
        goto out_fail;
      }

      break;

    case DATA_PDU_TYPE_FONT_MAP:
      if (!rdp_recv_font_map_pdu(rdp, cs))
      {
        WLog_Print(rdp->log, WLOG_ERROR,
                   "DATA_PDU_TYPE_FONT_MAP - rdp_recv_font_map_pdu() failed");
        goto out_fail;
      }

      break;

    case DATA_PDU_TYPE_SET_KEYBOARD_INDICATORS:
      if (!rdp_recv_server_set_keyboard_indicators_pdu(rdp, cs))
      {
        WLog_Print(rdp->log, WLOG_ERROR,
                   "DATA_PDU_TYPE_SET_KEYBOARD_INDICATORS - "
                   "rdp_recv_server_set_keyboard_indicators_pdu() failed");
        goto out_fail;
      }

      break;

    case DATA_PDU_TYPE_SET_KEYBOARD_IME_STATUS:
      if (!rdp_recv_server_set_keyboard_ime_status_pdu(rdp, cs))
      {
        WLog_Print(rdp->log, WLOG_ERROR,
                   "DATA_PDU_TYPE_SET_KEYBOARD_IME_STATUS - "
                   "rdp_recv_server_set_keyboard_ime_status_pdu() failed");
        goto out_fail;
      }

      break;

    case DATA_PDU_TYPE_SET_ERROR_INFO:
      if (!rdp_recv_set_error_info_data_pdu(rdp, cs))
      {
        WLog_Print(
            rdp->log, WLOG_ERROR,
            "DATA_PDU_TYPE_SET_ERROR_INFO - rdp_recv_set_error_info_data_pdu() failed");
        goto out_fail;
      }

      break;

    case DATA_PDU_TYPE_ARC_STATUS:
      if (!rdp_recv_server_auto_reconnect_status_pdu(rdp, cs))
      {
        WLog_Print(rdp->log, WLOG_ERROR,
                   "DATA_PDU_TYPE_ARC_STATUS - "
                   "rdp_recv_server_auto_reconnect_status_pdu() failed");
        goto out_fail;
      }

      break;

    case DATA_PDU_TYPE_STATUS_INFO:
      if (!rdp_recv_server_status_info_pdu(rdp, cs))
      {
        WLog_Print(rdp->log, WLOG_ERROR,
                   "DATA_PDU_TYPE_STATUS_INFO - rdp_recv_server_status_info_pdu() failed");
        goto out_fail;
      }

      break;

    case DATA_PDU_TYPE_MONITOR_LAYOUT:
      if (!rdp_recv_monitor_layout_pdu(rdp, cs))
      {
        WLog_Print(rdp->log, WLOG_ERROR,
                   "DATA_PDU_TYPE_MONITOR_LAYOUT - rdp_recv_monitor_layout_pdu() failed");
        goto out_fail;
      }

      break;

    default:
      WLog_Print(rdp->log, WLOG_WARN,
                 "[UNHANDLED] %s Data PDU (0x%02" PRIX8 "), length: %" PRIu16 "",
                 data_pdu_type_to_string(type), type, length);
      break;
  }

  if (cs != s)
    Stream_Release(cs);

  return STATE_RUN_SUCCESS;
out_fail:

  if (cs != s)
    Stream_Release(cs);

  return STATE_RUN_FAILED;
}

state_run_t rdp_recv_message_channel_pdu(rdpRdp* rdp, wStream* s, UINT16 securityFlags)
{
  WINPR_ASSERT(rdp);
  WINPR_ASSERT(s);

  if (securityFlags & SEC_AUTODETECT_REQ)
  {
    /* Server Auto-Detect Request PDU */
    return autodetect_recv_request_packet(rdp->autodetect, RDP_TRANSPORT_TCP, s);
  }

  if (securityFlags & SEC_AUTODETECT_RSP)
  {
    /* Client Auto-Detect Response PDU */
    return autodetect_recv_response_packet(rdp->autodetect, RDP_TRANSPORT_TCP, s);
  }

  if (securityFlags & SEC_HEARTBEAT)
  {
    /* Heartbeat PDU */
    return rdp_recv_heartbeat_packet(rdp, s);
  }

  if (securityFlags & SEC_TRANSPORT_REQ)
  {
    return multitransport_recv_request(rdp->multitransport, s);
  }

  if (securityFlags & SEC_TRANSPORT_RSP)
  {
    return multitransport_recv_response(rdp->multitransport, s);
  }

  if (securityFlags & SEC_LICENSE_PKT)
  {
    return license_recv(rdp->license, s);
  }

  if (securityFlags & SEC_LICENSE_ENCRYPT_CS)
  {
    return license_recv(rdp->license, s);
  }

  if (securityFlags & SEC_LICENSE_ENCRYPT_SC)
  {
    return license_recv(rdp->license, s);
  }

  return STATE_RUN_SUCCESS;
}

state_run_t rdp_recv_out_of_sequence_pdu(rdpRdp* rdp, wStream* s, UINT16 pduType, UINT16 length)
{
  state_run_t rc = STATE_RUN_FAILED;
  WINPR_ASSERT(rdp);

  switch (pduType)
  {
    case PDU_TYPE_DATA:
      rc = rdp_recv_data_pdu(rdp, s);
      break;
    case PDU_TYPE_SERVER_REDIRECTION:
      rc = rdp_recv_enhanced_security_redirection_packet(rdp, s);
      break;
    case PDU_TYPE_FLOW_RESPONSE:
    case PDU_TYPE_FLOW_STOP:
    case PDU_TYPE_FLOW_TEST:
      rc = STATE_RUN_SUCCESS;
      break;
    default:
    {
      char buffer1[256] = WINPR_C_ARRAY_INIT;
      char buffer2[256] = WINPR_C_ARRAY_INIT;

      WLog_Print(rdp->log, WLOG_ERROR, "expected %s, got %s",
                 pdu_type_to_str(PDU_TYPE_DEMAND_ACTIVE, buffer1, sizeof(buffer1)),
                 pdu_type_to_str(pduType, buffer2, sizeof(buffer2)));
      rc = STATE_RUN_FAILED;
    }
    break;
  }

  if (!tpkt_ensure_stream_consumed(rdp->log, s, length))
    return STATE_RUN_FAILED;
  return rc;
}

BOOL rdp_read_flow_control_pdu(rdpRdp* rdp, wStream* s, UINT16* type, UINT16* channel_id)
{
  /*
   * Read flow control PDU - documented in FlowPDU section in T.128
   * http://www.itu.int/rec/T-REC-T.128-199802-S/en
   * The specification for the PDU has pad8bits listed BEFORE pduTypeFlow.
   * However, so far pad8bits has always been observed to arrive AFTER pduTypeFlow.
   * Switched the order of these two fields to match this observation.
   */
  UINT8 pduType = 0;

  WINPR_ASSERT(rdp);
  WINPR_ASSERT(s);
  WINPR_ASSERT(type);
  WINPR_ASSERT(channel_id);

  if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 6))
    return FALSE;
  Stream_Read_UINT8(s, pduType); /* pduTypeFlow */
  *type = pduType;
  Stream_Seek_UINT8(s);               /* pad8bits */
  Stream_Seek_UINT8(s);               /* flowIdentifier */
  Stream_Seek_UINT8(s);               /* flowNumber */
  Stream_Read_UINT16(s, *channel_id); /* pduSource */
  return TRUE;
}

/**
 * Decrypt an RDP packet.
 *
 * @param rdp RDP module
 * @param s stream
 * @param pLength A pointer to the result variable, must not be nullptr
 * @param securityFlags the security flags to apply
 *
 * @return \b TRUE for success, \b FALSE otherwise
 */

BOOL rdp_decrypt(rdpRdp* rdp, wStream* s, UINT16* pLength, UINT16 securityFlags)
{
  BOOL res = FALSE;
  BYTE cmac[8] = WINPR_C_ARRAY_INIT;
  BYTE wmac[8] = WINPR_C_ARRAY_INIT;
  BOOL status = FALSE;

  WINPR_ASSERT(rdp);
  WINPR_ASSERT(rdp->settings);
  WINPR_ASSERT(s);
  WINPR_ASSERT(pLength);

  security_lock(rdp);

  INT32 length = *pLength;
  if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_NONE)
  {
    res = TRUE;
    goto unlock;
  }

  if (rdp->settings->EncryptionMethods == ENCRYPTION_METHOD_FIPS)
  {
    if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, 12))
      goto unlock;

    UINT16 len = 0;
    Stream_Read_UINT16(s, len); /* 0x10 */
    if (len != 0x10)
      WLog_Print(rdp->log, WLOG_WARN, "ENCRYPTION_METHOD_FIPS length %" PRIu16 " != 0x10",
                 len);

    UINT16 version = 0;
    Stream_Read_UINT8(s, version); /* 0x1 */
    if (version != 1)
      WLog_Print(rdp->log, WLOG_WARN, "ENCRYPTION_METHOD_FIPS version %" PRIu16 " != 1",
                 version);

    BYTE pad = 0;
    Stream_Read_UINT8(s, pad);
    const BYTE* sig = Stream_ConstPointer(s);
    Stream_Seek(s, 8); /* signature */
    length -= 12;
    const INT32 padLength = length - pad;

    if ((length <= 0) || (padLength <= 0) || (padLength > UINT16_MAX))
    {
      WLog_Print(rdp->log, WLOG_ERROR, "FATAL: invalid pad length %" PRId32, padLength);
      goto unlock;
    }

    if (!security_fips_decrypt(Stream_Pointer(s), (size_t)length, rdp))
      goto unlock;

    if (!security_fips_check_signature(Stream_ConstPointer(s), (size_t)padLength, sig, 8, rdp))
      goto unlock;

    if (!Stream_SetLength(s, Stream_Length(s) - pad))
      goto unlock;

    *pLength = (UINT16)padLength;
  }
  else
  {
    if (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, sizeof(wmac)))
      goto unlock;

    Stream_Read(s, wmac, sizeof(wmac));
    length -= sizeof(wmac);

    if (length <= 0)
    {
      WLog_Print(rdp->log, WLOG_ERROR, "FATAL: invalid length field");
      goto unlock;
    }

    if (!security_decrypt(Stream_PointerAs(s, BYTE), (size_t)length, rdp))
      goto unlock;

    if (securityFlags & SEC_SECURE_CHECKSUM)
      status = security_salted_mac_signature(rdp, Stream_ConstPointer(s), (UINT32)length,
                                             FALSE, cmac, sizeof(cmac));
    else
      status = security_mac_signature(rdp, Stream_ConstPointer(s), (UINT32)length, cmac,
                                      sizeof(cmac));

    if (!status)
      goto unlock;

    if (memcmp(wmac, cmac, sizeof(wmac)) != 0)
    {
      WLog_Print(rdp->log, WLOG_ERROR, "WARNING: invalid packet signature");
      /*
       * Because Standard RDP Security is totally broken,
       * and cannot protect against MITM, don't treat signature
       * verification failure as critical. This at least enables
       * us to work with broken RDP clients and servers that
       * generate invalid signatures.
       */
      // return FALSE;
    }

    *pLength = (UINT16)length;
  }
  res = TRUE;
unlock:
  security_unlock(rdp);
  return res;
}

const char* pdu_type_to_str(UINT16 pduType, char* buffer, size_t length)
{
  const char* str = nullptr;
  switch (pduType)
  {
    case PDU_TYPE_DEMAND_ACTIVE:
      str = "PDU_TYPE_DEMAND_ACTIVE";
      break;
    case PDU_TYPE_CONFIRM_ACTIVE:
      str = "PDU_TYPE_CONFIRM_ACTIVE";
      break;
    case PDU_TYPE_DEACTIVATE_ALL:
      str = "PDU_TYPE_DEACTIVATE_ALL";
      break;
    case PDU_TYPE_DATA:
      str = "PDU_TYPE_DATA";
      break;
    case PDU_TYPE_SERVER_REDIRECTION:
      str = "PDU_TYPE_SERVER_REDIRECTION";
      break;
    case PDU_TYPE_FLOW_TEST:
      str = "PDU_TYPE_FLOW_TEST";
      break;
    case PDU_TYPE_FLOW_RESPONSE:
      str = "PDU_TYPE_FLOW_RESPONSE";
      break;
    case PDU_TYPE_FLOW_STOP:
      str = "PDU_TYPE_FLOW_STOP";
      break;
    default:
      str = "PDU_TYPE_UNKNOWN";
      break;
  }

  winpr_str_append(str, buffer, length, "");
  {
    char msg[32] = WINPR_C_ARRAY_INIT;
    (void)_snprintf(msg, sizeof(msg), "[0x%08" PRIx32 "]", pduType);
    winpr_str_append(msg, buffer, length, "");
  }
  return buffer;
}

/**
 * Process an RDP packet.
 * @param rdp RDP module
 * @param s stream
 */
WINPR_ATTR_NODISCARD
static state_run_t rdp_recv_tpkt_pdu(rdpRdp* rdp, wStream* s)
{
  state_run_t rc = STATE_RUN_SUCCESS;
  UINT16 length = 0;
  UINT16 pduType = 0;
  UINT16 pduSource = 0;
  UINT16 channelId = 0;
  UINT16 securityFlags = 0;

  WINPR_ASSERT(rdp);
  WINPR_ASSERT(rdp->context);
  WINPR_ASSERT(s);

  freerdp* instance = rdp->context->instance;
  WINPR_ASSERT(instance);

  if (!rdp_read_header(rdp, s, &length, &channelId))
    return STATE_RUN_FAILED;

  if (freerdp_shall_disconnect_context(rdp->context))
    return STATE_RUN_SUCCESS;

  if (rdp->autodetect->bandwidthMeasureStarted)
  {
    rdp->autodetect->bandwidthMeasureByteCount += length;
  }

  if (rdp->mcs->messageChannelId && (channelId == rdp->mcs->messageChannelId))
  {
    rdp->inPackets++;
    return rdp_handle_message_channel(rdp, s, channelId, length);
  }

  if (rdp->settings->UseRdpSecurityLayer)
  {
    if (!rdp_read_security_header(rdp, s, &securityFlags, &length))
      return STATE_RUN_FAILED;

    if (securityFlags & (SEC_ENCRYPT | SEC_REDIRECTION_PKT))
    {
      if (!rdp_decrypt(rdp, s, &length, securityFlags))
        return STATE_RUN_FAILED;
    }

    if (securityFlags & SEC_REDIRECTION_PKT)
    {
      /*
       * [MS-RDPBCGR] 2.2.13.2.1
       *  - no share control header, nor the 2 byte pad
       */
      Stream_Rewind(s, 2);
      rdp->inPackets++;

      rc = rdp_recv_enhanced_security_redirection_packet(rdp, s);
      goto out;
    }
  }

  if (channelId == MCS_GLOBAL_CHANNEL_ID)
  {
    while (Stream_GetRemainingLength(s) > 3)
    {
      wStream subbuffer;
      wStream* sub = nullptr;
      size_t diff = 0;
      UINT16 remain = 0;

      if (!rdp_read_share_control_header(rdp, s, nullptr, &remain, &pduType, &pduSource))
        return STATE_RUN_FAILED;

      sub = Stream_StaticInit(&subbuffer, Stream_Pointer(s), remain);
      if (!Stream_SafeSeek(s, remain))
        return STATE_RUN_FAILED;

      rdp->settings->PduSource = pduSource;
      rdp->inPackets++;

      switch (pduType)
      {
        case PDU_TYPE_DATA:
          rc = rdp_recv_data_pdu(rdp, sub);
          if (state_run_failed(rc))
            return rc;
          break;

        case PDU_TYPE_DEACTIVATE_ALL:
          if (!rdp_recv_deactivate_all(rdp, sub))
          {
            WLog_Print(rdp->log, WLOG_ERROR,
                       "rdp_recv_tpkt_pdu: rdp_recv_deactivate_all() fail");
            return STATE_RUN_FAILED;
          }

          break;

        case PDU_TYPE_SERVER_REDIRECTION:
          return rdp_recv_enhanced_security_redirection_packet(rdp, sub);

        case PDU_TYPE_FLOW_RESPONSE:
        case PDU_TYPE_FLOW_STOP:
        case PDU_TYPE_FLOW_TEST:
          WLog_Print(rdp->log, WLOG_DEBUG, "flow message 0x%04" PRIX16 "", pduType);
          /* http://msdn.microsoft.com/en-us/library/cc240576.aspx */
          if (!Stream_SafeSeek(sub, remain))
            return STATE_RUN_FAILED;
          break;

        default:
        {
          char buffer[256] = WINPR_C_ARRAY_INIT;
          WLog_Print(rdp->log, WLOG_ERROR, "incorrect PDU type: %s",
                     pdu_type_to_str(pduType, buffer, sizeof(buffer)));
        }
        break;
      }

      diff = Stream_GetRemainingLength(sub);
      if (diff > 0)
      {
        char buffer[256] = WINPR_C_ARRAY_INIT;
        WLog_Print(rdp->log, WLOG_WARN,
                   "pduType %s not properly parsed, %" PRIuz
                   " bytes remaining unhandled. Skipping.",
                   pdu_type_to_str(pduType, buffer, sizeof(buffer)), diff);
      }
    }
  }
  else
  {
    rdp->inPackets++;

    if (!freerdp_channel_process(instance, s, channelId, length))
      return STATE_RUN_FAILED;
  }

out:
  if (!tpkt_ensure_stream_consumed(rdp->log, s, length))
    return STATE_RUN_FAILED;
  return rc;
}

WINPR_ATTR_NODISCARD
static state_run_t rdp_recv_fastpath_pdu(rdpRdp* rdp, wStream* s)
{
  UINT16 length = 0;

  WINPR_ASSERT(rdp);
  rdpFastPath* fastpath = rdp->fastpath;

  if (!fastpath_read_header_rdp(fastpath, s, &length))
  {
    WLog_Print(rdp->log, WLOG_ERROR, "rdp_recv_fastpath_pdu: fastpath_read_header_rdp() fail");
    return STATE_RUN_FAILED;
  }

  if ((length == 0) || (!Stream_CheckAndLogRequiredLengthWLog(rdp->log, s, length)))
  {
    WLog_Print(rdp->log, WLOG_ERROR, "incorrect FastPath PDU header length %" PRIu16 "",
               length);
    return STATE_RUN_FAILED;
  }

  if (rdp->autodetect->bandwidthMeasureStarted)
  {
    rdp->autodetect->bandwidthMeasureByteCount += length;
  }

  if (!fastpath_decrypt(fastpath, s, &length))
    return STATE_RUN_FAILED;

  return fastpath_recv_updates(rdp->fastpath, s);
}

WINPR_ATTR_NODISCARD
static state_run_t rdp_recv_pdu(rdpRdp* rdp, wStream* s)
{
  const int rc = tpkt_verify_header(s);
  if (rc > 0)
    return rdp_recv_tpkt_pdu(rdp, s);
  else if (rc == 0)
    return rdp_recv_fastpath_pdu(rdp, s);
  else
    return STATE_RUN_FAILED;
}

WINPR_ATTR_NODISCARD
static state_run_t rdp_handle_sc_flags(rdpRdp* rdp, wStream* s, UINT32 flag,
                                       CONNECTION_STATE nextState)
{
  const UINT32 mask = FINALIZE_SC_SYNCHRONIZE_PDU | FINALIZE_SC_CONTROL_COOPERATE_PDU |
                      FINALIZE_SC_CONTROL_GRANTED_PDU | FINALIZE_SC_FONT_MAP_PDU;
  WINPR_ASSERT(rdp);
  state_run_t status = rdp_recv_pdu(rdp, s);
  if (state_run_success(status))
  {
    const UINT32 flags = rdp->finalize_sc_pdus & mask;
    if ((flags & flag) == flag)
    {
      if (!rdp_client_transition_to_state(rdp, nextState))
        status = STATE_RUN_FAILED;
      else
        status = STATE_RUN_SUCCESS;
    }
    else
    {
      char flag_buffer[256] = WINPR_C_ARRAY_INIT;
      char mask_buffer[256] = WINPR_C_ARRAY_INIT;
      WLog_Print(rdp->log, WLOG_WARN,
                 "[%s] unexpected server message, expected flag %s [have %s]",
                 rdp_get_state_string(rdp),
                 rdp_finalize_flags_to_str(flag, flag_buffer, sizeof(flag_buffer)),
                 rdp_finalize_flags_to_str(flags, mask_buffer, sizeof(mask_buffer)));
    }
  }
  return status;
}

WINPR_ATTR_NODISCARD
static state_run_t rdp_client_exchange_monitor_layout(rdpRdp* rdp, wStream* s)
{
  WINPR_ASSERT(rdp);

  if (!rdp_check_monitor_layout_pdu_state(rdp, FALSE))
    return STATE_RUN_FAILED;

  /* We might receive unrelated messages from the server (channel traffic),
   * so only proceed if some flag changed
   */
  const UINT32 old = rdp->finalize_sc_pdus;
  state_run_t status = rdp_recv_pdu(rdp, s);
  const UINT32 now = rdp->finalize_sc_pdus;
  const BOOL changed = (old != now) || rdp->monitor_layout_pdu;

  /* This PDU is optional, so if we received a finalize PDU continue there */
  if (state_run_success(status) && changed)
  {
    if (!rdp->monitor_layout_pdu)
    {
      if (!rdp_finalize_is_flag_set(rdp, FINALIZE_SC_SYNCHRONIZE_PDU))
        return STATE_RUN_FAILED;
    }

    status = rdp_client_connect_finalize(rdp);
    if (state_run_success(status) && !rdp->monitor_layout_pdu)
      status = STATE_RUN_TRY_AGAIN;
  }
  return status;
}

WINPR_ATTR_NODISCARD
static state_run_t rdp_recv_callback_int(WINPR_ATTR_UNUSED rdpTransport* transport, wStream* s,
                                         void* extra)
{
  state_run_t status = STATE_RUN_SUCCESS;
  rdpRdp* rdp = (rdpRdp*)extra;

  WINPR_ASSERT(transport);
  WINPR_ASSERT(rdp);
  WINPR_ASSERT(s);

  switch (rdp_get_state(rdp))
  {
    case CONNECTION_STATE_NEGO:
      if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
        status = STATE_RUN_FAILED;
      else
        status = STATE_RUN_CONTINUE;
      break;
    case CONNECTION_STATE_NLA:
      if (nla_get_state(rdp->nla) < NLA_STATE_AUTH_INFO)
      {
        if (nla_recv_pdu(rdp->nla, s) < 1)
        {
          WLog_Print(rdp->log, WLOG_ERROR, "%s - nla_recv_pdu() fail",
                     rdp_get_state_string(rdp));
          status = STATE_RUN_FAILED;
        }
      }
      else if (nla_get_state(rdp->nla) == NLA_STATE_POST_NEGO)
      {
        if (nego_recv(rdp->transport, s, (void*)rdp->nego) < 0)
          return STATE_RUN_FAILED;

        if (!nego_update_settings_from_state(rdp->nego, rdp->settings))
          return STATE_RUN_FAILED;

        if (nego_get_state(rdp->nego) != NEGO_STATE_FINAL)
        {
          WLog_Print(rdp->log, WLOG_ERROR, "%s - nego_recv() fail",
                     rdp_get_state_string(rdp));
          status = STATE_RUN_FAILED;
        }
        else if (!nla_set_state(rdp->nla, NLA_STATE_FINAL))
          status = STATE_RUN_FAILED;
      }

      if (state_run_success(status))
      {
        if (nla_get_state(rdp->nla) == NLA_STATE_AUTH_INFO)
        {
          transport_set_nla_mode(rdp->transport, FALSE);

          if (rdp->settings->VmConnectMode)
          {
            if (!nego_set_state(rdp->nego, NEGO_STATE_NLA))
              status = STATE_RUN_FAILED;
            else if (!nego_set_requested_protocols(rdp->nego,
                                                   PROTOCOL_HYBRID | PROTOCOL_SSL))
              status = STATE_RUN_FAILED;
            else if (!nego_send_negotiation_request(rdp->nego))
              status = STATE_RUN_FAILED;
            else if (!nla_set_state(rdp->nla, NLA_STATE_POST_NEGO))
              status = STATE_RUN_FAILED;
          }
          else
          {
            if (!nla_set_state(rdp->nla, NLA_STATE_FINAL))
              status = STATE_RUN_FAILED;
          }
        }
      }
      if (state_run_success(status))
      {

        if (nla_get_state(rdp->nla) == NLA_STATE_FINAL)
        {
          if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
            status = STATE_RUN_FAILED;
          else
            status = STATE_RUN_CONTINUE;
        }
      }
      break;

    case CONNECTION_STATE_AAD:
      if (aad_recv(rdp->aad, s) < 1)
      {
        WLog_Print(rdp->log, WLOG_ERROR, "%s - aad_recv() fail", rdp_get_state_string(rdp));
        status = STATE_RUN_FAILED;
      }
      if (state_run_success(status))
      {
        if (aad_get_state(rdp->aad) == AAD_STATE_FINAL)
        {
          transport_set_aad_mode(rdp->transport, FALSE);
          if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_REQUEST))
            status = STATE_RUN_FAILED;
          else
            status = STATE_RUN_CONTINUE;
        }
      }
      break;

    case CONNECTION_STATE_MCS_CREATE_REQUEST:
      if (!mcs_client_begin(rdp->mcs))
      {
        WLog_Print(rdp->log, WLOG_ERROR, "%s - mcs_client_begin() fail",
                   rdp_get_state_string(rdp));
        status = STATE_RUN_FAILED;
      }
      else if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CREATE_RESPONSE))
        status = STATE_RUN_FAILED;
      else if (Stream_GetRemainingLength(s) > 0)
        status = STATE_RUN_CONTINUE;
      break;

    case CONNECTION_STATE_MCS_CREATE_RESPONSE:
      if (!mcs_recv_connect_response(rdp->mcs, s))
      {
        WLog_Print(rdp->log, WLOG_ERROR, "mcs_recv_connect_response failure");
        status = STATE_RUN_FAILED;
      }
      else
      {
        if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_ERECT_DOMAIN))
          status = STATE_RUN_FAILED;
        else if (!mcs_send_erect_domain_request(rdp->mcs))
        {
          WLog_Print(rdp->log, WLOG_ERROR, "mcs_send_erect_domain_request failure");
          status = STATE_RUN_FAILED;
        }
        else if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_ATTACH_USER))
          status = STATE_RUN_FAILED;
        else if (!mcs_send_attach_user_request(rdp->mcs))
        {
          WLog_Print(rdp->log, WLOG_ERROR, "mcs_send_attach_user_request failure");
          status = STATE_RUN_FAILED;
        }
        else if (!rdp_client_transition_to_state(rdp,
                                                 CONNECTION_STATE_MCS_ATTACH_USER_CONFIRM))
          status = STATE_RUN_FAILED;
      }
      break;

    case CONNECTION_STATE_MCS_ATTACH_USER_CONFIRM:
      if (!mcs_recv_attach_user_confirm(rdp->mcs, s))
      {
        WLog_Print(rdp->log, WLOG_ERROR, "mcs_recv_attach_user_confirm failure");
        status = STATE_RUN_FAILED;
      }
      else if (!freerdp_settings_get_bool(rdp->settings, FreeRDP_SupportSkipChannelJoin))
      {
        if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_MCS_CHANNEL_JOIN_REQUEST))
          status = STATE_RUN_FAILED;
        else if (!mcs_send_channel_join_request(rdp->mcs, rdp->mcs->userId))
        {
          WLog_Print(rdp->log, WLOG_ERROR, "mcs_send_channel_join_request failure");
          status = STATE_RUN_FAILED;
        }
        else if (!rdp_client_transition_to_state(
                     rdp, CONNECTION_STATE_MCS_CHANNEL_JOIN_RESPONSE))
          status = STATE_RUN_FAILED;
      }
      else
      {
        /* SKIP_CHANNELJOIN is active, consider channels to be joined */
        if (!rdp_client_skip_mcs_channel_join(rdp))
          status = STATE_RUN_FAILED;
      }
      break;

    case CONNECTION_STATE_MCS_CHANNEL_JOIN_RESPONSE:
      if (!rdp_client_connect_mcs_channel_join_confirm(rdp, s))
      {
        WLog_Print(rdp->log, WLOG_ERROR,
                   "%s - "
                   "rdp_client_connect_mcs_channel_join_confirm() fail",
                   rdp_get_state_string(rdp));
        status = STATE_RUN_FAILED;
      }

      break;

    case CONNECTION_STATE_CONNECT_TIME_AUTO_DETECT_REQUEST:
      if (!rdp_client_connect_auto_detect(rdp, s, WLOG_DEBUG))
      {
        if (!rdp_client_transition_to_state(rdp, CONNECTION_STATE_LICENSING))
          status = STATE_RUN_FAILED;
        else
          status = STATE_RUN_TRY_AGAIN;
      }
      break;

    case CONNECTION_STATE_LICENSING:
      status = rdp_client_connect_license(rdp, s);

      if (state_run_failed(status))
      {
        char buffer[64] = WINPR_C_ARRAY_INIT;
        WLog_Print(rdp->log, WLOG_DEBUG, "%s - rdp_client_connect_license() - %s",
                   rdp_get_state_string(rdp),
                   state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
      }

      break;

    case CONNECTION_STATE_MULTITRANSPORT_BOOTSTRAPPING_REQUEST:
      if (!rdp_client_connect_auto_detect(rdp, s, WLOG_DEBUG))
      {
        if (!rdp_client_transition_to_state(
                rdp, CONNECTION_STATE_CAPABILITIES_EXCHANGE_DEMAND_ACTIVE))
          status = STATE_RUN_FAILED;
        else
          status = STATE_RUN_TRY_AGAIN;
      }
      break;

    case CONNECTION_STATE_CAPABILITIES_EXCHANGE_DEMAND_ACTIVE:
      status = rdp_client_connect_demand_active(rdp, s);

      if (state_run_failed(status))
      {
        char buffer[64] = WINPR_C_ARRAY_INIT;
        WLog_Print(rdp->log, WLOG_DEBUG,
                   "%s - "
                   "rdp_client_connect_demand_active() - %s",
                   rdp_get_state_string(rdp),
                   state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
      }
      else if (status == STATE_RUN_ACTIVE)
      {
        if (!rdp_client_transition_to_state(
                rdp, CONNECTION_STATE_CAPABILITIES_EXCHANGE_CONFIRM_ACTIVE))
          status = STATE_RUN_FAILED;
        else
          status = STATE_RUN_CONTINUE;
      }
      break;

    case CONNECTION_STATE_CAPABILITIES_EXCHANGE_MONITOR_LAYOUT:
      status = rdp_client_exchange_monitor_layout(rdp, s);
      break;

    case CONNECTION_STATE_CAPABILITIES_EXCHANGE_CONFIRM_ACTIVE:
      status = rdp_client_connect_confirm_active(rdp, s);
      break;

    case CONNECTION_STATE_FINALIZATION_CLIENT_SYNC:
      status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_SYNCHRONIZE_PDU,
                                   CONNECTION_STATE_FINALIZATION_CLIENT_COOPERATE);
      break;
    case CONNECTION_STATE_FINALIZATION_CLIENT_COOPERATE:
      status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_CONTROL_COOPERATE_PDU,
                                   CONNECTION_STATE_FINALIZATION_CLIENT_GRANTED_CONTROL);
      break;
    case CONNECTION_STATE_FINALIZATION_CLIENT_GRANTED_CONTROL:
      status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_CONTROL_GRANTED_PDU,
                                   CONNECTION_STATE_FINALIZATION_CLIENT_FONT_MAP);
      break;
    case CONNECTION_STATE_FINALIZATION_CLIENT_FONT_MAP:
      status = rdp_handle_sc_flags(rdp, s, FINALIZE_SC_FONT_MAP_PDU, CONNECTION_STATE_ACTIVE);
      break;

    case CONNECTION_STATE_ACTIVE:
      status = rdp_recv_pdu(rdp, s);

      if (state_run_failed(status))
      {
        char buffer[64] = WINPR_C_ARRAY_INIT;
        WLog_Print(rdp->log, WLOG_DEBUG, "%s - rdp_recv_pdu() - %s",
                   rdp_get_state_string(rdp),
                   state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
      }
      break;

    default:
      WLog_Print(rdp->log, WLOG_ERROR, "%s state %u", rdp_get_state_string(rdp),
                 rdp_get_state(rdp));
      status = STATE_RUN_FAILED;
      break;
  }

  if (state_run_failed(status))
  {
    char buffer[64] = WINPR_C_ARRAY_INIT;
    WLog_Print(rdp->log, WLOG_ERROR, "%s status %s", rdp_get_state_string(rdp),
               state_run_result_string(status, buffer, ARRAYSIZE(buffer)));
  }
  return status;
}

state_run_t rdp_recv_callback(rdpTransport* transport, wStream* s, void* extra)
{
  char buffer[64] = WINPR_C_ARRAY_INIT;
  state_run_t rc = STATE_RUN_FAILED;
  const size_t start = Stream_GetPosition(s);
  const rdpContext* context = transport_get_context(transport);

  WINPR_ASSERT(context);
  do
  {
    const rdpRdp* rdp = context->rdp;
    WINPR_ASSERT(rdp);

    if (rc == STATE_RUN_TRY_AGAIN)
    {
      if (!Stream_SetPosition(s, start))
        return STATE_RUN_FAILED;
    }

    const char* old = rdp_get_state_string(rdp);
    const size_t orem = Stream_GetRemainingLength(s);
    rc = rdp_recv_callback_int(transport, s, extra);

    const char* now = rdp_get_state_string(rdp);
    const size_t rem = Stream_GetRemainingLength(s);

    WLog_Print(rdp->log, WLOG_TRACE,
               "(client)[%s -> %s] current return %s [feeding %" PRIuz " bytes, %" PRIuz
               " bytes not processed]",
               old, now, state_run_result_string(rc, buffer, sizeof(buffer)), orem, rem);
  } while ((rc == STATE_RUN_TRY_AGAIN) || (rc == STATE_RUN_CONTINUE));
  return rc;
}

BOOL rdp_send_channel_data(rdpRdp* rdp, UINT16 channelId, const BYTE* data, size_t size)
{
  return freerdp_channel_send(rdp, channelId, data, size);
}

BOOL rdp_channel_send_packet(rdpRdp* rdp, UINT16 channelId, size_t totalSize, UINT32 flags,
                             const BYTE* data, size_t chunkSize)
{
  return freerdp_channel_send_packet(rdp, channelId, totalSize, flags, data, chunkSize);
}

BOOL rdp_send_error_info(rdpRdp* rdp)
{
  UINT16 sec_flags = 0;
  wStream* s = nullptr;
  BOOL status = 0;

  if (rdp->errorInfo == ERRINFO_SUCCESS)
    return TRUE;

  s = rdp_data_pdu_init(rdp, &sec_flags);

  if (!s)
    return FALSE;

  Stream_Write_UINT32(s, rdp->errorInfo); /* error id (4 bytes) */
  status = rdp_send_data_pdu(rdp, s, DATA_PDU_TYPE_SET_ERROR_INFO, 0, sec_flags);
  return status;
}

int rdp_check_fds(rdpRdp* rdp)
{
  int status = 0;
  rdpTsg* tsg = nullptr;
  rdpTransport* transport = nullptr;

  WINPR_ASSERT(rdp);
  transport = rdp->transport;

  tsg = transport_get_tsg(transport);
  if (tsg)
  {
    if (!tsg_check_event_handles(tsg))
    {
      WLog_Print(rdp->log, WLOG_ERROR, "rdp_check_fds: tsg_check_event_handles()");
      return -1;
    }

    if (tsg_get_state(tsg) != TSG_STATE_PIPE_CREATED)
      return 1;
  }

  status = transport_check_fds(transport);

  if (status == 1)
  {
    if (!rdp_client_redirect(rdp)) /* session redirection */
      return -1;
  }

  if (status < 0)
    WLog_Print(rdp->log, WLOG_DEBUG, "transport_check_fds() - %i", status);
  else
    status = freerdp_timer_poll(rdp->timer);

  return status;
}

BOOL freerdp_get_stats(const rdpRdp* rdp, UINT64* inBytes, UINT64* outBytes, UINT64* inPackets,
                       UINT64* outPackets)
{
  if (!rdp)
    return FALSE;

  if (inBytes)
    *inBytes = rdp->inBytes;
  if (outBytes)
    *outBytes = rdp->outBytes;
  if (inPackets)
    *inPackets = rdp->inPackets;
  if (outPackets)
    *outPackets = rdp->outPackets;

  return TRUE;
}

WINPR_ATTR_NODISCARD
static bool rdp_new_common(rdpRdp* rdp)
{
  WINPR_ASSERT(rdp);

  bool rc = false;
  rdp->transport = transport_new(rdp->context);
  if (!rdp->transport)
    goto fail;

  if (rdp->io)
  {
    if (!transport_set_io_callbacks(rdp->transport, rdp->io))
      goto fail;
  }

  rdp->aad = aad_new(rdp->context);
  if (!rdp->aad)
    goto fail;

  rdp->nego = nego_new(rdp->transport);
  if (!rdp->nego)
    goto fail;

  rdp->mcs = mcs_new(rdp->context);
  if (!rdp->mcs)
    goto fail;

  rdp->license = license_new(rdp);
  if (!rdp->license)
    goto fail;

  rdp->fastpath = fastpath_new(rdp);
  if (!rdp->fastpath)
    goto fail;

  rc = true;
fail:
  return rc;
}

/**
 * Instantiate new RDP module.
 * @return new RDP module
 */

rdpRdp* rdp_new(rdpContext* context)
{
  DWORD flags = 0;
  rdpRdp* rdp = (rdpRdp*)calloc(1, sizeof(rdpRdp));

  if (!rdp)
    return nullptr;

  rdp->log = WLog_Create(RDP_TAG, WLog_GetRoot());
  if (!rdp->log)
    goto fail;

  (void)_snprintf(rdp->log_context, sizeof(rdp->log_context), "%p", (void*)context);
  if (!WLog_SetContext(rdp->log, nullptr, rdp->log_context))
    goto fail;

  InitializeCriticalSection(&rdp->critical);
  rdp->context = context;
  WINPR_ASSERT(rdp->context);

  if (context->ServerMode)
    flags |= FREERDP_SETTINGS_SERVER_MODE;

  if (!context->settings)
  {
    context->settings = rdp->settings = freerdp_settings_new(flags);

    if (!rdp->settings)
      goto fail;
  }
  else
    rdp->settings = context->settings;

  /* Keep a backup copy of settings for later comparisons */
  if (!rdp_set_backup_settings(rdp))
    goto fail;

  rdp->settings->instance = context->instance;

  context->settings = rdp->settings;
  if (context->instance)
    context->settings->instance = context->instance;
  else if (context->peer)
  {
    rdp->settings->instance = context->peer;

#if defined(WITH_FREERDP_DEPRECATED)
    context->peer->settings = rdp->settings;
#endif
  }

  if (!rdp_new_common(rdp))
    goto fail;

  {
    const rdpTransportIo* io = transport_get_io_callbacks(rdp->transport);
    if (!io)
      goto fail;
    rdp->io = calloc(1, sizeof(rdpTransportIo));
    if (!rdp->io)
      goto fail;
    *rdp->io = *io;
  }

  rdp->input = input_new(rdp);

  if (!rdp->input)
    goto fail;

  rdp->update = update_new(rdp);

  if (!rdp->update)
    goto fail;

  rdp->redirection = redirection_new();

  if (!rdp->redirection)
    goto fail;

  rdp->autodetect = autodetect_new(rdp->context);

  if (!rdp->autodetect)
    goto fail;

  rdp->heartbeat = heartbeat_new();

  if (!rdp->heartbeat)
    goto fail;

  rdp->multitransport = multitransport_new(rdp, INITIATE_REQUEST_PROTOCOL_UDPFECL |
                                                    INITIATE_REQUEST_PROTOCOL_UDPFECR);

  if (!rdp->multitransport)
    goto fail;

  rdp->bulk = bulk_new(context);

  if (!rdp->bulk)
    goto fail;

  rdp->pubSub = PubSub_New(TRUE);
  if (!rdp->pubSub)
    goto fail;

  rdp->abortEvent = CreateEvent(nullptr, TRUE, FALSE, nullptr);
  if (!rdp->abortEvent)
    goto fail;

  rdp->timer = freerdp_timer_new(rdp);
  if (!rdp->timer)
    goto fail;

  return rdp;

fail:
  WINPR_PRAGMA_DIAG_PUSH
  WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
  rdp_free(rdp);
  WINPR_PRAGMA_DIAG_POP
  return nullptr;
}

static void rdp_reset_free(rdpRdp* rdp)
{
  WINPR_ASSERT(rdp);

  security_lock(rdp);
  rdp_free_rc4_decrypt_keys(rdp);
  rdp_free_rc4_encrypt_keys(rdp);

  winpr_Cipher_Free(rdp->fips_encrypt);
  winpr_Cipher_Free(rdp->fips_decrypt);
  rdp->fips_encrypt = nullptr;
  rdp->fips_decrypt = nullptr;
  security_unlock(rdp);

  aad_free(rdp->aad);
  mcs_free(rdp->mcs);
  nego_free(rdp->nego);
  license_free(rdp->license);
  transport_free(rdp->transport);
  fastpath_free(rdp->fastpath);

  rdp->aad = nullptr;
  rdp->mcs = nullptr;
  rdp->nego = nullptr;
  rdp->license = nullptr;
  rdp->transport = nullptr;
  rdp->fastpath = nullptr;
}

BOOL rdp_reset(rdpRdp* rdp)
{
  BOOL rc = TRUE;

  WINPR_ASSERT(rdp);

  rdpSettings* settings = rdp->settings;
  WINPR_ASSERT(settings);

  bulk_reset(rdp->bulk);

  rdp_reset_free(rdp);

  if (!freerdp_settings_set_pointer_len(settings, FreeRDP_ServerRandom, nullptr, 0))
    rc = FALSE;

  if (!freerdp_settings_set_pointer_len(settings, FreeRDP_ServerCertificate, nullptr, 0))
    rc = FALSE;

  if (!freerdp_settings_set_string(settings, FreeRDP_ClientAddress, nullptr))
    rc = FALSE;

  if (!rc)
    goto fail;

  rc = rdp_new_common(rdp);
  if (!rc)
    goto fail;

  if (!transport_set_layer(rdp->transport, TRANSPORT_LAYER_TCP))
    goto fail;

  rdp->errorInfo = 0;
  rc = rdp_finalize_reset_flags(rdp, TRUE);

fail:
  return rc;
}

/**
 * Free RDP module.
 * @param rdp RDP module to be freed
 */

void rdp_free(rdpRdp* rdp)
{
  if (rdp)
  {
    freerdp_timer_free(rdp->timer);
    rdp_reset_free(rdp);

    freerdp_settings_free(rdp->settings);
    freerdp_settings_free(rdp->originalSettings);
    freerdp_settings_free(rdp->remoteSettings);

    input_free(rdp->input);
    update_free(rdp->update);
    nla_free(rdp->nla);
    redirection_free(rdp->redirection);
    autodetect_free(rdp->autodetect);
    heartbeat_free(rdp->heartbeat);
    multitransport_free(rdp->multitransport);
    bulk_free(rdp->bulk);
    free(rdp->io);
    PubSub_Free(rdp->pubSub);
    if (rdp->abortEvent)
      (void)CloseHandle(rdp->abortEvent);
    aad_free(rdp->aad);
    WINPR_JSON_Delete(rdp->wellknown);
    DeleteCriticalSection(&rdp->critical);
    WLog_Discard(rdp->log);
    free(rdp);
  }
}

BOOL rdp_io_callback_set_event(rdpRdp* rdp, BOOL set)
{
  if (!rdp)
    return FALSE;
  return transport_io_callback_set_event(rdp->transport, set);
}

const rdpTransportIo* rdp_get_io_callbacks(rdpRdp* rdp)
{
  if (!rdp)
    return nullptr;
  return rdp->io;
}

BOOL rdp_set_io_callbacks(rdpRdp* rdp, const rdpTransportIo* io_callbacks)
{
  if (!rdp)
    return FALSE;
  free(rdp->io);
  rdp->io = nullptr;
  if (io_callbacks)
  {
    rdp->io = malloc(sizeof(rdpTransportIo));
    if (!rdp->io)
      return FALSE;
    *rdp->io = *io_callbacks;
    return transport_set_io_callbacks(rdp->transport, rdp->io);
  }
  return TRUE;
}

BOOL rdp_set_io_callback_context(rdpRdp* rdp, void* usercontext)
{
  WINPR_ASSERT(rdp);
  rdp->ioContext = usercontext;
  return TRUE;
}

void* rdp_get_io_callback_context(rdpRdp* rdp)
{
  WINPR_ASSERT(rdp);
  return rdp->ioContext;
}

const char* rdp_finalize_flags_to_str(UINT32 flags, char* buffer, size_t size)
{
  char number[32] = WINPR_C_ARRAY_INIT;
  const UINT32 mask =
      (uint32_t)~(FINALIZE_SC_SYNCHRONIZE_PDU | FINALIZE_SC_CONTROL_COOPERATE_PDU |
                  FINALIZE_SC_CONTROL_GRANTED_PDU | FINALIZE_SC_FONT_MAP_PDU |
                  FINALIZE_CS_SYNCHRONIZE_PDU | FINALIZE_CS_CONTROL_COOPERATE_PDU |
                  FINALIZE_CS_CONTROL_REQUEST_PDU | FINALIZE_CS_PERSISTENT_KEY_LIST_PDU |
                  FINALIZE_CS_FONT_LIST_PDU | FINALIZE_DEACTIVATE_REACTIVATE);

  if (flags & FINALIZE_SC_SYNCHRONIZE_PDU)
    winpr_str_append("FINALIZE_SC_SYNCHRONIZE_PDU", buffer, size, "|");
  if (flags & FINALIZE_SC_CONTROL_COOPERATE_PDU)
    winpr_str_append("FINALIZE_SC_CONTROL_COOPERATE_PDU", buffer, size, "|");
  if (flags & FINALIZE_SC_CONTROL_GRANTED_PDU)
    winpr_str_append("FINALIZE_SC_CONTROL_GRANTED_PDU", buffer, size, "|");
  if (flags & FINALIZE_SC_FONT_MAP_PDU)
    winpr_str_append("FINALIZE_SC_FONT_MAP_PDU", buffer, size, "|");
  if (flags & FINALIZE_CS_SYNCHRONIZE_PDU)
    winpr_str_append("FINALIZE_CS_SYNCHRONIZE_PDU", buffer, size, "|");
  if (flags & FINALIZE_CS_CONTROL_COOPERATE_PDU)
    winpr_str_append("FINALIZE_CS_CONTROL_COOPERATE_PDU", buffer, size, "|");
  if (flags & FINALIZE_CS_CONTROL_REQUEST_PDU)
    winpr_str_append("FINALIZE_CS_CONTROL_REQUEST_PDU", buffer, size, "|");
  if (flags & FINALIZE_CS_PERSISTENT_KEY_LIST_PDU)
    winpr_str_append("FINALIZE_CS_PERSISTENT_KEY_LIST_PDU", buffer, size, "|");
  if (flags & FINALIZE_CS_FONT_LIST_PDU)
    winpr_str_append("FINALIZE_CS_FONT_LIST_PDU", buffer, size, "|");
  if (flags & FINALIZE_DEACTIVATE_REACTIVATE)
    winpr_str_append("FINALIZE_DEACTIVATE_REACTIVATE", buffer, size, "|");
  if (flags & mask)
    winpr_str_append("UNKNOWN_FLAG", buffer, size, "|");
  if (flags == 0)
    winpr_str_append("NO_FLAG_SET", buffer, size, "|");
  (void)_snprintf(number, sizeof(number), " [0x%08" PRIx32 "]", flags);
  winpr_str_append(number, buffer, size, "");
  return buffer;
}

BOOL rdp_finalize_reset_flags(rdpRdp* rdp, BOOL clearAll)
{
  WINPR_ASSERT(rdp);
  WLog_Print(rdp->log, WLOG_DEBUG, "[%s] reset finalize_sc_pdus", rdp_get_state_string(rdp));
  if (clearAll)
    rdp->finalize_sc_pdus = 0;
  else
    rdp->finalize_sc_pdus &= FINALIZE_DEACTIVATE_REACTIVATE;

  return rdp_set_monitor_layout_pdu_state(rdp, FALSE);
}

BOOL rdp_finalize_set_flag(rdpRdp* rdp, UINT32 flag)
{
  char buffer[1024] = WINPR_C_ARRAY_INIT;

  WINPR_ASSERT(rdp);

  WLog_Print(rdp->log, WLOG_DEBUG, "[%s] received flag %s", rdp_get_state_string(rdp),
             rdp_finalize_flags_to_str(flag, buffer, sizeof(buffer)));
  rdp->finalize_sc_pdus |= flag;
  return TRUE;
}

BOOL rdp_finalize_is_flag_set(rdpRdp* rdp, UINT32 flag)
{
  WINPR_ASSERT(rdp);
  return (rdp->finalize_sc_pdus & flag) == flag;
}

BOOL rdp_reset_rc4_encrypt_keys(rdpRdp* rdp)
{
  WINPR_ASSERT(rdp);
  rdp_free_rc4_encrypt_keys(rdp);
  rdp->rc4_encrypt_key = winpr_RC4_New(rdp->encrypt_key, rdp->rc4_key_len);

  rdp->encrypt_use_count = 0;
  return rdp->rc4_encrypt_key != nullptr;
}

void rdp_free_rc4_encrypt_keys(rdpRdp* rdp)
{
  WINPR_ASSERT(rdp);
  winpr_RC4_Free(rdp->rc4_encrypt_key);
  rdp->rc4_encrypt_key = nullptr;
}

void rdp_free_rc4_decrypt_keys(rdpRdp* rdp)
{
  WINPR_ASSERT(rdp);
  winpr_RC4_Free(rdp->rc4_decrypt_key);
  rdp->rc4_decrypt_key = nullptr;
}

BOOL rdp_reset_rc4_decrypt_keys(rdpRdp* rdp)
{
  WINPR_ASSERT(rdp);
  rdp_free_rc4_decrypt_keys(rdp);
  rdp->rc4_decrypt_key = winpr_RC4_New(rdp->decrypt_key, rdp->rc4_key_len);

  rdp->decrypt_use_count = 0;
  return rdp->rc4_decrypt_key != nullptr;
}

const char* rdp_security_flag_string(UINT32 securityFlags, char* buffer, size_t size)
{
  if (securityFlags & SEC_EXCHANGE_PKT)
    winpr_str_append("SEC_EXCHANGE_PKT", buffer, size, "|");
  if (securityFlags & SEC_TRANSPORT_REQ)
    winpr_str_append("SEC_TRANSPORT_REQ", buffer, size, "|");
  if (securityFlags & SEC_TRANSPORT_RSP)
    winpr_str_append("SEC_TRANSPORT_RSP", buffer, size, "|");
  if (securityFlags & SEC_ENCRYPT)
    winpr_str_append("SEC_ENCRYPT", buffer, size, "|");
  if (securityFlags & SEC_RESET_SEQNO)
    winpr_str_append("SEC_RESET_SEQNO", buffer, size, "|");
  if (securityFlags & SEC_IGNORE_SEQNO)
    winpr_str_append("SEC_IGNORE_SEQNO", buffer, size, "|");
  if (securityFlags & SEC_INFO_PKT)
    winpr_str_append("SEC_INFO_PKT", buffer, size, "|");
  if (securityFlags & SEC_LICENSE_PKT)
    winpr_str_append("SEC_LICENSE_PKT", buffer, size, "|");
  if (securityFlags & SEC_LICENSE_ENCRYPT_CS)
    winpr_str_append("SEC_LICENSE_ENCRYPT_CS", buffer, size, "|");
  if (securityFlags & SEC_LICENSE_ENCRYPT_SC)
    winpr_str_append("SEC_LICENSE_ENCRYPT_SC", buffer, size, "|");
  if (securityFlags & SEC_REDIRECTION_PKT)
    winpr_str_append("SEC_REDIRECTION_PKT", buffer, size, "|");
  if (securityFlags & SEC_SECURE_CHECKSUM)
    winpr_str_append("SEC_SECURE_CHECKSUM", buffer, size, "|");
  if (securityFlags & SEC_AUTODETECT_REQ)
    winpr_str_append("SEC_AUTODETECT_REQ", buffer, size, "|");
  if (securityFlags & SEC_AUTODETECT_RSP)
    winpr_str_append("SEC_AUTODETECT_RSP", buffer, size, "|");
  if (securityFlags & SEC_HEARTBEAT)
    winpr_str_append("SEC_HEARTBEAT", buffer, size, "|");
  if (securityFlags & SEC_FLAGSHI_VALID)
    winpr_str_append("SEC_FLAGSHI_VALID", buffer, size, "|");
  {
    char msg[32] = WINPR_C_ARRAY_INIT;

    (void)_snprintf(msg, sizeof(msg), "[0x%08" PRIx32 "]", securityFlags);
    winpr_str_append(msg, buffer, size, "");
  }
  return buffer;
}

WINPR_ATTR_NODISCARD
static BOOL rdp_reset_remote_settings(rdpRdp* rdp)
{
  UINT32 flags = FREERDP_SETTINGS_REMOTE_MODE;
  WINPR_ASSERT(rdp);
  freerdp_settings_free(rdp->remoteSettings);

  if (!freerdp_settings_get_bool(rdp->settings, FreeRDP_ServerMode))
    flags |= FREERDP_SETTINGS_SERVER_MODE;
  rdp->remoteSettings = freerdp_settings_new(flags);
  return rdp->remoteSettings != nullptr;
}

BOOL rdp_set_backup_settings(rdpRdp* rdp)
{
  WINPR_ASSERT(rdp);
  freerdp_settings_free(rdp->originalSettings);
  rdp->originalSettings = freerdp_settings_clone(rdp->settings);
  if (!rdp->originalSettings)
    return FALSE;
  return rdp_reset_remote_settings(rdp);
}

BOOL rdp_reset_runtime_settings(rdpRdp* rdp)
{
  WINPR_ASSERT(rdp);
  WINPR_ASSERT(rdp->context);

  freerdp_settings_free(rdp->settings);
  rdp->context->settings = rdp->settings = freerdp_settings_clone(rdp->originalSettings);

  if (!rdp->settings)
    return FALSE;
  return rdp_reset_remote_settings(rdp);
}

WINPR_ATTR_NODISCARD
static BOOL starts_with(const char* tok, const char* val)
{
  const size_t len = strlen(val);
  if (strncmp(tok, val, len) != 0)
    return FALSE;
  if (tok[len] != '=')
    return FALSE;
  return TRUE;
}

WINPR_ATTR_NODISCARD
static BOOL option_equals(const char* what, const char* val)
{
  return _stricmp(what, val) == 0;
}

WINPR_ATTR_NODISCARD
static BOOL parse_on_off_option(const char* value)
{
  WINPR_ASSERT(value);
  const char* sep = strchr(value, '=');
  if (!sep)
    return TRUE;
  if (option_equals("on", &sep[1]))
    return TRUE;
  if (option_equals("true", &sep[1]))
    return TRUE;
  if (option_equals("off", &sep[1]))
    return FALSE;
  if (option_equals("false", &sep[1]))
    return FALSE;

  errno = 0;
  long val = strtol(value, nullptr, 0);
  if (errno == 0)
    return (val != 0);

  return FALSE;
}

#define STR(x) #x

WINPR_ATTR_NODISCARD
static BOOL option_is_runtime_checks(WINPR_ATTR_UNUSED wLog* log, WINPR_ATTR_UNUSED DWORD level,
                                     const char* tok)
{
  const char* experimental[] = { STR(WITH_VERBOSE_WINPR_ASSERT) };
  for (size_t x = 0; x < ARRAYSIZE(experimental); x++)
  {
    const char* opt = experimental[x];
    if (starts_with(tok, opt))
    {
      return parse_on_off_option(tok);
    }
  }
  return FALSE;
}

WINPR_ATTR_NODISCARD
static BOOL option_is_experimental(WINPR_ATTR_UNUSED wLog* log, WINPR_ATTR_UNUSED DWORD level,
                                   const char* tok)
{
  const char* experimental[] = { STR(WITH_DSP_EXPERIMENTAL), STR(WITH_FFMPEG_HWACCEL),
                               STR(WITH_GFX_AV1),          STR(WITH_MEDIACODEC),
                               STR(WITH_CLIENT_SDL2),      STR(WITH_OPENCL),
                               STR(WITH_LIBRESSL),         STR(WITH_MBEDTLS),
                               STR(WITH_MEDIA_FOUNDATION), STR(WITH_KRB5_HEIMDAL) };
  for (size_t x = 0; x < ARRAYSIZE(experimental); x++)
  {
    const char* opt = experimental[x];
    if (starts_with(tok, opt))
    {
      return parse_on_off_option(tok);
    }
  }
  return FALSE;
}

WINPR_ATTR_NODISCARD
static BOOL option_is_debug(wLog* log, WINPR_ATTR_UNUSED DWORD level, const char* tok)
{
  WINPR_ASSERT(log);
  const char* debug[] = { STR(WITH_DEBUG_ALL),
                        STR(WITH_DEBUG_CERTIFICATE),
                        STR(WITH_DEBUG_CAPABILITIES),
                        STR(WITH_DEBUG_CHANNELS),
                        STR(WITH_DEBUG_CLIPRDR),
                        STR(WITH_DEBUG_CODECS),
                        STR(WITH_DEBUG_DVC),
                        STR(WITH_DEBUG_TSMF),
                        STR(WITH_DEBUG_KBD),
                        STR(WITH_DEBUG_LICENSE),
                        STR(WITH_DEBUG_NEGO),
                        STR(WITH_DEBUG_NLA),
                        STR(WITH_DEBUG_TSG),
                        STR(WITH_DEBUG_RAIL),
                        STR(WITH_DEBUG_RDP),
                        STR(WITH_DEBUG_RDPEI),
                        STR(WITH_DEBUG_REDIR),
                        STR(WITH_DEBUG_RDPDR),
                        STR(WITH_DEBUG_RFX),
                        STR(WITH_DEBUG_SCARD),
                        STR(WITH_DEBUG_SND),
                        STR(WITH_DEBUG_SVC),
                        STR(WITH_DEBUG_TRANSPORT),
                        STR(WITH_DEBUG_TIMEZONE),
                        STR(WITH_DEBUG_WND),
                        STR(WITH_DEBUG_RINGBUFFER),
                        STR(WITH_DEBUG_SYMBOLS),
                        STR(WITH_DEBUG_EVENTS),
                        STR(WITH_DEBUG_MUTEX),
                        STR(WITH_DEBUG_NTLM),
                        STR(WITH_DEBUG_SDL_KBD_EVENTS),
                        STR(WITH_DEBUG_SDL_KBD_EVENTS),
                        STR(WITH_DEBUG_THREADS),
                        STR(WITH_DEBUG_URBDRC) };

  for (size_t x = 0; x < ARRAYSIZE(debug); x++)
  {
    const char* opt = debug[x];
    if (starts_with(tok, opt))
      return parse_on_off_option(tok);
  }

  if (starts_with(tok, "WITH_DEBUG"))
  {
    WLog_Print(log, level, "[BUG] Unmapped Debug-Build option '%s'.", tok);
    return parse_on_off_option(tok);
  }

  return FALSE;
}

static void log_build_warn(wLog* log, DWORD level, const char* what, const char* msg,
                           BOOL (*cmp)(wLog* log, DWORD level, const char* tok))
{
  WINPR_PRAGMA_DIAG_PUSH
  WINPR_PRAGMA_DIAG_IGNORED_OVERLENGTH_STRINGS

  size_t len = sizeof(FREERDP_BUILD_CONFIG);
  char* list = calloc(len, sizeof(char));
  char* config = _strdup(FREERDP_BUILD_CONFIG);
  WINPR_PRAGMA_DIAG_POP

  if (config && list)
  {
    char* saveptr = nullptr;
    char* tok = strtok_s(config, " ", &saveptr);
    while (tok)
    {
      if (cmp(log, level, tok))
        winpr_str_append(tok, list, len, " ");

      tok = strtok_s(nullptr, " ", &saveptr);
    }
  }
  free(config);

  if (list)
  {
    if (strlen(list) > 0)
    {
      WLog_Print(log, level, "*************************************************");
      WLog_Print(log, level, "This build is using [%s] build options:", what);

      char* saveptr = nullptr;
      char* tok = strtok_s(list, " ", &saveptr);
      while (tok)
      {
        WLog_Print(log, level, "* '%s'", tok);
        tok = strtok_s(nullptr, " ", &saveptr);
      }
      WLog_Print(log, level, "*");
      WLog_Print(log, level, "[%s] build options %s", what, msg);
      WLog_Print(log, level, "*************************************************");
    }
  }
  free(list);
}

#define print_first_line(log, level, firstLine, what) \
  print_first_line_int((log), (level), (firstLine), (what), __FILE__, __func__, __LINE__)
static void print_first_line_int(wLog* log, DWORD level, log_line_t* firstLine, const char* what,
                                 const char* file, const char* fkt, size_t line)
{
  WINPR_ASSERT(firstLine);
  if (!firstLine->fkt)
  {
    if (WLog_IsLevelActive(log, level))
    {
      WLog_PrintTextMessage(log, level, line, file, fkt,
                            "*************************************************");
      WLog_PrintTextMessage(log, level, line, file, fkt,
                            "[SSL] {%s} build or configuration missing:", what);
    }
    firstLine->line = line;
    firstLine->file = file;
    firstLine->fkt = fkt;
    firstLine->level = level;
  }
}

static void print_last_line(wLog* log, const log_line_t* firstLine)
{
  WINPR_ASSERT(firstLine);
  if (firstLine->fkt)
  {
    if (WLog_IsLevelActive(log, firstLine->level))
      WLog_PrintTextMessage(log, firstLine->level, firstLine->line, firstLine->file,
                            firstLine->fkt,
                            "*************************************************");
  }
}

static void log_build_warn_cipher(wLog* log, DWORD level, log_line_t* firstLine,
                                  WINPR_CIPHER_TYPE md, const char* what, BOOL allowFIPS)
{
  BOOL haveCipher = FALSE;

  char key[WINPR_CIPHER_MAX_KEY_LENGTH] = WINPR_C_ARRAY_INIT;
  char iv[WINPR_CIPHER_MAX_IV_LENGTH] = WINPR_C_ARRAY_INIT;

  /* RC4 only exists in the compatibility functions winpr_RC4_*
   * winpr_Cipher_* does not support that. */
  if (md == WINPR_CIPHER_ARC4_128)
  {
    WINPR_RC4_CTX* enc = nullptr;
    if (allowFIPS)
      enc = winpr_RC4_New_Allow_FIPS(key, sizeof(key));
    else
      enc = winpr_RC4_New(key, sizeof(key));
    haveCipher = enc != nullptr;
    winpr_RC4_Free(enc);
  }
  else
  {
    WINPR_CIPHER_CTX* enc =
        winpr_Cipher_NewEx(md, WINPR_ENCRYPT, key, sizeof(key), iv, sizeof(iv));
    WINPR_CIPHER_CTX* dec =
        winpr_Cipher_NewEx(md, WINPR_DECRYPT, key, sizeof(key), iv, sizeof(iv));
    if (enc && dec)
      haveCipher = TRUE;

    winpr_Cipher_Free(enc);
    winpr_Cipher_Free(dec);
  }

  if (!haveCipher)
  {
    print_first_line(log, level, firstLine, "Cipher");
    WLog_Print(log, level, "* %s: %s", winpr_cipher_type_to_string(md), what);
  }
}

static void log_build_warn_hmac(wLog* log, DWORD level, log_line_t* firstLine, WINPR_MD_TYPE md,
                                const char* what)
{
  BOOL haveHmacX = FALSE;
  WINPR_HMAC_CTX* hmac = winpr_HMAC_New();
  if (hmac)
  {
    /* We need some key length, but there is no real limit here.
     * just take the cipher maximum key length as we already have that available.
     */
    char key[WINPR_CIPHER_MAX_KEY_LENGTH] = WINPR_C_ARRAY_INIT;
    haveHmacX = winpr_HMAC_Init(hmac, md, key, sizeof(key));
  }
  winpr_HMAC_Free(hmac);

  if (!haveHmacX)
  {
    print_first_line(log, level, firstLine, "HMAC");
    WLog_Print(log, level, " * %s: %s", winpr_md_type_to_string(md), what);
  }
}

static void log_build_warn_hash(wLog* log, DWORD level, log_line_t* firstLine, WINPR_MD_TYPE md,
                                const char* what, BOOL allowFIPS)
{
  BOOL haveDigestX = FALSE;
  WINPR_DIGEST_CTX* digest = winpr_Digest_New();
  if (digest)
  {
    if (allowFIPS)
      haveDigestX = winpr_Digest_Init_Allow_FIPS(digest, md);
    else
      haveDigestX = winpr_Digest_Init(digest, md);
  }
  winpr_Digest_Free(digest);

  if (!haveDigestX)
  {
    print_first_line(log, level, firstLine, "Digest");
    WLog_Print(log, level, " * %s: %s", winpr_md_type_to_string(md), what);
  }
}

static void log_build_warn_ssl(wLog* log, DWORD level)
{
  const BOOL fips = winpr_FIPSMode();

  if (fips)
  {
    WLog_Print(log, WLOG_INFO,
               "FIPS mode active: non-approved algorithms are unavailable "
               "as expected. NTLM, autoreconnect cookies, assistance files "
               "with encrypted passwords and RDP security will not work.");
  }

  log_line_t firstHashLine = WINPR_C_ARRAY_INIT;
  if (!fips)
  {
    log_build_warn_hash(log, level, &firstHashLine, WINPR_MD_MD4, "NTLM support not available",
                        FALSE);
    log_build_warn_hash(log, level, &firstHashLine, WINPR_MD_MD5,
                        "NTLM, assistance files with encrypted passwords "
                        " and autoreconnect cookies will not work",
                        FALSE);
  }
  log_build_warn_hash(log, level, &firstHashLine, WINPR_MD_MD5,
                      "RDP licensing and RDP security will not work", TRUE);
  log_build_warn_hash(log, level, &firstHashLine, WINPR_MD_SHA1,
                      "assistance files with encrypted passwords, Kerberos, Smartcard Logon, RDP "
                      "security support not available",
                      FALSE);
  log_build_warn_hash(log, level, &firstHashLine, WINPR_MD_SHA256,
                      "file clipboard, AAD gateway, NLA security and certificates might not work",
                      FALSE);
  print_last_line(log, &firstHashLine);

  if (!fips)
  {
    log_line_t firstHmacLine = WINPR_C_ARRAY_INIT;
    log_build_warn_hmac(log, level, &firstHmacLine, WINPR_MD_MD5,
                        "Autoreconnect cookie not supported");
    log_build_warn_hmac(log, level, &firstHmacLine, WINPR_MD_SHA1,
                        "RDP security not supported");
    print_last_line(log, &firstHmacLine);
  }

  log_line_t firstCipherLine = WINPR_C_ARRAY_INIT;
  if (!fips)
  {
    log_build_warn_cipher(log, level, &firstCipherLine, WINPR_CIPHER_ARC4_128,
                          "assistance files with encrypted passwords, NTLM "
                          "and autoreconnect cookies will not work",
                          FALSE);
  }
  log_build_warn_cipher(log, level, &firstCipherLine, WINPR_CIPHER_ARC4_128,
                        "RDP licensing and RDP security will not work", TRUE);
  if (!fips)
    log_build_warn_cipher(log, level, &firstCipherLine, WINPR_CIPHER_DES_EDE3_CBC,
                          "RDP security will not work", TRUE);
  log_build_warn_cipher(
      log, level, &firstCipherLine, WINPR_CIPHER_AES_128_CBC,
      "assistance file encrypted LHTicket will not work and ARM gateway might not", FALSE);
  log_build_warn_cipher(log, level, &firstCipherLine, WINPR_CIPHER_AES_192_CBC,
                        "ARM gateway might not work", FALSE);
  log_build_warn_cipher(log, level, &firstCipherLine, WINPR_CIPHER_AES_256_CBC,
                        "ARM gateway might not work", FALSE);
  print_last_line(log, &firstCipherLine);
}

static void rdp_log_build_warnings_wlog(wLog* log, DWORD level)
{
  static unsigned count = 0;

  /* Since this function is called in context creation routines stop logging
   * this issue repeatedly. This is required for proxy, which would otherwise
   * spam the log with these. */
  if (count > 0)
    return;
  count++;
  log_build_warn(log, level, "experimental", "might crash the application",
                 option_is_experimental);
  log_build_warn(log, level, "debug", "might leak sensitive information (credentials, ...)",
                 option_is_debug);
  log_build_warn(log, level, "runtime-check", "might slow down the application",
                 option_is_runtime_checks);
  log_build_warn_ssl(log, level);
  winpr_log_build_warn(log, level);
}

void rdp_log_build_warnings(rdpRdp* rdp)
{
  WINPR_ASSERT(rdp);
  rdp_log_build_warnings_wlog(rdp->log, WLOG_WARN);
}

size_t rdp_get_event_handles(rdpRdp* rdp, HANDLE* handles, uint32_t count)
{
  size_t nCount = transport_get_event_handles(rdp->transport, handles, count);

  if (nCount == 0)
    return 0;

  if (count < nCount + 2UL)
    return 0;

  handles[nCount++] = utils_get_abort_event(rdp);
  handles[nCount++] = freerdp_timer_get_event(rdp->timer);
  return nCount;
}

Coverage Report

Created: 2026-10-15 06:31