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;
49
50#ifdef __cplusplus
51extern "C"
52{
53#endif
54
59 typedef BOOL (*pRdpGlobalInit)(void);
60 typedef void (*pRdpGlobalUninit)(void);
61
62 typedef BOOL (*pRdpClientNew)(freerdp* instance, rdpContext* context);
63 typedef void (*pRdpClientFree)(freerdp* instance, rdpContext* context);
64
65 typedef int (*pRdpClientStart)(rdpContext* context);
66 typedef int (*pRdpClientStop)(rdpContext* context);
67
68 struct rdp_client_entry_points_v1
69 {
70 DWORD Size;
71 DWORD Version;
72
73 rdpSettings* settings;
74
75 WINPR_ATTR_NODISCARD pRdpGlobalInit GlobalInit;
76 pRdpGlobalUninit GlobalUninit;
77
78 DWORD ContextSize;
79 WINPR_ATTR_NODISCARD pRdpClientNew ClientNew;
80 pRdpClientFree ClientFree;
81
82 WINPR_ATTR_NODISCARD pRdpClientStart ClientStart;
83 pRdpClientStop ClientStop;
84 };
85
86#define RDP_CLIENT_INTERFACE_VERSION 1
87#define RDP_CLIENT_ENTRY_POINT_NAME "RdpClientEntry"
88
89 typedef int (*pRdpClientEntry)(RDP_CLIENT_ENTRY_POINTS* pEntryPoints);
90
91 /* Common Client Interface */
92#define FREERDP_MAX_TOUCH_CONTACTS 10
93
94 typedef struct
95 {
96 ALIGN64 INT32 id;
97 ALIGN64 UINT32 count;
98 ALIGN64 INT32 x;
99 ALIGN64 INT32 y;
100 ALIGN64 UINT32 flags;
101 ALIGN64 UINT32 pressure;
102 } FreeRDP_TouchContact;
103
104#define FREERDP_MAX_PEN_DEVICES 10
105
106 typedef struct pen_device
107 {
108 ALIGN64 INT32 deviceid;
109 ALIGN64 UINT32 flags;
110 ALIGN64 double max_pressure;
111 ALIGN64 BOOL hovering;
112 ALIGN64 BOOL pressed;
113 ALIGN64 INT32 last_x;
114 ALIGN64 INT32 last_y;
115 } FreeRDP_PenDevice;
116
117 struct rdp_client_context
118 {
119 rdpContext context;
120 ALIGN64 HANDLE thread;
121#if defined(CHANNEL_AINPUT_CLIENT)
122 ALIGN64 AInputClientContext* ainput;
123#else
124 UINT64 reserved1;
125#endif
126
127#if defined(CHANNEL_RDPEI_CLIENT)
128 ALIGN64 RdpeiClientContext* rdpei;
129#else
130 UINT64 reserved2;
131#endif
132
133 ALIGN64 INT32 lastX;
134 ALIGN64 INT32 lastY;
135 ALIGN64 BOOL mouse_grabbed;
137#if defined(CHANNEL_ENCOMSP_CLIENT)
138 ALIGN64 EncomspClientContext* encomsp;
139 ALIGN64 BOOL controlToggle;
140#else
141 UINT64 reserved3[2];
142#endif
143 ALIGN64 FreeRDP_TouchContact contacts[FREERDP_MAX_TOUCH_CONTACTS];
144 ALIGN64 FreeRDP_PenDevice pens[FREERDP_MAX_PEN_DEVICES];
146 ALIGN64 MIBClientWrapper* mibClientWrapper;
147 ALIGN64 BOOL pressed_buttons[5];
148 UINT64 reserved[129 - 16];
149 };
150
151 /* Common client functions */
152
153 FREERDP_API void freerdp_client_context_free(rdpContext* context);
154
155 WINPR_ATTR_MALLOC(freerdp_client_context_free, 1)
156 WINPR_ATTR_NODISCARD
157 FREERDP_API rdpContext* freerdp_client_context_new(const RDP_CLIENT_ENTRY_POINTS* pEntryPoints);
158
159 WINPR_ATTR_NODISCARD
160 FREERDP_API int freerdp_client_start(rdpContext* context);
161
162 FREERDP_API int freerdp_client_stop(rdpContext* context);
163
164 WINPR_ATTR_NODISCARD
165 FREERDP_API freerdp* freerdp_client_get_instance(rdpContext* context);
166
167 WINPR_ATTR_NODISCARD
168 FREERDP_API HANDLE freerdp_client_get_thread(rdpContext* context);
169
170 WINPR_ATTR_NODISCARD
171 FREERDP_API int freerdp_client_settings_parse_command_line(rdpSettings* settings, int argc,
172 char** argv, BOOL allowUnknown);
173
187 WINPR_ATTR_NODISCARD
188 FREERDP_API int freerdp_client_settings_parse_command_line_ex(
189 rdpSettings* settings, int argc, char** argv, BOOL allowUnknown,
190 COMMAND_LINE_ARGUMENT_A* args, size_t count,
191 freerdp_command_line_handle_option_t handle_option, void* handle_userdata);
192
193 WINPR_ATTR_NODISCARD
194 FREERDP_API int freerdp_client_settings_parse_connection_file(rdpSettings* settings,
195 const char* filename);
196
197 WINPR_ATTR_NODISCARD
198 FREERDP_API int freerdp_client_settings_parse_connection_file_buffer(rdpSettings* settings,
199 const BYTE* buffer,
200 size_t size);
201
202 WINPR_ATTR_NODISCARD
203 FREERDP_API int freerdp_client_settings_write_connection_file(const rdpSettings* settings,
204 const char* filename,
205 BOOL unicode);
206
207 WINPR_ATTR_NODISCARD
208 FREERDP_API int freerdp_client_settings_parse_assistance_file(rdpSettings* settings, int argc,
209 char* argv[]);
210
211 WINPR_ATTR_NODISCARD
212 FREERDP_API BOOL client_cli_authenticate_ex(freerdp* instance, char** username, char** password,
213 char** domain, rdp_auth_reason reason);
214
215 WINPR_ATTR_NODISCARD
216 FREERDP_API BOOL client_cli_choose_smartcard(freerdp* instance, SmartcardCertInfo** cert_list,
217 DWORD count, DWORD* choice, BOOL gateway);
218
219 WINPR_ATTR_NODISCARD
220 FREERDP_API int client_cli_logon_error_info(freerdp* instance, UINT32 data, UINT32 type);
221
222 WINPR_ATTR_NODISCARD
223 FREERDP_API BOOL client_cli_get_access_token(freerdp* instance, AccessTokenType tokenType,
224 char** token, size_t count, ...);
225
226 WINPR_ATTR_NODISCARD
227 FREERDP_API BOOL client_common_get_access_token(freerdp* instance, const char* request,
228 char** token);
229
230 WINPR_ATTR_NODISCARD
231 FREERDP_API SSIZE_T client_common_retry_dialog(freerdp* instance, const char* what,
232 size_t current, void* userarg);
233
234 FREERDP_API void
235 freerdp_client_OnChannelConnectedEventHandler(void* context,
236 const ChannelConnectedEventArgs* e);
237 FREERDP_API void
238 freerdp_client_OnChannelDisconnectedEventHandler(void* context,
239 const ChannelDisconnectedEventArgs* e);
240
241#if defined(WITH_FREERDP_DEPRECATED)
242 WINPR_DEPRECATED_VAR("Use client_cli_authenticate_ex",
243 WINPR_ATTR_NODISCARD FREERDP_API BOOL client_cli_authenticate(
244 freerdp* instance, char** username, char** password, char** domain));
245 WINPR_DEPRECATED_VAR("Use client_cli_authenticate_ex",
246 WINPR_ATTR_NODISCARD FREERDP_API BOOL client_cli_gw_authenticate(
247 freerdp* instance, char** username, char** password, char** domain));
248
249 WINPR_DEPRECATED_VAR("Use client_cli_verify_certificate_ex",
250 WINPR_ATTR_NODISCARD FREERDP_API DWORD client_cli_verify_certificate(
251 freerdp* instance, const char* common_name, const char* subject,
252 const char* issuer, const char* fingerprint, BOOL host_mismatch));
253#endif
254
255 WINPR_ATTR_NODISCARD
256 FREERDP_API DWORD client_cli_verify_certificate_ex(freerdp* instance, const char* host,
257 UINT16 port, const char* common_name,
258 const char* subject, const char* issuer,
259 const char* fingerprint, DWORD flags);
260
261#if defined(WITH_FREERDP_DEPRECATED)
262 WINPR_DEPRECATED_VAR(
263 "Use client_cli_verify_changed_certificate_ex",
264 WINPR_ATTR_NODISCARD FREERDP_API DWORD client_cli_verify_changed_certificate(
265 freerdp* instance, const char* common_name, const char* subject, const char* issuer,
266 const char* fingerprint, const char* old_subject, const char* old_issuer,
267 const char* old_fingerprint));
268#endif
269
270 WINPR_ATTR_NODISCARD
271 FREERDP_API DWORD client_cli_verify_changed_certificate_ex(
272 freerdp* instance, const char* host, UINT16 port, const char* common_name,
273 const char* subject, const char* issuer, const char* fingerprint, const char* old_subject,
274 const char* old_issuer, const char* old_fingerprint, DWORD flags);
275
276 WINPR_ATTR_NODISCARD
277 FREERDP_API BOOL client_cli_present_gateway_message(freerdp* instance, UINT32 type,
278 BOOL isDisplayMandatory,
279 BOOL isConsentMandatory, size_t length,
280 const WCHAR* message);
281
282 WINPR_ATTR_NODISCARD
283 FREERDP_API BOOL client_auto_reconnect(freerdp* instance);
284
285 WINPR_ATTR_NODISCARD
286 FREERDP_API BOOL client_auto_reconnect_ex(freerdp* instance,
287 BOOL (*window_events)(freerdp* instance));
288
289 typedef enum
290 {
291 FREERDP_TOUCH_DOWN = 0x01,
292 FREERDP_TOUCH_UP = 0x02,
293 FREERDP_TOUCH_MOTION = 0x04,
294 FREERDP_TOUCH_CANCEL = 0x08,
295 FREERDP_TOUCH_HAS_PRESSURE = 0x100
296 } FreeRDPTouchEventType;
297
298 FREERDP_API BOOL freerdp_client_handle_touch(rdpClientContext* cctx, UINT32 flags, INT32 finger,
299 UINT32 pressure, INT32 x, INT32 y);
300
301 typedef enum
302 {
303 FREERDP_PEN_REGISTER = 0x01,
304 FREERDP_PEN_ERASER_PRESSED = 0x02,
305 FREERDP_PEN_PRESS = 0x04,
306 FREERDP_PEN_MOTION = 0x08,
307 FREERDP_PEN_RELEASE = 0x10,
308 FREERDP_PEN_BARREL_PRESSED = 0x20,
309 FREERDP_PEN_HAS_PRESSURE = 0x40,
310 FREERDP_PEN_HAS_ROTATION = 0x80,
311 FREERDP_PEN_HAS_TILTX = 0x100,
312 FREERDP_PEN_HAS_TILTY = 0x200,
313 FREERDP_PEN_IS_INVERTED = 0x400
314 } FreeRDPPenEventType;
315
316 FREERDP_API BOOL freerdp_client_handle_pen(rdpClientContext* cctx, UINT32 flags, INT32 deviceid,
317 ...);
318 WINPR_ATTR_NODISCARD
319 FREERDP_API BOOL freerdp_client_is_pen(rdpClientContext* cctx, INT32 deviceid);
320
321 FREERDP_API BOOL freerdp_client_pen_cancel_all(rdpClientContext* cctx);
322
323 FREERDP_API BOOL freerdp_client_send_wheel_event(rdpClientContext* cctx, UINT16 mflags);
324
332 WINPR_ATTR_NODISCARD
333 FREERDP_API BOOL freerdp_client_use_relative_mouse_events(rdpClientContext* cctx);
334
335 FREERDP_API BOOL freerdp_client_send_button_event(rdpClientContext* cctx, BOOL relative,
336 UINT16 mflags, INT32 x, INT32 y);
337
338 FREERDP_API BOOL freerdp_client_send_extended_button_event(rdpClientContext* cctx,
339 BOOL relative, UINT16 mflags,
340 INT32 x, INT32 y);
341
342 WINPR_ATTR_NODISCARD
343 FREERDP_API int freerdp_client_common_stop(rdpContext* context);
344
345 WINPR_ATTR_NODISCARD
346 FREERDP_API BOOL freerdp_client_load_channels(freerdp* instance);
347
348#if defined(CHANNEL_ENCOMSP_CLIENT)
349 FREERDP_API BOOL freerdp_client_encomsp_toggle_control(EncomspClientContext* encomsp);
350
351 WINPR_ATTR_NODISCARD
352 FREERDP_API BOOL freerdp_client_encomsp_set_control(EncomspClientContext* encomsp,
353 BOOL control);
354#endif
355
359 typedef enum
360 {
361 FREERDP_CLIENT_AAD_AUTH_REQUEST,
362 FREERDP_CLIENT_AAD_TOKEN_REQUEST,
363 FREERDP_CLIENT_AAD_AVD_AUTH_REQUEST,
364 FREERDP_CLIENT_AAD_AVD_TOKEN_REQUEST,
365 } freerdp_client_aad_type;
366
373 WINPR_ATTR_MALLOC(free, 1)
374 WINPR_ATTR_NODISCARD
375 FREERDP_API char* freerdp_client_get_aad_url(rdpClientContext* cctx,
376 freerdp_client_aad_type type, ...);
377
378#ifdef __cplusplus
379}
380#endif
381
382#endif /* FREERDP_CLIENT_H */
COMMAND_LINE_ARGUMENT_A
Definition winpr/include/winpr/cmdline.h:100
FreeRDP_PenDevice
Definition include/freerdp/client.h:107
FreeRDP_TouchContact
Definition include/freerdp/client.h:95
rdp_client_context
Definition include/freerdp/client.h:118
rdp_client_context::reserved3
UINT64 reserved3[2]
Definition include/freerdp/client.h:141
rdp_client_context::mibClientWrapper
ALIGN64 MIBClientWrapper * mibClientWrapper
Definition include/freerdp/client.h:146
rdp_client_context::reserved
UINT64 reserved[129 - 16]
Definition include/freerdp/client.h:148
rdp_client_context::contacts
ALIGN64 FreeRDP_TouchContact contacts[FREERDP_MAX_TOUCH_CONTACTS]
Definition include/freerdp/client.h:143
rdp_client_context::pressed_buttons
ALIGN64 BOOL pressed_buttons[5]
Definition include/freerdp/client.h:147
rdp_client_context::pens
ALIGN64 FreeRDP_PenDevice pens[FREERDP_MAX_PEN_DEVICES]
Definition include/freerdp/client.h:144
rdp_client_context::lastX
ALIGN64 INT32 lastX
Definition include/freerdp/client.h:133
rdp_client_context::lastY
ALIGN64 INT32 lastY
Definition include/freerdp/client.h:134
rdp_client_context::thread
ALIGN64 HANDLE thread
Definition include/freerdp/client.h:120
rdp_client_entry_points_v1
Definition include/freerdp/client.h:69