Coverage Report

Created: 2024-09-08 06:20

/src/FreeRDP/libfreerdp/core/streamdump.c
Line
Count
Source (jump to first uncovered line)
1
/**
2
 * FreeRDP: A Remote Desktop Protocol Implementation
3
 *
4
 * RDP session stream dump interface
5
 *
6
 * Copyright 2022 Armin Novak
7
 * Copyright 2022 Thincast Technologies GmbH
8
 *
9
 * Licensed under the Apache License, Version 2.0 (the "License");
10
 * you may not use this file except in compliance with the License.
11
 * You may obtain a copy of the License at
12
 *
13
 *     http://www.apache.org/licenses/LICENSE-2.0
14
 *
15
 * Unless required by applicable law or agreed to in writing, software
16
 * distributed under the License is distributed on an "AS IS" BASIS,
17
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18
 * See the License for the specific language governing permissions and
19
 * limitations under the License.
20
 */
21
22
#include <time.h>
23
24
#include <winpr/sysinfo.h>
25
#include <winpr/path.h>
26
#include <winpr/string.h>
27
28
#include <freerdp/freerdp.h>
29
#include <freerdp/streamdump.h>
30
#include <freerdp/transport_io.h>
31
32
#include "streamdump.h"
33
34
13.2k
#define TAG FREERDP_TAG("streamdump")
35
36
struct stream_dump_context
37
{
38
  rdpTransportIo io;
39
  size_t writeDumpOffset;
40
  size_t readDumpOffset;
41
  size_t replayOffset;
42
  UINT64 replayTime;
43
  CONNECTION_STATE state;
44
  BOOL isServer;
45
  BOOL nodelay;
46
  wLog* log;
47
};
48
49
static UINT32 crc32b(const BYTE* data, size_t length)
50
0
{
51
0
  UINT32 crc = 0xFFFFFFFF;
52
53
0
  for (size_t x = 0; x < length; x++)
54
0
  {
55
0
    const UINT32 d = data[x] & 0xFF;
56
0
    crc = crc ^ d;
57
0
    for (int j = 7; j >= 0; j--)
58
0
    {
59
0
      UINT32 mask = ~(crc & 1);
60
0
      crc = (crc >> 1) ^ (0xEDB88320 & mask);
61
0
    }
62
0
  }
63
0
  return ~crc;
64
0
}
65
66
#if !defined(BUILD_TESTING)
67
static
68
#endif
69
    BOOL
70
    stream_dump_read_line(FILE* fp, wStream* s, UINT64* pts, size_t* pOffset, UINT32* flags)
71
0
{
72
0
  BOOL rc = FALSE;
73
0
  UINT64 ts = 0;
74
0
  UINT64 size = 0;
75
0
  size_t r = 0;
76
0
  UINT32 crc32 = 0;
77
0
  BYTE received = 0;
78
79
0
  if (!fp || !s || !flags)
80
0
    return FALSE;
81
82
0
  if (pOffset)
83
0
    _fseeki64(fp, *pOffset, SEEK_SET);
84
85
0
  r = fread(&ts, 1, sizeof(ts), fp);
86
0
  if (r != sizeof(ts))
87
0
    goto fail;
88
0
  r = fread(&received, 1, sizeof(received), fp);
89
0
  if (r != sizeof(received))
90
0
    goto fail;
91
0
  r = fread(&crc32, 1, sizeof(crc32), fp);
92
0
  if (r != sizeof(crc32))
93
0
    goto fail;
94
0
  r = fread(&size, 1, sizeof(size), fp);
95
0
  if (r != sizeof(size))
96
0
    goto fail;
97
0
  if (received)
98
0
    *flags = STREAM_MSG_SRV_RX;
99
0
  else
100
0
    *flags = STREAM_MSG_SRV_TX;
101
0
  if (!Stream_EnsureRemainingCapacity(s, size))
102
0
    goto fail;
103
0
  r = fread(Stream_Pointer(s), 1, size, fp);
104
0
  if (r != size)
105
0
    goto fail;
106
0
  if (crc32 != crc32b(Stream_ConstPointer(s), size))
107
0
    goto fail;
108
0
  Stream_Seek(s, size);
109
110
0
  if (pOffset)
111
0
  {
112
0
    INT64 tmp = _ftelli64(fp);
113
0
    if (tmp < 0)
114
0
      goto fail;
115
0
    *pOffset = (size_t)tmp;
116
0
  }
117
118
0
  if (pts)
119
0
    *pts = ts;
120
0
  rc = TRUE;
121
122
0
fail:
123
0
  Stream_SealLength(s);
124
0
  return rc;
125
0
}
126
127
#if !defined(BUILD_TESTING)
128
static
129
#endif
130
    BOOL
131
    stream_dump_write_line(FILE* fp, UINT32 flags, wStream* s)
132
0
{
133
0
  BOOL rc = FALSE;
134
0
  const UINT64 t = GetTickCount64();
135
0
  const BYTE* data = Stream_Buffer(s);
136
0
  const UINT64 size = Stream_Length(s);
137
138
0
  if (!fp || !s)
139
0
    return FALSE;
140
141
0
  {
142
0
    const UINT32 crc32 = crc32b(data, size);
143
0
    const BYTE received = flags & STREAM_MSG_SRV_RX;
144
0
    size_t r = fwrite(&t, 1, sizeof(t), fp);
145
0
    if (r != sizeof(t))
146
0
      goto fail;
147
0
    r = fwrite(&received, 1, sizeof(received), fp);
148
0
    if (r != sizeof(received))
149
0
      goto fail;
150
0
    r = fwrite(&crc32, 1, sizeof(crc32), fp);
151
0
    if (r != sizeof(crc32))
152
0
      goto fail;
153
0
    r = fwrite(&size, 1, sizeof(size), fp);
154
0
    if (r != sizeof(size))
155
0
      goto fail;
156
0
    r = fwrite(data, 1, size, fp);
157
0
    if (r != size)
158
0
      goto fail;
159
0
  }
160
161
0
  rc = TRUE;
162
0
fail:
163
0
  return rc;
164
0
}
165
166
static FILE* stream_dump_get_file(const rdpSettings* settings, const char* mode)
167
0
{
168
0
  const char* cfolder = NULL;
169
0
  char* file = NULL;
170
0
  FILE* fp = NULL;
171
172
0
  if (!settings || !mode)
173
0
    return NULL;
174
175
0
  cfolder = freerdp_settings_get_string(settings, FreeRDP_TransportDumpFile);
176
0
  if (!cfolder)
177
0
    file = GetKnownSubPath(KNOWN_PATH_TEMP, "freerdp-transport-dump");
178
0
  else
179
0
    file = _strdup(cfolder);
180
181
0
  if (!file)
182
0
    goto fail;
183
184
0
  fp = winpr_fopen(file, mode);
185
0
fail:
186
0
  free(file);
187
0
  return fp;
188
0
}
189
190
SSIZE_T stream_dump_append(const rdpContext* context, UINT32 flags, wStream* s, size_t* offset)
191
0
{
192
0
  SSIZE_T rc = -1;
193
0
  FILE* fp = NULL;
194
0
  const UINT32 mask = STREAM_MSG_SRV_RX | STREAM_MSG_SRV_TX;
195
0
  CONNECTION_STATE state = freerdp_get_state(context);
196
0
  int r = 0;
197
198
0
  if (!context || !s || !offset)
199
0
    return -1;
200
201
0
  if ((flags & STREAM_MSG_SRV_RX) && (flags & STREAM_MSG_SRV_TX))
202
0
    return -1;
203
204
0
  if ((flags & mask) == 0)
205
0
    return -1;
206
207
0
  if (state < context->dump->state)
208
0
    return 0;
209
210
0
  fp = stream_dump_get_file(context->settings, "ab");
211
0
  if (!fp)
212
0
    return -1;
213
214
0
  r = _fseeki64(fp, *offset, SEEK_SET);
215
0
  if (r < 0)
216
0
    goto fail;
217
218
0
  if (!stream_dump_write_line(fp, flags, s))
219
0
    goto fail;
220
0
  rc = _ftelli64(fp);
221
0
  if (rc < 0)
222
0
    goto fail;
223
0
  *offset = (size_t)rc;
224
0
fail:
225
0
  if (fp)
226
0
    (void)fclose(fp);
227
0
  return rc;
228
0
}
229
230
SSIZE_T stream_dump_get(const rdpContext* context, UINT32* flags, wStream* s, size_t* offset,
231
                        UINT64* pts)
232
0
{
233
0
  SSIZE_T rc = -1;
234
0
  FILE* fp = NULL;
235
0
  int r = 0;
236
237
0
  if (!context || !s || !offset)
238
0
    return -1;
239
0
  fp = stream_dump_get_file(context->settings, "rb");
240
0
  if (!fp)
241
0
    return -1;
242
0
  r = _fseeki64(fp, *offset, SEEK_SET);
243
0
  if (r < 0)
244
0
    goto fail;
245
246
0
  if (!stream_dump_read_line(fp, s, pts, offset, flags))
247
0
    goto fail;
248
249
0
  rc = _ftelli64(fp);
250
0
fail:
251
0
  if (fp)
252
0
    (void)fclose(fp);
253
0
  return rc;
254
0
}
255
256
static int stream_dump_transport_write(rdpTransport* transport, wStream* s)
257
0
{
258
0
  SSIZE_T r = 0;
259
0
  rdpContext* ctx = transport_get_context(transport);
260
261
0
  WINPR_ASSERT(ctx);
262
0
  WINPR_ASSERT(ctx->dump);
263
0
  WINPR_ASSERT(s);
264
265
0
  r = stream_dump_append(ctx, ctx->dump->isServer ? STREAM_MSG_SRV_TX : STREAM_MSG_SRV_RX, s,
266
0
                         &ctx->dump->writeDumpOffset);
267
0
  if (r < 0)
268
0
    return -1;
269
270
0
  WINPR_ASSERT(ctx->dump->io.WritePdu);
271
0
  return ctx->dump->io.WritePdu(transport, s);
272
0
}
273
274
static int stream_dump_transport_read(rdpTransport* transport, wStream* s)
275
0
{
276
0
  int rc = 0;
277
0
  rdpContext* ctx = transport_get_context(transport);
278
279
0
  WINPR_ASSERT(ctx);
280
0
  WINPR_ASSERT(ctx->dump);
281
0
  WINPR_ASSERT(s);
282
283
0
  WINPR_ASSERT(ctx->dump->io.ReadPdu);
284
0
  rc = ctx->dump->io.ReadPdu(transport, s);
285
0
  if (rc > 0)
286
0
  {
287
0
    SSIZE_T r =
288
0
        stream_dump_append(ctx, ctx->dump->isServer ? STREAM_MSG_SRV_RX : STREAM_MSG_SRV_TX, s,
289
0
                           &ctx->dump->readDumpOffset);
290
0
    if (r < 0)
291
0
      return -1;
292
0
  }
293
0
  return rc;
294
0
}
295
296
static BOOL stream_dump_register_write_handlers(rdpContext* context)
297
0
{
298
0
  rdpTransportIo dump = { 0 };
299
0
  const rdpTransportIo* dfl = freerdp_get_io_callbacks(context);
300
301
0
  if (!freerdp_settings_get_bool(context->settings, FreeRDP_TransportDump))
302
0
    return TRUE;
303
304
0
  WINPR_ASSERT(dfl);
305
0
  dump = *dfl;
306
307
  /* Remember original callbacks for later */
308
0
  WINPR_ASSERT(context->dump);
309
0
  context->dump->io.ReadPdu = dfl->ReadPdu;
310
0
  context->dump->io.WritePdu = dfl->WritePdu;
311
312
  /* Set our dump wrappers */
313
0
  dump.WritePdu = stream_dump_transport_write;
314
0
  dump.ReadPdu = stream_dump_transport_read;
315
0
  return freerdp_set_io_callbacks(context, &dump);
316
0
}
317
318
static int stream_dump_replay_transport_write(rdpTransport* transport, wStream* s)
319
0
{
320
0
  rdpContext* ctx = transport_get_context(transport);
321
0
  size_t size = 0;
322
323
0
  WINPR_ASSERT(ctx);
324
0
  WINPR_ASSERT(s);
325
326
0
  size = Stream_Length(s);
327
0
  WLog_Print(ctx->dump->log, WLOG_TRACE, "replay write %" PRIuz, size);
328
  // TODO: Compare with write file
329
330
0
  return 1;
331
0
}
332
333
static int stream_dump_replay_transport_read(rdpTransport* transport, wStream* s)
334
0
{
335
0
  rdpContext* ctx = transport_get_context(transport);
336
337
0
  size_t size = 0;
338
0
  time_t slp = 0;
339
0
  UINT64 ts = 0;
340
0
  UINT32 flags = 0;
341
342
0
  WINPR_ASSERT(ctx);
343
0
  WINPR_ASSERT(ctx->dump);
344
0
  WINPR_ASSERT(s);
345
346
0
  const size_t start = Stream_GetPosition(s);
347
0
  do
348
0
  {
349
0
    Stream_SetPosition(s, start);
350
0
    if (stream_dump_get(ctx, &flags, s, &ctx->dump->replayOffset, &ts) < 0)
351
0
      return -1;
352
0
  } while (flags & STREAM_MSG_SRV_RX);
353
354
0
  if (!ctx->dump->nodelay)
355
0
  {
356
0
    if ((ctx->dump->replayTime > 0) && (ts > ctx->dump->replayTime))
357
0
      slp = ts - ctx->dump->replayTime;
358
0
  }
359
0
  ctx->dump->replayTime = ts;
360
361
0
  size = Stream_Length(s);
362
0
  Stream_SetPosition(s, 0);
363
0
  WLog_Print(ctx->dump->log, WLOG_TRACE, "replay read %" PRIuz, size);
364
365
0
  if (slp > 0)
366
0
  {
367
0
    size_t duration = slp;
368
0
    do
369
0
    {
370
0
      const DWORD actual = (DWORD)MIN(duration, UINT32_MAX);
371
0
      Sleep(actual);
372
0
      duration -= actual;
373
0
    } while (duration > 0);
374
0
  }
375
376
0
  return 1;
377
0
}
378
379
static int stream_dump_replay_transport_tcp_connect(rdpContext* context, rdpSettings* settings,
380
                                                    const char* hostname, int port, DWORD timeout)
381
0
{
382
0
  WINPR_ASSERT(context);
383
0
  WINPR_ASSERT(settings);
384
0
  WINPR_ASSERT(hostname);
385
386
0
  return 42;
387
0
}
388
389
static rdpTransportLayer* stream_dump_replay_transport_connect_layer(rdpTransport* transport,
390
                                                                     const char* hostname, int port,
391
                                                                     DWORD timeout)
392
0
{
393
0
  WINPR_ASSERT(transport);
394
0
  WINPR_ASSERT(hostname);
395
396
0
  return NULL;
397
0
}
398
399
static BOOL stream_dump_replay_transport_tls_connect(rdpTransport* transport)
400
0
{
401
0
  WINPR_ASSERT(transport);
402
0
  return TRUE;
403
0
}
404
405
static BOOL stream_dump_replay_transport_accept(rdpTransport* transport)
406
0
{
407
0
  WINPR_ASSERT(transport);
408
0
  return TRUE;
409
0
}
410
411
static BOOL stream_dump_register_read_handlers(rdpContext* context)
412
0
{
413
0
  const rdpTransportIo* dfl = freerdp_get_io_callbacks(context);
414
415
0
  if (!freerdp_settings_get_bool(context->settings, FreeRDP_TransportDumpReplay))
416
0
    return TRUE;
417
418
0
  WINPR_ASSERT(dfl);
419
0
  rdpTransportIo dump = *dfl;
420
421
  /* Remember original callbacks for later */
422
0
  WINPR_ASSERT(context->dump);
423
0
  context->dump->nodelay =
424
0
      freerdp_settings_get_bool(context->settings, FreeRDP_TransportDumpReplayNodelay);
425
0
  context->dump->io.ReadPdu = dfl->ReadPdu;
426
0
  context->dump->io.WritePdu = dfl->WritePdu;
427
428
  /* Set our dump wrappers */
429
0
  dump.WritePdu = stream_dump_transport_write;
430
0
  dump.ReadPdu = stream_dump_transport_read;
431
432
  /* Set our dump wrappers */
433
0
  dump.WritePdu = stream_dump_replay_transport_write;
434
0
  dump.ReadPdu = stream_dump_replay_transport_read;
435
0
  dump.TCPConnect = stream_dump_replay_transport_tcp_connect;
436
0
  dump.TLSAccept = stream_dump_replay_transport_accept;
437
0
  dump.TLSConnect = stream_dump_replay_transport_tls_connect;
438
0
  dump.ConnectLayer = stream_dump_replay_transport_connect_layer;
439
0
  if (!freerdp_set_io_callbacks(context, &dump))
440
0
    return FALSE;
441
0
  return freerdp_io_callback_set_event(context, TRUE);
442
0
}
443
444
BOOL stream_dump_register_handlers(rdpContext* context, CONNECTION_STATE state, BOOL isServer)
445
0
{
446
0
  WINPR_ASSERT(context);
447
0
  WINPR_ASSERT(context->dump);
448
0
  context->dump->state = state;
449
0
  context->dump->isServer = isServer;
450
0
  if (!stream_dump_register_write_handlers(context))
451
0
    return FALSE;
452
0
  return stream_dump_register_read_handlers(context);
453
0
}
454
455
void stream_dump_free(rdpStreamDumpContext* dump)
456
13.2k
{
457
13.2k
  free(dump);
458
13.2k
}
459
460
rdpStreamDumpContext* stream_dump_new(void)
461
13.2k
{
462
13.2k
  rdpStreamDumpContext* dump = calloc(1, sizeof(rdpStreamDumpContext));
463
13.2k
  if (!dump)
464
0
    return NULL;
465
13.2k
  dump->log = WLog_Get(TAG);
466
467
13.2k
  return dump;
468
13.2k
}