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
91 typedef BOOL (*pContextNew)(freerdp* instance, rdpContext* context);
92 typedef void (*pContextFree)(freerdp* instance, rdpContext* context);
94 typedef BOOL (*pConnectCallback)(freerdp* instance);
95 typedef void (*pPostDisconnect)(freerdp* instance);
110 typedef BOOL (*pAuthenticate)(freerdp* instance,
char** username,
char** password,
134 typedef BOOL (*pAuthenticateEx)(freerdp* instance,
char** username,
char** password,
135 char** domain, rdp_auth_reason reason);
155 typedef BOOL (*pChooseSmartcard)(freerdp* instance,
SmartcardCertInfo** cert_list, DWORD count,
156 DWORD* choice, BOOL gateway);
160 ACCESS_TOKEN_TYPE_AAD,
161 ACCESS_TOKEN_TYPE_AVD
174 typedef BOOL (*pGetAccessToken)(freerdp* instance, AccessTokenType tokenType,
char** token,
190 typedef BOOL (*pGetCommonAccessToken)(rdpContext* context, AccessTokenType tokenType,
191 char** token,
size_t count, ...);
204 typedef SSIZE_T (*pRetryDialog)(freerdp* instance,
const char* what,
size_t current,
222#if defined(WITH_FREERDP_DEPRECATED)
223 WINPR_DEPRECATED_VAR(
"Use pVerifyCertificateEx",
224 typedef DWORD (*pVerifyCertificate)(
225 freerdp* instance,
const char* common_name,
const char* subject,
226 const char* issuer,
const char* fingerprint, BOOL host_mismatch));
244 typedef DWORD (*pVerifyCertificateEx)(freerdp* instance,
const char* host, UINT16 port,
245 const char* common_name,
const char* subject,
246 const char* issuer,
const char* fingerprint, DWORD flags);
263#if defined(WITH_FREERDP_DEPRECATED)
264 WINPR_DEPRECATED_VAR(
"Use pVerifyChangedCertificateEx",
265 typedef DWORD (*pVerifyChangedCertificate)(
266 freerdp* instance,
const char* common_name,
const char* subject,
267 const char* issuer,
const char* new_fingerprint,
268 const char* old_subject,
const char* old_issuer,
269 const char* old_fingerprint));
292 typedef DWORD (*pVerifyChangedCertificateEx)(freerdp* instance,
const char* host, UINT16 port,
293 const char* common_name,
const char* subject,
294 const char* issuer,
const char* new_fingerprint,
295 const char* old_subject,
const char* old_issuer,
296 const char* old_fingerprint, DWORD flags);
311 typedef int (*pVerifyX509Certificate)(freerdp* instance,
const BYTE* data,
size_t length,
312 const char* hostname, UINT16 port, DWORD flags);
314 typedef int (*pLogonErrorInfo)(freerdp* instance, UINT32 data, UINT32 type);
316 typedef BOOL (*pSendChannelData)(freerdp* instance, UINT16 channelId,
const BYTE* data,
318 typedef BOOL (*pSendChannelPacket)(freerdp* instance, UINT16 channelId,
size_t totalSize,
319 UINT32 flags,
const BYTE* data,
size_t chunkSize);
320 typedef BOOL (*pReceiveChannelData)(freerdp* instance, UINT16 channelId,
const BYTE* data,
321 size_t size, UINT32 flags,
size_t totalSize);
324 typedef BOOL (*pPresentGatewayMessage)(freerdp* instance, UINT32 type, BOOL isDisplayMandatory,
325 BOOL isConsentMandatory,
size_t length,
326 const WCHAR* message);
345 ALIGN64 UINT32 LastError;
347 UINT64 paddingA[16 - 4];
360 ALIGN64 wPubSub* pubSub;
362 ALIGN64 HANDLE channelErrorEvent;
363 ALIGN64 UINT channelErrorNum;
364 ALIGN64
char* errorDescription;
366 UINT64 paddingB[32 - 22];
378 ALIGN64 rdpRail* rail;
379 ALIGN64 rdpCache* cache;
380 ALIGN64 rdpChannels* channels;
381 ALIGN64 rdpGraphics* graphics;
382 ALIGN64 rdpInput* input;
383 ALIGN64 rdpUpdate* update;
384 ALIGN64 rdpSettings* settings;
385 ALIGN64 rdpMetrics* metrics;
386 ALIGN64 rdpCodecs* codecs;
387 ALIGN64 rdpAutoDetect* autodetect;
388 UINT64 paddingC1[45 - 44];
389 ALIGN64
int disconnectUltimatum;
390 UINT64 paddingC[64 - 46];
392 ALIGN64 rdpStreamDumpContext* dump;
395 UINT64 paddingD[96 - 66];
396 UINT64 paddingE[128 - 96];
406 enum Disconnect_Ultimatum
408 Disconnect_Ultimatum_domain_disconnected = 0,
409 Disconnect_Ultimatum_provider_initiated = 1,
410 Disconnect_Ultimatum_token_purged = 2,
411 Disconnect_Ultimatum_user_requested = 3,
412 Disconnect_Ultimatum_channel_purged = 4
415#include <freerdp/client.h>
437 ALIGN64 RDP_CLIENT_ENTRY_POINTS* pClientEntryPoints;
439 UINT64 paddingA[16 - 2];
441#if defined(WITH_FREERDP_DEPRECATED)
442 WINPR_DEPRECATED_VAR(
"use rdpContext::input instead", ALIGN64 rdpInput* input;)
445 WINPR_DEPRECATED_VAR(
"use rdpContext::update instead",
446 ALIGN64 rdpUpdate* update;)
449 WINPR_DEPRECATED_VAR(
"use rdpContext::settings instead",
450 ALIGN64 rdpSettings* settings;)
456 WINPR_DEPRECATED_VAR(
"use rdpContext::autodetect instead",
457 ALIGN64 rdpAutoDetect* autodetect;)
464 ALIGN64 rdpHeartbeat* heartbeat;
466 UINT64 paddingB[32 - 21];
479 WINPR_ATTR_NODISCARD ALIGN64 pContextNew
490 UINT64 paddingC[47 - 35];
492 ALIGN64 UINT ConnectionCallbackState;
494 WINPR_ATTR_NODISCARD ALIGN64 pConnectCallback
500 WINPR_ATTR_NODISCARD ALIGN64 pConnectCallback
506#if defined(WITH_FREERDP_DEPRECATED)
507 WINPR_DEPRECATED_VAR(
"[since 3.25.0] Use AuthenticateEx instead",
508 WINPR_ATTR_NODISCARD ALIGN64 pAuthenticate
514 WINPR_DEPRECATED_VAR(
"Use VerifyCertificateEx or VerifyX509Certificate instead",
515 WINPR_ATTR_NODISCARD ALIGN64 pVerifyCertificate
517 WINPR_DEPRECATED_VAR(
"Use VerifyChangedCertificateEx or VerifyX509Certificate instead",
518 WINPR_ATTR_NODISCARD ALIGN64 pVerifyChangedCertificate
519 VerifyChangedCertificate;)
521 ALIGN64 UINT64 reserved50[3];
523 WINPR_ATTR_NODISCARD ALIGN64 pVerifyX509Certificate
527 WINPR_ATTR_NODISCARD ALIGN64 pLogonErrorInfo
531 ALIGN64 pPostDisconnect
539#if defined(WITH_FREERDP_DEPRECATED)
540 WINPR_DEPRECATED_VAR(
"[since 3.25.0] Use AuthenticateEx instead",
541 WINPR_ATTR_NODISCARD ALIGN64 pAuthenticate
542 GatewayAuthenticate);
547 ALIGN64 UINT64 reserved56[1];
553 WINPR_ATTR_NODISCARD ALIGN64 pConnectCallback
Redirect;
559 WINPR_ATTR_NODISCARD ALIGN64 pConnectCallback
564 ALIGN64 pPostDisconnect
573 WINPR_ATTR_NODISCARD ALIGN64 pSendChannelData
578 WINPR_ATTR_NODISCARD ALIGN64 pReceiveChannelData
585 WINPR_ATTR_NODISCARD ALIGN64 pVerifyCertificateEx
589 WINPR_ATTR_NODISCARD ALIGN64 pVerifyChangedCertificateEx
593 WINPR_ATTR_NODISCARD ALIGN64 pSendChannelPacket
603 WINPR_ATTR_NODISCARD ALIGN64 pChooseSmartcard
608 WINPR_ATTR_NODISCARD ALIGN64 pGetAccessToken GetAccessToken;
611 WINPR_ATTR_NODISCARD ALIGN64 pRetryDialog
614 UINT64 paddingE[80 - 73];
619 wListDictionary* init;
620 wListDictionary* open;
624 FREERDP_API
void freerdp_context_free(freerdp* instance);
627 FREERDP_API BOOL freerdp_context_new(freerdp* instance);
630 FREERDP_API BOOL freerdp_context_new_ex(freerdp* instance, rdpSettings* settings);
633 FREERDP_API BOOL freerdp_context_reset(freerdp* instance);
636 FREERDP_API BOOL freerdp_connect(freerdp* instance);
638#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
639 WINPR_DEPRECATED_VAR(
"use freerdp_abort_connect_context instead",
640 FREERDP_API BOOL freerdp_abort_connect(freerdp* instance));
643 FREERDP_API BOOL freerdp_abort_connect_context(rdpContext* context);
646 FREERDP_API HANDLE freerdp_abort_event(rdpContext* context);
648#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
649 WINPR_DEPRECATED_VAR(
"use freerdp_shall_disconnect_context instead",
650 WINPR_ATTR_NODISCARD FREERDP_API BOOL
651 freerdp_shall_disconnect(
const freerdp* instance));
655 FREERDP_API BOOL freerdp_shall_disconnect_context(
const rdpContext* context);
657 FREERDP_API BOOL freerdp_disconnect(freerdp* instance);
668 FREERDP_API
const char* freerdp_disconnect_reason_string(
int reason);
670#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
671 WINPR_DEPRECATED_VAR(
"use freerdp_disconnect_before_reconnect_context instead",
672 WINPR_ATTR_NODISCARD FREERDP_API BOOL
673 freerdp_disconnect_before_reconnect(freerdp* instance));
677 FREERDP_API BOOL freerdp_disconnect_before_reconnect_context(rdpContext* context);
680 FREERDP_API BOOL freerdp_reconnect(freerdp* instance);
683 FREERDP_API UINT freerdp_channels_attach(freerdp* instance);
686 FREERDP_API UINT freerdp_channels_detach(freerdp* instance);
688#if defined(WITH_FREERDP_DEPRECATED)
689 WINPR_DEPRECATED_VAR(
"Use freerdp_get_event_handles",
690 WINPR_ATTR_NODISCARD FREERDP_API BOOL
691 freerdp_get_fds(freerdp* instance,
void** rfds,
int* rcount,
692 void** wfds,
int* wcount));
696 FREERDP_API BOOL freerdp_check_fds(freerdp* instance);
699 FREERDP_API DWORD freerdp_get_event_handles(rdpContext* context, HANDLE* events, DWORD count);
702 FREERDP_API BOOL freerdp_check_event_handles(rdpContext* context);
705 FREERDP_API wMessageQueue* freerdp_get_message_queue(freerdp* instance, DWORD
id);
708 FREERDP_API HANDLE freerdp_get_message_queue_event_handle(freerdp* instance, DWORD
id);
711 FREERDP_API
int freerdp_message_queue_process_message(freerdp* instance, DWORD
id,
715 FREERDP_API
int freerdp_message_queue_process_pending_messages(freerdp* instance, DWORD
id);
718 FREERDP_API UINT32 freerdp_error_info(
const freerdp* instance);
720 FREERDP_API
void freerdp_set_error_info(rdpRdp* rdp, UINT32 error);
723 FREERDP_API BOOL freerdp_send_error_info(rdpRdp* rdp);
726 FREERDP_API BOOL freerdp_get_stats(
const rdpRdp* rdp, UINT64* inBytes, UINT64* outBytes,
727 UINT64* inPackets, UINT64* outPackets);
729 FREERDP_API
void freerdp_get_version(
int* major,
int* minor,
int* revision);
732 FREERDP_API
const char* freerdp_get_version_string(
void);
735 FREERDP_API
const char* freerdp_get_build_revision(
void);
738 FREERDP_API
const char* freerdp_get_build_config(
void);
740 FREERDP_API
void freerdp_free(freerdp* instance);
742 WINPR_ATTR_MALLOC(freerdp_free, 1)
744 FREERDP_API freerdp* freerdp_new(
void);
747 FREERDP_API BOOL freerdp_focus_required(freerdp* instance);
748 FREERDP_API
void freerdp_set_focus(freerdp* instance);
751 FREERDP_API
int freerdp_get_disconnect_ultimatum(const rdpContext* context);
754 FREERDP_API UINT32 freerdp_get_last_error(const rdpContext* context);
757 FREERDP_API const
char* freerdp_get_last_error_name(UINT32 code);
760 FREERDP_API const
char* freerdp_get_last_error_string(UINT32 code);
763 FREERDP_API const
char* freerdp_get_last_error_category(UINT32 code);
765#define freerdp_set_last_error(context, lastError) \
766 freerdp_set_last_error_ex((context), (lastError), __func__, __FILE__, __LINE__)
768#define freerdp_set_last_error_if_not(context, lastError) \
771 if (freerdp_get_last_error(context) == FREERDP_ERROR_SUCCESS) \
772 freerdp_set_last_error_log(context, lastError); \
775#define freerdp_set_last_error_log(context, lastError) \
776 freerdp_set_last_error_ex((context), (lastError), __func__, __FILE__, __LINE__)
777 FREERDP_API
void freerdp_set_last_error_ex(rdpContext* context, UINT32 lastError,
778 const char* fkt,
const char* file,
int line);
781 FREERDP_API
const char* freerdp_get_logon_error_info_type(UINT32 type);
784 FREERDP_API
const char* freerdp_get_logon_error_info_type_ex(UINT32 type,
char* buffer,
788 FREERDP_API
const char* freerdp_get_logon_error_info_data(UINT32 data);
791 FREERDP_API
const char* freerdp_get_logon_error_info_data_ex(UINT32 data,
char* buffer,
795 FREERDP_API ULONG freerdp_get_transport_sent(
const rdpContext* context, BOOL resetCount);
798 FREERDP_API BOOL freerdp_nla_impersonate(rdpContext* context);
801 FREERDP_API BOOL freerdp_nla_revert_to_self(rdpContext* context);
804 FREERDP_API UINT32 freerdp_get_nla_sspi_error(
const rdpContext* context);
815 FREERDP_API BOOL freerdp_nla_encrypt(rdpContext* context,
const SecBuffer* inBuffer,
827 FREERDP_API BOOL freerdp_nla_decrypt(rdpContext* context,
const SecBuffer* inBuffer,
840 FREERDP_API SECURITY_STATUS freerdp_nla_QueryContextAttributes(rdpContext* context,
841 DWORD ulAttr, PVOID pBuffer);
853 FREERDP_API SECURITY_STATUS freerdp_nla_FreeContextBuffer(rdpContext* context, PVOID pBuffer);
855 FREERDP_API
void clearChannelError(rdpContext* context);
858 FREERDP_API HANDLE getChannelErrorEventHandle(rdpContext* context);
861 FREERDP_API UINT getChannelError(
const rdpContext* context);
864 FREERDP_API
const char* getChannelErrorDescription(
const rdpContext* context);
866 FREERDP_API
void setChannelError(rdpContext* context, UINT errorNum,
const char* format, ...);
869 FREERDP_API BOOL checkChannelErrorEvent(rdpContext* context);
872 FREERDP_API
const char* freerdp_nego_get_routing_token(
const rdpContext* context,
882 FREERDP_API CONNECTION_STATE freerdp_get_state(
const rdpContext* context);
891 FREERDP_API
const char* freerdp_state_string(CONNECTION_STATE state);
903 FREERDP_API BOOL freerdp_is_active_state(
const rdpContext* context);
906 FREERDP_API BOOL freerdp_channels_from_mcs(rdpSettings* settings,
const rdpContext* context);
909 FREERDP_API BOOL freerdp_is_valid_mcs_create_request(
const BYTE* data,
size_t size);
912 FREERDP_API BOOL freerdp_is_valid_mcs_create_response(
const BYTE* data,
size_t size);
927 FREERDP_API BOOL freerdp_persist_credentials(rdpContext* context);
938 FREERDP_API BOOL freerdp_set_common_access_token(rdpContext* context,
939 pGetCommonAccessToken GetCommonAccessToken);
948 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