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 /* Common client functions */
160
161 FREERDP_API void freerdp_client_context_free(rdpContext* context);
162
163 WINPR_ATTR_MALLOC(freerdp_client_context_free, 1)
164 FREERDP_API rdpContext* freerdp_client_context_new(const RDP_CLIENT_ENTRY_POINTS* pEntryPoints);
165
166 WINPR_ATTR_NODISCARD
167 FREERDP_API int freerdp_client_start(rdpContext* context);
168
169 FREERDP_API int freerdp_client_stop(rdpContext* context);
170
171 WINPR_ATTR_NODISCARD
172 FREERDP_API freerdp* freerdp_client_get_instance(rdpContext* context);
173
174 WINPR_ATTR_NODISCARD
175 FREERDP_API HANDLE freerdp_client_get_thread(rdpContext* context);
176
177 WINPR_ATTR_NODISCARD
178 FREERDP_API int freerdp_client_settings_parse_command_line(rdpSettings* settings, int argc,
179 char** argv, BOOL allowUnknown);
180
194 WINPR_ATTR_NODISCARD
195 FREERDP_API int freerdp_client_settings_parse_command_line_ex(
196 rdpSettings* settings, int argc, char** argv, BOOL allowUnknown,
197 COMMAND_LINE_ARGUMENT_A* args, size_t count,
198 freerdp_command_line_handle_option_t handle_option, void* handle_userdata);
199
200 WINPR_ATTR_NODISCARD
201 FREERDP_API int freerdp_client_settings_parse_connection_file(rdpSettings* settings,
202 const char* filename);
203
204 WINPR_ATTR_NODISCARD
205 FREERDP_API int freerdp_client_settings_parse_connection_file_buffer(rdpSettings* settings,
206 const BYTE* buffer,
207 size_t size);
208
209 WINPR_ATTR_NODISCARD
210 FREERDP_API int freerdp_client_settings_write_connection_file(const rdpSettings* settings,
211 const char* filename,
212 BOOL unicode);
213
214 WINPR_ATTR_NODISCARD
215 FREERDP_API int freerdp_client_settings_parse_assistance_file(rdpSettings* settings, int argc,
216 char* argv[]);
217
218 WINPR_ATTR_NODISCARD
219 FREERDP_API BOOL client_cli_authenticate_ex(freerdp* instance, char** username, char** password,
220 char** domain, rdp_auth_reason reason);
221
222 WINPR_ATTR_NODISCARD
223 FREERDP_API BOOL client_cli_choose_smartcard(freerdp* instance, SmartcardCertInfo** cert_list,
224 DWORD count, DWORD* choice, BOOL gateway);
225
226 WINPR_ATTR_NODISCARD
227 FREERDP_API int client_cli_logon_error_info(freerdp* instance, UINT32 data, UINT32 type);
228
240 WINPR_ATTR_NODISCARD
241 FREERDP_API BOOL client_failsafe_get_access_token(freerdp* instance, AccessTokenType tokenType,
242 char** token, size_t count, ...);
243
255 WINPR_ATTR_NODISCARD
256 FREERDP_API BOOL client_helper_get_access_token(freerdp* instance, AccessTokenType tokenType,
257 char** token, size_t count, ...);
258
270 WINPR_ATTR_NODISCARD
271 FREERDP_API BOOL client_cli_get_access_token(freerdp* instance, AccessTokenType tokenType,
272 char** token, size_t count, ...);
273
274 WINPR_ATTR_NODISCARD
275 FREERDP_API BOOL client_common_get_access_token(freerdp* instance, const char* request,
276 char** token);
277
278 WINPR_ATTR_NODISCARD
279 FREERDP_API SSIZE_T client_common_retry_dialog(freerdp* instance, const char* what,
280 size_t current, void* userarg);
281
291 WINPR_ATTR_NODISCARD
292 FREERDP_API BOOL client_common_save_session_info(rdpContext* context, UINT32 type,
293 const void* data);
294
295 FREERDP_API void
296 freerdp_client_OnChannelConnectedEventHandler(void* context,
297 const ChannelConnectedEventArgs* e);
298 FREERDP_API void
299 freerdp_client_OnChannelDisconnectedEventHandler(void* context,
300 const ChannelDisconnectedEventArgs* e);
301
302#if defined(WITH_FREERDP_DEPRECATED)
303 WINPR_DEPRECATED_VAR("Use client_cli_authenticate_ex",
304 WINPR_ATTR_NODISCARD FREERDP_API BOOL client_cli_authenticate(
305 freerdp* instance, char** username, char** password, char** domain));
306 WINPR_DEPRECATED_VAR("Use client_cli_authenticate_ex",
307 WINPR_ATTR_NODISCARD FREERDP_API BOOL client_cli_gw_authenticate(
308 freerdp* instance, char** username, char** password, char** domain));
309
310 WINPR_DEPRECATED_VAR("Use client_cli_verify_certificate_ex",
311 WINPR_ATTR_NODISCARD FREERDP_API DWORD client_cli_verify_certificate(
312 freerdp* instance, const char* common_name, const char* subject,
313 const char* issuer, const char* fingerprint, BOOL host_mismatch));
314#endif
315
316 WINPR_ATTR_NODISCARD
317 FREERDP_API DWORD client_cli_verify_certificate_ex(freerdp* instance, const char* host,
318 UINT16 port, const char* common_name,
319 const char* subject, const char* issuer,
320 const char* fingerprint, DWORD flags);
321
322#if defined(WITH_FREERDP_DEPRECATED)
323 WINPR_DEPRECATED_VAR(
324 "Use client_cli_verify_changed_certificate_ex",
325 WINPR_ATTR_NODISCARD FREERDP_API DWORD client_cli_verify_changed_certificate(
326 freerdp* instance, const char* common_name, const char* subject, const char* issuer,
327 const char* fingerprint, const char* old_subject, const char* old_issuer,
328 const char* old_fingerprint));
329#endif
330
331 WINPR_ATTR_NODISCARD
332 FREERDP_API DWORD client_cli_verify_changed_certificate_ex(
333 freerdp* instance, const char* host, UINT16 port, const char* common_name,
334 const char* subject, const char* issuer, const char* fingerprint, const char* old_subject,
335 const char* old_issuer, const char* old_fingerprint, DWORD flags);
336
337 WINPR_ATTR_NODISCARD
338 FREERDP_API BOOL client_cli_present_gateway_message(freerdp* instance, UINT32 type,
339 BOOL isDisplayMandatory,
340 BOOL isConsentMandatory, size_t length,
341 const WCHAR* message);
342
343 WINPR_ATTR_NODISCARD
344 FREERDP_API BOOL client_auto_reconnect(freerdp* instance);
345
346 WINPR_ATTR_NODISCARD
347 FREERDP_API BOOL client_auto_reconnect_ex(freerdp* instance,
348 BOOL (*window_events)(freerdp* instance));
349
350 typedef enum
351 {
352 FREERDP_TOUCH_DOWN = 0x01,
353 FREERDP_TOUCH_UP = 0x02,
354 FREERDP_TOUCH_MOTION = 0x04,
355 FREERDP_TOUCH_CANCEL = 0x08,
356 FREERDP_TOUCH_HAS_PRESSURE = 0x100
357 } FreeRDPTouchEventType;
358
359 FREERDP_API BOOL freerdp_client_handle_touch(rdpClientContext* cctx, UINT32 flags, INT32 finger,
360 UINT32 pressure, INT32 x, INT32 y);
361
362 typedef enum
363 {
364 FREERDP_PEN_REGISTER = 0x01,
365 FREERDP_PEN_ERASER_PRESSED = 0x02,
366 FREERDP_PEN_PRESS = 0x04,
367 FREERDP_PEN_MOTION = 0x08,
368 FREERDP_PEN_RELEASE = 0x10,
369 FREERDP_PEN_BARREL_PRESSED = 0x20,
370 FREERDP_PEN_HAS_PRESSURE = 0x40,
371 FREERDP_PEN_HAS_ROTATION = 0x80,
372 FREERDP_PEN_HAS_TILTX = 0x100,
373 FREERDP_PEN_HAS_TILTY = 0x200,
374 FREERDP_PEN_IS_INVERTED = 0x400
375 } FreeRDPPenEventType;
376
377 FREERDP_API BOOL freerdp_client_handle_pen(rdpClientContext* cctx, UINT32 flags, INT32 deviceid,
378 ...);
379 WINPR_ATTR_NODISCARD
380 FREERDP_API BOOL freerdp_client_is_pen(rdpClientContext* cctx, INT32 deviceid);
381
382 FREERDP_API BOOL freerdp_client_pen_cancel_all(rdpClientContext* cctx);
383
384 FREERDP_API BOOL freerdp_client_send_wheel_event(rdpClientContext* cctx, UINT16 mflags);
385
393 WINPR_ATTR_NODISCARD
394 FREERDP_API BOOL freerdp_client_use_relative_mouse_events(rdpClientContext* cctx);
395
396 FREERDP_API BOOL freerdp_client_send_button_event(rdpClientContext* cctx, BOOL relative,
397 UINT16 mflags, INT32 x, INT32 y);
398
399 FREERDP_API BOOL freerdp_client_send_extended_button_event(rdpClientContext* cctx,
400 BOOL relative, UINT16 mflags,
401 INT32 x, INT32 y);
402
403 WINPR_ATTR_NODISCARD
404 FREERDP_API int freerdp_client_common_stop(rdpContext* context);
405
406 WINPR_ATTR_NODISCARD
407 FREERDP_API BOOL freerdp_client_load_channels(freerdp* instance);
408
409#if defined(CHANNEL_ENCOMSP_CLIENT)
410 FREERDP_API BOOL freerdp_client_encomsp_toggle_control(EncomspClientContext* encomsp);
411
412 WINPR_ATTR_NODISCARD
413 FREERDP_API BOOL freerdp_client_encomsp_set_control(EncomspClientContext* encomsp,
414 BOOL control);
415#endif
416
420 typedef enum
421 {
422 FREERDP_CLIENT_AAD_AUTH_REQUEST,
423 FREERDP_CLIENT_AAD_TOKEN_REQUEST,
424 FREERDP_CLIENT_AAD_AVD_AUTH_REQUEST,
425 FREERDP_CLIENT_AAD_AVD_TOKEN_REQUEST,
426 } freerdp_client_aad_type;
427
434 WINPR_ATTR_MALLOC(winpr_zfree, 1)
435 FREERDP_API char* freerdp_client_get_aad_url(rdpClientContext* cctx,
436 freerdp_client_aad_type type, ...);
437
448 WINPR_ATTR_MALLOC(winpr_zfree, 1)
449 FREERDP_API char* freerdp_client_extract_aad_code(rdpClientContext* cctx, const char* data,
450 size_t length);
451
452#ifdef __cplusplus
453}
454#endif
455
456#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