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);
98#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
112 typedef BOOL (*pAuthenticate)(freerdp* instance,
char** username,
char** password,
137 typedef BOOL (*pAuthenticateEx)(freerdp* instance,
char** username,
char** password,
138 char** domain, rdp_auth_reason reason);
158 typedef BOOL (*pChooseSmartcard)(freerdp* instance,
SmartcardCertInfo** cert_list, DWORD count,
159 DWORD* choice, BOOL gateway);
163 ACCESS_TOKEN_TYPE_AAD,
164 ACCESS_TOKEN_TYPE_AVD
177 typedef BOOL (*pGetAccessToken)(freerdp* instance, AccessTokenType tokenType,
char** token,
193 typedef BOOL (*pGetCommonAccessToken)(rdpContext* context, AccessTokenType tokenType,
194 char** token,
size_t count, ...);
207 typedef SSIZE_T (*pRetryDialog)(freerdp* instance,
const char* what,
size_t current,
225#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
226 WINPR_DEPRECATED_VAR(
"Use pVerifyCertificateEx",
227 typedef DWORD (*pVerifyCertificate)(
228 freerdp* instance,
const char* common_name,
const char* subject,
229 const char* issuer,
const char* fingerprint, BOOL host_mismatch));
247 typedef DWORD (*pVerifyCertificateEx)(freerdp* instance,
const char* host, UINT16 port,
248 const char* common_name,
const char* subject,
249 const char* issuer,
const char* fingerprint, DWORD flags);
266#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
267 WINPR_DEPRECATED_VAR(
"Use pVerifyChangedCertificateEx",
268 typedef DWORD (*pVerifyChangedCertificate)(
269 freerdp* instance,
const char* common_name,
const char* subject,
270 const char* issuer,
const char* new_fingerprint,
271 const char* old_subject,
const char* old_issuer,
272 const char* old_fingerprint));
295 typedef DWORD (*pVerifyChangedCertificateEx)(freerdp* instance,
const char* host, UINT16 port,
296 const char* common_name,
const char* subject,
297 const char* issuer,
const char* new_fingerprint,
298 const char* old_subject,
const char* old_issuer,
299 const char* old_fingerprint, DWORD flags);
314 typedef int (*pVerifyX509Certificate)(freerdp* instance,
const BYTE* data,
size_t length,
315 const char* hostname, UINT16 port, DWORD flags);
317 typedef int (*pLogonErrorInfo)(freerdp* instance, UINT32 data, UINT32 type);
319 typedef BOOL (*pSendChannelData)(freerdp* instance, UINT16 channelId,
const BYTE* data,
321 typedef BOOL (*pSendChannelPacket)(freerdp* instance, UINT16 channelId,
size_t totalSize,
322 UINT32 flags,
const BYTE* data,
size_t chunkSize);
323 typedef BOOL (*pReceiveChannelData)(freerdp* instance, UINT16 channelId,
const BYTE* data,
324 size_t size, UINT32 flags,
size_t totalSize);
327 typedef BOOL (*pPresentGatewayMessage)(freerdp* instance, UINT32 type, BOOL isDisplayMandatory,
328 BOOL isConsentMandatory,
size_t length,
329 const WCHAR* message);
348 ALIGN64 UINT32 LastError;
350 UINT64 paddingA[16 - 4];
363 ALIGN64 wPubSub* pubSub;
365 ALIGN64 HANDLE channelErrorEvent;
366 ALIGN64 UINT channelErrorNum;
367 ALIGN64
char* errorDescription;
369 UINT64 paddingB[32 - 22];
381 ALIGN64 rdpRail* rail;
382 ALIGN64 rdpCache* cache;
383 ALIGN64 rdpChannels* channels;
384 ALIGN64 rdpGraphics* graphics;
385 ALIGN64 rdpInput* input;
386 ALIGN64 rdpUpdate* update;
387 ALIGN64 rdpSettings* settings;
388 ALIGN64 rdpMetrics* metrics;
389 ALIGN64 rdpCodecs* codecs;
390 ALIGN64 rdpAutoDetect* autodetect;
391 UINT64 paddingC1[45 - 44];
392 ALIGN64
int disconnectUltimatum;
393 UINT64 paddingC[64 - 46];
395 ALIGN64 rdpStreamDumpContext* dump;
398 UINT64 paddingD[96 - 66];
399 UINT64 paddingE[128 - 96];
409 enum Disconnect_Ultimatum
411 Disconnect_Ultimatum_domain_disconnected = 0,
412 Disconnect_Ultimatum_provider_initiated = 1,
413 Disconnect_Ultimatum_token_purged = 2,
414 Disconnect_Ultimatum_user_requested = 3,
415 Disconnect_Ultimatum_channel_purged = 4
418#include <freerdp/client.h>
440 ALIGN64 RDP_CLIENT_ENTRY_POINTS* pClientEntryPoints;
442 UINT64 paddingA[16 - 2];
444#if defined(WITH_FREERDP_DEPRECATED)
449 ALIGN64 rdpUpdate* update;)
453 ALIGN64 rdpSettings* settings;)
460 ALIGN64 rdpAutoDetect* autodetect;)
467 ALIGN64 rdpHeartbeat* heartbeat;
469 UINT64 paddingB[32 - 21];
482 WINPR_ATTR_NODISCARD ALIGN64 pContextNew
493 UINT64 paddingC[47 - 35];
495 ALIGN64 UINT ConnectionCallbackState;
497 WINPR_ATTR_NODISCARD ALIGN64 pConnectCallback
503 WINPR_ATTR_NODISCARD ALIGN64 pConnectCallback
509#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
511 WINPR_ATTR_NODISCARD ALIGN64 pAuthenticate
518 WINPR_ATTR_NODISCARD ALIGN64 pVerifyCertificate
521 WINPR_ATTR_NODISCARD ALIGN64 pVerifyChangedCertificate
522 VerifyChangedCertificate;)
524 ALIGN64 UINT64 reserved50[3];
526 WINPR_ATTR_NODISCARD ALIGN64 pVerifyX509Certificate
530 WINPR_ATTR_NODISCARD ALIGN64 pLogonErrorInfo
534 ALIGN64 pPostDisconnect
542#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
544 WINPR_ATTR_NODISCARD ALIGN64 pAuthenticate
545 GatewayAuthenticate);
550 ALIGN64 UINT64 reserved56[1];
556 WINPR_ATTR_NODISCARD ALIGN64 pConnectCallback
Redirect;
562 WINPR_ATTR_NODISCARD ALIGN64 pConnectCallback
567 ALIGN64 pPostDisconnect
576 WINPR_ATTR_NODISCARD ALIGN64 pSendChannelData
581 WINPR_ATTR_NODISCARD ALIGN64 pReceiveChannelData
588 WINPR_ATTR_NODISCARD ALIGN64 pVerifyCertificateEx
592 WINPR_ATTR_NODISCARD ALIGN64 pVerifyChangedCertificateEx
596 WINPR_ATTR_NODISCARD ALIGN64 pSendChannelPacket
606 WINPR_ATTR_NODISCARD ALIGN64 pChooseSmartcard
611 WINPR_ATTR_NODISCARD ALIGN64 pGetAccessToken GetAccessToken;
614 WINPR_ATTR_NODISCARD ALIGN64 pRetryDialog
617 UINT64 paddingE[80 - 73];
622 wListDictionary* init;
623 wListDictionary* open;
627 FREERDP_API
void freerdp_context_free(freerdp* instance);
630 FREERDP_API BOOL freerdp_context_new(freerdp* instance);
633 FREERDP_API BOOL freerdp_context_new_ex(freerdp* instance, rdpSettings* settings);
636 FREERDP_API BOOL freerdp_context_reset(freerdp* instance);
639 FREERDP_API BOOL freerdp_connect(freerdp* instance);
641#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
642 WINPR_DEPRECATED_VAR(
"use freerdp_abort_connect_context instead",
643 FREERDP_API BOOL freerdp_abort_connect(freerdp* instance));
646 FREERDP_API BOOL freerdp_abort_connect_context(rdpContext* context);
649 FREERDP_API HANDLE freerdp_abort_event(rdpContext* context);
651#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
652 WINPR_DEPRECATED_VAR(
"use freerdp_shall_disconnect_context instead",
653 WINPR_ATTR_NODISCARD FREERDP_API BOOL
654 freerdp_shall_disconnect(
const freerdp* instance));
658 FREERDP_API BOOL freerdp_shall_disconnect_context(
const rdpContext* context);
660 FREERDP_API BOOL freerdp_disconnect(freerdp* instance);
671 FREERDP_API
const char* freerdp_disconnect_reason_string(
int reason);
673#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
674 WINPR_DEPRECATED_VAR(
"use freerdp_disconnect_before_reconnect_context instead",
675 WINPR_ATTR_NODISCARD FREERDP_API BOOL
676 freerdp_disconnect_before_reconnect(freerdp* instance));
680 FREERDP_API BOOL freerdp_disconnect_before_reconnect_context(rdpContext* context);
683 FREERDP_API BOOL freerdp_reconnect(freerdp* instance);
686 FREERDP_API UINT freerdp_channels_attach(freerdp* instance);
689 FREERDP_API UINT freerdp_channels_detach(freerdp* instance);
691#if defined(WITH_FREERDP_DEPRECATED)
692 WINPR_DEPRECATED_VAR(
"Use freerdp_get_event_handles",
693 WINPR_ATTR_NODISCARD FREERDP_API BOOL
694 freerdp_get_fds(freerdp* instance,
void** rfds,
int* rcount,
695 void** wfds,
int* wcount));
699 FREERDP_API BOOL freerdp_check_fds(freerdp* instance);
702 FREERDP_API DWORD freerdp_get_event_handles(rdpContext* context, HANDLE* events, DWORD count);
705 FREERDP_API BOOL freerdp_check_event_handles(rdpContext* context);
708 FREERDP_API wMessageQueue* freerdp_get_message_queue(freerdp* instance, DWORD
id);
711 FREERDP_API HANDLE freerdp_get_message_queue_event_handle(freerdp* instance, DWORD
id);
714 FREERDP_API
int freerdp_message_queue_process_message(freerdp* instance, DWORD
id,
718 FREERDP_API
int freerdp_message_queue_process_pending_messages(freerdp* instance, DWORD
id);
721 FREERDP_API UINT32 freerdp_error_info(
const freerdp* instance);
723 FREERDP_API
void freerdp_set_error_info(rdpRdp* rdp, UINT32 error);
726 FREERDP_API BOOL freerdp_send_error_info(rdpRdp* rdp);
729 FREERDP_API BOOL freerdp_get_stats(
const rdpRdp* rdp, UINT64* inBytes, UINT64* outBytes,
730 UINT64* inPackets, UINT64* outPackets);
732 FREERDP_API
void freerdp_get_version(
int* major,
int* minor,
int* revision);
735 FREERDP_API
const char* freerdp_get_version_string(
void);
738 FREERDP_API
const char* freerdp_get_build_revision(
void);
741 FREERDP_API
const char* freerdp_get_build_config(
void);
743 FREERDP_API
void freerdp_free(freerdp* instance);
745 WINPR_ATTR_MALLOC(freerdp_free, 1)
747 FREERDP_API freerdp* freerdp_new(
void);
750 FREERDP_API BOOL freerdp_focus_required(freerdp* instance);
751 FREERDP_API
void freerdp_set_focus(freerdp* instance);
754 FREERDP_API
int freerdp_get_disconnect_ultimatum(const rdpContext* context);
757 FREERDP_API UINT32 freerdp_get_last_error(const rdpContext* context);
760 FREERDP_API const
char* freerdp_get_last_error_name(UINT32 code);
763 FREERDP_API const
char* freerdp_get_last_error_string(UINT32 code);
766 FREERDP_API const
char* freerdp_get_last_error_category(UINT32 code);
768#define freerdp_set_last_error(context, lastError) \
769 freerdp_set_last_error_ex((context), (lastError), __func__, __FILE__, __LINE__)
771#define freerdp_set_last_error_if_not(context, lastError) \
774 if (freerdp_get_last_error(context) == FREERDP_ERROR_SUCCESS) \
775 freerdp_set_last_error_log(context, lastError); \
778#define freerdp_set_last_error_log(context, lastError) \
779 freerdp_set_last_error_ex((context), (lastError), __func__, __FILE__, __LINE__)
780 FREERDP_API
void freerdp_set_last_error_ex(rdpContext* context, UINT32 lastError,
781 const char* fkt,
const char* file,
int line);
784 FREERDP_API
const char* freerdp_get_logon_error_info_type(UINT32 type);
787 FREERDP_API
const char* freerdp_get_logon_error_info_type_ex(UINT32 type,
char* buffer,
791 FREERDP_API
const char* freerdp_get_logon_error_info_data(UINT32 data);
794 FREERDP_API
const char* freerdp_get_logon_error_info_data_ex(UINT32 data,
char* buffer,
798 FREERDP_API ULONG freerdp_get_transport_sent(
const rdpContext* context, BOOL resetCount);
801 FREERDP_API BOOL freerdp_nla_impersonate(rdpContext* context);
804 FREERDP_API BOOL freerdp_nla_revert_to_self(rdpContext* context);
807 FREERDP_API UINT32 freerdp_get_nla_sspi_error(
const rdpContext* context);
818 FREERDP_API BOOL freerdp_nla_encrypt(rdpContext* context,
const SecBuffer* inBuffer,
830 FREERDP_API BOOL freerdp_nla_decrypt(rdpContext* context,
const SecBuffer* inBuffer,
843 FREERDP_API SECURITY_STATUS freerdp_nla_QueryContextAttributes(rdpContext* context,
844 DWORD ulAttr, PVOID pBuffer);
856 FREERDP_API SECURITY_STATUS freerdp_nla_FreeContextBuffer(rdpContext* context, PVOID pBuffer);
858 FREERDP_API
void clearChannelError(rdpContext* context);
861 FREERDP_API HANDLE getChannelErrorEventHandle(rdpContext* context);
864 FREERDP_API UINT getChannelError(
const rdpContext* context);
867 FREERDP_API
const char* getChannelErrorDescription(
const rdpContext* context);
869 FREERDP_API
void setChannelError(rdpContext* context, UINT errorNum,
const char* format, ...);
872 FREERDP_API BOOL checkChannelErrorEvent(rdpContext* context);
875 FREERDP_API
const char* freerdp_nego_get_routing_token(
const rdpContext* context,
885 FREERDP_API CONNECTION_STATE freerdp_get_state(
const rdpContext* context);
894 FREERDP_API
const char* freerdp_state_string(CONNECTION_STATE state);
906 FREERDP_API BOOL freerdp_is_active_state(
const rdpContext* context);
909 FREERDP_API BOOL freerdp_channels_from_mcs(rdpSettings* settings,
const rdpContext* context);
912 FREERDP_API BOOL freerdp_is_valid_mcs_create_request(
const BYTE* data,
size_t size);
915 FREERDP_API BOOL freerdp_is_valid_mcs_create_response(
const BYTE* data,
size_t size);
930 FREERDP_API BOOL freerdp_persist_credentials(rdpContext* context);
941 FREERDP_API BOOL freerdp_set_common_access_token(rdpContext* context,
942 pGetCommonAccessToken GetCommonAccessToken);
951 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_DEPRECATED_VAR("[since 3.25.0] Use AuthenticateEx instead", WINPR_ATTR_NODISCARD ALIGN64 pAuthenticate GatewayAuthenticate)
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_DEPRECATED_VAR("[since 3.25.0] Use AuthenticateEx instead", WINPR_ATTR_NODISCARD ALIGN64 pAuthenticate Authenticate)
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