Coverage Report

Created: 2026-01-16 07:10

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/FreeRDP/libfreerdp/core/autodetect.c
Line
Count
Source
1
/**
2
 * FreeRDP: A Remote Desktop Protocol Implementation
3
 * Auto-Detect PDUs
4
 *
5
 * Copyright 2014 Dell Software <Mike.McDonald@software.dell.com>
6
 *
7
 * Licensed under the Apache License, Version 2.0 (the "License");
8
 * you may not use this file except in compliance with the License.
9
 * You may obtain a copy of the License at
10
 *
11
 *     http://www.apache.org/licenses/LICENSE-2.0
12
 *
13
 * Unless required by applicable law or agreed to in writing, software
14
 * distributed under the License is distributed on an "AS IS" BASIS,
15
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
 * See the License for the specific language governing permissions and
17
 * limitations under the License.
18
 */
19
20
#include <freerdp/config.h>
21
22
#include <winpr/crypto.h>
23
#include <winpr/assert.h>
24
25
#include "autodetect.h"
26
27
4.92k
#define TYPE_ID_AUTODETECT_REQUEST 0x00
28
3.35k
#define TYPE_ID_AUTODETECT_RESPONSE 0x01
29
30
57
#define RDP_RTT_REQUEST_TYPE_CONTINUOUS 0x0001
31
25
#define RDP_RTT_REQUEST_TYPE_CONNECTTIME 0x1001
32
33
944
#define RDP_RTT_RESPONSE_TYPE 0x0000
34
35
37
#define RDP_BW_START_REQUEST_TYPE_CONTINUOUS 0x0014
36
28
#define RDP_BW_START_REQUEST_TYPE_TUNNEL 0x0114
37
17
#define RDP_BW_START_REQUEST_TYPE_CONNECTTIME 0x1014
38
87
#define RDP_BW_PAYLOAD_REQUEST_TYPE 0x0002
39
209
#define RDP_BW_STOP_REQUEST_TYPE_CONNECTTIME 0x002B
40
143
#define RDP_BW_STOP_REQUEST_TYPE_CONTINUOUS 0x0429
41
81
#define RDP_BW_STOP_REQUEST_TYPE_TUNNEL 0x0629
42
43
20
#define RDP_NETCHAR_SYNC_RESPONSE_TYPE 0x0018
44
45
53
#define RDP_NETCHAR_RESULTS_0x0840 0x0840U
46
77
#define RDP_NETCHAR_RESULTS_0x0880 0x0880U
47
108
#define RDP_NETCHAR_RESULTS_0x08C0 0x08C0U
48
49
typedef struct
50
{
51
  UINT8 headerLength;
52
  UINT8 headerTypeId;
53
  UINT16 sequenceNumber;
54
  UINT16 requestType;
55
} AUTODETECT_REQ_PDU;
56
57
typedef struct
58
{
59
  UINT8 headerLength;
60
  UINT8 headerTypeId;
61
  UINT16 sequenceNumber;
62
  UINT16 responseType;
63
} AUTODETECT_RSP_PDU;
64
65
static const char* autodetect_header_type_string(UINT8 headerType, char* buffer, size_t size)
66
5.12k
{
67
5.12k
  const char* str = NULL;
68
5.12k
  switch (headerType)
69
5.12k
  {
70
1.29k
    case TYPE_ID_AUTODETECT_REQUEST:
71
1.29k
      str = "TYPE_ID_AUTODETECT_REQUEST";
72
1.29k
      break;
73
97
    case TYPE_ID_AUTODETECT_RESPONSE:
74
97
      str = "TYPE_ID_AUTODETECT_RESPONSE";
75
97
      break;
76
3.73k
    default:
77
3.73k
      str = "TYPE_ID_AUTODETECT_UNKNOWN";
78
3.73k
      break;
79
5.12k
  }
80
81
5.12k
  (void)_snprintf(buffer, size, "%s [0x%08" PRIx8 "]", str, headerType);
82
5.12k
  return buffer;
83
5.12k
}
84
85
static const char* autodetect_request_type_to_string(UINT32 requestType)
86
5.12k
{
87
5.12k
  switch (requestType)
88
5.12k
  {
89
895
    case RDP_RTT_RESPONSE_TYPE:
90
895
      return "RDP_RTT_RESPONSE_TYPE";
91
18
    case RDP_BW_RESULTS_RESPONSE_TYPE_CONNECTTIME:
92
18
      return "RDP_BW_RESULTS_RESPONSE_TYPE_CONNECTTIME";
93
9
    case RDP_BW_RESULTS_RESPONSE_TYPE_CONTINUOUS:
94
9
      return "RDP_BW_RESULTS_RESPONSE_TYPE_CONTINUOUS";
95
42
    case RDP_RTT_REQUEST_TYPE_CONTINUOUS:
96
42
      return "RDP_RTT_REQUEST_TYPE_CONTINUOUS";
97
6
    case RDP_RTT_REQUEST_TYPE_CONNECTTIME:
98
6
      return "RDP_RTT_REQUEST_TYPE_CONNECTTIME";
99
25
    case RDP_BW_START_REQUEST_TYPE_CONTINUOUS:
100
25
      return "RDP_BW_START_REQUEST_TYPE_CONTINUOUS";
101
17
    case RDP_BW_START_REQUEST_TYPE_TUNNEL:
102
17
      return "RDP_BW_START_REQUEST_TYPE_TUNNEL";
103
4
    case RDP_BW_START_REQUEST_TYPE_CONNECTTIME:
104
4
      return "RDP_BW_START_REQUEST_TYPE_CONNECTTIME";
105
17
    case RDP_BW_PAYLOAD_REQUEST_TYPE:
106
17
      return "RDP_BW_PAYLOAD_REQUEST_TYPE";
107
8
    case RDP_BW_STOP_REQUEST_TYPE_CONNECTTIME:
108
8
      return "RDP_BW_STOP_REQUEST_TYPE_CONNECTTIME";
109
6
    case RDP_BW_STOP_REQUEST_TYPE_CONTINUOUS:
110
6
      return "RDP_BW_STOP_REQUEST_TYPE_CONTINUOUS";
111
3
    case RDP_BW_STOP_REQUEST_TYPE_TUNNEL:
112
3
      return "RDP_BW_STOP_REQUEST_TYPE_TUNNEL";
113
7
    case RDP_NETCHAR_RESULTS_0x0840:
114
7
      return "RDP_NETCHAR_RESULTS_0x0840";
115
8
    case RDP_NETCHAR_RESULTS_0x0880:
116
8
      return "RDP_NETCHAR_RESULTS_0x0880";
117
12
    case RDP_NETCHAR_RESULTS_0x08C0:
118
12
      return "RDP_NETCHAR_RESULTS_0x08C0";
119
4.04k
    default:
120
4.04k
      return "UNKNOWN";
121
5.12k
  }
122
5.12k
}
123
124
static const char* autodetect_request_type_to_string_buffer(UINT32 requestType, char* buffer,
125
                                                            size_t size)
126
5.12k
{
127
5.12k
  const char* str = autodetect_request_type_to_string(requestType);
128
5.12k
  (void)_snprintf(buffer, size, "%s [0x%08" PRIx32 "]", str, requestType);
129
5.12k
  return buffer;
130
5.12k
}
131
132
static BOOL autodetect_send_rtt_measure_request(rdpAutoDetect* autodetect,
133
                                                WINPR_ATTR_UNUSED RDP_TRANSPORT_TYPE transport,
134
                                                UINT16 sequenceNumber)
135
0
{
136
0
  UINT16 requestType = 0;
137
0
  UINT16 sec_flags = 0;
138
0
  wStream* s = NULL;
139
140
0
  WINPR_ASSERT(autodetect);
141
0
  WINPR_ASSERT(autodetect->context);
142
143
0
  s = rdp_message_channel_pdu_init(autodetect->context->rdp, &sec_flags);
144
0
  if (!s)
145
0
    return FALSE;
146
147
0
  if (freerdp_get_state(autodetect->context) < CONNECTION_STATE_ACTIVE)
148
0
    requestType = RDP_RTT_REQUEST_TYPE_CONNECTTIME;
149
0
  else
150
0
    requestType = RDP_RTT_REQUEST_TYPE_CONTINUOUS;
151
152
0
  WLog_Print(autodetect->log, WLOG_TRACE, "sending RTT Measure Request PDU");
153
0
  Stream_Write_UINT8(s, 0x06);                       /* headerLength (1 byte) */
154
0
  Stream_Write_UINT8(s, TYPE_ID_AUTODETECT_REQUEST); /* headerTypeId (1 byte) */
155
0
  Stream_Write_UINT16(s, sequenceNumber);            /* sequenceNumber (2 bytes) */
156
0
  Stream_Write_UINT16(s, requestType);               /* requestType (2 bytes) */
157
0
  autodetect->rttMeasureStartTime = GetTickCount64();
158
0
  return rdp_send_message_channel_pdu(autodetect->context->rdp, s,
159
0
                                      sec_flags | SEC_AUTODETECT_REQ);
160
0
}
161
162
static BOOL autodetect_send_rtt_measure_response(rdpAutoDetect* autodetect, UINT16 sequenceNumber)
163
2
{
164
2
  UINT16 sec_flags = 0;
165
2
  wStream* s = NULL;
166
167
2
  WINPR_ASSERT(autodetect);
168
2
  WINPR_ASSERT(autodetect->context);
169
170
  /* Send the response PDU to the server */
171
2
  s = rdp_message_channel_pdu_init(autodetect->context->rdp, &sec_flags);
172
173
2
  if (!s)
174
0
    return FALSE;
175
176
2
  WLog_Print(autodetect->log, WLOG_TRACE,
177
2
             "sending RTT Measure Response PDU (seqNumber=0x%" PRIx16 ")", sequenceNumber);
178
2
  Stream_Write_UINT8(s, 0x06);                        /* headerLength (1 byte) */
179
2
  Stream_Write_UINT8(s, TYPE_ID_AUTODETECT_RESPONSE); /* headerTypeId (1 byte) */
180
2
  Stream_Write_UINT16(s, sequenceNumber);             /* sequenceNumber (2 bytes) */
181
2
  Stream_Write_UINT16(s, RDP_RTT_RESPONSE_TYPE);      /* responseType (1 byte) */
182
2
  return rdp_send_message_channel_pdu(autodetect->context->rdp, s,
183
2
                                      sec_flags | SEC_AUTODETECT_RSP);
184
2
}
185
186
static BOOL autodetect_send_bandwidth_measure_start(rdpAutoDetect* autodetect,
187
                                                    WINPR_ATTR_UNUSED RDP_TRANSPORT_TYPE transport,
188
                                                    UINT16 sequenceNumber)
189
0
{
190
0
  UINT16 requestType = 0;
191
0
  UINT16 sec_flags = 0;
192
0
  wStream* s = NULL;
193
194
0
  WINPR_ASSERT(autodetect);
195
0
  WINPR_ASSERT(autodetect->context);
196
197
0
  s = rdp_message_channel_pdu_init(autodetect->context->rdp, &sec_flags);
198
0
  if (!s)
199
0
    return FALSE;
200
201
0
  if (freerdp_get_state(autodetect->context) < CONNECTION_STATE_ACTIVE)
202
0
    requestType = RDP_BW_START_REQUEST_TYPE_CONNECTTIME;
203
0
  else
204
0
    requestType = RDP_BW_START_REQUEST_TYPE_CONTINUOUS;
205
206
0
  WLog_Print(autodetect->log, WLOG_TRACE,
207
0
             "sending Bandwidth Measure Start PDU(seqNumber=%" PRIu16 ")", sequenceNumber);
208
0
  Stream_Write_UINT8(s, 0x06);                       /* headerLength (1 byte) */
209
0
  Stream_Write_UINT8(s, TYPE_ID_AUTODETECT_REQUEST); /* headerTypeId (1 byte) */
210
0
  Stream_Write_UINT16(s, sequenceNumber);            /* sequenceNumber (2 bytes) */
211
0
  Stream_Write_UINT16(s, requestType);               /* requestType (2 bytes) */
212
0
  return rdp_send_message_channel_pdu(autodetect->context->rdp, s,
213
0
                                      sec_flags | SEC_AUTODETECT_REQ);
214
0
}
215
216
static BOOL
217
autodetect_send_bandwidth_measure_payload(rdpAutoDetect* autodetect,
218
                                          WINPR_ATTR_UNUSED RDP_TRANSPORT_TYPE transport,
219
                                          UINT16 sequenceNumber, UINT16 payloadLength)
220
0
{
221
0
  UINT16 sec_flags = 0;
222
0
  wStream* s = NULL;
223
224
0
  WINPR_ASSERT(autodetect);
225
0
  WINPR_ASSERT(autodetect->context);
226
227
0
  WINPR_ASSERT(freerdp_get_state(autodetect->context) < CONNECTION_STATE_ACTIVE);
228
229
0
  s = rdp_message_channel_pdu_init(autodetect->context->rdp, &sec_flags);
230
0
  if (!s)
231
0
    return FALSE;
232
233
0
  WLog_Print(autodetect->log, WLOG_TRACE,
234
0
             "sending Bandwidth Measure Payload PDU -> payloadLength=%" PRIu16 "", payloadLength);
235
  /* 4-bytes aligned */
236
0
  payloadLength &= ~3;
237
238
0
  if (!Stream_EnsureRemainingCapacity(s, 8 + payloadLength))
239
0
  {
240
0
    WLog_Print(autodetect->log, WLOG_ERROR, "Failed to ensure %lu bytes in stream",
241
0
               8ul + payloadLength);
242
0
    Stream_Release(s);
243
0
    return FALSE;
244
0
  }
245
246
0
  Stream_Write_UINT8(s, 0x08);                         /* headerLength (1 byte) */
247
0
  Stream_Write_UINT8(s, TYPE_ID_AUTODETECT_REQUEST);   /* headerTypeId (1 byte) */
248
0
  Stream_Write_UINT16(s, sequenceNumber);              /* sequenceNumber (2 bytes) */
249
0
  Stream_Write_UINT16(s, RDP_BW_PAYLOAD_REQUEST_TYPE); /* requestType (2 bytes) */
250
0
  Stream_Write_UINT16(s, payloadLength);               /* payloadLength (2 bytes) */
251
  /* Random data (better measurement in case the line is compressed) */
252
0
  winpr_RAND(Stream_Pointer(s), payloadLength);
253
0
  Stream_Seek(s, payloadLength);
254
0
  return rdp_send_message_channel_pdu(autodetect->context->rdp, s,
255
0
                                      sec_flags | SEC_AUTODETECT_REQ);
256
0
}
257
258
static BOOL autodetect_send_bandwidth_measure_stop(rdpAutoDetect* autodetect,
259
                                                   WINPR_ATTR_UNUSED RDP_TRANSPORT_TYPE transport,
260
                                                   UINT16 sequenceNumber, UINT16 payloadLength)
261
0
{
262
0
  UINT16 requestType = 0;
263
0
  UINT16 sec_flags = 0;
264
0
  wStream* s = NULL;
265
266
0
  WINPR_ASSERT(autodetect);
267
0
  WINPR_ASSERT(autodetect->context);
268
269
0
  s = rdp_message_channel_pdu_init(autodetect->context->rdp, &sec_flags);
270
0
  if (!s)
271
0
    return FALSE;
272
273
0
  if (freerdp_get_state(autodetect->context) < CONNECTION_STATE_ACTIVE)
274
0
    requestType = RDP_BW_STOP_REQUEST_TYPE_CONNECTTIME;
275
0
  else
276
0
    requestType = RDP_BW_STOP_REQUEST_TYPE_CONTINUOUS;
277
278
0
  if (requestType == RDP_BW_STOP_REQUEST_TYPE_CONTINUOUS)
279
0
    payloadLength = 0;
280
281
0
  WLog_Print(autodetect->log, WLOG_TRACE,
282
0
             "sending Bandwidth Measure Stop PDU -> payloadLength=%" PRIu16 "", payloadLength);
283
  /* 4-bytes aligned */
284
0
  payloadLength &= ~3;
285
0
  Stream_Write_UINT8(s, requestType == RDP_BW_STOP_REQUEST_TYPE_CONNECTTIME
286
0
                            ? 0x08
287
0
                            : 0x06);                 /* headerLength (1 byte) */
288
0
  Stream_Write_UINT8(s, TYPE_ID_AUTODETECT_REQUEST); /* headerTypeId (1 byte) */
289
0
  Stream_Write_UINT16(s, sequenceNumber);            /* sequenceNumber (2 bytes) */
290
0
  Stream_Write_UINT16(s, requestType);               /* requestType (2 bytes) */
291
292
0
  if (requestType == RDP_BW_STOP_REQUEST_TYPE_CONNECTTIME)
293
0
  {
294
0
    Stream_Write_UINT16(s, payloadLength); /* payloadLength (2 bytes) */
295
296
0
    if (payloadLength > 0)
297
0
    {
298
0
      if (!Stream_EnsureRemainingCapacity(s, payloadLength))
299
0
      {
300
0
        WLog_Print(autodetect->log, WLOG_ERROR,
301
0
                   "Failed to ensure %" PRIu16 " bytes in stream", payloadLength);
302
0
        Stream_Release(s);
303
0
        return FALSE;
304
0
      }
305
306
      /* Random data (better measurement in case the line is compressed) */
307
0
      winpr_RAND(Stream_Pointer(s), payloadLength);
308
0
      Stream_Seek(s, payloadLength);
309
0
    }
310
0
  }
311
312
0
  return rdp_send_message_channel_pdu(autodetect->context->rdp, s,
313
0
                                      sec_flags | SEC_AUTODETECT_REQ);
314
0
}
315
316
static BOOL autodetect_send_bandwidth_measure_results(rdpAutoDetect* autodetect,
317
                                                      RDP_TRANSPORT_TYPE transport,
318
                                                      UINT16 responseType, UINT16 sequenceNumber)
319
64
{
320
64
  BOOL success = TRUE;
321
64
  UINT16 sec_flags = 0;
322
64
  UINT64 timeDelta = GetTickCount64();
323
324
64
  WINPR_ASSERT(autodetect);
325
64
  WINPR_ASSERT(autodetect->context);
326
327
  /* Compute the total time */
328
64
  if (autodetect->bandwidthMeasureStartTime > timeDelta)
329
0
  {
330
0
    WLog_Print(autodetect->log, WLOG_WARN,
331
0
               "Invalid bandwidthMeasureStartTime %" PRIu64 " > current %" PRIu64
332
0
               ", trimming to 0",
333
0
               autodetect->bandwidthMeasureStartTime, timeDelta);
334
0
    timeDelta = 0;
335
0
  }
336
64
  else
337
64
    timeDelta -= autodetect->bandwidthMeasureStartTime;
338
339
  /* Send the result PDU to the server */
340
64
  wStream* s = rdp_message_channel_pdu_init(autodetect->context->rdp, &sec_flags);
341
342
64
  if (!s)
343
0
    return FALSE;
344
345
64
  WLog_Print(autodetect->log, WLOG_TRACE,
346
64
             "sending Bandwidth Measure Results PDU -> timeDelta=%" PRIu64 ", byteCount=%" PRIu32
347
64
             "",
348
64
             timeDelta, autodetect->bandwidthMeasureByteCount);
349
350
64
  Stream_Write_UINT8(s, 0x0E);                                   /* headerLength (1 byte) */
351
64
  Stream_Write_UINT8(s, TYPE_ID_AUTODETECT_RESPONSE);            /* headerTypeId (1 byte) */
352
64
  Stream_Write_UINT16(s, sequenceNumber);                        /* sequenceNumber (2 bytes) */
353
64
  Stream_Write_UINT16(s, responseType);                          /* responseType (1 byte) */
354
64
  Stream_Write_UINT32(s, (UINT32)MIN(timeDelta, UINT32_MAX));    /* timeDelta (4 bytes) */
355
64
  Stream_Write_UINT32(s, autodetect->bandwidthMeasureByteCount); /* byteCount (4 bytes) */
356
64
  IFCALLRET(autodetect->ClientBandwidthMeasureResult, success, autodetect, transport,
357
64
            responseType, sequenceNumber, (UINT32)MIN(timeDelta, UINT32_MAX),
358
64
            autodetect->bandwidthMeasureByteCount);
359
360
64
  if (!success)
361
0
  {
362
0
    WLog_Print(autodetect->log, WLOG_ERROR, "ClientBandwidthMeasureResult failed");
363
0
    Stream_Release(s);
364
0
    return FALSE;
365
0
  }
366
367
64
  return rdp_send_message_channel_pdu(autodetect->context->rdp, s,
368
64
                                      sec_flags | SEC_AUTODETECT_RSP);
369
64
}
370
371
static BOOL autodetect_send_netchar_result(rdpAutoDetect* autodetect,
372
                                           WINPR_ATTR_UNUSED RDP_TRANSPORT_TYPE transport,
373
                                           UINT16 sequenceNumber,
374
                                           const rdpNetworkCharacteristicsResult* result)
375
17
{
376
17
  UINT16 sec_flags = 0;
377
17
  wStream* s = NULL;
378
379
17
  WINPR_ASSERT(autodetect);
380
17
  WINPR_ASSERT(autodetect->context);
381
382
17
  s = rdp_message_channel_pdu_init(autodetect->context->rdp, &sec_flags);
383
384
17
  if (!s)
385
0
    return FALSE;
386
387
17
  WLog_Print(autodetect->log, WLOG_TRACE, "sending Network Characteristics Result PDU");
388
389
17
  switch (result->type)
390
17
  {
391
2
    case RDP_NETCHAR_RESULT_TYPE_BASE_RTT_AVG_RTT:
392
2
      Stream_Write_UINT8(s, 0x0E);                       /* headerLength (1 byte) */
393
2
      Stream_Write_UINT8(s, TYPE_ID_AUTODETECT_REQUEST); /* headerTypeId (1 byte) */
394
2
      Stream_Write_UINT16(s, sequenceNumber);            /* sequenceNumber (2 bytes) */
395
2
      WINPR_ASSERT((result->type <= UINT16_MAX));
396
2
      WINPR_ASSERT((result->type >= 0));
397
2
      Stream_Write_UINT16(s, (UINT16)result->type);      /* requestType (2 bytes) */
398
2
      Stream_Write_UINT32(s, result->baseRTT);           /* baseRTT (4 bytes) */
399
2
      Stream_Write_UINT32(s, result->averageRTT);        /* averageRTT (4 bytes) */
400
2
      break;
401
2
    case RDP_NETCHAR_RESULT_TYPE_BW_AVG_RTT:
402
1
      Stream_Write_UINT8(s, 0x0E);                       /* headerLength (1 byte) */
403
1
      Stream_Write_UINT8(s, TYPE_ID_AUTODETECT_REQUEST); /* headerTypeId (1 byte) */
404
1
      Stream_Write_UINT16(s, sequenceNumber);            /* sequenceNumber (2 bytes) */
405
1
      WINPR_ASSERT((result->type <= UINT16_MAX));
406
1
      WINPR_ASSERT((result->type >= 0));
407
1
      Stream_Write_UINT16(s, (UINT16)result->type);      /* requestType (2 bytes) */
408
1
      Stream_Write_UINT32(s, result->bandwidth);         /* bandwidth (4 bytes) */
409
1
      Stream_Write_UINT32(s, result->averageRTT);        /* averageRTT (4 bytes) */
410
1
      break;
411
14
    case RDP_NETCHAR_RESULT_TYPE_BASE_RTT_BW_AVG_RTT:
412
14
      Stream_Write_UINT8(s, 0x12);                       /* headerLength (1 byte) */
413
14
      Stream_Write_UINT8(s, TYPE_ID_AUTODETECT_REQUEST); /* headerTypeId (1 byte) */
414
14
      Stream_Write_UINT16(s, sequenceNumber);            /* sequenceNumber (2 bytes) */
415
14
      WINPR_ASSERT((result->type <= UINT16_MAX));
416
14
      WINPR_ASSERT((result->type >= 0));
417
14
      Stream_Write_UINT16(s, (UINT16)result->type);      /* requestType (2 bytes) */
418
14
      Stream_Write_UINT32(s, result->baseRTT);           /* baseRTT (4 bytes) */
419
14
      Stream_Write_UINT32(s, result->bandwidth);         /* bandwidth (4 bytes) */
420
14
      Stream_Write_UINT32(s, result->averageRTT);        /* averageRTT (4 bytes) */
421
14
      break;
422
14
    default:
423
0
      WINPR_ASSERT(FALSE);
424
0
      break;
425
17
  }
426
427
17
  return rdp_send_message_channel_pdu(autodetect->context->rdp, s,
428
17
                                      sec_flags | SEC_AUTODETECT_REQ);
429
17
}
430
431
static FREERDP_AUTODETECT_STATE
432
autodetect_on_connect_time_auto_detect_begin_default(rdpAutoDetect* autodetect)
433
0
{
434
0
  WINPR_ASSERT(autodetect);
435
0
  WINPR_ASSERT(autodetect->RTTMeasureRequest);
436
437
0
  if (!autodetect->RTTMeasureRequest(autodetect, RDP_TRANSPORT_TCP, 0x23))
438
0
    return FREERDP_AUTODETECT_STATE_FAIL;
439
440
0
  return FREERDP_AUTODETECT_STATE_REQUEST;
441
0
}
442
443
static FREERDP_AUTODETECT_STATE
444
autodetect_on_connect_time_auto_detect_progress_default(rdpAutoDetect* autodetect)
445
0
{
446
0
  WINPR_ASSERT(autodetect);
447
448
0
  if (autodetect->state == FREERDP_AUTODETECT_STATE_RESPONSE ||
449
0
      autodetect->state == FREERDP_AUTODETECT_STATE_COMPLETE)
450
0
    return FREERDP_AUTODETECT_STATE_COMPLETE;
451
452
0
  return autodetect->state;
453
0
}
454
455
static BOOL autodetect_recv_rtt_measure_request(rdpAutoDetect* autodetect,
456
                                                WINPR_ATTR_UNUSED RDP_TRANSPORT_TYPE transport,
457
                                                WINPR_ATTR_UNUSED wStream* s,
458
                                                const AUTODETECT_REQ_PDU* autodetectReqPdu)
459
19
{
460
19
  WINPR_ASSERT(autodetect);
461
19
  WINPR_ASSERT(s);
462
19
  WINPR_ASSERT(autodetectReqPdu);
463
464
19
  if (autodetectReqPdu->headerLength != 0x06)
465
17
  {
466
17
    WLog_Print(autodetect->log, WLOG_ERROR,
467
17
               "autodetectReqPdu->headerLength != 0x06 [0x%02" PRIx8 "]",
468
17
               autodetectReqPdu->headerLength);
469
17
    return FALSE;
470
17
  }
471
472
2
  WLog_Print(autodetect->log, WLOG_TRACE, "received RTT Measure Request PDU");
473
  /* Send a response to the server */
474
2
  return autodetect_send_rtt_measure_response(autodetect, autodetectReqPdu->sequenceNumber);
475
19
}
476
477
static BOOL autodetect_recv_rtt_measure_response(rdpAutoDetect* autodetect,
478
                                                 RDP_TRANSPORT_TYPE transport,
479
                                                 WINPR_ATTR_UNUSED wStream* s,
480
                                                 const AUTODETECT_RSP_PDU* autodetectRspPdu)
481
49
{
482
49
  BOOL success = TRUE;
483
484
49
  WINPR_ASSERT(autodetect);
485
49
  WINPR_ASSERT(autodetectRspPdu);
486
487
49
  if (autodetectRspPdu->headerLength != 0x06)
488
13
  {
489
13
    WLog_Print(autodetect->log, WLOG_ERROR,
490
13
               "autodetectRspPdu->headerLength != 0x06 [0x%02" PRIx8 "]",
491
13
               autodetectRspPdu->headerLength);
492
13
    return FALSE;
493
13
  }
494
495
36
  WLog_Print(autodetect->log, WLOG_TRACE, "received RTT Measure Response PDU");
496
36
  autodetect->netCharAverageRTT =
497
36
      (UINT32)MIN(GetTickCount64() - autodetect->rttMeasureStartTime, UINT32_MAX);
498
499
36
  if (autodetect->netCharBaseRTT == 0 ||
500
0
      autodetect->netCharBaseRTT > autodetect->netCharAverageRTT)
501
36
    autodetect->netCharBaseRTT = autodetect->netCharAverageRTT;
502
503
36
  IFCALLRET(autodetect->RTTMeasureResponse, success, autodetect, transport,
504
36
            autodetectRspPdu->sequenceNumber);
505
36
  if (!success)
506
0
    WLog_Print(autodetect->log, WLOG_WARN, "RTTMeasureResponse failed");
507
36
  return success;
508
49
}
509
510
static BOOL autodetect_recv_bandwidth_measure_start(rdpAutoDetect* autodetect,
511
                                                    WINPR_ATTR_UNUSED RDP_TRANSPORT_TYPE transport,
512
                                                    WINPR_ATTR_UNUSED wStream* s,
513
                                                    const AUTODETECT_REQ_PDU* autodetectReqPdu)
514
13
{
515
13
  WINPR_ASSERT(autodetect);
516
13
  WINPR_ASSERT(s);
517
13
  WINPR_ASSERT(autodetectReqPdu);
518
519
13
  if (autodetectReqPdu->headerLength != 0x06)
520
9
  {
521
9
    WLog_Print(autodetect->log, WLOG_ERROR,
522
9
               "autodetectReqPdu->headerLength != 0x06 [0x%02" PRIx8 "]",
523
9
               autodetectReqPdu->headerLength);
524
9
    return FALSE;
525
9
  }
526
527
4
  WLog_Print(autodetect->log, WLOG_TRACE,
528
4
             "received Bandwidth Measure Start PDU - time=%" PRIu64 "", GetTickCount64());
529
  /* Initialize bandwidth measurement parameters */
530
4
  autodetect->bandwidthMeasureStartTime = GetTickCount64();
531
4
  autodetect->bandwidthMeasureByteCount = 0;
532
533
  /* Continuous Auto-Detection: mark the start of the measurement */
534
4
  if (autodetectReqPdu->requestType == RDP_BW_START_REQUEST_TYPE_CONTINUOUS)
535
2
  {
536
2
    autodetect->bandwidthMeasureStarted = TRUE;
537
2
  }
538
539
4
  return TRUE;
540
13
}
541
542
static BOOL
543
autodetect_recv_bandwidth_measure_payload(rdpAutoDetect* autodetect,
544
                                          WINPR_ATTR_UNUSED RDP_TRANSPORT_TYPE transport,
545
                                          wStream* s, const AUTODETECT_REQ_PDU* autodetectReqPdu)
546
70
{
547
70
  UINT16 payloadLength = 0;
548
549
70
  WINPR_ASSERT(autodetect);
550
70
  WINPR_ASSERT(s);
551
70
  WINPR_ASSERT(autodetectReqPdu);
552
553
70
  if (autodetectReqPdu->headerLength != 0x08)
554
6
  {
555
6
    WLog_Print(autodetect->log, WLOG_ERROR,
556
6
               "autodetectReqPdu->headerLength != 0x08 [0x%02" PRIx8 "]",
557
6
               autodetectReqPdu->headerLength);
558
6
    return FALSE;
559
6
  }
560
561
64
  if (!Stream_CheckAndLogRequiredLengthWLog(autodetect->log, s, 2))
562
2
    return FALSE;
563
564
62
  Stream_Read_UINT16(s, payloadLength); /* payloadLength (2 bytes) */
565
62
  if (!Stream_CheckAndLogRequiredLengthWLog(autodetect->log, s, payloadLength))
566
6
    return FALSE;
567
56
  Stream_Seek(s, payloadLength);
568
569
56
  WLog_Print(autodetect->log, WLOG_DEBUG,
570
56
             "received Bandwidth Measure Payload PDU -> payloadLength=%" PRIu16 "",
571
56
             payloadLength);
572
  /* Add the payload length to the bandwidth measurement parameters */
573
56
  autodetect->bandwidthMeasureByteCount += payloadLength;
574
56
  return TRUE;
575
62
}
576
577
static BOOL autodetect_recv_bandwidth_measure_stop(rdpAutoDetect* autodetect,
578
                                                   RDP_TRANSPORT_TYPE transport, wStream* s,
579
                                                   const AUTODETECT_REQ_PDU* autodetectReqPdu)
580
78
{
581
78
  UINT16 payloadLength = 0;
582
78
  UINT16 responseType = 0;
583
584
78
  WINPR_ASSERT(autodetect);
585
78
  WINPR_ASSERT(s);
586
78
  WINPR_ASSERT(autodetectReqPdu);
587
588
78
  if (autodetectReqPdu->requestType == RDP_BW_STOP_REQUEST_TYPE_CONNECTTIME)
589
59
  {
590
59
    if (autodetectReqPdu->headerLength != 0x08)
591
7
    {
592
7
      WLog_Print(autodetect->log, WLOG_ERROR,
593
7
                 "autodetectReqPdu->headerLength != 0x08 [0x%02" PRIx8 "]",
594
7
                 autodetectReqPdu->headerLength);
595
7
      return FALSE;
596
7
    }
597
598
52
    if (!Stream_CheckAndLogRequiredLengthWLog(autodetect->log, s, 2))
599
2
      return FALSE;
600
601
50
    Stream_Read_UINT16(s, payloadLength); /* payloadLength (2 bytes) */
602
50
  }
603
19
  else
604
19
  {
605
19
    if (autodetectReqPdu->headerLength != 0x06)
606
3
    {
607
3
      WLog_Print(autodetect->log, WLOG_ERROR,
608
3
                 "autodetectReqPdu->headerLength != 0x06 [0x%02" PRIx8 "]",
609
3
                 autodetectReqPdu->headerLength);
610
3
      return FALSE;
611
3
    }
612
613
16
    payloadLength = 0;
614
16
  }
615
616
66
  if (!Stream_CheckAndLogRequiredLengthWLog(autodetect->log, s, payloadLength))
617
2
    return FALSE;
618
64
  Stream_Seek(s, payloadLength);
619
620
64
  WLog_Print(autodetect->log, WLOG_TRACE,
621
64
             "received Bandwidth Measure Stop PDU -> payloadLength=%" PRIu16 "", payloadLength);
622
  /* Add the payload length to the bandwidth measurement parameters */
623
64
  autodetect->bandwidthMeasureByteCount += payloadLength;
624
625
  /* Continuous Auto-Detection: mark the stop of the measurement */
626
64
  if (autodetectReqPdu->requestType == RDP_BW_STOP_REQUEST_TYPE_CONTINUOUS)
627
13
  {
628
13
    autodetect->bandwidthMeasureStarted = FALSE;
629
13
  }
630
631
  /* Send a response the server */
632
64
  responseType = autodetectReqPdu->requestType == RDP_BW_STOP_REQUEST_TYPE_CONNECTTIME
633
64
                     ? RDP_BW_RESULTS_RESPONSE_TYPE_CONNECTTIME
634
64
                     : RDP_BW_RESULTS_RESPONSE_TYPE_CONTINUOUS;
635
64
  return autodetect_send_bandwidth_measure_results(autodetect, transport, responseType,
636
64
                                                   autodetectReqPdu->sequenceNumber);
637
66
}
638
639
static BOOL autodetect_recv_bandwidth_measure_results(rdpAutoDetect* autodetect,
640
                                                      RDP_TRANSPORT_TYPE transport, wStream* s,
641
                                                      const AUTODETECT_RSP_PDU* autodetectRspPdu)
642
12
{
643
12
  UINT32 timeDelta = 0;
644
12
  UINT32 byteCount = 0;
645
12
  BOOL success = TRUE;
646
647
12
  WINPR_ASSERT(autodetect);
648
12
  WINPR_ASSERT(s);
649
12
  WINPR_ASSERT(autodetectRspPdu);
650
651
12
  if (autodetectRspPdu->headerLength != 0x0E)
652
3
  {
653
3
    WLog_Print(autodetect->log, WLOG_ERROR,
654
3
               "autodetectRspPdu->headerLength != 0x0E [0x%02" PRIx8 "]",
655
3
               autodetectRspPdu->headerLength);
656
3
    return FALSE;
657
3
  }
658
659
9
  WLog_Print(autodetect->log, WLOG_TRACE, "received Bandwidth Measure Results PDU");
660
9
  if (!Stream_CheckAndLogRequiredLengthWLog(autodetect->log, s, 8))
661
2
    return FALSE;
662
7
  Stream_Read_UINT32(s, timeDelta); /* timeDelta (4 bytes) */
663
7
  Stream_Read_UINT32(s, byteCount); /* byteCount (4 bytes) */
664
665
7
  IFCALLRET(autodetect->BandwidthMeasureResults, success, autodetect, transport,
666
7
            autodetectRspPdu->sequenceNumber, autodetectRspPdu->responseType, timeDelta,
667
7
            byteCount);
668
7
  if (!success)
669
0
    WLog_Print(autodetect->log, WLOG_WARN, "BandwidthMeasureResults failed");
670
7
  return success;
671
9
}
672
673
static BOOL autodetect_recv_netchar_sync(rdpAutoDetect* autodetect, RDP_TRANSPORT_TYPE transport,
674
                                         wStream* s, const AUTODETECT_RSP_PDU* autodetectRspPdu)
675
20
{
676
20
  UINT32 bandwidth = 0;
677
20
  UINT32 rtt = 0;
678
20
  BOOL success = TRUE;
679
680
20
  WINPR_ASSERT(autodetect);
681
20
  WINPR_ASSERT(s);
682
20
  WINPR_ASSERT(autodetectRspPdu);
683
684
20
  if (autodetectRspPdu->headerLength != 0x0E)
685
3
  {
686
3
    WLog_Print(autodetect->log, WLOG_ERROR,
687
3
               "autodetectRspPdu->headerLength != 0x0E [0x%02" PRIx8 "]",
688
3
               autodetectRspPdu->headerLength);
689
3
    return FALSE;
690
3
  }
691
17
  if (!Stream_CheckAndLogRequiredLengthWLog(autodetect->log, s, 8))
692
2
    return FALSE;
693
694
  /* bandwidth and averageRTT fields are present (baseRTT field is not) */
695
15
  Stream_Read_UINT32(s, bandwidth); /* bandwidth (4 bytes) */
696
15
  Stream_Read_UINT32(s, rtt);       /* rtt (4 bytes) */
697
698
15
  WLog_Print(autodetect->log, WLOG_TRACE,
699
15
             "received Network Characteristics Sync PDU -> bandwidth=%" PRIu32 ", rtt=%" PRIu32
700
15
             "",
701
15
             bandwidth, rtt);
702
703
15
  IFCALLRET(autodetect->NetworkCharacteristicsSync, success, autodetect, transport,
704
15
            autodetectRspPdu->sequenceNumber, bandwidth, rtt);
705
15
  if (!success)
706
0
    WLog_Print(autodetect->log, WLOG_WARN, "NetworkCharacteristicsSync failed");
707
15
  return success;
708
17
}
709
710
static BOOL autodetect_recv_netchar_request(rdpAutoDetect* autodetect, RDP_TRANSPORT_TYPE transport,
711
                                            wStream* s, const AUTODETECT_REQ_PDU* autodetectReqPdu)
712
71
{
713
71
  rdpNetworkCharacteristicsResult result = {
714
71
    .type = RDP_NETCHAR_RESERVED, .baseRTT = 0, .averageRTT = 0, .bandwidth = 0
715
71
  };
716
71
  BOOL success = TRUE;
717
718
71
  WINPR_ASSERT(autodetect);
719
71
  WINPR_ASSERT(s);
720
71
  WINPR_ASSERT(autodetectReqPdu);
721
722
71
  switch (autodetectReqPdu->requestType)
723
71
  {
724
23
    case RDP_NETCHAR_RESULTS_0x0840:
725
726
      /* baseRTT and averageRTT fields are present (bandwidth field is not) */
727
23
      if (autodetectReqPdu->headerLength != 0x0E)
728
4
      {
729
4
        WLog_Print(autodetect->log, WLOG_ERROR,
730
4
                   "autodetectReqPdu->headerLength != 0x0E [0x%02" PRIx8 "]",
731
4
                   autodetectReqPdu->headerLength);
732
4
        return FALSE;
733
4
      }
734
19
      if (!Stream_CheckAndLogRequiredLengthWLog(autodetect->log, s, 8))
735
2
        return FALSE;
736
737
17
      result.type = RDP_NETCHAR_RESULT_TYPE_BASE_RTT_AVG_RTT;
738
17
      Stream_Read_UINT32(s, result.baseRTT);    /* baseRTT (4 bytes) */
739
17
      Stream_Read_UINT32(s, result.averageRTT); /* averageRTT (4 bytes) */
740
17
      break;
741
742
23
    case RDP_NETCHAR_RESULTS_0x0880:
743
744
      /* bandwidth and averageRTT fields are present (baseRTT field is not) */
745
23
      if (autodetectReqPdu->headerLength != 0x0E)
746
4
      {
747
4
        WLog_Print(autodetect->log, WLOG_ERROR,
748
4
                   "autodetectReqPdu->headerLength != 0x0E [0x%02" PRIx8 "]",
749
4
                   autodetectReqPdu->headerLength);
750
4
        return FALSE;
751
4
      }
752
19
      if (!Stream_CheckAndLogRequiredLengthWLog(autodetect->log, s, 8))
753
2
        return FALSE;
754
755
17
      result.type = RDP_NETCHAR_RESULT_TYPE_BW_AVG_RTT;
756
17
      Stream_Read_UINT32(s, result.bandwidth);  /* bandwidth (4 bytes) */
757
17
      Stream_Read_UINT32(s, result.averageRTT); /* averageRTT (4 bytes) */
758
17
      break;
759
760
25
    case RDP_NETCHAR_RESULTS_0x08C0:
761
762
      /* baseRTT, bandwidth, and averageRTT fields are present */
763
25
      if (autodetectReqPdu->headerLength != 0x12)
764
8
      {
765
8
        WLog_Print(autodetect->log, WLOG_ERROR,
766
8
                   "autodetectReqPdu->headerLength != 0x012 [0x%02" PRIx8 "]",
767
8
                   autodetectReqPdu->headerLength);
768
8
        return FALSE;
769
8
      }
770
17
      if (!Stream_CheckAndLogRequiredLengthWLog(autodetect->log, s, 12))
771
2
        return FALSE;
772
773
15
      result.type = RDP_NETCHAR_RESULT_TYPE_BASE_RTT_BW_AVG_RTT;
774
15
      Stream_Read_UINT32(s, result.baseRTT);    /* baseRTT (4 bytes) */
775
15
      Stream_Read_UINT32(s, result.bandwidth);  /* bandwidth (4 bytes) */
776
15
      Stream_Read_UINT32(s, result.averageRTT); /* averageRTT (4 bytes) */
777
15
      break;
778
779
0
    default:
780
0
      WINPR_ASSERT(FALSE);
781
0
      break;
782
71
  }
783
784
49
  WLog_Print(autodetect->log, WLOG_TRACE,
785
49
             "received Network Characteristics Result PDU -> baseRTT=%" PRIu32
786
49
             ", bandwidth=%" PRIu32 ", averageRTT=%" PRIu32 "",
787
49
             result.baseRTT, result.bandwidth, result.averageRTT);
788
789
49
  IFCALLRET(autodetect->NetworkCharacteristicsResult, success, autodetect, transport,
790
49
            autodetectReqPdu->sequenceNumber, &result);
791
49
  if (!success)
792
17
    WLog_Print(autodetect->log, WLOG_WARN, "NetworkCharacteristicsResult failed");
793
49
  return success;
794
71
}
795
796
state_run_t autodetect_recv_request_packet(rdpAutoDetect* autodetect, RDP_TRANSPORT_TYPE transport,
797
                                           wStream* s)
798
16.5k
{
799
16.5k
  AUTODETECT_REQ_PDU autodetectReqPdu = { 0 };
800
16.5k
  const rdpSettings* settings = NULL;
801
16.5k
  BOOL success = FALSE;
802
803
16.5k
  WINPR_ASSERT(autodetect);
804
16.5k
  WINPR_ASSERT(autodetect->context);
805
806
16.5k
  settings = autodetect->context->settings;
807
16.5k
  WINPR_ASSERT(settings);
808
809
16.5k
  if (!Stream_CheckAndLogRequiredLengthWLog(autodetect->log, s, 6))
810
12.8k
    return STATE_RUN_FAILED;
811
812
3.63k
  Stream_Read_UINT8(s, autodetectReqPdu.headerLength);    /* headerLength (1 byte) */
813
3.63k
  Stream_Read_UINT8(s, autodetectReqPdu.headerTypeId);    /* headerTypeId (1 byte) */
814
3.63k
  Stream_Read_UINT16(s, autodetectReqPdu.sequenceNumber); /* sequenceNumber (2 bytes) */
815
3.63k
  Stream_Read_UINT16(s, autodetectReqPdu.requestType);    /* requestType (2 bytes) */
816
817
3.63k
  if (WLog_IsLevelActive(autodetect->log, WLOG_TRACE))
818
0
  {
819
0
    char rbuffer[128] = { 0 };
820
0
    const char* requestTypeStr = autodetect_request_type_to_string_buffer(
821
0
        autodetectReqPdu.requestType, rbuffer, sizeof(rbuffer));
822
823
0
    char hbuffer[128] = { 0 };
824
0
    const char* headerStr =
825
0
        autodetect_header_type_string(autodetectReqPdu.headerTypeId, hbuffer, sizeof(hbuffer));
826
827
0
    WLog_Print(autodetect->log, WLOG_TRACE,
828
0
               "rdp_recv_autodetect_request_packet: headerLength=%" PRIu8
829
0
               ", headerTypeId=%s, sequenceNumber=%" PRIu16 ", requestType=%s",
830
0
               autodetectReqPdu.headerLength, headerStr, autodetectReqPdu.sequenceNumber,
831
0
               requestTypeStr);
832
0
  }
833
834
3.63k
  if (!freerdp_settings_get_bool(settings, FreeRDP_NetworkAutoDetect))
835
0
  {
836
0
    char rbuffer[128] = { 0 };
837
0
    const char* requestTypeStr = autodetect_request_type_to_string_buffer(
838
0
        autodetectReqPdu.requestType, rbuffer, sizeof(rbuffer));
839
840
0
    WLog_Print(autodetect->log, WLOG_WARN,
841
0
               "Received a [MS-RDPBCGR] 2.2.14.1.1 RTT Measure Request [%s] "
842
0
               "message but support was not enabled",
843
0
               requestTypeStr);
844
0
    goto fail;
845
0
  }
846
847
3.63k
  if (autodetectReqPdu.headerTypeId != TYPE_ID_AUTODETECT_REQUEST)
848
2.00k
  {
849
2.00k
    char rbuffer[128] = { 0 };
850
2.00k
    const char* requestTypeStr = autodetect_request_type_to_string_buffer(
851
2.00k
        autodetectReqPdu.requestType, rbuffer, sizeof(rbuffer));
852
2.00k
    char hbuffer[128] = { 0 };
853
2.00k
    const char* headerStr =
854
2.00k
        autodetect_header_type_string(autodetectReqPdu.headerTypeId, hbuffer, sizeof(hbuffer));
855
856
2.00k
    WLog_Print(autodetect->log, WLOG_ERROR,
857
2.00k
               "Received a [MS-RDPBCGR] 2.2.14.1.1 RTT Measure Request [%s] "
858
2.00k
               "message with invalid headerTypeId=%s",
859
2.00k
               requestTypeStr, headerStr);
860
2.00k
    goto fail;
861
2.00k
  }
862
863
1.62k
  IFCALL(autodetect->RequestReceived, autodetect, transport, autodetectReqPdu.requestType,
864
1.62k
         autodetectReqPdu.sequenceNumber);
865
1.62k
  switch (autodetectReqPdu.requestType)
866
1.62k
  {
867
15
    case RDP_RTT_REQUEST_TYPE_CONTINUOUS:
868
19
    case RDP_RTT_REQUEST_TYPE_CONNECTTIME:
869
      /* RTT Measure Request (RDP_RTT_REQUEST) - MS-RDPBCGR 2.2.14.1.1 */
870
19
      success =
871
19
          autodetect_recv_rtt_measure_request(autodetect, transport, s, &autodetectReqPdu);
872
19
      break;
873
874
8
    case RDP_BW_START_REQUEST_TYPE_CONTINUOUS:
875
11
    case RDP_BW_START_REQUEST_TYPE_TUNNEL:
876
13
    case RDP_BW_START_REQUEST_TYPE_CONNECTTIME:
877
      /* Bandwidth Measure Start (RDP_BW_START) - MS-RDPBCGR 2.2.14.1.2 */
878
13
      success = autodetect_recv_bandwidth_measure_start(autodetect, transport, s,
879
13
                                                        &autodetectReqPdu);
880
13
      break;
881
882
70
    case RDP_BW_PAYLOAD_REQUEST_TYPE:
883
      /* Bandwidth Measure Payload (RDP_BW_PAYLOAD) - MS-RDPBCGR 2.2.14.1.3 */
884
70
      success = autodetect_recv_bandwidth_measure_payload(autodetect, transport, s,
885
70
                                                          &autodetectReqPdu);
886
70
      break;
887
888
59
    case RDP_BW_STOP_REQUEST_TYPE_CONNECTTIME:
889
73
    case RDP_BW_STOP_REQUEST_TYPE_CONTINUOUS:
890
78
    case RDP_BW_STOP_REQUEST_TYPE_TUNNEL:
891
      /* Bandwidth Measure Stop (RDP_BW_STOP) - MS-RDPBCGR 2.2.14.1.4 */
892
78
      success =
893
78
          autodetect_recv_bandwidth_measure_stop(autodetect, transport, s, &autodetectReqPdu);
894
78
      break;
895
896
23
    case RDP_NETCHAR_RESULTS_0x0840:
897
46
    case RDP_NETCHAR_RESULTS_0x0880:
898
71
    case RDP_NETCHAR_RESULTS_0x08C0:
899
      /* Network Characteristics Result (RDP_NETCHAR_RESULT) - MS-RDPBCGR 2.2.14.1.5 */
900
71
      success = autodetect_recv_netchar_request(autodetect, transport, s, &autodetectReqPdu);
901
71
      break;
902
903
1.37k
    default:
904
1.37k
      WLog_Print(autodetect->log, WLOG_ERROR, "Unknown requestType=0x%04" PRIx16,
905
1.37k
                 autodetectReqPdu.requestType);
906
1.37k
      break;
907
1.62k
  }
908
909
3.63k
fail:
910
3.63k
  if (success)
911
92
    autodetect->state = FREERDP_AUTODETECT_STATE_REQUEST;
912
3.54k
  else
913
3.54k
    autodetect->state = FREERDP_AUTODETECT_STATE_FAIL;
914
3.63k
  return success ? STATE_RUN_SUCCESS : STATE_RUN_FAILED;
915
1.62k
}
916
917
state_run_t autodetect_recv_response_packet(rdpAutoDetect* autodetect, RDP_TRANSPORT_TYPE transport,
918
                                            wStream* s)
919
16.5k
{
920
16.5k
  AUTODETECT_RSP_PDU autodetectRspPdu = { 0 };
921
16.5k
  const rdpSettings* settings = NULL;
922
16.5k
  BOOL success = FALSE;
923
924
16.5k
  WINPR_ASSERT(autodetect);
925
16.5k
  WINPR_ASSERT(autodetect->context);
926
16.5k
  WINPR_ASSERT(s);
927
928
16.5k
  settings = autodetect->context->settings;
929
16.5k
  WINPR_ASSERT(settings);
930
931
16.5k
  if (!Stream_CheckAndLogRequiredLengthWLog(autodetect->log, s, 6))
932
13.2k
    goto fail;
933
934
3.25k
  Stream_Read_UINT8(s, autodetectRspPdu.headerLength);    /* headerLength (1 byte) */
935
3.25k
  Stream_Read_UINT8(s, autodetectRspPdu.headerTypeId);    /* headerTypeId (1 byte) */
936
3.25k
  Stream_Read_UINT16(s, autodetectRspPdu.sequenceNumber); /* sequenceNumber (2 bytes) */
937
3.25k
  Stream_Read_UINT16(s, autodetectRspPdu.responseType);   /* responseType (2 bytes) */
938
939
3.25k
  if (WLog_IsLevelActive(autodetect->log, WLOG_TRACE))
940
0
  {
941
0
    char rbuffer[128] = { 0 };
942
0
    const char* requestStr = autodetect_request_type_to_string_buffer(
943
0
        autodetectRspPdu.responseType, rbuffer, sizeof(rbuffer));
944
0
    char hbuffer[128] = { 0 };
945
0
    const char* headerStr =
946
0
        autodetect_header_type_string(autodetectRspPdu.headerTypeId, hbuffer, sizeof(hbuffer));
947
948
0
    WLog_Print(autodetect->log, WLOG_TRACE,
949
0
               "rdp_recv_autodetect_response_packet: headerLength=%" PRIu8 ", headerTypeId=%s"
950
0
               ", sequenceNumber=%" PRIu16 ", requestType=%s",
951
0
               autodetectRspPdu.headerLength, headerStr, autodetectRspPdu.sequenceNumber,
952
0
               requestStr);
953
0
  }
954
955
3.25k
  if (!freerdp_settings_get_bool(settings, FreeRDP_NetworkAutoDetect))
956
0
  {
957
0
    char rbuffer[128] = { 0 };
958
959
0
    const char* requestStr = autodetect_request_type_to_string_buffer(
960
0
        autodetectRspPdu.responseType, rbuffer, sizeof(rbuffer));
961
962
0
    WLog_Print(autodetect->log, WLOG_WARN,
963
0
               "Received a [MS-RDPBCGR] 2.2.14.2.1 RTT Measure Response [%s] "
964
0
               "message but support was not enabled",
965
0
               requestStr);
966
0
    return STATE_RUN_FAILED;
967
0
  }
968
969
3.25k
  if (autodetectRspPdu.headerTypeId != TYPE_ID_AUTODETECT_RESPONSE)
970
3.11k
  {
971
3.11k
    char rbuffer[128] = { 0 };
972
3.11k
    const char* requestStr = autodetect_request_type_to_string_buffer(
973
3.11k
        autodetectRspPdu.responseType, rbuffer, sizeof(rbuffer));
974
3.11k
    char hbuffer[128] = { 0 };
975
3.11k
    const char* headerStr =
976
3.11k
        autodetect_header_type_string(autodetectRspPdu.headerTypeId, hbuffer, sizeof(hbuffer));
977
3.11k
    WLog_Print(autodetect->log, WLOG_ERROR,
978
3.11k
               "Received a [MS-RDPBCGR] 2.2.14.2.1 RTT Measure Response [%s] "
979
3.11k
               "message with invalid headerTypeId=%s",
980
3.11k
               requestStr, headerStr);
981
3.11k
    goto fail;
982
3.11k
  }
983
984
134
  IFCALL(autodetect->ResponseReceived, autodetect, transport, autodetectRspPdu.responseType,
985
134
         autodetectRspPdu.sequenceNumber);
986
134
  switch (autodetectRspPdu.responseType)
987
134
  {
988
49
    case RDP_RTT_RESPONSE_TYPE:
989
      /* RTT Measure Response (RDP_RTT_RESPONSE) - MS-RDPBCGR 2.2.14.2.1 */
990
49
      success =
991
49
          autodetect_recv_rtt_measure_response(autodetect, transport, s, &autodetectRspPdu);
992
49
      break;
993
994
7
    case RDP_BW_RESULTS_RESPONSE_TYPE_CONNECTTIME:
995
12
    case RDP_BW_RESULTS_RESPONSE_TYPE_CONTINUOUS:
996
      /* Bandwidth Measure Results (RDP_BW_RESULTS) - MS-RDPBCGR 2.2.14.2.2 */
997
12
      success = autodetect_recv_bandwidth_measure_results(autodetect, transport, s,
998
12
                                                          &autodetectRspPdu);
999
12
      break;
1000
1001
20
    case RDP_NETCHAR_SYNC_RESPONSE_TYPE:
1002
      /* Network Characteristics Sync (RDP_NETCHAR_SYNC) - MS-RDPBCGR 2.2.14.2.3 */
1003
20
      success = autodetect_recv_netchar_sync(autodetect, transport, s, &autodetectRspPdu);
1004
20
      break;
1005
1006
53
    default:
1007
53
      WLog_Print(autodetect->log, WLOG_ERROR, "Unknown responseType=0x%04" PRIx16,
1008
53
                 autodetectRspPdu.responseType);
1009
53
      break;
1010
134
  }
1011
1012
16.5k
fail:
1013
16.5k
  if (success)
1014
58
  {
1015
58
    if (autodetectRspPdu.responseType == RDP_BW_RESULTS_RESPONSE_TYPE_CONNECTTIME)
1016
5
      autodetect->state = FREERDP_AUTODETECT_STATE_COMPLETE;
1017
53
    else
1018
53
      autodetect->state = FREERDP_AUTODETECT_STATE_RESPONSE;
1019
58
  }
1020
16.4k
  else
1021
16.4k
    autodetect->state = FREERDP_AUTODETECT_STATE_FAIL;
1022
1023
16.5k
  return success ? STATE_RUN_SUCCESS : STATE_RUN_FAILED;
1024
134
}
1025
1026
void autodetect_on_connect_time_auto_detect_begin(rdpAutoDetect* autodetect)
1027
0
{
1028
0
  WINPR_ASSERT(autodetect);
1029
0
  WINPR_ASSERT(autodetect->OnConnectTimeAutoDetectBegin);
1030
1031
0
  autodetect->state = autodetect->OnConnectTimeAutoDetectBegin(autodetect);
1032
0
}
1033
1034
void autodetect_on_connect_time_auto_detect_progress(rdpAutoDetect* autodetect)
1035
0
{
1036
0
  WINPR_ASSERT(autodetect);
1037
0
  WINPR_ASSERT(autodetect->OnConnectTimeAutoDetectProgress);
1038
1039
0
  autodetect->state = autodetect->OnConnectTimeAutoDetectProgress(autodetect);
1040
0
}
1041
1042
rdpAutoDetect* autodetect_new(rdpContext* context)
1043
16.5k
{
1044
16.5k
  rdpAutoDetect* autoDetect = (rdpAutoDetect*)calloc(1, sizeof(rdpAutoDetect));
1045
16.5k
  if (!autoDetect)
1046
0
    return NULL;
1047
16.5k
  autoDetect->context = context;
1048
16.5k
  autoDetect->log = WLog_Get(AUTODETECT_TAG);
1049
1050
16.5k
  return autoDetect;
1051
16.5k
}
1052
1053
void autodetect_free(rdpAutoDetect* autoDetect)
1054
16.5k
{
1055
16.5k
  free(autoDetect);
1056
16.5k
}
1057
1058
void autodetect_register_server_callbacks(rdpAutoDetect* autodetect)
1059
7.97k
{
1060
7.97k
  WINPR_ASSERT(autodetect);
1061
1062
7.97k
  autodetect->RTTMeasureRequest = autodetect_send_rtt_measure_request;
1063
7.97k
  autodetect->BandwidthMeasureStart = autodetect_send_bandwidth_measure_start;
1064
7.97k
  autodetect->BandwidthMeasurePayload = autodetect_send_bandwidth_measure_payload;
1065
7.97k
  autodetect->BandwidthMeasureStop = autodetect_send_bandwidth_measure_stop;
1066
7.97k
  autodetect->NetworkCharacteristicsResult = autodetect_send_netchar_result;
1067
1068
  /*
1069
   * Default handlers for Connect-Time Auto-Detection
1070
   * (MAY be overridden by the API user)
1071
   */
1072
7.97k
  autodetect->OnConnectTimeAutoDetectBegin = autodetect_on_connect_time_auto_detect_begin_default;
1073
7.97k
  autodetect->OnConnectTimeAutoDetectProgress =
1074
7.97k
      autodetect_on_connect_time_auto_detect_progress_default;
1075
7.97k
}
1076
1077
FREERDP_AUTODETECT_STATE autodetect_get_state(rdpAutoDetect* autodetect)
1078
0
{
1079
0
  WINPR_ASSERT(autodetect);
1080
0
  return autodetect->state;
1081
0
}
1082
1083
rdpAutoDetect* autodetect_get(rdpContext* context)
1084
0
{
1085
0
  WINPR_ASSERT(context);
1086
0
  WINPR_ASSERT(context->rdp);
1087
0
  return context->rdp->autodetect;
1088
0
}