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
173 WINPR_ATTR_NODISCARD
174 FREERDP_API freerdp* freerdp_client_get_instance(rdpContext* context);
175
176 WINPR_ATTR_NODISCARD
177 FREERDP_API HANDLE freerdp_client_get_thread(rdpContext* context);
178
179 WINPR_ATTR_NODISCARD
180 FREERDP_API int freerdp_client_settings_parse_command_line(rdpSettings* settings, int argc,
181 char** argv, BOOL allowUnknown);
182
196 WINPR_ATTR_NODISCARD
197 FREERDP_API int freerdp_client_settings_parse_command_line_ex(
198 rdpSettings* settings, int argc, char** argv, BOOL allowUnknown,
199 COMMAND_LINE_ARGUMENT_A* args, size_t count,
200 freerdp_command_line_handle_option_t handle_option, void* handle_userdata);
201
202 WINPR_ATTR_NODISCARD
203 FREERDP_API int freerdp_client_settings_parse_connection_file(rdpSettings* settings,
204 const char* filename);
205
206 WINPR_ATTR_NODISCARD
207 FREERDP_API int freerdp_client_settings_parse_connection_file_buffer(rdpSettings* settings,
208 const BYTE* buffer,
209 size_t size);
210
211 WINPR_ATTR_NODISCARD
212 FREERDP_API int freerdp_client_settings_write_connection_file(const rdpSettings* settings,
213 const char* filename,
214 BOOL unicode);
215
216 WINPR_ATTR_NODISCARD
217 FREERDP_API int freerdp_client_settings_parse_assistance_file(rdpSettings* settings, int argc,
218 char* argv[]);
219
220 WINPR_ATTR_NODISCARD
221 FREERDP_API BOOL client_cli_authenticate_ex(freerdp* instance, char** username, char** password,
222 char** domain, rdp_auth_reason reason);
223
224 WINPR_ATTR_NODISCARD
225 FREERDP_API BOOL client_cli_choose_smartcard(freerdp* instance, SmartcardCertInfo** cert_list,
226 DWORD count, DWORD* choice, BOOL gateway);
227
228 WINPR_ATTR_NODISCARD
229 FREERDP_API int client_cli_logon_error_info(freerdp* instance, UINT32 data, UINT32 type);
230
242 WINPR_ATTR_NODISCARD
243 FREERDP_API BOOL client_failsafe_get_access_token(freerdp* instance, AccessTokenType tokenType,
244 char** token, size_t count, ...);
245
257 WINPR_ATTR_NODISCARD
258 FREERDP_API BOOL client_helper_get_access_token(freerdp* instance, AccessTokenType tokenType,
259 char** token, size_t count, ...);
260
272 WINPR_ATTR_NODISCARD
273 FREERDP_API BOOL client_cli_get_access_token(freerdp* instance, AccessTokenType tokenType,
274 char** token, size_t count, ...);
275
276 WINPR_ATTR_NODISCARD
277 FREERDP_API BOOL client_common_get_access_token(freerdp* instance, const char* request,
278 char** token);
279
280 WINPR_ATTR_NODISCARD
281 FREERDP_API SSIZE_T client_common_retry_dialog(freerdp* instance, const char* what,
282 size_t current, void* userarg);
283
293 WINPR_ATTR_NODISCARD
294 FREERDP_API BOOL client_common_save_session_info(rdpContext* context, UINT32 type,
295 const void* data);
296
297 FREERDP_API void
298 freerdp_client_OnChannelConnectedEventHandler(void* context,
299 const ChannelConnectedEventArgs* e);
300 FREERDP_API void
301 freerdp_client_OnChannelDisconnectedEventHandler(void* context,
302 const ChannelDisconnectedEventArgs* e);
303
304#if defined(WITH_FREERDP_DEPRECATED)
305 WINPR_DEPRECATED_VAR("Use client_cli_authenticate_ex",
306 WINPR_ATTR_NODISCARD FREERDP_API BOOL client_cli_authenticate(
307 freerdp* instance, char** username, char** password, char** domain));
308 WINPR_DEPRECATED_VAR("Use client_cli_authenticate_ex",
309 WINPR_ATTR_NODISCARD FREERDP_API BOOL client_cli_gw_authenticate(
310 freerdp* instance, char** username, char** password, char** domain));
311
312 WINPR_DEPRECATED_VAR("Use client_cli_verify_certificate_ex",
313 WINPR_ATTR_NODISCARD FREERDP_API DWORD client_cli_verify_certificate(
314 freerdp* instance, const char* common_name, const char* subject,
315 const char* issuer, const char* fingerprint, BOOL host_mismatch));
316#endif
317
318 WINPR_ATTR_NODISCARD
319 FREERDP_API DWORD client_cli_verify_certificate_ex(freerdp* instance, const char* host,
320 UINT16 port, const char* common_name,
321 const char* subject, const char* issuer,
322 const char* fingerprint, DWORD flags);
323
324#if defined(WITH_FREERDP_DEPRECATED)
325 WINPR_DEPRECATED_VAR(
326 "Use client_cli_verify_changed_certificate_ex",
327 WINPR_ATTR_NODISCARD FREERDP_API DWORD client_cli_verify_changed_certificate(
328 freerdp* instance, const char* common_name, const char* subject, const char* issuer,
329 const char* fingerprint, const char* old_subject, const char* old_issuer,
330 const char* old_fingerprint));
331#endif
332
333 WINPR_ATTR_NODISCARD
334 FREERDP_API DWORD client_cli_verify_changed_certificate_ex(
335 freerdp* instance, const char* host, UINT16 port, const char* common_name,
336 const char* subject, const char* issuer, const char* fingerprint, const char* old_subject,
337 const char* old_issuer, const char* old_fingerprint, DWORD flags);
338
339 WINPR_ATTR_NODISCARD
340 FREERDP_API BOOL client_cli_present_gateway_message(freerdp* instance, UINT32 type,
341 BOOL isDisplayMandatory,
342 BOOL isConsentMandatory, size_t length,
343 const WCHAR* message);
344
345 WINPR_ATTR_NODISCARD
346 FREERDP_API BOOL client_auto_reconnect(freerdp* instance);
347
355 WINPR_ATTR_NODISCARD
356 FREERDP_API BOOL client_auto_reconnect_ex(freerdp* instance, window_events_fkt_t window_events);
357
358 typedef enum
359 {
360 FREERDP_TOUCH_DOWN = 0x01,
361 FREERDP_TOUCH_UP = 0x02,
362 FREERDP_TOUCH_MOTION = 0x04,
363 FREERDP_TOUCH_CANCEL = 0x08,
364 FREERDP_TOUCH_HAS_PRESSURE = 0x100
365 } FreeRDPTouchEventType;
366
367 FREERDP_API BOOL freerdp_client_handle_touch(rdpClientContext* cctx, UINT32 flags, INT32 finger,
368 UINT32 pressure, INT32 x, INT32 y);
369
370 typedef enum
371 {
372 FREERDP_PEN_REGISTER = 0x01,
373 FREERDP_PEN_ERASER_PRESSED = 0x02,
374 FREERDP_PEN_PRESS = 0x04,
375 FREERDP_PEN_MOTION = 0x08,
376 FREERDP_PEN_RELEASE = 0x10,
377 FREERDP_PEN_BARREL_PRESSED = 0x20,
378 FREERDP_PEN_HAS_PRESSURE = 0x40,
379 FREERDP_PEN_HAS_ROTATION = 0x80,
380 FREERDP_PEN_HAS_TILTX = 0x100,
381 FREERDP_PEN_HAS_TILTY = 0x200,
382 FREERDP_PEN_IS_INVERTED = 0x400
383 } FreeRDPPenEventType;
384
385 FREERDP_API BOOL freerdp_client_handle_pen(rdpClientContext* cctx, UINT32 flags, INT32 deviceid,
386 ...);
387 WINPR_ATTR_NODISCARD
388 FREERDP_API BOOL freerdp_client_is_pen(rdpClientContext* cctx, INT32 deviceid);
389
390 FREERDP_API BOOL freerdp_client_pen_cancel_all(rdpClientContext* cctx);
391
392 FREERDP_API BOOL freerdp_client_send_wheel_event(rdpClientContext* cctx, UINT16 mflags);
393
401 WINPR_ATTR_NODISCARD
402 FREERDP_API BOOL freerdp_client_use_relative_mouse_events(rdpClientContext* cctx);
403
404 FREERDP_API BOOL freerdp_client_send_button_event(rdpClientContext* cctx, BOOL relative,
405 UINT16 mflags, INT32 x, INT32 y);
406
407 FREERDP_API BOOL freerdp_client_send_extended_button_event(rdpClientContext* cctx,
408 BOOL relative, UINT16 mflags,
409 INT32 x, INT32 y);
410
411 WINPR_ATTR_NODISCARD
412 FREERDP_API int freerdp_client_common_stop(rdpContext* context);
413
414 WINPR_ATTR_NODISCARD
415 FREERDP_API BOOL freerdp_client_load_channels(freerdp* instance);
416
417#if defined(CHANNEL_ENCOMSP_CLIENT)
418 FREERDP_API BOOL freerdp_client_encomsp_toggle_control(EncomspClientContext* encomsp);
419
420 WINPR_ATTR_NODISCARD
421 FREERDP_API BOOL freerdp_client_encomsp_set_control(EncomspClientContext* encomsp,
422 BOOL control);
423#endif
424
428 typedef enum
429 {
430 FREERDP_CLIENT_AAD_AUTH_REQUEST,
431 FREERDP_CLIENT_AAD_TOKEN_REQUEST,
432 FREERDP_CLIENT_AAD_AVD_AUTH_REQUEST,
433 FREERDP_CLIENT_AAD_AVD_TOKEN_REQUEST,
434 } freerdp_client_aad_type;
435
442 WINPR_ATTR_MALLOC(winpr_zfree, 1)
443 FREERDP_API char* freerdp_client_get_aad_url(rdpClientContext* cctx,
444 freerdp_client_aad_type type, ...);
445
456 WINPR_ATTR_MALLOC(winpr_zfree, 1)
457 FREERDP_API char* freerdp_client_extract_aad_code(rdpClientContext* cctx, const char* data,
458 size_t length);
459
460#ifdef __cplusplus
461}
462#endif
463
464#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