SDL3/dialogs/sdl_dialogs.cpp

 
#include <vector>
#include <string>
#include <cassert>
 
#include <freerdp/log.h>
#include <freerdp/utils/passphrase.h>
#include <freerdp/utils/smartcardlogon.h>
 
#include <SDL3/SDL.h>
 
#include "../sdl_context.hpp"
#include "sdl_dialogs.hpp"
#include "sdl_input_widget_pair.hpp"
#include "sdl_input_widget_pair_list.hpp"
#include "sdl_select.hpp"
#include "sdl_select_list.hpp"
#include "sdl_connection_dialog.hpp"
 
enum
{
  SHOW_DIALOG_ACCEPT_REJECT = 1,
  SHOW_DIALOG_TIMED_ACCEPT = 2
};
 
static const char* type_str_for_flags(UINT32 flags)
{
  const char* type = "RDP-Server";
 
  if (flags & VERIFY_CERT_FLAG_GATEWAY)
    type = "RDP-Gateway";
 
  if (flags & VERIFY_CERT_FLAG_REDIRECT)
    type = "RDP-Redirect";
  return type;
}
 
static BOOL sdl_wait_for_result(rdpContext* context, Uint32 type, SDL_Event* result)
{
  const SDL_Event empty = {};
 
  WINPR_ASSERT(context);
  WINPR_ASSERT(result);
 
  while (!freerdp_shall_disconnect_context(context))
  {
    *result = empty;
    const int rc = SDL_PeepEvents(result, 1, SDL_GETEVENT, type, type);
    if (rc > 0)
      return TRUE;
    Sleep(1);
  }
  return FALSE;
}
 
static int sdl_show_dialog(rdpContext* context, const char* title, const char* message,
                           Sint32 flags)
{
  SDL_Event event = {};
 
  if (!sdl_push_user_event(SDL_EVENT_USER_SHOW_DIALOG, title, message, flags))
    return 0;
 
  if (!sdl_wait_for_result(context, SDL_EVENT_USER_SHOW_RESULT, &event))
    return 0;
 
  return event.user.code;
}
 
BOOL sdl_authenticate_ex(freerdp* instance, char** username, char** password, char** domain,
                         rdp_auth_reason reason)
{
  SDL_Event event = {};
  BOOL res = FALSE;
 
  const char* target = freerdp_settings_get_server_name(instance->context->settings);
  switch (reason)
  {
    case AUTH_RDSTLS:
    case AUTH_NLA:
      break;
 
    case AUTH_TLS:
    case AUTH_RDP:
    case AUTH_SMARTCARD_PIN: /* in this case password is pin code */
    case AUTH_FIDO_PIN:
      if ((*username) && (*password))
        return TRUE;
      break;
    case GW_AUTH_HTTP:
    case GW_AUTH_RDG:
    case GW_AUTH_RPC:
      target =
          freerdp_settings_get_string(instance->context->settings, FreeRDP_GatewayHostname);
      break;
    default:
      break;
  }
 
  char* title = nullptr;
  size_t titlesize = 0;
  winpr_asprintf(&title, &titlesize, "Credentials required for %s", target);
 
  CStringPtr guard(title, free);
  char* u = nullptr;
  char* d = nullptr;
  char* p = nullptr;
 
  assert(username);
  assert(domain);
  assert(password);
 
  u = *username;
  d = *domain;
  p = *password;
 
  auto sdl = get_context(instance);
  if (!p && !sdl->credentialsRead())
  {
    std::string line;
    line.reserve(1024);
 
    const BOOL fromStdin =
        freerdp_settings_get_bool(instance->context->settings, FreeRDP_CredentialsFromStdin);
    auto env =
        freerdp_passphrase_from_env(instance->context, title, line.data(), line.capacity());
    if (!env && fromStdin)
      env = freerdp_passphrase_read(instance->context, title, line.data(), line.capacity(),
                                    fromStdin);
    if (env)
      p = _strdup(env);
 
    *password = p;
    if (p)
    {
      sdl->setCredentialsRead();
      if (u)
        return TRUE;
    }
  }
 
  if (!sdl_push_user_event(SDL_EVENT_USER_AUTH_DIALOG, title, u, d, p, reason))
    return res;
 
  if (!sdl_wait_for_result(instance->context, SDL_EVENT_USER_AUTH_RESULT, &event))
    return res;
 
  auto arg = reinterpret_cast<SDL_UserAuthArg*>(event.padding);
 
  res = arg->result > 0;
 
  free(*username);
  free(*domain);
  free(*password);
  *username = arg->user;
  *domain = arg->domain;
  *password = arg->password;
 
  return res;
}
 
BOOL sdl_choose_smartcard(freerdp* instance, SmartcardCertInfo** cert_list, DWORD count,
                          DWORD* choice, BOOL gateway)
{
  BOOL res = FALSE;
 
  WINPR_ASSERT(instance);
  WINPR_ASSERT(cert_list);
  WINPR_ASSERT(choice);
 
  std::vector<std::string> strlist;
  std::vector<const char*> list;
  for (DWORD i = 0; i < count; i++)
  {
    const SmartcardCertInfo* cert = cert_list[i];
    char* reader = ConvertWCharToUtf8Alloc(cert->reader, nullptr);
    char* container_name = ConvertWCharToUtf8Alloc(cert->containerName, nullptr);
 
    char* msg = nullptr;
    size_t len = 0;
 
    winpr_asprintf(&msg, &len,
                   "%s\n\tReader: %s\n\tUser: %s@%s\n\tSubject: %s\n\tIssuer: %s\n\tUPN: %s",
                   container_name, reader, cert->userHint, cert->domainHint, cert->subject,
                   cert->issuer, cert->upn);
 
    strlist.emplace_back(msg);
    free(msg);
    free(reader);
    free(container_name);
 
    auto& m = strlist.back();
    list.push_back(m.c_str());
  }
 
  SDL_Event event = {};
  const char* title = "Select a logon smartcard certificate";
  if (gateway)
    title = "Select a gateway logon smartcard certificate";
  if (!sdl_push_user_event(SDL_EVENT_USER_SCARD_DIALOG, title, list.data(), count))
    return res;
 
  if (!sdl_wait_for_result(instance->context, SDL_EVENT_USER_SCARD_RESULT, &event))
    return res;
 
  res = (event.user.code >= 0);
  *choice = static_cast<DWORD>(event.user.code);
 
  return res;
}
 
SSIZE_T sdl_retry_dialog(freerdp* instance, const char* what, size_t current,
                         [[maybe_unused]] void* userarg)
{
  WINPR_ASSERT(instance);
  WINPR_ASSERT(instance->context);
  WINPR_ASSERT(what);
 
  auto sdl = get_context(instance->context);
  auto settings = instance->context->settings;
  const BOOL enabled = freerdp_settings_get_bool(settings, FreeRDP_AutoReconnectionEnabled);
  const size_t delay = freerdp_settings_get_uint32(settings, FreeRDP_TcpConnectTimeout);
 
  sdl->getDialog().setTitle("Retry connection to %s",
                            freerdp_settings_get_server_name(instance->context->settings));
 
  if ((strcmp(what, "arm-transport") != 0) && (strcmp(what, "connection") != 0))
  {
    sdl->getDialog().showError("Unknown module %s, aborting", what);
    return -1;
  }
 
  if (current == 0)
  {
    if (strcmp(what, "arm-transport") == 0)
      sdl->getDialog().showWarn("[%s] Starting your VM. It may take up to 5 minutes", what);
  }
 
  if (!enabled)
  {
    sdl->getDialog().showError(
        "Automatic reconnection disabled, terminating. Try to connect again later");
    return -1;
  }
 
  const size_t max = freerdp_settings_get_uint32(settings, FreeRDP_AutoReconnectMaxRetries);
  if (current >= max)
  {
    sdl->getDialog().showError(
        "[%s] retries exceeded. Your VM failed to start. Try again later or contact your "
        "tech support for help if this keeps happening.",
        what);
    return -1;
  }
 
  sdl->getDialog().showInfo("[%s] retry %" PRIuz "/%" PRIuz ", delaying %" PRIuz
                            "ms before next attempt",
                            what, current + 1, max, delay);
  return WINPR_ASSERTING_INT_CAST(ssize_t, delay);
}
 
BOOL sdl_present_gateway_message(freerdp* instance, [[maybe_unused]] UINT32 type,
                                 BOOL isDisplayMandatory, BOOL isConsentMandatory, size_t length,
                                 const WCHAR* wmessage)
{
  if (!isDisplayMandatory)
    return TRUE;
 
  char* title = nullptr;
  size_t len = 0;
  winpr_asprintf(&title, &len, "[gateway]");
 
  Sint32 flags = 0;
  if (isConsentMandatory)
    flags = SHOW_DIALOG_ACCEPT_REJECT;
  else if (isDisplayMandatory)
    flags = SHOW_DIALOG_TIMED_ACCEPT;
  char* message = ConvertWCharNToUtf8Alloc(wmessage, length, nullptr);
 
  const int rc = sdl_show_dialog(instance->context, title, message, flags);
  free(title);
  free(message);
  return rc > 0;
}
 
int sdl_logon_error_info(freerdp* instance, UINT32 data, UINT32 type)
{
  if (!instance || !instance->context)
    return -1;
 
  /* ignore LOGON_MSG_SESSION_CONTINUE message */
  switch (type)
  {
    case LOGON_MSG_SESSION_CONTINUE:
      return 0;
    default:
      break;
  }
 
  const char* str_data = freerdp_get_logon_error_info_data(data);
  const char* str_type = freerdp_get_logon_error_info_type(type);
  /* The server shows its own logon UI: show the desktop, a local dialog would block it. */
  auto sdl = get_context(instance);
  sdl->getRailChannelContext().noteLogonPrompt();
  WLog_Print(sdl->getWLog(), WLOG_INFO, "Logon Error Info %s [%s]", str_data, str_type);
  return 1;
}
 
static DWORD sdl_show_ceritifcate_dialog(rdpContext* context, const char* title,
                                         const char* message)
{
  if (!sdl_push_user_event(SDL_EVENT_USER_CERT_DIALOG, title, message))
    return 0;
 
  SDL_Event event = {};
  if (!sdl_wait_for_result(context, SDL_EVENT_USER_CERT_RESULT, &event))
    return 0;
  return static_cast<DWORD>(event.user.code);
}
 
static char* sdl_pem_cert(const char* pem)
{
  rdpCertificate* cert = freerdp_certificate_new_from_pem(pem);
  if (!cert)
    return nullptr;
 
  char* fp = freerdp_certificate_get_fingerprint(cert);
  char* start = freerdp_certificate_get_validity(cert, TRUE);
  char* end = freerdp_certificate_get_validity(cert, FALSE);
  freerdp_certificate_free(cert);
 
  char* str = nullptr;
  size_t slen = 0;
  winpr_asprintf(&str, &slen,
                 "Valid from:  %s\n"
                 "Valid to:    %s\n"
                 "Thumbprint:  %s\n",
                 start, end, fp);
  free(fp);
  free(start);
  free(end);
  return str;
}
 
DWORD sdl_verify_changed_certificate_ex(freerdp* instance, const char* host, UINT16 port,
                                        const char* common_name, const char* subject,
                                        const char* issuer, const char* new_fingerprint,
                                        const char* old_subject, const char* old_issuer,
                                        const char* old_fingerprint, DWORD flags)
{
  const char* type = type_str_for_flags(flags);
 
  WINPR_ASSERT(instance);
  WINPR_ASSERT(instance->context);
  WINPR_ASSERT(instance->context->settings);
 
  /* Newer versions of FreeRDP allow exposing the whole PEM by setting
   * FreeRDP_CertificateCallbackPreferPEM to TRUE
   */
  char* new_fp_str = nullptr;
  size_t len = 0;
  if (flags & VERIFY_CERT_FLAG_FP_IS_PEM)
    new_fp_str = sdl_pem_cert(new_fingerprint);
  else
    winpr_asprintf(&new_fp_str, &len, "Thumbprint:  %s\n", new_fingerprint);
 
  /* Newer versions of FreeRDP allow exposing the whole PEM by setting
   * FreeRDP_CertificateCallbackPreferPEM to TRUE
   */
  char* old_fp_str = nullptr;
  size_t olen = 0;
  if (flags & VERIFY_CERT_FLAG_FP_IS_PEM)
    old_fp_str = sdl_pem_cert(old_fingerprint);
  else
    winpr_asprintf(&old_fp_str, &olen, "Thumbprint:  %s\n", old_fingerprint);
 
  const char* collission_str = "";
  if (flags & VERIFY_CERT_FLAG_MATCH_LEGACY_SHA1)
  {
    collission_str =
        "A matching entry with legacy SHA1 was found in local known_hosts2 store.\n"
        "If you just upgraded from a FreeRDP version before 2.0 this is expected.\n"
        "The hashing algorithm has been upgraded from SHA1 to SHA256.\n"
        "All manually accepted certificates must be reconfirmed!\n"
        "\n";
  }
 
  char* title = nullptr;
  size_t tlen = 0;
  winpr_asprintf(&title, &tlen, "Certificate for %s:%" PRIu16 " (%s) has changed", host, port,
                 type);
 
  char* message = nullptr;
  size_t mlen = 0;
  winpr_asprintf(&message, &mlen,
                 "New Certificate details:\n"
                 "Common Name: %s\n"
                 "Subject:     %s\n"
                 "Issuer:      %s\n"
                 "%s\n"
                 "Old Certificate details:\n"
                 "Subject:     %s\n"
                 "Issuer:      %s\n"
                 "%s\n"
                 "%s\n"
                 "The above X.509 certificate does not match the certificate used for previous "
                 "connections.\n"
                 "This may indicate that the certificate has been tampered with.\n"
                 "Please contact the administrator of the RDP server and clarify.\n",
                 common_name, subject, issuer, new_fp_str, old_subject, old_issuer, old_fp_str,
                 collission_str);
 
  const DWORD rc = sdl_show_ceritifcate_dialog(instance->context, title, message);
  free(title);
  free(message);
  free(new_fp_str);
  free(old_fp_str);
 
  return rc;
}
 
DWORD sdl_verify_certificate_ex(freerdp* instance, const char* host, UINT16 port,
                                const char* common_name, const char* subject, const char* issuer,
                                const char* fingerprint, DWORD flags)
{
  const char* type = type_str_for_flags(flags);
 
  /* Newer versions of FreeRDP allow exposing the whole PEM by setting
   * FreeRDP_CertificateCallbackPreferPEM to TRUE
   */
  char* fp_str = nullptr;
  size_t len = 0;
  if (flags & VERIFY_CERT_FLAG_FP_IS_PEM)
    fp_str = sdl_pem_cert(fingerprint);
  else
    winpr_asprintf(&fp_str, &len, "Thumbprint:  %s\n", fingerprint);
 
  char* title = nullptr;
  size_t tlen = 0;
  winpr_asprintf(&title, &tlen, "New certificate for %s:%" PRIu16 " (%s)", host, port, type);
 
  char* message = nullptr;
  size_t mlen = 0;
  winpr_asprintf(
      &message, &mlen,
      "Common Name: %s\n"
      "Subject:     %s\n"
      "Issuer:      %s\n"
      "%s\n"
      "The above X.509 certificate could not be verified, possibly because you do not have\n"
      "the CA certificate in your certificate store, or the certificate has expired.\n"
      "Please look at the OpenSSL documentation on how to add a private CA to the store.\n",
      common_name, subject, issuer, fp_str);
 
  const DWORD rc = sdl_show_ceritifcate_dialog(instance->context, title, message);
  free(fp_str);
  free(title);
  free(message);
  return rc;
}
 
BOOL sdl_cert_dialog_show(const char* title, const char* message)
{
  int buttonid = -1;
  enum
  {
    BUTTONID_CERT_ACCEPT_PERMANENT = 23,
    BUTTONID_CERT_ACCEPT_TEMPORARY = 24,
    BUTTONID_CERT_DENY = 25
  };
  const SDL_MessageBoxButtonData buttons[] = {
    { 0, BUTTONID_CERT_ACCEPT_PERMANENT, "permanent" },
    { SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT, BUTTONID_CERT_ACCEPT_TEMPORARY, "temporary" },
    { SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT, BUTTONID_CERT_DENY, "cancel" }
  };
 
  const SDL_MessageBoxData data = { SDL_MESSAGEBOX_WARNING, nullptr, title,  message,
                                  ARRAYSIZE(buttons),     buttons, nullptr };
  const int rc = SDL_ShowMessageBox(&data, &buttonid);
 
  Sint32 value = -1;
  if (rc < 0)
    value = 0;
  else
  {
    switch (buttonid)
    {
      case BUTTONID_CERT_ACCEPT_PERMANENT:
        value = 1;
        break;
      case BUTTONID_CERT_ACCEPT_TEMPORARY:
        value = 2;
        break;
      default:
        value = 0;
        break;
    }
  }
 
  return sdl_push_user_event(SDL_EVENT_USER_CERT_RESULT, value);
}
 
BOOL sdl_message_dialog_show(const char* title, const char* message, Sint32 flags)
{
  int buttonid = -1;
  enum
  {
    BUTTONID_SHOW_ACCEPT = 24,
    BUTTONID_SHOW_DENY = 25
  };
  const SDL_MessageBoxButtonData buttons[] = {
    { SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT, BUTTONID_SHOW_ACCEPT, "accept" },
    { SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT, BUTTONID_SHOW_DENY, "cancel" }
  };
 
  const int button_cnt = (flags & SHOW_DIALOG_ACCEPT_REJECT) ? 2 : 1;
  const SDL_MessageBoxData data = {
    SDL_MESSAGEBOX_WARNING, nullptr, title, message, button_cnt, buttons, nullptr
  };
  const int rc = SDL_ShowMessageBox(&data, &buttonid);
 
  Sint32 value = -1;
  if (rc < 0)
    value = 0;
  else
  {
    switch (buttonid)
    {
      case BUTTONID_SHOW_ACCEPT:
        value = 1;
        break;
      default:
        value = 0;
        break;
    }
  }
 
  return sdl_push_user_event(SDL_EVENT_USER_SHOW_RESULT, value);
}
 
BOOL sdl_auth_dialog_show(const SDL_UserAuthArg* args)
{
  const std::vector<std::string> auth = { "Username:        ", "Domain:          ",
                                        "Password:        " };
  const std::vector<std::string> authPin = { "Device:       ", "PIN:        " };
  const std::vector<std::string> fidoPin = { "FIDO2 PIN:    " };
  const std::vector<std::string> gw = { "GatewayUsername: ", "GatewayDomain:   ",
                                      "GatewayPassword: " };
  std::vector<std::string> prompt;
  Sint32 rc = -1;
 
  switch (args->result)
  {
    case AUTH_SMARTCARD_PIN:
      prompt = authPin;
      break;
    case AUTH_FIDO_PIN:
      prompt = fidoPin;
      break;
    case AUTH_RDSTLS:
    case AUTH_TLS:
    case AUTH_RDP:
    case AUTH_NLA:
      prompt = auth;
      break;
    case GW_AUTH_HTTP:
    case GW_AUTH_RDG:
    case GW_AUTH_RPC:
      prompt = gw;
      break;
    default:
      break;
  }
 
  std::vector<std::string> result;
 
  auto parent = SDL_GetMouseFocus();
  if (!parent)
    parent = SDL_GetKeyboardFocus();
 
  if (!prompt.empty())
  {
    std::vector<std::string> initial{ args->user ? args->user : "Smartcard", "" };
    std::vector<Uint32> flags = { SdlInputWidgetPair::SDL_INPUT_READONLY,
                                SdlInputWidgetPair::SDL_INPUT_MASK };
    if (args->result == AUTH_FIDO_PIN)
    {
      initial = { "" };
      flags = { SdlInputWidgetPair::SDL_INPUT_MASK };
    }
    else if (args->result != AUTH_SMARTCARD_PIN)
    {
      initial = { args->user ? args->user : "", args->domain ? args->domain : "",
                args->password ? args->password : "" };
      flags = { 0, 0, SdlInputWidgetPair::SDL_INPUT_MASK };
    }
 
    ssize_t selected = -1;
    switch (args->result)
    {
      case AUTH_SMARTCARD_PIN:
      case AUTH_RDSTLS:
      case AUTH_FIDO_PIN:
        break;
      default:
        if (args->user)
        {
          selected++;
          if (args->domain)
            selected++;
        }
        break;
    }
    SdlInputWidgetPairList ilist(args->title, prompt, initial, flags, selected);
    ilist.parent(parent);
    rc = ilist.run(result);
  }
 
  if ((result.size() < prompt.size()))
    rc = -1;
 
  char* user = nullptr;
  char* domain = nullptr;
  char* pwd = nullptr;
  if (rc > 0)
  {
    if (args->result == AUTH_FIDO_PIN)
    {
      pwd = _strdup(result.at(0).c_str());
    }
    else
    {
      user = _strdup(result.at(0).c_str());
      if (args->result == AUTH_SMARTCARD_PIN)
        pwd = _strdup(result.at(1).c_str());
      else
      {
        domain = _strdup(result.at(1).c_str());
        pwd = _strdup(result.at(2).c_str());
      }
    }
  }
 
  return sdl_push_user_event(SDL_EVENT_USER_AUTH_RESULT, user, domain, pwd, rc);
}
 
BOOL sdl_scard_dialog_show(const char* title, Sint32 count, const char** list)
{
  std::vector<std::string> vlist;
  vlist.reserve(WINPR_ASSERTING_INT_CAST(size_t, count));
  for (Sint32 x = 0; x < count; x++)
    vlist.emplace_back(list[x]);
  SdlSelectList slist(title, vlist);
  Sint32 value = slist.run();
  return sdl_push_user_event(SDL_EVENT_USER_SCARD_RESULT, value);
}
 
void sdl_dialogs_uninit()
{
  TTF_Quit();
}
 
void sdl_dialogs_init()
{
  TTF_Init();
}