FreeRDP
Loading...
Searching...
No Matches
include/freerdp/client.h
1
21#ifndef FREERDP_CLIENT_H
22#define FREERDP_CLIENT_H
23
24#include <winpr/cmdline.h>
25#include <freerdp/client/cmdline.h>
26
27#include <freerdp/config.h>
28#include <freerdp/api.h>
29#include <freerdp/types.h>
30#include <freerdp/event.h>
31#include <freerdp/freerdp.h>
32
33#if defined(CHANNEL_AINPUT_CLIENT)
34#include <freerdp/client/ainput.h>
35#endif
36
37#if defined(CHANNEL_RDPEI_CLIENT)
38#include <freerdp/client/rdpei.h>
39#endif
40
41#if defined(CHANNEL_ENCOMSP_CLIENT)
42#include <freerdp/client/encomsp.h>
43#endif
44
48typedef struct MIBClientWrapper MIBClientWrapper;
49typedef struct AadAuthHelper AadAuthHelper;
50
51#ifdef __cplusplus
52extern "C"
53{
54#endif
55
60 typedef BOOL (*pRdpGlobalInit)(void);
61 typedef void (*pRdpGlobalUninit)(void);
62
63 typedef BOOL (*pRdpClientNew)(freerdp* instance, rdpContext* context);
64 typedef void (*pRdpClientFree)(freerdp* instance, rdpContext* context);
65
66 typedef int (*pRdpClientStart)(rdpContext* context);
67 typedef int (*pRdpClientStop)(rdpContext* context);
68
69 struct rdp_client_entry_points_v1
70 {
71 DWORD Size;
72 DWORD Version;
73
74 rdpSettings* settings;
75
76 WINPR_ATTR_NODISCARD pRdpGlobalInit GlobalInit;
77 pRdpGlobalUninit GlobalUninit;
78
79 DWORD ContextSize;
80 WINPR_ATTR_NODISCARD pRdpClientNew ClientNew;
81 pRdpClientFree ClientFree;
82
83 WINPR_ATTR_NODISCARD pRdpClientStart ClientStart;
84 pRdpClientStop ClientStop;
85 };
86
87#define RDP_CLIENT_INTERFACE_VERSION 1
88#define RDP_CLIENT_ENTRY_POINT_NAME "RdpClientEntry"
89
90 typedef int (*pRdpClientEntry)(RDP_CLIENT_ENTRY_POINTS* pEntryPoints);
91
92 /* Common Client Interface */
93#define FREERDP_MAX_TOUCH_CONTACTS 10
94
95 typedef struct
96 {
97 ALIGN64 INT32 id;
98 ALIGN64 UINT32 count;
99 ALIGN64 INT32 x;
100 ALIGN64 INT32 y;
101 ALIGN64 UINT32 flags;
102 ALIGN64 UINT32 pressure;
103 } FreeRDP_TouchContact;
104
105#define FREERDP_MAX_PEN_DEVICES 10
106
107 typedef struct pen_device
108 {
109 ALIGN64 INT32 deviceid;
110 ALIGN64 UINT32 flags;
111 ALIGN64 double max_pressure;
112 ALIGN64 BOOL hovering;
113 ALIGN64 BOOL pressed;
114 ALIGN64 INT32 last_x;
115 ALIGN64 INT32 last_y;
116 } FreeRDP_PenDevice;
117
121 typedef struct rdp_client_oauth2 rdpClientOAuth2;
122
123 struct rdp_client_context
124 {
125 rdpContext context;
126 ALIGN64 HANDLE thread;
127#if defined(CHANNEL_AINPUT_CLIENT)
128 ALIGN64 AInputClientContext* ainput;
129#else
130 UINT64 reserved1;
131#endif
132
133#if defined(CHANNEL_RDPEI_CLIENT)
134 ALIGN64 RdpeiClientContext* rdpei;
135#else
136 UINT64 reserved2;
137#endif
138
139 ALIGN64 INT32 lastX;
140 ALIGN64 INT32 lastY;
141 ALIGN64 BOOL mouse_grabbed;
143#if defined(CHANNEL_ENCOMSP_CLIENT)
144 ALIGN64 EncomspClientContext* encomsp;
145 ALIGN64 BOOL controlToggle;
146#else
147 UINT64 reserved3[2];
148#endif
149 ALIGN64 FreeRDP_TouchContact contacts[FREERDP_MAX_TOUCH_CONTACTS];
150 ALIGN64 FreeRDP_PenDevice pens[FREERDP_MAX_PEN_DEVICES];
152 ALIGN64 MIBClientWrapper* mibClientWrapper;
153 ALIGN64 BOOL pressed_buttons[5];
154 ALIGN64 rdpClientOAuth2* oauth2;
155 ALIGN64 AadAuthHelper* aadHelper;
156 UINT64 reserved[129 - 18];
157 };
158
159 typedef BOOL (*window_events_fkt_t)(freerdp* instance);
160
161 /* Common client functions */
162
163 FREERDP_API void freerdp_client_context_free(rdpContext* context);
164
165 WINPR_ATTR_MALLOC(freerdp_client_context_free, 1)
166 FREERDP_API rdpContext* freerdp_client_context_new(const RDP_CLIENT_ENTRY_POINTS* pEntryPoints);
167
168 WINPR_ATTR_NODISCARD
169 FREERDP_API int freerdp_client_start(rdpContext* context);
170
171 FREERDP_API int freerdp_client_stop(rdpContext* context);
172
181 WINPR_ATTR_NODISCARD
182 FREERDP_API BOOL freerdp_client_enable_translation(const char* locale, const char* searchPath);
183
184 WINPR_ATTR_NODISCARD
185 FREERDP_API freerdp* freerdp_client_get_instance(rdpContext* context);
186
187 WINPR_ATTR_NODISCARD
188 FREERDP_API HANDLE freerdp_client_get_thread(rdpContext* context);
189
190 WINPR_ATTR_NODISCARD
191 FREERDP_API int freerdp_client_settings_parse_command_line(rdpSettings* settings, int argc,
192 char** argv, BOOL allowUnknown);
193
207 WINPR_ATTR_NODISCARD
208 FREERDP_API int freerdp_client_settings_parse_command_line_ex(
209 rdpSettings* settings, int argc, char** argv, BOOL allowUnknown,
210 COMMAND_LINE_ARGUMENT_A* args, size_t count,
211 freerdp_command_line_handle_option_t handle_option, void* handle_userdata);
212
213 WINPR_ATTR_NODISCARD
214 FREERDP_API int freerdp_client_settings_parse_connection_file(rdpSettings* settings,
215 const char* filename);
216
217 WINPR_ATTR_NODISCARD
218 FREERDP_API int freerdp_client_settings_parse_connection_file_buffer(rdpSettings* settings,
219 const BYTE* buffer,
220 size_t size);
221
222 WINPR_ATTR_NODISCARD
223 FREERDP_API int freerdp_client_settings_write_connection_file(const rdpSettings* settings,
224 const char* filename,
225 BOOL unicode);
226
227 WINPR_ATTR_NODISCARD
228 FREERDP_API int freerdp_client_settings_parse_assistance_file(rdpSettings* settings, int argc,
229 char* argv[]);
230
231 WINPR_ATTR_NODISCARD
232 FREERDP_API BOOL client_cli_authenticate_ex(freerdp* instance, char** username, char** password,
233 char** domain, rdp_auth_reason reason);
234
235 WINPR_ATTR_NODISCARD
236 FREERDP_API BOOL client_cli_choose_smartcard(freerdp* instance, SmartcardCertInfo** cert_list,
237 DWORD count, DWORD* choice, BOOL gateway);
238
239 WINPR_ATTR_NODISCARD
240 FREERDP_API int client_cli_logon_error_info(freerdp* instance, UINT32 data, UINT32 type);
241
253 WINPR_ATTR_NODISCARD
254 FREERDP_API BOOL client_failsafe_get_access_token(freerdp* instance, AccessTokenType tokenType,
255 char** token, size_t count, ...);
256
268 WINPR_ATTR_NODISCARD
269 FREERDP_API BOOL client_helper_get_access_token(freerdp* instance, AccessTokenType tokenType,
270 char** token, size_t count, ...);
271
283 WINPR_ATTR_NODISCARD
284 FREERDP_API BOOL client_cli_get_access_token(freerdp* instance, AccessTokenType tokenType,
285 char** token, size_t count, ...);
286
287 WINPR_ATTR_NODISCARD
288 FREERDP_API BOOL client_common_get_access_token(freerdp* instance, const char* request,
289 char** token);
290
291 WINPR_ATTR_NODISCARD
292 FREERDP_API SSIZE_T client_common_retry_dialog(freerdp* instance, const char* what,
293 size_t current, void* userarg);
294
304 WINPR_ATTR_NODISCARD
305 FREERDP_API BOOL client_common_save_session_info(rdpContext* context, UINT32 type,
306 const void* data);
307
308 FREERDP_API void
309 freerdp_client_OnChannelConnectedEventHandler(void* context,
310 const ChannelConnectedEventArgs* e);
311 FREERDP_API void
312 freerdp_client_OnChannelDisconnectedEventHandler(void* context,
313 const ChannelDisconnectedEventArgs* e);
314
315#if defined(WITH_FREERDP_DEPRECATED)
316 WINPR_DEPRECATED_VAR("Use client_cli_authenticate_ex",
317 WINPR_ATTR_NODISCARD FREERDP_API BOOL client_cli_authenticate(
318 freerdp* instance, char** username, char** password, char** domain));
319 WINPR_DEPRECATED_VAR("Use client_cli_authenticate_ex",
320 WINPR_ATTR_NODISCARD FREERDP_API BOOL client_cli_gw_authenticate(
321 freerdp* instance, char** username, char** password, char** domain));
322
323 WINPR_DEPRECATED_VAR("Use client_cli_verify_certificate_ex",
324 WINPR_ATTR_NODISCARD FREERDP_API DWORD client_cli_verify_certificate(
325 freerdp* instance, const char* common_name, const char* subject,
326 const char* issuer, const char* fingerprint, BOOL host_mismatch));
327#endif
328
329 WINPR_ATTR_NODISCARD
330 FREERDP_API DWORD client_cli_verify_certificate_ex(freerdp* instance, const char* host,
331 UINT16 port, const char* common_name,
332 const char* subject, const char* issuer,
333 const char* fingerprint, DWORD flags);
334
335#if defined(WITH_FREERDP_DEPRECATED)
336 WINPR_DEPRECATED_VAR(
337 "Use client_cli_verify_changed_certificate_ex",
338 WINPR_ATTR_NODISCARD FREERDP_API DWORD client_cli_verify_changed_certificate(
339 freerdp* instance, const char* common_name, const char* subject, const char* issuer,
340 const char* fingerprint, const char* old_subject, const char* old_issuer,
341 const char* old_fingerprint));
342#endif
343
344 WINPR_ATTR_NODISCARD
345 FREERDP_API DWORD client_cli_verify_changed_certificate_ex(
346 freerdp* instance, const char* host, UINT16 port, const char* common_name,
347 const char* subject, const char* issuer, const char* fingerprint, const char* old_subject,
348 const char* old_issuer, const char* old_fingerprint, DWORD flags);
349
350 WINPR_ATTR_NODISCARD
351 FREERDP_API BOOL client_cli_present_gateway_message(freerdp* instance, UINT32 type,
352 BOOL isDisplayMandatory,
353 BOOL isConsentMandatory, size_t length,
354 const WCHAR* message);
355
356 WINPR_ATTR_NODISCARD
357 FREERDP_API BOOL client_auto_reconnect(freerdp* instance);
358
366 WINPR_ATTR_NODISCARD
367 FREERDP_API BOOL client_auto_reconnect_ex(freerdp* instance, window_events_fkt_t window_events);
368
369 typedef enum
370 {
371 FREERDP_TOUCH_DOWN = 0x01,
372 FREERDP_TOUCH_UP = 0x02,
373 FREERDP_TOUCH_MOTION = 0x04,
374 FREERDP_TOUCH_CANCEL = 0x08,
375 FREERDP_TOUCH_HAS_PRESSURE = 0x100
376 } FreeRDPTouchEventType;
377
378 FREERDP_API BOOL freerdp_client_handle_touch(rdpClientContext* cctx, UINT32 flags, INT32 finger,
379 UINT32 pressure, INT32 x, INT32 y);
380
381 typedef enum
382 {
383 FREERDP_PEN_REGISTER = 0x01,
384 FREERDP_PEN_ERASER_PRESSED = 0x02,
385 FREERDP_PEN_PRESS = 0x04,
386 FREERDP_PEN_MOTION = 0x08,
387 FREERDP_PEN_RELEASE = 0x10,
388 FREERDP_PEN_BARREL_PRESSED = 0x20,
389 FREERDP_PEN_HAS_PRESSURE = 0x40,
390 FREERDP_PEN_HAS_ROTATION = 0x80,
391 FREERDP_PEN_HAS_TILTX = 0x100,
392 FREERDP_PEN_HAS_TILTY = 0x200,
393 FREERDP_PEN_IS_INVERTED = 0x400
394 } FreeRDPPenEventType;
395
396 FREERDP_API BOOL freerdp_client_handle_pen(rdpClientContext* cctx, UINT32 flags, INT32 deviceid,
397 ...);
398 WINPR_ATTR_NODISCARD
399 FREERDP_API BOOL freerdp_client_is_pen(rdpClientContext* cctx, INT32 deviceid);
400
401 FREERDP_API BOOL freerdp_client_pen_cancel_all(rdpClientContext* cctx);
402
403 FREERDP_API BOOL freerdp_client_send_wheel_event(rdpClientContext* cctx, UINT16 mflags);
404
412 WINPR_ATTR_NODISCARD
413 FREERDP_API BOOL freerdp_client_use_relative_mouse_events(rdpClientContext* cctx);
414
415 FREERDP_API BOOL freerdp_client_send_button_event(rdpClientContext* cctx, BOOL relative,
416 UINT16 mflags, INT32 x, INT32 y);
417
418 FREERDP_API BOOL freerdp_client_send_extended_button_event(rdpClientContext* cctx,
419 BOOL relative, UINT16 mflags,
420 INT32 x, INT32 y);
421
422 WINPR_ATTR_NODISCARD
423 FREERDP_API int freerdp_client_common_stop(rdpContext* context);
424
425 WINPR_ATTR_NODISCARD
426 FREERDP_API BOOL freerdp_client_load_channels(freerdp* instance);
427
428#if defined(CHANNEL_ENCOMSP_CLIENT)
429 FREERDP_API BOOL freerdp_client_encomsp_toggle_control(EncomspClientContext* encomsp);
430
431 WINPR_ATTR_NODISCARD
432 FREERDP_API BOOL freerdp_client_encomsp_set_control(EncomspClientContext* encomsp,
433 BOOL control);
434#endif
435
439 typedef enum
440 {
441 FREERDP_CLIENT_AAD_AUTH_REQUEST,
442 FREERDP_CLIENT_AAD_TOKEN_REQUEST,
443 FREERDP_CLIENT_AAD_AVD_AUTH_REQUEST,
444 FREERDP_CLIENT_AAD_AVD_TOKEN_REQUEST,
445 } freerdp_client_aad_type;
446
453 WINPR_ATTR_MALLOC(winpr_zfree, 1)
454 FREERDP_API char* freerdp_client_get_aad_url(rdpClientContext* cctx,
455 freerdp_client_aad_type type, ...);
456
467 WINPR_ATTR_MALLOC(winpr_zfree, 1)
468 FREERDP_API char* freerdp_client_extract_aad_code(rdpClientContext* cctx, const char* data,
469 size_t length);
470
471#ifdef __cplusplus
472}
473#endif
474
475#endif /* FREERDP_CLIENT_H */
COMMAND_LINE_ARGUMENT_A
Definition winpr/include/winpr/cmdline.h:100
FreeRDP_PenDevice
Definition include/freerdp/client.h:108
FreeRDP_TouchContact
Definition include/freerdp/client.h:96
rdp_client_context
Definition include/freerdp/client.h:124
rdp_client_context::reserved3
UINT64 reserved3[2]
Definition include/freerdp/client.h:147
rdp_client_context::mibClientWrapper
ALIGN64 MIBClientWrapper * mibClientWrapper
Definition include/freerdp/client.h:152
rdp_client_context::reserved
UINT64 reserved[129 - 18]
Definition include/freerdp/client.h:156
rdp_client_context::contacts
ALIGN64 FreeRDP_TouchContact contacts[FREERDP_MAX_TOUCH_CONTACTS]
Definition include/freerdp/client.h:149
rdp_client_context::pressed_buttons
ALIGN64 BOOL pressed_buttons[5]
Definition include/freerdp/client.h:153
rdp_client_context::aadHelper
ALIGN64 AadAuthHelper * aadHelper
Definition include/freerdp/client.h:155
rdp_client_context::pens
ALIGN64 FreeRDP_PenDevice pens[FREERDP_MAX_PEN_DEVICES]
Definition include/freerdp/client.h:150
rdp_client_context::oauth2
ALIGN64 rdpClientOAuth2 * oauth2
Definition include/freerdp/client.h:154
rdp_client_context::lastX
ALIGN64 INT32 lastX
Definition include/freerdp/client.h:139
rdp_client_context::lastY
ALIGN64 INT32 lastY
Definition include/freerdp/client.h:140
rdp_client_context::thread
ALIGN64 HANDLE thread
Definition include/freerdp/client.h:126
rdp_client_entry_points_v1
Definition include/freerdp/client.h:70