FreeRDP
Loading...
Searching...
No Matches
rdp.h
1
21#ifndef FREERDP_LIB_CORE_RDP_H
22#define FREERDP_LIB_CORE_RDP_H
23
24#include <winpr/json.h>
25#include <winpr/stream.h>
26#include <winpr/crypto.h>
27
28#include <freerdp/config.h>
29#include <freerdp/api.h>
30#include <freerdp/license.h>
31#include <freerdp/freerdp.h>
32#include <freerdp/settings.h>
33#include <freerdp/log.h>
34
35#include "nla.h"
36#include "aad.h"
37#include "mcs.h"
38#include "tpkt.h"
39#include "../codec/bulk.h"
40#include "fastpath.h"
41#include "tpdu.h"
42#include "nego.h"
43#include "input.h"
44#include "update.h"
45#include "license.h"
46#include "errinfo.h"
47#include "autodetect.h"
48#include "heartbeat.h"
49#include "multitransport.h"
50#include "security.h"
51#include "transport.h"
52#include "connection.h"
53#include "redirection.h"
54#include "capabilities.h"
55#include "channels.h"
56#include "timer.h"
57
58/* Security Header Flags */
59#define SEC_EXCHANGE_PKT 0x0001
60#define SEC_TRANSPORT_REQ 0x0002
61#define SEC_TRANSPORT_RSP 0x0004
62#define SEC_ENCRYPT 0x0008
63#define SEC_RESET_SEQNO 0x0010
64#define SEC_IGNORE_SEQNO 0x0020
65#define SEC_INFO_PKT 0x0040
66#define SEC_LICENSE_PKT 0x0080
67#define SEC_LICENSE_ENCRYPT_CS 0x0200
68#define SEC_LICENSE_ENCRYPT_SC 0x0200
69#define SEC_REDIRECTION_PKT 0x0400
70#define SEC_SECURE_CHECKSUM 0x0800
71#define SEC_AUTODETECT_REQ 0x1000
72#define SEC_AUTODETECT_RSP 0x2000
73#define SEC_HEARTBEAT 0x4000
74#define SEC_FLAGSHI_VALID 0x8000
75
76#define SEC_PKT_CS_MASK (SEC_EXCHANGE_PKT | SEC_INFO_PKT)
77#define SEC_PKT_SC_MASK (SEC_LICENSE_PKT | SEC_REDIRECTION_PKT)
78#define SEC_PKT_MASK (SEC_PKT_CS_MASK | SEC_PKT_SC_MASK)
79
80#define RDP_SECURITY_HEADER_LENGTH 4
81#define RDP_SHARE_CONTROL_HEADER_LENGTH 6
82#define RDP_SHARE_DATA_HEADER_LENGTH 12
83#define RDP_PACKET_HEADER_MAX_LENGTH (TPDU_DATA_LENGTH + MCS_SEND_DATA_HEADER_MAX_LENGTH)
84
85#define PDU_TYPE_DEMAND_ACTIVE 0x1
86#define PDU_TYPE_CONFIRM_ACTIVE 0x3
87#define PDU_TYPE_DEACTIVATE_ALL 0x6
88#define PDU_TYPE_DATA 0x7
89#define PDU_TYPE_SERVER_REDIRECTION 0xA
90
91#define PDU_TYPE_FLOW_TEST 0x41
92#define PDU_TYPE_FLOW_RESPONSE 0x42
93#define PDU_TYPE_FLOW_STOP 0x43
94
95typedef enum
96{
97 FINALIZE_SC_SYNCHRONIZE_PDU = 0x01,
98 FINALIZE_SC_CONTROL_COOPERATE_PDU = 0x02,
99 FINALIZE_SC_CONTROL_GRANTED_PDU = 0x04,
100 FINALIZE_SC_FONT_MAP_PDU = 0x08,
101
102 FINALIZE_CS_SYNCHRONIZE_PDU = 0x10,
103 FINALIZE_CS_CONTROL_COOPERATE_PDU = 0x20,
104 FINALIZE_CS_CONTROL_REQUEST_PDU = 0x40,
105 FINALIZE_CS_PERSISTENT_KEY_LIST_PDU = 0x80,
106 FINALIZE_CS_FONT_LIST_PDU = 0x100,
107
108 FINALIZE_DEACTIVATE_REACTIVATE = 0x200
109} rdpFinalizePduType;
110
111/* Data PDU Types */
112typedef enum
113{
114 DATA_PDU_TYPE_UPDATE = 0x02,
115 DATA_PDU_TYPE_CONTROL = 0x14,
116 DATA_PDU_TYPE_POINTER = 0x1B,
117 DATA_PDU_TYPE_INPUT = 0x1C,
118 DATA_PDU_TYPE_SYNCHRONIZE = 0x1F,
119 DATA_PDU_TYPE_REFRESH_RECT = 0x21,
120 DATA_PDU_TYPE_PLAY_SOUND = 0x22,
121 DATA_PDU_TYPE_SUPPRESS_OUTPUT = 0x23,
122 DATA_PDU_TYPE_SHUTDOWN_REQUEST = 0x24,
123 DATA_PDU_TYPE_SHUTDOWN_DENIED = 0x25,
124 DATA_PDU_TYPE_SAVE_SESSION_INFO = 0x26,
125 DATA_PDU_TYPE_FONT_LIST = 0x27,
126 DATA_PDU_TYPE_FONT_MAP = 0x28,
127 DATA_PDU_TYPE_SET_KEYBOARD_INDICATORS = 0x29,
128 DATA_PDU_TYPE_BITMAP_CACHE_PERSISTENT_LIST = 0x2B,
129 DATA_PDU_TYPE_BITMAP_CACHE_ERROR = 0x2C,
130 DATA_PDU_TYPE_SET_KEYBOARD_IME_STATUS = 0x2D,
131 DATA_PDU_TYPE_OFFSCREEN_CACHE_ERROR = 0x2E,
132 DATA_PDU_TYPE_SET_ERROR_INFO = 0x2F,
133 DATA_PDU_TYPE_DRAW_NINEGRID_ERROR = 0x30,
134 DATA_PDU_TYPE_DRAW_GDIPLUS_ERROR = 0x31,
135 DATA_PDU_TYPE_ARC_STATUS = 0x32,
136 DATA_PDU_TYPE_STATUS_INFO = 0x36,
137 DATA_PDU_TYPE_MONITOR_LAYOUT = 0x37,
138 DATA_PDU_TYPE_FRAME_ACKNOWLEDGE = 0x38
139} rdpPduType;
140
141/* Stream Identifiers */
142#define STREAM_UNDEFINED 0x00
143#define STREAM_LOW 0x01
144#define STREAM_MED 0x02
145#define STREAM_HI 0x04
146
147struct rdp_rdp
148{
149 CONNECTION_STATE state;
150 rdpContext* context;
151 rdpNla* nla;
152 rdpAad* aad;
153 rdpMcs* mcs;
154 rdpNego* nego;
155 rdpBulk* bulk;
156 rdpInput* input;
157 rdpUpdate* update;
158 rdpFastPath* fastpath;
159 rdpLicense* license;
160 rdpRedirection* redirection;
161 rdpSettings* settings;
162 rdpSettings* originalSettings;
163 rdpSettings* remoteSettings;
164 UINT32 redirectionCount;
165 rdpTransport* transport;
166 rdpAutoDetect* autodetect;
167 rdpHeartbeat* heartbeat;
168 rdpMultitransport* multitransport;
169 WINPR_RC4_CTX* rc4_decrypt_key;
170 UINT32 decrypt_use_count;
171 UINT32 decrypt_checksum_use_count;
172 WINPR_RC4_CTX* rc4_encrypt_key;
173 UINT32 encrypt_use_count;
174 UINT32 encrypt_checksum_use_count;
175 WINPR_CIPHER_CTX* fips_encrypt;
176 WINPR_CIPHER_CTX* fips_decrypt;
177 BOOL do_crypt;
178 BOOL do_crypt_license;
179 BOOL do_secure_checksum;
180 BYTE sign_key[16];
181 BYTE decrypt_key[16];
182 BYTE encrypt_key[16];
183 BYTE decrypt_update_key[16];
184 BYTE encrypt_update_key[16];
185 size_t rc4_key_len;
186 BYTE fips_sign_key[20];
187 BYTE fips_encrypt_key[24];
188 BYTE fips_decrypt_key[24];
189 UINT32 errorInfo;
190 UINT32 finalize_sc_pdus;
191 BOOL resendFocus;
192
193 UINT64 inBytes;
194 UINT64 inPackets;
195 UINT64 outBytes;
196 UINT64 outPackets;
197 CRITICAL_SECTION critical;
198 rdpTransportIo* io;
199 void* ioContext;
200 HANDLE abortEvent;
201
202 wPubSub* pubSub;
203
204 BOOL monitor_layout_pdu;
205 BOOL was_deactivated;
206 UINT32 deactivated_width;
207 UINT32 deactivated_height;
208
209 wLog* log;
210 char log_context[64];
211 WINPR_JSON* wellknown;
212 FreeRDPTimer* timer;
213 WINPR_ATTR_NODISCARD pGetCommonAccessToken GetCommonAccessToken;
214};
215
216WINPR_ATTR_NODISCARD
217FREERDP_LOCAL BOOL rdp_read_security_header(rdpRdp* rdp, wStream* s, UINT16* flags, UINT16* length);
218
219WINPR_ATTR_NODISCARD
220FREERDP_LOCAL BOOL rdp_write_security_header(rdpRdp* rdp, wStream* s, UINT16 flags);
221
222WINPR_ATTR_NODISCARD
223FREERDP_LOCAL BOOL rdp_read_share_control_header(rdpRdp* rdp, wStream* s, UINT16* tpktLength,
224 UINT16* remainingLength, UINT16* type,
225 UINT16* channel_id);
226
227WINPR_ATTR_NODISCARD
228FREERDP_LOCAL BOOL rdp_read_share_data_header(rdpRdp* rdp, wStream* s, UINT16* length, BYTE* type,
229 UINT32* shareId, BYTE* compressedType,
230 UINT16* compressedLength);
231
232WINPR_ATTR_NODISCARD
233FREERDP_LOCAL BOOL rdp_send(rdpRdp* rdp, wStream* s, UINT16 channelId, UINT16 sec_flags);
234
235WINPR_ATTR_MALLOC(rdp_send, 2)
236WINPR_ATTR_NODISCARD
237FREERDP_LOCAL wStream* rdp_send_stream_init(rdpRdp* rdp, UINT16* sec_flags);
238
239WINPR_ATTR_MALLOC(Stream_Release, 1)
240WINPR_ATTR_NODISCARD
241FREERDP_LOCAL wStream* rdp_send_stream_pdu_init(rdpRdp* rdp, UINT16* sec_flags);
242
243WINPR_ATTR_NODISCARD
244FREERDP_LOCAL BOOL rdp_read_header(rdpRdp* rdp, wStream* s, UINT16* length, UINT16* channelId);
245
246WINPR_ATTR_NODISCARD
247FREERDP_LOCAL BOOL rdp_write_header(rdpRdp* rdp, wStream* s, size_t length, UINT16 channelId,
248 UINT16 sec_flags);
249
250WINPR_ATTR_NODISCARD
251FREERDP_LOCAL BOOL rdp_send_pdu(rdpRdp* rdp, wStream* s, UINT16 type, UINT16 channel_id,
252 UINT16 sec_flags);
253
254WINPR_ATTR_NODISCARD
255FREERDP_LOCAL BOOL rdp_send_data_pdu(rdpRdp* rdp, wStream* s, BYTE type, UINT16 channel_id,
256 UINT16 sec_flags);
257
258WINPR_ATTR_MALLOC(rdp_send_data_pdu, 2)
259WINPR_ATTR_NODISCARD
260FREERDP_LOCAL wStream* rdp_data_pdu_init(rdpRdp* rdp, UINT16* sec_flags);
261
262WINPR_ATTR_NODISCARD
263FREERDP_LOCAL state_run_t rdp_recv_data_pdu(rdpRdp* rdp, wStream* s);
264
265WINPR_ATTR_NODISCARD
266FREERDP_LOCAL BOOL rdp_send_channel_data(rdpRdp* rdp, UINT16 channelId, const BYTE* data,
267 size_t size);
268
269WINPR_ATTR_NODISCARD
270FREERDP_LOCAL BOOL rdp_channel_send_packet(rdpRdp* rdp, UINT16 channelId, size_t totalSize,
271 UINT32 flags, const BYTE* data, size_t chunkSize);
272
273WINPR_ATTR_NODISCARD
274FREERDP_LOCAL BOOL rdp_send_message_channel_pdu(rdpRdp* rdp, wStream* s, UINT16 sec_flags);
275
276WINPR_ATTR_MALLOC(rdp_send_message_channel_pdu, 2)
277WINPR_ATTR_NODISCARD
278FREERDP_LOCAL wStream* rdp_message_channel_pdu_init(rdpRdp* rdp, UINT16* sec_flags);
279
280WINPR_ATTR_NODISCARD
281FREERDP_LOCAL state_run_t rdp_recv_message_channel_pdu(rdpRdp* rdp, wStream* s,
282 UINT16 securityFlags);
283
284WINPR_ATTR_NODISCARD
285FREERDP_LOCAL state_run_t rdp_recv_out_of_sequence_pdu(rdpRdp* rdp, wStream* s, UINT16 pduType,
286 UINT16 length);
287
288WINPR_ATTR_NODISCARD
289FREERDP_LOCAL state_run_t rdp_recv_callback(rdpTransport* transport, wStream* s, void* extra);
290
291WINPR_ATTR_NODISCARD
292FREERDP_LOCAL int rdp_check_fds(rdpRdp* rdp);
293
294FREERDP_LOCAL void rdp_free(rdpRdp* rdp);
295
296WINPR_ATTR_MALLOC(rdp_free, 1)
297FREERDP_LOCAL rdpRdp* rdp_new(rdpContext* context);
298
299WINPR_ATTR_NODISCARD
300FREERDP_LOCAL BOOL rdp_reset(rdpRdp* rdp);
301
302WINPR_ATTR_NODISCARD
303FREERDP_LOCAL BOOL rdp_io_callback_set_event(rdpRdp* rdp, BOOL reset);
304
305WINPR_ATTR_NODISCARD
306FREERDP_LOCAL const rdpTransportIo* rdp_get_io_callbacks(rdpRdp* rdp);
307
308WINPR_ATTR_NODISCARD
309FREERDP_LOCAL BOOL rdp_set_io_callbacks(rdpRdp* rdp, const rdpTransportIo* io_callbacks);
310
311WINPR_ATTR_NODISCARD
312FREERDP_LOCAL BOOL rdp_set_io_callback_context(rdpRdp* rdp, void* usercontext);
313
314WINPR_ATTR_NODISCARD
315FREERDP_LOCAL void* rdp_get_io_callback_context(rdpRdp* rdp);
316
317#define RDP_TAG FREERDP_TAG("core.rdp")
318#ifdef WITH_DEBUG_RDP
319#define DEBUG_RDP(rdp, ...) WLog_Print(rdp->log, WLOG_DEBUG, __VA_ARGS__)
320#else
321#define DEBUG_RDP(rdp, ...) \
322 do \
323 { \
324 } while (0)
325#endif
326
327WINPR_ATTR_NODISCARD FREERDP_LOCAL const char* data_pdu_type_to_string(UINT8 type);
328
329WINPR_ATTR_NODISCARD FREERDP_LOCAL const char* pdu_type_to_str(UINT16 pduType, char* buffer,
330 size_t length);
331
332WINPR_ATTR_NODISCARD FREERDP_LOCAL BOOL rdp_finalize_reset_flags(rdpRdp* rdp, BOOL clearAll);
333
334FREERDP_LOCAL BOOL rdp_finalize_set_flag(rdpRdp* rdp, UINT32 flag);
335
336WINPR_ATTR_NODISCARD FREERDP_LOCAL BOOL rdp_finalize_is_flag_set(rdpRdp* rdp, UINT32 flag);
337
338WINPR_ATTR_NODISCARD FREERDP_LOCAL const char* rdp_finalize_flags_to_str(UINT32 flags, char* buffer,
339 size_t size);
340
341WINPR_ATTR_NODISCARD FREERDP_LOCAL BOOL rdp_decrypt(rdpRdp* rdp, wStream* s, UINT16* pLength,
342 UINT16 securityFlags);
343
344FREERDP_LOCAL BOOL rdp_set_error_info(rdpRdp* rdp, UINT32 errorInfo);
345
346WINPR_ATTR_NODISCARD FREERDP_LOCAL BOOL rdp_send_error_info(rdpRdp* rdp);
347
348void rdp_free_rc4_encrypt_keys(rdpRdp* rdp);
349
350WINPR_ATTR_NODISCARD FREERDP_LOCAL BOOL rdp_reset_rc4_encrypt_keys(rdpRdp* rdp);
351
352void rdp_free_rc4_decrypt_keys(rdpRdp* rdp);
353
354WINPR_ATTR_NODISCARD FREERDP_LOCAL BOOL rdp_reset_rc4_decrypt_keys(rdpRdp* rdp);
355
356WINPR_ATTR_NODISCARD FREERDP_LOCAL const char* rdp_security_flag_string(UINT32 securityFlags,
357 char* buffer, size_t size);
358
359WINPR_ATTR_NODISCARD FREERDP_LOCAL BOOL rdp_set_backup_settings(rdpRdp* rdp);
360
361WINPR_ATTR_NODISCARD FREERDP_LOCAL BOOL rdp_reset_runtime_settings(rdpRdp* rdp);
362
363FREERDP_LOCAL void rdp_log_build_warnings(rdpRdp* rdp);
364
365WINPR_ATTR_NODISCARD
366FREERDP_LOCAL size_t rdp_get_event_handles(rdpRdp* rdp, HANDLE* handles, uint32_t count);
367
368#endif /* FREERDP_LIB_CORE_RDP_H */
RTL_CRITICAL_SECTION
Definition include/winpr/synch.h:160
rdp_rdp
Definition rdp.h:148