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 pRdpGlobalInit GlobalInit;
76 pRdpGlobalUninit GlobalUninit;
77
78 DWORD ContextSize;
79 pRdpClientNew ClientNew;
80 pRdpClientFree ClientFree;
81
82 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 UINT64 reserved[129 - 11];
148 };
149
150 /* Common client functions */
151
152 FREERDP_API void freerdp_client_context_free(rdpContext* context);
153
154 WINPR_ATTR_MALLOC(freerdp_client_context_free, 1)
155 FREERDP_API rdpContext* freerdp_client_context_new(const RDP_CLIENT_ENTRY_POINTS* pEntryPoints);
156
157 FREERDP_API int freerdp_client_start(rdpContext* context);
158 FREERDP_API int freerdp_client_stop(rdpContext* context);
159
160 FREERDP_API freerdp* freerdp_client_get_instance(rdpContext* context);
161 FREERDP_API HANDLE freerdp_client_get_thread(rdpContext* context);
162
163 FREERDP_API int freerdp_client_settings_parse_command_line(rdpSettings* settings, int argc,
164 char** argv, BOOL allowUnknown);
165
179 FREERDP_API int freerdp_client_settings_parse_command_line_ex(
180 rdpSettings* settings, int argc, char** argv, BOOL allowUnknown,
181 COMMAND_LINE_ARGUMENT_A* args, size_t count,
182 freerdp_command_line_handle_option_t handle_option, void* handle_userdata);
183
184 FREERDP_API int freerdp_client_settings_parse_connection_file(rdpSettings* settings,
185 const char* filename);
186 FREERDP_API int freerdp_client_settings_parse_connection_file_buffer(rdpSettings* settings,
187 const BYTE* buffer,
188 size_t size);
189 FREERDP_API int freerdp_client_settings_write_connection_file(const rdpSettings* settings,
190 const char* filename,
191 BOOL unicode);
192
193 FREERDP_API int freerdp_client_settings_parse_assistance_file(rdpSettings* settings, int argc,
194 char* argv[]);
195
196 FREERDP_API BOOL client_cli_authenticate_ex(freerdp* instance, char** username, char** password,
197 char** domain, rdp_auth_reason reason);
198
199 FREERDP_API BOOL client_cli_choose_smartcard(freerdp* instance, SmartcardCertInfo** cert_list,
200 DWORD count, DWORD* choice, BOOL gateway);
201
202 FREERDP_API int client_cli_logon_error_info(freerdp* instance, UINT32 data, UINT32 type);
203
204 FREERDP_API BOOL client_cli_get_access_token(freerdp* instance, AccessTokenType tokenType,
205 char** token, size_t count, ...);
206 FREERDP_API BOOL client_common_get_access_token(freerdp* instance, const char* request,
207 char** token);
208
209 FREERDP_API SSIZE_T client_common_retry_dialog(freerdp* instance, const char* what,
210 size_t current, void* userarg);
211
212 FREERDP_API void
213 freerdp_client_OnChannelConnectedEventHandler(void* context,
214 const ChannelConnectedEventArgs* e);
215 FREERDP_API void
216 freerdp_client_OnChannelDisconnectedEventHandler(void* context,
217 const ChannelDisconnectedEventArgs* e);
218
219#if defined(WITH_FREERDP_DEPRECATED)
220 WINPR_DEPRECATED_VAR("Use client_cli_authenticate_ex",
221 FREERDP_API BOOL client_cli_authenticate(freerdp* instance,
222 char** username, char** password,
223 char** domain));
224 WINPR_DEPRECATED_VAR("Use client_cli_authenticate_ex",
225 FREERDP_API BOOL client_cli_gw_authenticate(
226 freerdp* instance, char** username, char** password, char** domain));
227
228 WINPR_DEPRECATED_VAR("Use client_cli_verify_certificate_ex",
229 FREERDP_API DWORD client_cli_verify_certificate(
230 freerdp* instance, const char* common_name, const char* subject,
231 const char* issuer, const char* fingerprint, BOOL host_mismatch));
232#endif
233
234 FREERDP_API DWORD client_cli_verify_certificate_ex(freerdp* instance, const char* host,
235 UINT16 port, const char* common_name,
236 const char* subject, const char* issuer,
237 const char* fingerprint, DWORD flags);
238
239#if defined(WITH_FREERDP_DEPRECATED)
240 WINPR_DEPRECATED_VAR("Use client_cli_verify_changed_certificate_ex",
241 FREERDP_API DWORD client_cli_verify_changed_certificate(
242 freerdp* instance, const char* common_name, const char* subject,
243 const char* issuer, const char* fingerprint, const char* old_subject,
244 const char* old_issuer, const char* old_fingerprint));
245#endif
246
247 FREERDP_API DWORD client_cli_verify_changed_certificate_ex(
248 freerdp* instance, const char* host, UINT16 port, const char* common_name,
249 const char* subject, const char* issuer, const char* fingerprint, const char* old_subject,
250 const char* old_issuer, const char* old_fingerprint, DWORD flags);
251
252 FREERDP_API BOOL client_cli_present_gateway_message(freerdp* instance, UINT32 type,
253 BOOL isDisplayMandatory,
254 BOOL isConsentMandatory, size_t length,
255 const WCHAR* message);
256
257 FREERDP_API BOOL client_auto_reconnect(freerdp* instance);
258 FREERDP_API BOOL client_auto_reconnect_ex(freerdp* instance,
259 BOOL (*window_events)(freerdp* instance));
260
261 typedef enum
262 {
263 FREERDP_TOUCH_DOWN = 0x01,
264 FREERDP_TOUCH_UP = 0x02,
265 FREERDP_TOUCH_MOTION = 0x04,
266 FREERDP_TOUCH_HAS_PRESSURE = 0x100
267 } FreeRDPTouchEventType;
268
269 FREERDP_API BOOL freerdp_client_handle_touch(rdpClientContext* cctx, UINT32 flags, INT32 finger,
270 UINT32 pressure, INT32 x, INT32 y);
271
272 typedef enum
273 {
274 FREERDP_PEN_REGISTER = 0x01,
275 FREERDP_PEN_ERASER_PRESSED = 0x02,
276 FREERDP_PEN_PRESS = 0x04,
277 FREERDP_PEN_MOTION = 0x08,
278 FREERDP_PEN_RELEASE = 0x10,
279 FREERDP_PEN_BARREL_PRESSED = 0x20,
280 FREERDP_PEN_HAS_PRESSURE = 0x40,
281 FREERDP_PEN_HAS_ROTATION = 0x80,
282 FREERDP_PEN_HAS_TILTX = 0x100,
283 FREERDP_PEN_HAS_TILTY = 0x200,
284 FREERDP_PEN_IS_INVERTED = 0x400
285 } FreeRDPPenEventType;
286
287 FREERDP_API BOOL freerdp_client_handle_pen(rdpClientContext* cctx, UINT32 flags, INT32 deviceid,
288 ...);
289 FREERDP_API BOOL freerdp_client_is_pen(rdpClientContext* cctx, INT32 deviceid);
290
291 FREERDP_API BOOL freerdp_client_pen_cancel_all(rdpClientContext* cctx);
292
293 FREERDP_API BOOL freerdp_client_send_wheel_event(rdpClientContext* cctx, UINT16 mflags);
294
295 FREERDP_API BOOL freerdp_client_send_mouse_event(rdpClientContext* cctx, UINT64 mflags, INT32 x,
296 INT32 y);
297
305 FREERDP_API BOOL freerdp_client_use_relative_mouse_events(rdpClientContext* cctx);
306
307 FREERDP_API BOOL freerdp_client_send_button_event(rdpClientContext* cctx, BOOL relative,
308 UINT16 mflags, INT32 x, INT32 y);
309
310 FREERDP_API BOOL freerdp_client_send_extended_button_event(rdpClientContext* cctx,
311 BOOL relative, UINT16 mflags,
312 INT32 x, INT32 y);
313
314 FREERDP_API int freerdp_client_common_stop(rdpContext* context);
315
316 FREERDP_API BOOL freerdp_client_load_channels(freerdp* instance);
317
318#if defined(CHANNEL_ENCOMSP_CLIENT)
319 FREERDP_API BOOL freerdp_client_encomsp_toggle_control(EncomspClientContext* encomsp);
320 FREERDP_API BOOL freerdp_client_encomsp_set_control(EncomspClientContext* encomsp,
321 BOOL control);
322#endif
323
327 typedef enum
328 {
329 FREERDP_CLIENT_AAD_AUTH_REQUEST,
330 FREERDP_CLIENT_AAD_TOKEN_REQUEST,
331 FREERDP_CLIENT_AAD_AVD_AUTH_REQUEST,
332 FREERDP_CLIENT_AAD_AVD_TOKEN_REQUEST,
333 } freerdp_client_aad_type;
334
341 WINPR_ATTR_MALLOC(free, 1)
342 FREERDP_API char* freerdp_client_get_aad_url(rdpClientContext* cctx,
343 freerdp_client_aad_type type, ...);
344
345#ifdef __cplusplus
346}
347#endif
348
349#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::contacts
ALIGN64 FreeRDP_TouchContact contacts[FREERDP_MAX_TOUCH_CONTACTS]
Definition include/freerdp/client.h:143
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::reserved
UINT64 reserved[129 - 11]
Definition include/freerdp/client.h:147
rdp_client_context::thread
ALIGN64 HANDLE thread
Definition include/freerdp/client.h:120
rdp_client_entry_points_v1
Definition include/freerdp/client.h:69