25#include <winpr/stream.h>
26#include <winpr/sspi.h>
28#include <freerdp/api.h>
29#include <freerdp/types.h>
30#include <freerdp/error.h>
31#include <freerdp/event.h>
33#include <freerdp/settings.h>
35#include <freerdp/gdi/gdi.h>
36#include <freerdp/codecs.h>
37#include <freerdp/metrics.h>
38#include <freerdp/extension.h>
39#include <freerdp/heartbeat.h>
40#include <freerdp/message.h>
41#include <freerdp/autodetect.h>
42#include <freerdp/streamdump.h>
50 typedef struct rdp_rail rdpRail;
55 typedef RDP_CLIENT_ENTRY_POINTS_V1 RDP_CLIENT_ENTRY_POINTS;
57#include <freerdp/utils/smartcardlogon.h>
58#include <freerdp/update.h>
59#include <freerdp/input.h>
60#include <freerdp/graphics.h>
62#define MCS_BASE_CHANNEL_ID 1001
63#define MCS_GLOBAL_CHANNEL_ID 1003
66#define VERIFY_CERT_FLAG_NONE 0x00
67#define VERIFY_CERT_FLAG_LEGACY 0x02
68#define VERIFY_CERT_FLAG_REDIRECT 0x10
69#define VERIFY_CERT_FLAG_GATEWAY 0x20
70#define VERIFY_CERT_FLAG_CHANGED 0x40
71#define VERIFY_CERT_FLAG_MISMATCH 0x80
72#define VERIFY_CERT_FLAG_MATCH_LEGACY_SHA1 0x100
73#define VERIFY_CERT_FLAG_FP_IS_PEM 0x200
76#define GATEWAY_MESSAGE_CONSENT 1
77#define GATEWAY_MESSAGE_SERVICE 2
92 typedef BOOL (*pContextNew)(freerdp* instance, rdpContext* context);
93 typedef void (*pContextFree)(freerdp* instance, rdpContext* context);
95 typedef BOOL (*pConnectCallback)(freerdp* instance);
96 typedef void (*pPostDisconnect)(freerdp* instance);
111 typedef BOOL (*pAuthenticate)(freerdp* instance,
char** username,
char** password,
135 typedef BOOL (*pAuthenticateEx)(freerdp* instance,
char** username,
char** password,
136 char** domain, rdp_auth_reason reason);
156 typedef BOOL (*pChooseSmartcard)(freerdp* instance,
SmartcardCertInfo** cert_list, DWORD count,
157 DWORD* choice, BOOL gateway);
161 ACCESS_TOKEN_TYPE_AAD,
162 ACCESS_TOKEN_TYPE_AVD
175 typedef BOOL (*pGetAccessToken)(freerdp* instance, AccessTokenType tokenType,
char** token,
191 typedef BOOL (*pGetCommonAccessToken)(rdpContext* context, AccessTokenType tokenType,
192 char** token,
size_t count, ...);
205 typedef SSIZE_T (*pRetryDialog)(freerdp* instance,
const char* what,
size_t current,
223#if defined(WITH_FREERDP_DEPRECATED)
224 WINPR_DEPRECATED_VAR(
"Use pVerifyCertificateEx",
225 typedef DWORD (*pVerifyCertificate)(
226 freerdp* instance,
const char* common_name,
const char* subject,
227 const char* issuer,
const char* fingerprint, BOOL host_mismatch));
245 typedef DWORD (*pVerifyCertificateEx)(freerdp* instance,
const char* host, UINT16 port,
246 const char* common_name,
const char* subject,
247 const char* issuer,
const char* fingerprint, DWORD flags);
264#if defined(WITH_FREERDP_DEPRECATED)
265 WINPR_DEPRECATED_VAR(
"Use pVerifyChangedCertificateEx",
266 typedef DWORD (*pVerifyChangedCertificate)(
267 freerdp* instance,
const char* common_name,
const char* subject,
268 const char* issuer,
const char* new_fingerprint,
269 const char* old_subject,
const char* old_issuer,
270 const char* old_fingerprint));
293 typedef DWORD (*pVerifyChangedCertificateEx)(freerdp* instance,
const char* host, UINT16 port,
294 const char* common_name,
const char* subject,
295 const char* issuer,
const char* new_fingerprint,
296 const char* old_subject,
const char* old_issuer,
297 const char* old_fingerprint, DWORD flags);
312 typedef int (*pVerifyX509Certificate)(freerdp* instance,
const BYTE* data,
size_t length,
313 const char* hostname, UINT16 port, DWORD flags);
315 typedef int (*pLogonErrorInfo)(freerdp* instance, UINT32 data, UINT32 type);
317 typedef BOOL (*pSendChannelData)(freerdp* instance, UINT16 channelId,
const BYTE* data,
319 typedef BOOL (*pSendChannelPacket)(freerdp* instance, UINT16 channelId,
size_t totalSize,
320 UINT32 flags,
const BYTE* data,
size_t chunkSize);
321 typedef BOOL (*pReceiveChannelData)(freerdp* instance, UINT16 channelId,
const BYTE* data,
322 size_t size, UINT32 flags,
size_t totalSize);
325 typedef BOOL (*pPresentGatewayMessage)(freerdp* instance, UINT32 type, BOOL isDisplayMandatory,
326 BOOL isConsentMandatory,
size_t length,
327 const WCHAR* message);
346 ALIGN64 UINT32 LastError;
348 UINT64 paddingA[16 - 4];
361 ALIGN64 wPubSub* pubSub;
363 ALIGN64 HANDLE channelErrorEvent;
364 ALIGN64 UINT channelErrorNum;
365 ALIGN64
char* errorDescription;
367 UINT64 paddingB[32 - 22];
379 ALIGN64 rdpRail* rail;
380 ALIGN64 rdpCache* cache;
381 ALIGN64 rdpChannels* channels;
382 ALIGN64 rdpGraphics* graphics;
383 ALIGN64 rdpInput* input;
384 ALIGN64 rdpUpdate* update;
385 ALIGN64 rdpSettings* settings;
386 ALIGN64 rdpMetrics* metrics;
387 ALIGN64 rdpCodecs* codecs;
388 ALIGN64 rdpAutoDetect* autodetect;
389 UINT64 paddingC1[45 - 44];
390 ALIGN64
int disconnectUltimatum;
391 UINT64 paddingC[64 - 46];
393 ALIGN64 rdpStreamDumpContext* dump;
396 UINT64 paddingD[96 - 66];
397 UINT64 paddingE[128 - 96];
407 enum Disconnect_Ultimatum
409 Disconnect_Ultimatum_domain_disconnected = 0,
410 Disconnect_Ultimatum_provider_initiated = 1,
411 Disconnect_Ultimatum_token_purged = 2,
412 Disconnect_Ultimatum_user_requested = 3,
413 Disconnect_Ultimatum_channel_purged = 4
416#include <freerdp/client.h>
438 ALIGN64 RDP_CLIENT_ENTRY_POINTS* pClientEntryPoints;
440 UINT64 paddingA[16 - 2];
442#if defined(WITH_FREERDP_DEPRECATED)
443 WINPR_DEPRECATED_VAR(
"use rdpContext::input instead", ALIGN64 rdpInput* input;)
446 WINPR_DEPRECATED_VAR(
"use rdpContext::update instead",
447 ALIGN64 rdpUpdate* update;)
450 WINPR_DEPRECATED_VAR(
"use rdpContext::settings instead",
451 ALIGN64 rdpSettings* settings;)
457 WINPR_DEPRECATED_VAR(
"use rdpContext::autodetect instead",
458 ALIGN64 rdpAutoDetect* autodetect;)
465 ALIGN64 rdpHeartbeat* heartbeat;
467 UINT64 paddingB[32 - 21];
480 WINPR_ATTR_NODISCARD ALIGN64 pContextNew
491 UINT64 paddingC[47 - 35];
493 ALIGN64 UINT ConnectionCallbackState;
495 WINPR_ATTR_NODISCARD ALIGN64 pConnectCallback
501 WINPR_ATTR_NODISCARD ALIGN64 pConnectCallback
507#if defined(WITH_FREERDP_DEPRECATED)
508 WINPR_DEPRECATED_VAR(
"[since 3.25.0] Use AuthenticateEx instead",
509 WINPR_ATTR_NODISCARD ALIGN64 pAuthenticate
515 WINPR_DEPRECATED_VAR(
"Use VerifyCertificateEx or VerifyX509Certificate instead",
516 WINPR_ATTR_NODISCARD ALIGN64 pVerifyCertificate
518 WINPR_DEPRECATED_VAR(
"Use VerifyChangedCertificateEx or VerifyX509Certificate instead",
519 WINPR_ATTR_NODISCARD ALIGN64 pVerifyChangedCertificate
520 VerifyChangedCertificate;)
522 ALIGN64 UINT64 reserved50[3];
524 WINPR_ATTR_NODISCARD ALIGN64 pVerifyX509Certificate
528 WINPR_ATTR_NODISCARD ALIGN64 pLogonErrorInfo
532 ALIGN64 pPostDisconnect
540#if defined(WITH_FREERDP_DEPRECATED)
541 WINPR_DEPRECATED_VAR(
"[since 3.25.0] Use AuthenticateEx instead",
542 WINPR_ATTR_NODISCARD ALIGN64 pAuthenticate
543 GatewayAuthenticate);
548 ALIGN64 UINT64 reserved56[1];
554 WINPR_ATTR_NODISCARD ALIGN64 pConnectCallback
Redirect;
560 WINPR_ATTR_NODISCARD ALIGN64 pConnectCallback
565 ALIGN64 pPostDisconnect
574 WINPR_ATTR_NODISCARD ALIGN64 pSendChannelData
579 WINPR_ATTR_NODISCARD ALIGN64 pReceiveChannelData
586 WINPR_ATTR_NODISCARD ALIGN64 pVerifyCertificateEx
590 WINPR_ATTR_NODISCARD ALIGN64 pVerifyChangedCertificateEx
594 WINPR_ATTR_NODISCARD ALIGN64 pSendChannelPacket
604 WINPR_ATTR_NODISCARD ALIGN64 pChooseSmartcard
609 WINPR_ATTR_NODISCARD ALIGN64 pGetAccessToken GetAccessToken;
612 WINPR_ATTR_NODISCARD ALIGN64 pRetryDialog
615 UINT64 paddingE[80 - 73];
620 wListDictionary* init;
621 wListDictionary* open;
625 FREERDP_API
void freerdp_context_free(freerdp* instance);
628 FREERDP_API BOOL freerdp_context_new(freerdp* instance);
631 FREERDP_API BOOL freerdp_context_new_ex(freerdp* instance, rdpSettings* settings);
634 FREERDP_API BOOL freerdp_context_reset(freerdp* instance);
637 FREERDP_API BOOL freerdp_connect(freerdp* instance);
639#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
640 WINPR_DEPRECATED_VAR(
"use freerdp_abort_connect_context instead",
641 FREERDP_API BOOL freerdp_abort_connect(freerdp* instance));
644 FREERDP_API BOOL freerdp_abort_connect_context(rdpContext* context);
647 FREERDP_API HANDLE freerdp_abort_event(rdpContext* context);
649#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
650 WINPR_DEPRECATED_VAR(
"use freerdp_shall_disconnect_context instead",
651 WINPR_ATTR_NODISCARD FREERDP_API BOOL
652 freerdp_shall_disconnect(
const freerdp* instance));
656 FREERDP_API BOOL freerdp_shall_disconnect_context(
const rdpContext* context);
658 FREERDP_API BOOL freerdp_disconnect(freerdp* instance);
669 FREERDP_API
const char* freerdp_disconnect_reason_string(
int reason);
671#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
672 WINPR_DEPRECATED_VAR(
"use freerdp_disconnect_before_reconnect_context instead",
673 WINPR_ATTR_NODISCARD FREERDP_API BOOL
674 freerdp_disconnect_before_reconnect(freerdp* instance));
678 FREERDP_API BOOL freerdp_disconnect_before_reconnect_context(rdpContext* context);
681 FREERDP_API BOOL freerdp_reconnect(freerdp* instance);
684 FREERDP_API UINT freerdp_channels_attach(freerdp* instance);
687 FREERDP_API UINT freerdp_channels_detach(freerdp* instance);
689#if defined(WITH_FREERDP_DEPRECATED)
690 WINPR_DEPRECATED_VAR(
"Use freerdp_get_event_handles",
691 WINPR_ATTR_NODISCARD FREERDP_API BOOL
692 freerdp_get_fds(freerdp* instance,
void** rfds,
int* rcount,
693 void** wfds,
int* wcount));
697 FREERDP_API BOOL freerdp_check_fds(freerdp* instance);
700 FREERDP_API DWORD freerdp_get_event_handles(rdpContext* context, HANDLE* events, DWORD count);
703 FREERDP_API BOOL freerdp_check_event_handles(rdpContext* context);
706 FREERDP_API wMessageQueue* freerdp_get_message_queue(freerdp* instance, DWORD
id);
709 FREERDP_API HANDLE freerdp_get_message_queue_event_handle(freerdp* instance, DWORD
id);
712 FREERDP_API
int freerdp_message_queue_process_message(freerdp* instance, DWORD
id,
716 FREERDP_API
int freerdp_message_queue_process_pending_messages(freerdp* instance, DWORD
id);
719 FREERDP_API UINT32 freerdp_error_info(
const freerdp* instance);
721 FREERDP_API
void freerdp_set_error_info(rdpRdp* rdp, UINT32 error);
724 FREERDP_API BOOL freerdp_send_error_info(rdpRdp* rdp);
727 FREERDP_API BOOL freerdp_get_stats(
const rdpRdp* rdp, UINT64* inBytes, UINT64* outBytes,
728 UINT64* inPackets, UINT64* outPackets);
730 FREERDP_API
void freerdp_get_version(
int* major,
int* minor,
int* revision);
733 FREERDP_API
const char* freerdp_get_version_string(
void);
736 FREERDP_API
const char* freerdp_get_build_revision(
void);
739 FREERDP_API
const char* freerdp_get_build_config(
void);
741 FREERDP_API
void freerdp_free(freerdp* instance);
743 WINPR_ATTR_MALLOC(freerdp_free, 1)
745 FREERDP_API freerdp* freerdp_new(
void);
748 FREERDP_API BOOL freerdp_focus_required(freerdp* instance);
749 FREERDP_API
void freerdp_set_focus(freerdp* instance);
752 FREERDP_API
int freerdp_get_disconnect_ultimatum(const rdpContext* context);
755 FREERDP_API UINT32 freerdp_get_last_error(const rdpContext* context);
758 FREERDP_API const
char* freerdp_get_last_error_name(UINT32 code);
761 FREERDP_API const
char* freerdp_get_last_error_string(UINT32 code);
764 FREERDP_API const
char* freerdp_get_last_error_category(UINT32 code);
766#define freerdp_set_last_error(context, lastError) \
767 freerdp_set_last_error_ex((context), (lastError), __func__, __FILE__, __LINE__)
769#define freerdp_set_last_error_if_not(context, lastError) \
772 if (freerdp_get_last_error(context) == FREERDP_ERROR_SUCCESS) \
773 freerdp_set_last_error_log(context, lastError); \
776#define freerdp_set_last_error_log(context, lastError) \
777 freerdp_set_last_error_ex((context), (lastError), __func__, __FILE__, __LINE__)
778 FREERDP_API
void freerdp_set_last_error_ex(rdpContext* context, UINT32 lastError,
779 const char* fkt,
const char* file,
int line);
782 FREERDP_API
const char* freerdp_get_logon_error_info_type(UINT32 type);
785 FREERDP_API
const char* freerdp_get_logon_error_info_type_ex(UINT32 type,
char* buffer,
789 FREERDP_API
const char* freerdp_get_logon_error_info_data(UINT32 data);
792 FREERDP_API
const char* freerdp_get_logon_error_info_data_ex(UINT32 data,
char* buffer,
796 FREERDP_API ULONG freerdp_get_transport_sent(
const rdpContext* context, BOOL resetCount);
799 FREERDP_API BOOL freerdp_nla_impersonate(rdpContext* context);
802 FREERDP_API BOOL freerdp_nla_revert_to_self(rdpContext* context);
805 FREERDP_API UINT32 freerdp_get_nla_sspi_error(
const rdpContext* context);
816 FREERDP_API BOOL freerdp_nla_encrypt(rdpContext* context,
const SecBuffer* inBuffer,
828 FREERDP_API BOOL freerdp_nla_decrypt(rdpContext* context,
const SecBuffer* inBuffer,
841 FREERDP_API SECURITY_STATUS freerdp_nla_QueryContextAttributes(rdpContext* context,
842 DWORD ulAttr, PVOID pBuffer);
854 FREERDP_API SECURITY_STATUS freerdp_nla_FreeContextBuffer(rdpContext* context, PVOID pBuffer);
856 FREERDP_API
void clearChannelError(rdpContext* context);
859 FREERDP_API HANDLE getChannelErrorEventHandle(rdpContext* context);
862 FREERDP_API UINT getChannelError(
const rdpContext* context);
865 FREERDP_API
const char* getChannelErrorDescription(
const rdpContext* context);
867 FREERDP_API
void setChannelError(rdpContext* context, UINT errorNum,
const char* format, ...);
870 FREERDP_API BOOL checkChannelErrorEvent(rdpContext* context);
873 FREERDP_API
const char* freerdp_nego_get_routing_token(
const rdpContext* context,
883 FREERDP_API CONNECTION_STATE freerdp_get_state(
const rdpContext* context);
892 FREERDP_API
const char* freerdp_state_string(CONNECTION_STATE state);
904 FREERDP_API BOOL freerdp_is_active_state(
const rdpContext* context);
907 FREERDP_API BOOL freerdp_channels_from_mcs(rdpSettings* settings,
const rdpContext* context);
910 FREERDP_API BOOL freerdp_is_valid_mcs_create_request(
const BYTE* data,
size_t size);
913 FREERDP_API BOOL freerdp_is_valid_mcs_create_response(
const BYTE* data,
size_t size);
928 FREERDP_API BOOL freerdp_persist_credentials(rdpContext* context);
939 FREERDP_API BOOL freerdp_set_common_access_token(rdpContext* context,
940 pGetCommonAccessToken GetCommonAccessToken);
949 FREERDP_API pGetCommonAccessToken freerdp_get_common_access_token(
const rdpContext* context);
ALIGN64 freerdp_peer * peer
ALIGN64 freerdp * instance
WINPR_ATTR_NODISCARD ALIGN64 pVerifyCertificateEx VerifyCertificateEx
WINPR_ATTR_NODISCARD ALIGN64 pConnectCallback Redirect
WINPR_ATTR_NODISCARD ALIGN64 pLogonErrorInfo LogonErrorInfo
WINPR_ATTR_NODISCARD ALIGN64 pContextNew ContextNew
ALIGN64 pPostDisconnect PostDisconnect
WINPR_ATTR_NODISCARD ALIGN64 pAuthenticateEx AuthenticateEx
WINPR_ATTR_NODISCARD ALIGN64 pConnectCallback LoadChannels
ALIGN64 rdpContext * context
WINPR_ATTR_NODISCARD ALIGN64 pPresentGatewayMessage PresentGatewayMessage
ALIGN64 pContextFree ContextFree
WINPR_ATTR_NODISCARD ALIGN64 pVerifyX509Certificate VerifyX509Certificate
WINPR_ATTR_NODISCARD ALIGN64 pConnectCallback PreConnect
WINPR_ATTR_NODISCARD ALIGN64 pVerifyChangedCertificateEx VerifyChangedCertificateEx
WINPR_ATTR_NODISCARD ALIGN64 pConnectCallback PostConnect