/src/FreeRDP/libfreerdp/utils/smartcard_call.c

Source
/**
 * FreeRDP: A Remote Desktop Protocol Implementation
 * Smartcard Device Service Virtual Channel
 *
 * Copyright (C) Alexi Volkov <alexi@myrealbox.com> 2006
 * Copyright 2011 O.S. Systems Software Ltda.
 * Copyright 2011 Anthony Tong <atong@trustedcs.com>
 * Copyright 2015 Thincast Technologies GmbH
 * Copyright 2015 DI (FH) Martin Haimberger <martin.haimberger@thincast.com>
 * Copyright 2017 Armin Novak <armin.novak@thincast.com>
 * Copyright 2017 Thincast Technologies GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include <freerdp/config.h>

#include <winpr/assert.h>

#include <winpr/crt.h>
#include <winpr/print.h>
#include <winpr/stream.h>
#include <winpr/library.h>
#include <winpr/smartcard.h>

#include <freerdp/freerdp.h>
#include <freerdp/channels/rdpdr.h>
#include <freerdp/channels/scard.h>

#include <freerdp/utils/rdpdr_utils.h>
#include <freerdp/utils/smartcard_pack.h>
#include <freerdp/utils/smartcard_call.h>

#include "smartcard_pack.h"

#include <freerdp/log.h>
#define SCARD_TAG FREERDP_TAG("utils.smartcard.call")

#if defined(WITH_SMARTCARD_EMULATE)
#include <freerdp/emulate/scard/smartcard_emulate.h>

#define wrap_raw(ctx, fkt, ...)                                         \
  ctx->useEmulatedCard ? Emulate_##fkt(ctx->emulation, ##__VA_ARGS__) \
                       : ctx->pWinSCardApi->pfn##fkt(__VA_ARGS__)
#define wrap_ptr(ctx, fkt, ...) wrap_raw(ctx, fkt, ##__VA_ARGS__)
#else
#define wrap_raw(ctx, fkt, ...) \
  ctx->useEmulatedCard ? SCARD_F_INTERNAL_ERROR : ctx->pWinSCardApi->pfn##fkt(__VA_ARGS__)
#define wrap_ptr(ctx, fkt, ...) \
  ctx->useEmulatedCard ? nullptr : ctx->pWinSCardApi->pfn##fkt(__VA_ARGS__)
#endif

#if defined(_WIN32)
#define wrap(ctx, fkt, ...) wrap_raw(ctx, fkt, ##__VA_ARGS__)
#else
#define wrap(ctx, fkt, ...)                                               \
  __extension__({                                                       \
    LONG defstatus = wrap_raw(ctx, fkt, ##__VA_ARGS__);               \
    if (defstatus != SCARD_S_SUCCESS)                                 \
      WLog_Print(ctx->log, WLOG_TRACE, "[" #fkt "] failed with %s", \
                 SCardGetErrorString(defstatus));                   \
    defstatus;                                                        \
  })
#endif

struct s_scard_call_context
{
  BOOL useEmulatedCard;
  HANDLE StartedEvent;
  wLinkedList* names;
  wHashTable* rgSCardContextList;
#if defined(WITH_SMARTCARD_EMULATE)
  SmartcardEmulationContext* emulation;
#endif
  HANDLE hWinSCardLibrary;
  SCardApiFunctionTable WinSCardApi;
  const SCardApiFunctionTable* pWinSCardApi;
  HANDLE stopEvent;
  void* userdata;

  void* (*fn_new)(void*, SCARDCONTEXT);
  void (*fn_free)(void*);
  wLog* log;
  rdpContext* context;
};

struct s_scard_context_element
{
  void* context;
  void (*fn_free)(void*);
};

static void context_free(void* arg);

WINPR_ATTR_NODISCARD WINPR_ATTR_NODISCARD static LONG
smartcard_EstablishContext_Call(scard_call_context* smartcard, wStream* out,
                                SMARTCARD_OPERATION* operation)
{
  SCARDCONTEXT hContext = WINPR_C_ARRAY_INIT;
  EstablishContext_Return ret = WINPR_C_ARRAY_INIT;
  EstablishContext_Call* call = &operation->call.establishContext;
  LONG status = ret.ReturnCode =
      wrap(smartcard, SCardEstablishContext, call->dwScope, nullptr, nullptr, &hContext);

  if (ret.ReturnCode == SCARD_S_SUCCESS)
  {
    const void* key = (void*)(size_t)hContext;
    struct s_scard_context_element* pContext =
        calloc(1, sizeof(struct s_scard_context_element));
    if (!pContext)
      return STATUS_NO_MEMORY;

    pContext->fn_free = smartcard->fn_free;

    if (smartcard->fn_new)
    {
      pContext->context = smartcard->fn_new(smartcard->userdata, hContext);
      if (!pContext->context)
      {
        free(pContext);
        return STATUS_NO_MEMORY;
      }
    }

    if (!HashTable_Insert(smartcard->rgSCardContextList, key, (void*)pContext))
    {
      WLog_Print(smartcard->log, WLOG_ERROR, "HashTable_Insert failed!");
      context_free(pContext);
      return STATUS_INTERNAL_ERROR;
    }
  }
  else
  {
    return scard_log_status_error_wlog(smartcard->log, "SCardEstablishContext", status);
  }

  // NOLINTNEXTLINE(clang-analyzer-unix.Malloc): HashTable_Insert takes ownership of pContext
  smartcard_scard_context_native_to_redir(&(ret.hContext), hContext);

  status = smartcard_pack_establish_context_return(out, &ret);
  if (status != SCARD_S_SUCCESS)
  {
    return scard_log_status_error_wlog(smartcard->log,
                                       "smartcard_pack_establish_context_return", status);
  }

  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_ReleaseContext_Call(scard_call_context* smartcard,
                                                               WINPR_ATTR_UNUSED wStream* out,
                                                               SMARTCARD_OPERATION* operation)
{
  Long_Return ret = WINPR_C_ARRAY_INIT;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  ret.ReturnCode = wrap(smartcard, SCardReleaseContext, operation->hContext);

  if (ret.ReturnCode == SCARD_S_SUCCESS)
    HashTable_Remove(smartcard->rgSCardContextList, (void*)operation->hContext);
  else
  {
    return scard_log_status_error_wlog(smartcard->log, "SCardReleaseContext", ret.ReturnCode);
  }

  smartcard_trace_long_return_int(smartcard->log, &ret, "ReleaseContext");
  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_IsValidContext_Call(scard_call_context* smartcard,
                                                               WINPR_ATTR_UNUSED wStream* out,
                                                               SMARTCARD_OPERATION* operation)
{
  Long_Return ret = WINPR_C_ARRAY_INIT;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  ret.ReturnCode = wrap(smartcard, SCardIsValidContext, operation->hContext);
  smartcard_trace_long_return_int(smartcard->log, &ret, "IsValidContext");
  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_ListReaderGroupsA_Call(scard_call_context* smartcard,
                                                                  wStream* out,
                                                                  SMARTCARD_OPERATION* operation)
{
  LONG status = 0;
  ListReaderGroups_Return ret = WINPR_C_ARRAY_INIT;
  LPSTR mszGroups = nullptr;
  DWORD cchGroups = 0;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  cchGroups = SCARD_AUTOALLOCATE;
  ret.ReturnCode =
      wrap(smartcard, SCardListReaderGroupsA, operation->hContext, (LPSTR)&mszGroups, &cchGroups);
  if ((ret.ReturnCode == SCARD_S_SUCCESS) && (cchGroups == SCARD_AUTOALLOCATE))
    return SCARD_F_UNKNOWN_ERROR;

  ret.msz = (BYTE*)mszGroups;
  ret.cBytes = cchGroups;

  status = smartcard_pack_list_reader_groups_return(out, &ret, FALSE);

  if (status != SCARD_S_SUCCESS)
    return status;

  if (mszGroups)
    wrap(smartcard, SCardFreeMemory, operation->hContext, mszGroups);

  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_ListReaderGroupsW_Call(scard_call_context* smartcard,
                                                                  wStream* out,
                                                                  SMARTCARD_OPERATION* operation)
{
  LONG status = 0;
  ListReaderGroups_Return ret = WINPR_C_ARRAY_INIT;
  LPWSTR mszGroups = nullptr;
  DWORD cchGroups = 0;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  cchGroups = SCARD_AUTOALLOCATE;
  status = ret.ReturnCode = wrap(smartcard, SCardListReaderGroupsW, operation->hContext,
                                 (LPWSTR)&mszGroups, &cchGroups);
  if ((ret.ReturnCode == SCARD_S_SUCCESS) && (cchGroups == SCARD_AUTOALLOCATE))
    return SCARD_F_UNKNOWN_ERROR;

  ret.msz = (BYTE*)mszGroups;

  WINPR_ASSERT(cchGroups < SCARD_AUTOALLOCATE / sizeof(WCHAR));
  const size_t blen = sizeof(WCHAR) * cchGroups;
  WINPR_ASSERT(blen <= UINT32_MAX);
  ret.cBytes = (UINT32)blen;

  if (status != SCARD_S_SUCCESS)
    return status;

  status = smartcard_pack_list_reader_groups_return(out, &ret, TRUE);

  if (status != SCARD_S_SUCCESS)
    return status;

  if (mszGroups)
    wrap(smartcard, SCardFreeMemory, operation->hContext, mszGroups);

  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD
static BOOL filter_match(wLinkedList* list, LPCSTR reader, size_t readerLen)
{
  if (readerLen < 1)
    return FALSE;

  LinkedList_Enumerator_Reset(list);

  while (LinkedList_Enumerator_MoveNext(list))
  {
    const char* filter = LinkedList_Enumerator_Current(list);

    if (filter)
    {
      if (strstr(reader, filter) != nullptr)
        return TRUE;
    }
  }

  return FALSE;
}

WINPR_ATTR_NODISCARD
static DWORD filter_device_by_name_a(wLinkedList* list, LPSTR* mszReaders, DWORD cchReaders)
{
  size_t rpos = 0;
  size_t wpos = 0;

  if (*mszReaders == nullptr || LinkedList_Count(list) < 1)
    return cchReaders;

  do
  {
    LPCSTR rreader = &(*mszReaders)[rpos];
    LPSTR wreader = &(*mszReaders)[wpos];
    size_t readerLen = strnlen(rreader, cchReaders - rpos);

    rpos += readerLen + 1;

    if (filter_match(list, rreader, readerLen))
    {
      if (rreader != wreader)
        memmove(wreader, rreader, readerLen + 1);

      wpos += readerLen + 1;
    }
  } while (rpos < cchReaders);

  /* this string must be double 0 terminated */
  if (rpos != wpos)
  {
    if (wpos >= cchReaders)
      return 0;

    (*mszReaders)[wpos++] = '\0';
  }

  return (DWORD)wpos;
}

WINPR_ATTR_NODISCARD
static DWORD filter_device_by_name_w(wLinkedList* list, LPWSTR* mszReaders, DWORD cchReaders)
{
  DWORD rc = 0;
  LPSTR readers = nullptr;

  if (LinkedList_Count(list) < 1)
    return cchReaders;

  readers = ConvertMszWCharNToUtf8Alloc(*mszReaders, cchReaders, nullptr);

  if (!readers)
  {
    free(readers);
    return 0;
  }

  *mszReaders = nullptr;
  rc = filter_device_by_name_a(list, &readers, cchReaders);

  *mszReaders = ConvertMszUtf8NToWCharAlloc(readers, rc, nullptr);
  if (!*mszReaders)
    rc = 0;

  free(readers);
  return rc;
}

WINPR_ATTR_NODISCARD static LONG smartcard_ListReadersA_Call(scard_call_context* smartcard,
                                                             wStream* out,
                                                             SMARTCARD_OPERATION* operation)
{
  ListReaders_Return ret = WINPR_C_ARRAY_INIT;
  LPSTR mszReaders = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  ListReaders_Call* call = &operation->call.listReaders;
  DWORD cchReaders = SCARD_AUTOALLOCATE;
  LONG status = ret.ReturnCode = wrap(smartcard, SCardListReadersA, operation->hContext,
                                      (LPCSTR)call->mszGroups, (LPSTR)&mszReaders, &cchReaders);
  if (status == SCARD_S_SUCCESS)
  {
    if (cchReaders == SCARD_AUTOALLOCATE)
      status = SCARD_F_UNKNOWN_ERROR;
  }

  if (status != SCARD_S_SUCCESS)
  {
    (void)scard_log_status_error_wlog(smartcard->log, "SCardListReadersA", status);
    return smartcard_pack_list_readers_return(out, &ret, FALSE);
  }

  void* original = mszReaders;
  cchReaders = filter_device_by_name_a(smartcard->names, &mszReaders, cchReaders);
  ret.msz = (BYTE*)mszReaders;
  ret.cBytes = cchReaders;

  status = smartcard_pack_list_readers_return(out, &ret, FALSE);
  if (original)
    wrap(smartcard, SCardFreeMemory, operation->hContext, original);

  if (status != SCARD_S_SUCCESS)
    return scard_log_status_error_wlog(smartcard->log, "smartcard_pack_list_readers_return",
                                       status);

  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_ListReadersW_Call(scard_call_context* smartcard,
                                                             wStream* out,
                                                             SMARTCARD_OPERATION* operation)
{
  LONG status = 0;
  ListReaders_Return ret = WINPR_C_ARRAY_INIT;
  DWORD cchReaders = 0;
  ListReaders_Call* call = nullptr;
  union
  {
    const BYTE* bp;
    const char* sz;
    const WCHAR* wz;
  } string;
  union
  {
    WCHAR** ppw;
    WCHAR* pw;
    CHAR* pc;
    BYTE* pb;
  } mszReaders;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(operation);

  call = &operation->call.listReaders;

  string.bp = call->mszGroups;
  cchReaders = SCARD_AUTOALLOCATE;
  status = ret.ReturnCode = wrap(smartcard, SCardListReadersW, operation->hContext, string.wz,
                                 (LPWSTR)&mszReaders.pw, &cchReaders);
  if (status == SCARD_S_SUCCESS)
  {
    if (cchReaders == SCARD_AUTOALLOCATE)
      status = SCARD_F_UNKNOWN_ERROR;
  }

  if (status != SCARD_S_SUCCESS)
  {
    (void)scard_log_status_error_wlog(smartcard->log, "SCardListReadersW", status);
    return smartcard_pack_list_readers_return(out, &ret, TRUE);
  }

  void* original = mszReaders.pb;
  cchReaders = filter_device_by_name_w(smartcard->names, &mszReaders.pw, cchReaders);
  ret.msz = mszReaders.pb;
  ret.cBytes = cchReaders * sizeof(WCHAR);
  status = smartcard_pack_list_readers_return(out, &ret, TRUE);

  if (original)
    wrap(smartcard, SCardFreeMemory, operation->hContext, original);

  if (status != SCARD_S_SUCCESS)
    return status;

  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG
smartcard_IntroduceReaderGroupA_Call(scard_call_context* smartcard, WINPR_ATTR_UNUSED wStream* out,
                                     SMARTCARD_OPERATION* operation)
{
  Long_Return ret = WINPR_C_ARRAY_INIT;
  ContextAndStringA_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.contextAndStringA;
  ret.ReturnCode = wrap(smartcard, SCardIntroduceReaderGroupA, operation->hContext, call->sz);
  scard_log_status_error_wlog(smartcard->log, "SCardIntroduceReaderGroupA", ret.ReturnCode);
  smartcard_trace_long_return_int(smartcard->log, &ret, "IntroduceReaderGroupA");
  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG
smartcard_IntroduceReaderGroupW_Call(scard_call_context* smartcard, WINPR_ATTR_UNUSED wStream* out,
                                     SMARTCARD_OPERATION* operation)
{
  Long_Return ret = WINPR_C_ARRAY_INIT;
  ContextAndStringW_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.contextAndStringW;
  ret.ReturnCode = wrap(smartcard, SCardIntroduceReaderGroupW, operation->hContext, call->sz);
  scard_log_status_error_wlog(smartcard->log, "SCardIntroduceReaderGroupW", ret.ReturnCode);
  smartcard_trace_long_return_int(smartcard->log, &ret, "IntroduceReaderGroupW");
  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_IntroduceReaderA_Call(scard_call_context* smartcard,
                                                                 WINPR_ATTR_UNUSED wStream* out,
                                                                 SMARTCARD_OPERATION* operation)
{
  Long_Return ret = WINPR_C_ARRAY_INIT;
  ContextAndTwoStringA_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.contextAndTwoStringA;
  ret.ReturnCode =
      wrap(smartcard, SCardIntroduceReaderA, operation->hContext, call->sz1, call->sz2);
  scard_log_status_error_wlog(smartcard->log, "SCardIntroduceReaderA", ret.ReturnCode);
  smartcard_trace_long_return_int(smartcard->log, &ret, "IntroduceReaderA");
  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_IntroduceReaderW_Call(scard_call_context* smartcard,
                                                                 WINPR_ATTR_UNUSED wStream* out,
                                                                 SMARTCARD_OPERATION* operation)
{
  Long_Return ret = WINPR_C_ARRAY_INIT;
  ContextAndTwoStringW_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.contextAndTwoStringW;
  ret.ReturnCode =
      wrap(smartcard, SCardIntroduceReaderW, operation->hContext, call->sz1, call->sz2);
  scard_log_status_error_wlog(smartcard->log, "SCardIntroduceReaderW", ret.ReturnCode);
  smartcard_trace_long_return_int(smartcard->log, &ret, "IntroduceReaderW");
  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_ForgetReaderA_Call(scard_call_context* smartcard,
                                                              WINPR_ATTR_UNUSED wStream* out,
                                                              SMARTCARD_OPERATION* operation)
{
  Long_Return ret = WINPR_C_ARRAY_INIT;
  ContextAndStringA_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.contextAndStringA;
  ret.ReturnCode = wrap(smartcard, SCardForgetReaderA, operation->hContext, call->sz);
  scard_log_status_error_wlog(smartcard->log, "SCardForgetReaderA", ret.ReturnCode);
  smartcard_trace_long_return_int(smartcard->log, &ret, "SCardForgetReaderA");
  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_ForgetReaderW_Call(scard_call_context* smartcard,
                                                              WINPR_ATTR_UNUSED wStream* out,
                                                              SMARTCARD_OPERATION* operation)
{
  Long_Return ret = WINPR_C_ARRAY_INIT;
  ContextAndStringW_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.contextAndStringW;
  ret.ReturnCode = wrap(smartcard, SCardForgetReaderW, operation->hContext, call->sz);
  scard_log_status_error_wlog(smartcard->log, "SCardForgetReaderW", ret.ReturnCode);
  smartcard_trace_long_return_int(smartcard->log, &ret, "SCardForgetReaderW");
  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_AddReaderToGroupA_Call(scard_call_context* smartcard,
                                                                  WINPR_ATTR_UNUSED wStream* out,
                                                                  SMARTCARD_OPERATION* operation)
{
  Long_Return ret = WINPR_C_ARRAY_INIT;
  ContextAndTwoStringA_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.contextAndTwoStringA;
  ret.ReturnCode =
      wrap(smartcard, SCardAddReaderToGroupA, operation->hContext, call->sz1, call->sz2);
  scard_log_status_error_wlog(smartcard->log, "SCardAddReaderToGroupA", ret.ReturnCode);
  smartcard_trace_long_return_int(smartcard->log, &ret, "SCardAddReaderToGroupA");
  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_AddReaderToGroupW_Call(scard_call_context* smartcard,
                                                                  WINPR_ATTR_UNUSED wStream* out,
                                                                  SMARTCARD_OPERATION* operation)
{
  Long_Return ret = WINPR_C_ARRAY_INIT;
  ContextAndTwoStringW_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.contextAndTwoStringW;
  ret.ReturnCode =
      wrap(smartcard, SCardAddReaderToGroupW, operation->hContext, call->sz1, call->sz2);
  scard_log_status_error_wlog(smartcard->log, "SCardAddReaderToGroupW", ret.ReturnCode);
  smartcard_trace_long_return_int(smartcard->log, &ret, "SCardAddReaderToGroupA");
  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG
smartcard_RemoveReaderFromGroupA_Call(scard_call_context* smartcard, WINPR_ATTR_UNUSED wStream* out,
                                      SMARTCARD_OPERATION* operation)
{
  Long_Return ret = WINPR_C_ARRAY_INIT;
  ContextAndTwoStringA_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.contextAndTwoStringA;
  ret.ReturnCode =
      wrap(smartcard, SCardRemoveReaderFromGroupA, operation->hContext, call->sz1, call->sz2);
  scard_log_status_error_wlog(smartcard->log, "SCardRemoveReaderFromGroupA", ret.ReturnCode);
  smartcard_trace_long_return_int(smartcard->log, &ret, "SCardRemoveReaderFromGroupA");
  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG
smartcard_RemoveReaderFromGroupW_Call(scard_call_context* smartcard, WINPR_ATTR_UNUSED wStream* out,
                                      SMARTCARD_OPERATION* operation)
{
  Long_Return ret = WINPR_C_ARRAY_INIT;
  ContextAndTwoStringW_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.contextAndTwoStringW;
  ret.ReturnCode =
      wrap(smartcard, SCardRemoveReaderFromGroupW, operation->hContext, call->sz1, call->sz2);
  scard_log_status_error_wlog(smartcard->log, "SCardRemoveReaderFromGroupW", ret.ReturnCode);
  smartcard_trace_long_return_int(smartcard->log, &ret, "SCardRemoveReaderFromGroupW");
  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_LocateCardsA_Call(scard_call_context* smartcard,
                                                             wStream* out,
                                                             SMARTCARD_OPERATION* operation)
{
  LONG status = 0;
  LocateCards_Return ret = WINPR_C_ARRAY_INIT;
  LocateCardsA_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(operation);

  call = &operation->call.locateCardsA;

  ret.ReturnCode = wrap(smartcard, SCardLocateCardsA, operation->hContext, call->mszCards,
                        call->rgReaderStates, call->cReaders);
  scard_log_status_error_wlog(smartcard->log, "SCardLocateCardsA", ret.ReturnCode);
  ret.rgReaderStates = nullptr;

  if (call->cReaders > 0)
  {
    ret.rgReaderStates =
        (ReaderState_Return*)calloc(call->cReaders, sizeof(ReaderState_Return));

    if (!ret.rgReaderStates)
      return STATUS_NO_MEMORY;
    ret.cReaders = call->cReaders;
  }

  for (UINT32 x = 0; x < ret.cReaders; x++)
  {
    const LPSCARD_READERSTATEA cstate = &call->rgReaderStates[x];
    ReaderState_Return* cur = &ret.rgReaderStates[x];

    cur->dwCurrentState = cstate->dwCurrentState;
    cur->dwEventState = cstate->dwEventState;
    cur->cbAtr = cstate->cbAtr;
    CopyMemory(&(cur->rgbAtr), &(cstate->rgbAtr), sizeof(cur->rgbAtr));
    if (!smartcard_reader_state_return_is_valid(x, cur))
    {
      free(ret.rgReaderStates);
      return SCARD_E_INVALID_ATR;
    }
  }

  status = smartcard_pack_locate_cards_return(out, &ret);
  free(ret.rgReaderStates);

  if (status != SCARD_S_SUCCESS)
    return status;

  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_LocateCardsW_Call(scard_call_context* smartcard,
                                                             wStream* out,
                                                             SMARTCARD_OPERATION* operation)
{
  LONG status = 0;
  LocateCards_Return ret = WINPR_C_ARRAY_INIT;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(operation);

  LocateCardsW_Call* call = &operation->call.locateCardsW;

  ret.ReturnCode = wrap(smartcard, SCardLocateCardsW, operation->hContext, call->mszCards,
                        call->rgReaderStates, call->cReaders);
  scard_log_status_error_wlog(smartcard->log, "SCardLocateCardsW", ret.ReturnCode);
  ret.rgReaderStates = nullptr;

  if (call->cReaders > 0)
  {
    ret.rgReaderStates =
        (ReaderState_Return*)calloc(call->cReaders, sizeof(ReaderState_Return));

    if (!ret.rgReaderStates)
      return STATUS_NO_MEMORY;
    ret.cReaders = call->cReaders;
  }

  for (UINT32 x = 0; x < ret.cReaders; x++)
  {
    const LPSCARD_READERSTATEW cstate = &call->rgReaderStates[x];
    ReaderState_Return* cur = &ret.rgReaderStates[x];

    cur->dwCurrentState = cstate->dwCurrentState;
    cur->dwEventState = cstate->dwEventState;
    cur->cbAtr = cstate->cbAtr;
    CopyMemory(&(cur->rgbAtr), &(cstate->rgbAtr), sizeof(cur->rgbAtr));
    if (!smartcard_reader_state_return_is_valid(x, cur))
    {
      free(ret.rgReaderStates);
      return SCARD_E_INVALID_ATR;
    }
  }

  status = smartcard_pack_locate_cards_return(out, &ret);
  free(ret.rgReaderStates);

  if (status != SCARD_S_SUCCESS)
    return status;

  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_ReadCacheA_Call(scard_call_context* smartcard,
                                                           wStream* out,
                                                           SMARTCARD_OPERATION* operation)
{
  LONG status = 0;
  BOOL autoalloc = 0;
  ReadCache_Return ret = WINPR_C_ARRAY_INIT;
  ReadCacheA_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.readCacheA;
  autoalloc = (call->Common.cbDataLen == SCARD_AUTOALLOCATE);

  if (!call->Common.fPbDataIsNULL)
  {
    if (!autoalloc)
    {
      ret.pbData = malloc(call->Common.cbDataLen);
      if (!ret.pbData)
        return SCARD_F_INTERNAL_ERROR;
    }
    ret.cbDataLen = call->Common.cbDataLen;
  }

  if (autoalloc)
    ret.ReturnCode = wrap(smartcard, SCardReadCacheA, operation->hContext,
                          call->Common.CardIdentifier, call->Common.FreshnessCounter,
                          call->szLookupName, (BYTE*)&ret.pbData, &ret.cbDataLen);
  else
    ret.ReturnCode =
        wrap(smartcard, SCardReadCacheA, operation->hContext, call->Common.CardIdentifier,
             call->Common.FreshnessCounter, call->szLookupName, ret.pbData, &ret.cbDataLen);

  WLog_Print(smartcard->log, WLOG_TRACE, "key=%s, length=%" PRIu32, call->szLookupName,
             ret.cbDataLen);

  if ((ret.ReturnCode != SCARD_W_CACHE_ITEM_NOT_FOUND) &&
      (ret.ReturnCode != SCARD_W_CACHE_ITEM_STALE))
  {
    scard_log_status_error_wlog(smartcard->log, "SCardReadCacheA", ret.ReturnCode);
  }

  status = smartcard_pack_read_cache_return(out, &ret);
  if (autoalloc)
    wrap(smartcard, SCardFreeMemory, operation->hContext, ret.pbData);
  else
    free(ret.pbData);
  if (status != SCARD_S_SUCCESS)
    return status;

  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_ReadCacheW_Call(scard_call_context* smartcard,
                                                           wStream* out,
                                                           SMARTCARD_OPERATION* operation)
{
  LONG status = 0;
  ReadCache_Return ret = WINPR_C_ARRAY_INIT;
  ReadCacheW_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.readCacheW;

  if (!call->Common.fPbDataIsNULL)
    ret.cbDataLen = SCARD_AUTOALLOCATE;

  ret.ReturnCode =
      wrap(smartcard, SCardReadCacheW, operation->hContext, call->Common.CardIdentifier,
           call->Common.FreshnessCounter, call->szLookupName, (BYTE*)&ret.pbData, &ret.cbDataLen);

  if (WLog_IsLevelActive(smartcard->log, WLOG_TRACE))
  {
    char buffer[128] = WINPR_C_ARRAY_INIT;
    (void)ConvertWCharToUtf8(call->szLookupName, buffer, sizeof(buffer));
    WLog_Print(smartcard->log, WLOG_TRACE, "key=%s, length=%" PRIu32, buffer, ret.cbDataLen);
  }
  if ((ret.ReturnCode != SCARD_W_CACHE_ITEM_NOT_FOUND) &&
      (ret.ReturnCode != SCARD_W_CACHE_ITEM_STALE))
  {
    scard_log_status_error_wlog(smartcard->log, "SCardReadCacheW", ret.ReturnCode);
  }

  status = smartcard_pack_read_cache_return(out, &ret);

  wrap(smartcard, SCardFreeMemory, operation->hContext, ret.pbData);

  if (status != SCARD_S_SUCCESS)
    return status;

  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_WriteCacheA_Call(scard_call_context* smartcard,
                                                            WINPR_ATTR_UNUSED wStream* out,
                                                            SMARTCARD_OPERATION* operation)
{
  Long_Return ret = WINPR_C_ARRAY_INIT;
  WriteCacheA_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.writeCacheA;

  ret.ReturnCode = wrap(smartcard, SCardWriteCacheA, operation->hContext,
                        call->Common.CardIdentifier, call->Common.FreshnessCounter,
                        call->szLookupName, call->Common.pbData, call->Common.cbDataLen);
  scard_log_status_error_wlog(smartcard->log, "SCardWriteCacheA", ret.ReturnCode);
  smartcard_trace_long_return_int(smartcard->log, &ret, "SCardWriteCacheA");
  WLog_Print(smartcard->log, WLOG_TRACE, "key=%s, length=%" PRIu32, call->szLookupName,
             call->Common.cbDataLen);
  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_WriteCacheW_Call(scard_call_context* smartcard,
                                                            WINPR_ATTR_UNUSED wStream* out,
                                                            SMARTCARD_OPERATION* operation)
{
  Long_Return ret = WINPR_C_ARRAY_INIT;
  WriteCacheW_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.writeCacheW;

  ret.ReturnCode = wrap(smartcard, SCardWriteCacheW, operation->hContext,
                        call->Common.CardIdentifier, call->Common.FreshnessCounter,
                        call->szLookupName, call->Common.pbData, call->Common.cbDataLen);
  scard_log_status_error_wlog(smartcard->log, "SCardWriteCacheW", ret.ReturnCode);
  smartcard_trace_long_return_int(smartcard->log, &ret, "SCardWriteCacheW");

  if (WLog_IsLevelActive(smartcard->log, WLOG_TRACE))
  {
    char buffer[128] = WINPR_C_ARRAY_INIT;
    (void)ConvertWCharToUtf8(call->szLookupName, buffer, sizeof(buffer));
    WLog_Print(smartcard->log, WLOG_TRACE, "key=%s, length=%" PRIu32, buffer,
               call->Common.cbDataLen);
  }
  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_GetTransmitCount_Call(scard_call_context* smartcard,
                                                                 wStream* out,
                                                                 SMARTCARD_OPERATION* operation)
{
  LONG status = 0;
  GetTransmitCount_Return ret = WINPR_C_ARRAY_INIT;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  ret.ReturnCode = wrap(smartcard, SCardGetTransmitCount, operation->hCard, &ret.cTransmitCount);
  scard_log_status_error_wlog(smartcard->log, "SCardGetTransmitCount", ret.ReturnCode);
  status = smartcard_pack_get_transmit_count_return(out, &ret);
  if (status != SCARD_S_SUCCESS)
    return status;

  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_ReleaseStartedEvent_Call(scard_call_context* smartcard,
                                                                    wStream* out,
                                                                    SMARTCARD_OPERATION* operation)
{
  WINPR_UNUSED(smartcard);
  WINPR_UNUSED(out);
  WINPR_UNUSED(operation);

  WLog_Print(smartcard->log, WLOG_WARN,
             "According to [MS-RDPESC] 3.1.4 Message Processing Events and Sequencing Rules "
             "this is not supported?!?");
  return SCARD_E_UNSUPPORTED_FEATURE;
}

WINPR_ATTR_NODISCARD static LONG smartcard_GetReaderIcon_Call(scard_call_context* smartcard,
                                                              wStream* out,
                                                              SMARTCARD_OPERATION* operation)
{
  LONG status = 0;
  GetReaderIcon_Return ret = WINPR_C_ARRAY_INIT;
  GetReaderIcon_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.getReaderIcon;

  ret.cbDataLen = SCARD_AUTOALLOCATE;
  ret.ReturnCode = wrap(smartcard, SCardGetReaderIconW, operation->hContext, call->szReaderName,
                        (LPBYTE)&ret.pbData, &ret.cbDataLen);
  scard_log_status_error_wlog(smartcard->log, "SCardGetReaderIconW", ret.ReturnCode);
  if ((ret.ReturnCode == SCARD_S_SUCCESS) && (ret.cbDataLen == SCARD_AUTOALLOCATE))
    return SCARD_F_UNKNOWN_ERROR;

  status = smartcard_pack_get_reader_icon_return(out, &ret);
  wrap(smartcard, SCardFreeMemory, operation->hContext, ret.pbData);
  if (status != SCARD_S_SUCCESS)
    return status;

  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_GetDeviceTypeId_Call(scard_call_context* smartcard,
                                                                wStream* out,
                                                                SMARTCARD_OPERATION* operation)
{
  LONG status = 0;
  GetDeviceTypeId_Return ret = WINPR_C_ARRAY_INIT;
  GetDeviceTypeId_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.getDeviceTypeId;

  ret.ReturnCode = wrap(smartcard, SCardGetDeviceTypeIdW, operation->hContext, call->szReaderName,
                        &ret.dwDeviceId);
  scard_log_status_error_wlog(smartcard->log, "SCardGetDeviceTypeIdW", ret.ReturnCode);

  status = smartcard_pack_device_type_id_return(out, &ret);
  if (status != SCARD_S_SUCCESS)
    return status;

  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD
static BOOL smartcard_context_was_aborted(scard_call_context* smartcard)
{
  WINPR_ASSERT(smartcard);

  HANDLE handles[] = { smartcard->stopEvent, freerdp_abort_event(smartcard->context) };
  const DWORD rc = WaitForMultipleObjects(ARRAYSIZE(handles), handles, FALSE, 0);
  return (rc >= WAIT_OBJECT_0) && (rc <= WAIT_OBJECT_0 + ARRAYSIZE(handles));
}

WINPR_ATTR_NODISCARD static LONG smartcard_GetStatusChangeA_Call(scard_call_context* smartcard,
                                                                 wStream* out,
                                                                 SMARTCARD_OPERATION* operation)
{
  LONG status = STATUS_NO_MEMORY;
  DWORD dwTimeOut = 0;
  const DWORD dwTimeStep = 100;
  GetStatusChange_Return ret = WINPR_C_ARRAY_INIT;
  GetStatusChangeA_Call* call = nullptr;
  LPSCARD_READERSTATEA rgReaderStates = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.getStatusChangeA;
  dwTimeOut = call->dwTimeOut;

  if (call->cReaders > 0)
  {
    rgReaderStates = calloc(call->cReaders, sizeof(SCARD_READERSTATEA));
    ret.rgReaderStates =
        (ReaderState_Return*)calloc(call->cReaders, sizeof(ReaderState_Return));
    if (!rgReaderStates || !ret.rgReaderStates)
      goto fail;

    ret.cReaders = call->cReaders;
  }

  for (UINT32 x = 0; x < MAX(1, dwTimeOut);)
  {
    if (call->cReaders > 0)
      memcpy(rgReaderStates, call->rgReaderStates,
             call->cReaders * sizeof(SCARD_READERSTATEA));
    ret.ReturnCode = wrap(smartcard, SCardGetStatusChangeA, operation->hContext,
                          MIN(dwTimeOut, dwTimeStep), rgReaderStates, call->cReaders);
    if (ret.ReturnCode != SCARD_E_TIMEOUT)
      break;
    if (smartcard_context_was_aborted(smartcard))
      break;
    if (dwTimeOut != INFINITE)
      x += dwTimeStep;
  }
  scard_log_status_error_wlog(smartcard->log, "SCardGetStatusChangeA", ret.ReturnCode);

  status = SCARD_E_INVALID_ATR;
  for (UINT32 index = 0; index < ret.cReaders; index++)
  {
    const SCARD_READERSTATEA* cur = &rgReaderStates[index];
    ReaderState_Return* rout = &ret.rgReaderStates[index];

    rout->dwCurrentState = cur->dwCurrentState;
    rout->dwEventState = cur->dwEventState;
    rout->cbAtr = cur->cbAtr;
    CopyMemory(&(rout->rgbAtr), cur->rgbAtr, sizeof(rout->rgbAtr));
    if (!smartcard_reader_state_return_is_valid(index, rout))
      goto fail;
  }

  status = smartcard_pack_get_status_change_return(out, &ret, FALSE);
fail:
  free(ret.rgReaderStates);
  free(rgReaderStates);
  if (status != SCARD_S_SUCCESS)
    return status;
  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_GetStatusChangeW_Call(scard_call_context* smartcard,
                                                                 wStream* out,
                                                                 SMARTCARD_OPERATION* operation)
{
  LONG status = STATUS_NO_MEMORY;
  DWORD dwTimeOut = 0;
  const DWORD dwTimeStep = 100;
  GetStatusChange_Return ret = WINPR_C_ARRAY_INIT;
  LPSCARD_READERSTATEW rgReaderStates = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  GetStatusChangeW_Call* call = &operation->call.getStatusChangeW;
  dwTimeOut = call->dwTimeOut;

  if (call->cReaders > 0)
  {
    rgReaderStates = calloc(call->cReaders, sizeof(SCARD_READERSTATEW));
    ret.rgReaderStates =
        (ReaderState_Return*)calloc(call->cReaders, sizeof(ReaderState_Return));
    if (!rgReaderStates || !ret.rgReaderStates)
      goto fail;

    ret.cReaders = call->cReaders;
  }

  for (UINT32 x = 0; x < MAX(1, dwTimeOut);)
  {
    if (call->cReaders > 0)
      memcpy(rgReaderStates, call->rgReaderStates,
             call->cReaders * sizeof(SCARD_READERSTATEW));
    {
      ret.ReturnCode = wrap(smartcard, SCardGetStatusChangeW, operation->hContext,
                            MIN(dwTimeOut, dwTimeStep), rgReaderStates, call->cReaders);
    }
    if (ret.ReturnCode != SCARD_E_TIMEOUT)
      break;
    if (smartcard_context_was_aborted(smartcard))
      break;
    if (dwTimeOut != INFINITE)
      x += dwTimeStep;
  }
  scard_log_status_error_wlog(smartcard->log, "SCardGetStatusChangeW", ret.ReturnCode);

  status = SCARD_E_INVALID_ATR;
  for (UINT32 index = 0; index < ret.cReaders; index++)
  {
    const SCARD_READERSTATEW* cur = &rgReaderStates[index];
    ReaderState_Return* rout = &ret.rgReaderStates[index];

    rout->dwCurrentState = cur->dwCurrentState;
    rout->dwEventState = cur->dwEventState;
    rout->cbAtr = cur->cbAtr;
    CopyMemory(&(rout->rgbAtr), cur->rgbAtr, sizeof(rout->rgbAtr));
    if (!smartcard_reader_state_return_is_valid(index, rout))
      goto fail;
  }

  status = smartcard_pack_get_status_change_return(out, &ret, TRUE);
fail:
  free(ret.rgReaderStates);
  free(rgReaderStates);
  if (status != SCARD_S_SUCCESS)
    return status;
  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_Cancel_Call(scard_call_context* smartcard,
                                                       WINPR_ATTR_UNUSED wStream* out,
                                                       SMARTCARD_OPERATION* operation)
{
  Long_Return ret = WINPR_C_ARRAY_INIT;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  ret.ReturnCode = wrap(smartcard, SCardCancel, operation->hContext);
  scard_log_status_error_wlog(smartcard->log, "SCardCancel", ret.ReturnCode);
  smartcard_trace_long_return_int(smartcard->log, &ret, "Cancel");
  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG
smartcard_ConnectA_Call(scard_call_context* smartcard, wStream* out, SMARTCARD_OPERATION* operation)
{
  LONG status = 0;
  SCARDHANDLE hCard = 0;
  Connect_Return ret = WINPR_C_ARRAY_INIT;
  ConnectA_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.connectA;

  if ((call->Common.dwPreferredProtocols == SCARD_PROTOCOL_UNDEFINED) &&
      (call->Common.dwShareMode != SCARD_SHARE_DIRECT))
  {
    call->Common.dwPreferredProtocols = SCARD_PROTOCOL_Tx;
  }

  ret.ReturnCode = wrap(smartcard, SCardConnectA, operation->hContext, (char*)call->szReader,
                        call->Common.dwShareMode, call->Common.dwPreferredProtocols, &hCard,
                        &ret.dwActiveProtocol);
  smartcard_scard_context_native_to_redir(&(ret.hContext), operation->hContext);
  smartcard_scard_handle_native_to_redir(&(ret.hCard), hCard);

  status = smartcard_pack_connect_return(out, &ret);
  if (status != SCARD_S_SUCCESS)
    goto out_fail;

  status = ret.ReturnCode;
out_fail:

  return status;
}

WINPR_ATTR_NODISCARD static LONG
smartcard_ConnectW_Call(scard_call_context* smartcard, wStream* out, SMARTCARD_OPERATION* operation)
{
  LONG status = 0;
  SCARDHANDLE hCard = 0;
  Connect_Return ret = WINPR_C_ARRAY_INIT;
  ConnectW_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.connectW;

  if ((call->Common.dwPreferredProtocols == SCARD_PROTOCOL_UNDEFINED) &&
      (call->Common.dwShareMode != SCARD_SHARE_DIRECT))
  {
    call->Common.dwPreferredProtocols = SCARD_PROTOCOL_Tx;
  }

  ret.ReturnCode = wrap(smartcard, SCardConnectW, operation->hContext, (WCHAR*)call->szReader,
                        call->Common.dwShareMode, call->Common.dwPreferredProtocols, &hCard,
                        &ret.dwActiveProtocol);
  smartcard_scard_context_native_to_redir(&(ret.hContext), operation->hContext);
  smartcard_scard_handle_native_to_redir(&(ret.hCard), hCard);

  status = smartcard_pack_connect_return(out, &ret);
  if (status != SCARD_S_SUCCESS)
    goto out_fail;

  status = ret.ReturnCode;
out_fail:

  return status;
}

WINPR_ATTR_NODISCARD static LONG smartcard_Reconnect_Call(scard_call_context* smartcard,
                                                          wStream* out,
                                                          SMARTCARD_OPERATION* operation)
{
  LONG status = 0;
  Reconnect_Return ret = WINPR_C_ARRAY_INIT;
  Reconnect_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.reconnect;
  ret.ReturnCode =
      wrap(smartcard, SCardReconnect, operation->hCard, call->dwShareMode,
           call->dwPreferredProtocols, call->dwInitialization, &ret.dwActiveProtocol);
  scard_log_status_error_wlog(smartcard->log, "SCardReconnect", ret.ReturnCode);
  status = smartcard_pack_reconnect_return(out, &ret);
  if (status != SCARD_S_SUCCESS)
    return status;

  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_Disconnect_Call(scard_call_context* smartcard,
                                                           WINPR_ATTR_UNUSED wStream* out,
                                                           SMARTCARD_OPERATION* operation)
{
  Long_Return ret = WINPR_C_ARRAY_INIT;
  HCardAndDisposition_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.hCardAndDisposition;

  ret.ReturnCode = wrap(smartcard, SCardDisconnect, operation->hCard, call->dwDisposition);
  scard_log_status_error_wlog(smartcard->log, "SCardDisconnect", ret.ReturnCode);
  smartcard_trace_long_return_int(smartcard->log, &ret, "Disconnect");

  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_BeginTransaction_Call(scard_call_context* smartcard,
                                                                 WINPR_ATTR_UNUSED wStream* out,
                                                                 SMARTCARD_OPERATION* operation)
{
  Long_Return ret = WINPR_C_ARRAY_INIT;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  ret.ReturnCode = wrap(smartcard, SCardBeginTransaction, operation->hCard);
  scard_log_status_error_wlog(smartcard->log, "SCardBeginTransaction", ret.ReturnCode);
  smartcard_trace_long_return_int(smartcard->log, &ret, "BeginTransaction");
  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_EndTransaction_Call(scard_call_context* smartcard,
                                                               WINPR_ATTR_UNUSED wStream* out,
                                                               SMARTCARD_OPERATION* operation)
{
  Long_Return ret = WINPR_C_ARRAY_INIT;
  HCardAndDisposition_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.hCardAndDisposition;

  ret.ReturnCode = wrap(smartcard, SCardEndTransaction, operation->hCard, call->dwDisposition);
  scard_log_status_error_wlog(smartcard->log, "SCardEndTransaction", ret.ReturnCode);
  smartcard_trace_long_return_int(smartcard->log, &ret, "EndTransaction");
  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_State_Call(scard_call_context* smartcard, wStream* out,
                                                      SMARTCARD_OPERATION* operation)
{
  LONG status = 0;
  State_Return ret = WINPR_C_ARRAY_INIT;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  ret.cbAtrLen = SCARD_ATR_LENGTH;
  ret.ReturnCode = wrap(smartcard, SCardState, operation->hCard, &ret.dwState, &ret.dwProtocol,
                        (BYTE*)&ret.rgAtr, &ret.cbAtrLen);

  scard_log_status_error_wlog(smartcard->log, "SCardState", ret.ReturnCode);
  status = smartcard_pack_state_return(out, &ret);
  if (status != SCARD_S_SUCCESS)
    return status;

  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_StatusA_Call(scard_call_context* smartcard, wStream* out,
                                                        SMARTCARD_OPERATION* operation)
{
  LONG status = 0;
  Status_Return ret = WINPR_C_ARRAY_INIT;
  DWORD cchReaderLen = 0;
  DWORD cbAtrLen = 0;
  LPSTR mszReaderNames = nullptr;
  Status_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.status;

  call->cbAtrLen = 32;
  cbAtrLen = call->cbAtrLen;

  if (call->fmszReaderNamesIsNULL)
    cchReaderLen = 0;
  else
    cchReaderLen = SCARD_AUTOALLOCATE;

  status = ret.ReturnCode =
      wrap(smartcard, SCardStatusA, operation->hCard,
           call->fmszReaderNamesIsNULL ? nullptr : (LPSTR)&mszReaderNames, &cchReaderLen,
           &ret.dwState, &ret.dwProtocol, cbAtrLen ? (BYTE*)&ret.pbAtr : nullptr, &cbAtrLen);

  scard_log_status_error_wlog(smartcard->log, "SCardStatusA", status);
  if ((ret.ReturnCode == SCARD_S_SUCCESS) && (cchReaderLen == SCARD_AUTOALLOCATE))
    return SCARD_F_UNKNOWN_ERROR;

  if (status == SCARD_S_SUCCESS)
  {
    if (!call->fmszReaderNamesIsNULL)
      ret.mszReaderNames = (BYTE*)mszReaderNames;

    ret.cBytes = cchReaderLen;

    if (call->cbAtrLen)
      ret.cbAtrLen = cbAtrLen;
  }

  status = smartcard_pack_status_return(out, &ret, FALSE);

  if (mszReaderNames)
    wrap(smartcard, SCardFreeMemory, operation->hContext, mszReaderNames);

  if (status != SCARD_S_SUCCESS)
    return status;
  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_StatusW_Call(scard_call_context* smartcard, wStream* out,
                                                        SMARTCARD_OPERATION* operation)
{
  LONG status = 0;
  Status_Return ret = WINPR_C_ARRAY_INIT;
  LPWSTR mszReaderNames = nullptr;
  Status_Call* call = nullptr;
  DWORD cbAtrLen = 0;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.status;

  /**
   * [MS-RDPESC]
   * According to 2.2.2.18 Status_Call cbAtrLen is unused an must be ignored upon receipt.
   */
  cbAtrLen = call->cbAtrLen = 32;

  if (call->fmszReaderNamesIsNULL)
    ret.cBytes = 0;
  else
    ret.cBytes = SCARD_AUTOALLOCATE;

  status = ret.ReturnCode =
      wrap(smartcard, SCardStatusW, operation->hCard,
           call->fmszReaderNamesIsNULL ? nullptr : (LPWSTR)&mszReaderNames, &ret.cBytes,
           &ret.dwState, &ret.dwProtocol, (BYTE*)&ret.pbAtr, &cbAtrLen);
  scard_log_status_error_wlog(smartcard->log, "SCardStatusW", status);
  if ((ret.ReturnCode == SCARD_S_SUCCESS) && (ret.cBytes == SCARD_AUTOALLOCATE))
    return SCARD_F_UNKNOWN_ERROR;

  size_t blen = 0;
  if (status == SCARD_S_SUCCESS)
  {
    if (!call->fmszReaderNamesIsNULL)
      ret.mszReaderNames = (BYTE*)mszReaderNames;

    ret.cbAtrLen = cbAtrLen;
  }

  if (ret.cBytes != SCARD_AUTOALLOCATE)
  {
    /* SCardStatusW returns number of characters, we need number of bytes */
    WINPR_ASSERT(ret.cBytes < SCARD_AUTOALLOCATE / sizeof(WCHAR));
    blen = sizeof(WCHAR) * ret.cBytes;
    WINPR_ASSERT(blen <= UINT32_MAX);
    ret.cBytes = (UINT32)blen;
  }

  status = smartcard_pack_status_return(out, &ret, TRUE);
  if (status != SCARD_S_SUCCESS)
    return status;

  if (mszReaderNames)
    wrap(smartcard, SCardFreeMemory, operation->hContext, mszReaderNames);

  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG
smartcard_Transmit_Call(scard_call_context* smartcard, wStream* out, SMARTCARD_OPERATION* operation)
{
  LONG status = 0;
  Transmit_Return ret = WINPR_C_ARRAY_INIT;
  Transmit_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.transmit;
  ret.cbRecvLength = 0;
  ret.pbRecvBuffer = nullptr;

  if (call->cbRecvLength && !call->fpbRecvBufferIsNULL)
  {
    if (call->cbRecvLength >= 66560)
      call->cbRecvLength = 66560;

    const UINT32 cbRecvLength = call->cbRecvLength;
    ret.pbRecvBuffer = (BYTE*)malloc(cbRecvLength);

    if (!ret.pbRecvBuffer)
      return STATUS_NO_MEMORY;
    ret.cbRecvLength = cbRecvLength;
  }

  ret.pioRecvPci = call->pioRecvPci;
  ret.ReturnCode =
      wrap(smartcard, SCardTransmit, operation->hCard, call->pioSendPci, call->pbSendBuffer,
           call->cbSendLength, ret.pioRecvPci, ret.pbRecvBuffer, &(ret.cbRecvLength));

  scard_log_status_error_wlog(smartcard->log, "SCardTransmit", ret.ReturnCode);

  status = smartcard_pack_transmit_return(out, &ret);
  free(ret.pbRecvBuffer);

  if (status != SCARD_S_SUCCESS)
    return status;
  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_Control_Call(scard_call_context* smartcard, wStream* out,
                                                        SMARTCARD_OPERATION* operation)
{
  LONG status = 0;
  Control_Return ret = WINPR_C_ARRAY_INIT;
  Control_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.control;
  ret.pvOutBuffer = (BYTE*)malloc(call->cbOutBufferSize);

  if (!ret.pvOutBuffer)
    return SCARD_E_NO_MEMORY;
  ret.cbOutBufferSize = call->cbOutBufferSize;

  ret.ReturnCode =
      wrap(smartcard, SCardControl, operation->hCard, call->dwControlCode, call->pvInBuffer,
           call->cbInBufferSize, ret.pvOutBuffer, call->cbOutBufferSize, &ret.cbOutBufferSize);
  scard_log_status_error_wlog(smartcard->log, "SCardControl", ret.ReturnCode);
  status = smartcard_pack_control_return(out, &ret);

  free(ret.pvOutBuffer);
  if (status != SCARD_S_SUCCESS)
    return status;
  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_GetAttrib_Call(scard_call_context* smartcard,
                                                          wStream* out,
                                                          SMARTCARD_OPERATION* operation)
{
  BOOL autoAllocate = FALSE;
  LONG status = 0;
  DWORD cbAttrLen = 0;
  LPBYTE pbAttr = nullptr;
  GetAttrib_Return ret = WINPR_C_ARRAY_INIT;
  const GetAttrib_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(operation);

  call = &operation->call.getAttrib;

  if (!call->fpbAttrIsNULL)
  {
    autoAllocate = (call->cbAttrLen == SCARD_AUTOALLOCATE);
    cbAttrLen = call->cbAttrLen;
    if (cbAttrLen && !autoAllocate)
    {
      ret.pbAttr = (BYTE*)malloc(cbAttrLen);

      if (!ret.pbAttr)
        return SCARD_E_NO_MEMORY;
    }

    pbAttr = autoAllocate ? (LPBYTE) & (ret.pbAttr) : ret.pbAttr;
  }

  ret.ReturnCode =
      wrap(smartcard, SCardGetAttrib, operation->hCard, call->dwAttrId, pbAttr, &cbAttrLen);
  scard_log_status_error_wlog(smartcard->log, "SCardGetAttrib", ret.ReturnCode);
  if ((ret.ReturnCode == SCARD_S_SUCCESS) && (cbAttrLen == SCARD_AUTOALLOCATE))
    return SCARD_F_UNKNOWN_ERROR;

  ret.cbAttrLen = cbAttrLen;

  status = smartcard_pack_get_attrib_return(out, &ret, call->dwAttrId, call->cbAttrLen);

  if (autoAllocate)
    wrap(smartcard, SCardFreeMemory, operation->hContext, ret.pbAttr);
  else
    free(ret.pbAttr);
  return status;
}

WINPR_ATTR_NODISCARD static LONG smartcard_SetAttrib_Call(scard_call_context* smartcard,
                                                          WINPR_ATTR_UNUSED wStream* out,
                                                          SMARTCARD_OPERATION* operation)
{
  Long_Return ret = WINPR_C_ARRAY_INIT;
  SetAttrib_Call* call = nullptr;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_ASSERT(operation);

  call = &operation->call.setAttrib;

  ret.ReturnCode = wrap(smartcard, SCardSetAttrib, operation->hCard, call->dwAttrId, call->pbAttr,
                        call->cbAttrLen);
  scard_log_status_error_wlog(smartcard->log, "SCardSetAttrib", ret.ReturnCode);
  smartcard_trace_long_return_int(smartcard->log, &ret, "SetAttrib");

  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_AccessStartedEvent_Call(scard_call_context* smartcard,
                                                                   WINPR_ATTR_UNUSED wStream* out,
                                                                   SMARTCARD_OPERATION* operation)
{
  LONG status = SCARD_S_SUCCESS;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(out);
  WINPR_UNUSED(operation);

  if (!smartcard->StartedEvent)
    smartcard->StartedEvent = wrap_ptr(smartcard, SCardAccessStartedEvent);

  if (!smartcard->StartedEvent)
    status = SCARD_E_NO_SERVICE;

  return status;
}

WINPR_ATTR_NODISCARD static LONG smartcard_LocateCardsByATRA_Call(scard_call_context* smartcard,
                                                                  wStream* out,
                                                                  SMARTCARD_OPERATION* operation)
{
  LONG status = SCARD_E_INVALID_HANDLE;
  GetStatusChange_Return ret = WINPR_C_ARRAY_INIT;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(operation);

  LocateCardsByATRA_Call* call = &operation->call.locateCardsByATRA;
  LPSCARD_READERSTATEA states =
      (LPSCARD_READERSTATEA)calloc(call->cReaders, sizeof(SCARD_READERSTATEA));

  if (!states)
    return STATUS_NO_MEMORY;

  for (UINT32 i = 0; i < call->cReaders; i++)
  {
    const LPSCARD_READERSTATEA cstate = &call->rgReaderStates[i];
    LPSCARD_READERSTATEA state = &states[i];

    state->szReader = cstate->szReader;
    state->dwCurrentState = cstate->dwCurrentState;
    state->dwEventState = cstate->dwEventState;
    state->cbAtr = cstate->cbAtr;

    if (state->cbAtr > sizeof(state->rgbAtr))
    {
      WLog_WARN(SCARD_TAG, "[%" PRIu32 "] val->cbAtr=%" PRIu32 ", max=%" PRIuz, i,
                state->cbAtr, sizeof(state->rgbAtr));
      goto fail;
    }
    CopyMemory(&(state->rgbAtr), &(cstate->rgbAtr), sizeof(cstate->rgbAtr));
  }

  status = ret.ReturnCode = wrap(smartcard, SCardGetStatusChangeA, operation->hContext,
                                 0x000001F4, states, call->cReaders);

  scard_log_status_error_wlog(smartcard->log, "SCardGetStatusChangeA", status);
  for (UINT32 i = 0; i < call->cAtrs; i++)
  {
    for (UINT32 j = 0; j < call->cReaders; j++)
    {
      const LocateCards_ATRMask* mask = &call->rgAtrMasks[i];
      for (UINT32 k = 0; k < mask->cbAtr; k++)
      {
        if ((mask->rgbAtr[k] & mask->rgbMask[k]) !=
            (states[j].rgbAtr[k] & mask->rgbMask[k]))
        {
          break;
        }

        states[j].dwEventState |= SCARD_STATE_ATRMATCH;
      }
    }
  }

  ret.rgReaderStates = nullptr;

  if (call->cReaders > 0)
    ret.rgReaderStates =
        (ReaderState_Return*)calloc(call->cReaders, sizeof(ReaderState_Return));

  if (!ret.rgReaderStates)
  {
    status = STATUS_NO_MEMORY;
    goto fail;
  }

  ret.cReaders = call->cReaders;

  status = SCARD_E_INVALID_ATR;
  for (UINT32 i = 0; i < ret.cReaders; i++)
  {
    const LPSCARD_READERSTATEA state = &states[i];
    ReaderState_Return* cur = &ret.rgReaderStates[i];

    cur->dwCurrentState = state->dwCurrentState;
    cur->dwEventState = state->dwEventState;
    cur->cbAtr = state->cbAtr;
    CopyMemory(&(cur->rgbAtr), &(state->rgbAtr), sizeof(cur->rgbAtr));

    if (!smartcard_reader_state_return_is_valid(i, cur))
      goto fail;
  }

  status = smartcard_pack_get_status_change_return(out, &ret, FALSE);

fail:
  free(states);
  free(ret.rgReaderStates);
  if (status != SCARD_S_SUCCESS)
    return status;
  return ret.ReturnCode;
}

WINPR_ATTR_NODISCARD static LONG smartcard_LocateCardsByATRW_Call(scard_call_context* smartcard,
                                                                  wStream* out,
                                                                  SMARTCARD_OPERATION* operation)
{
  LONG status = SCARD_E_INVALID_HANDLE;
  GetStatusChange_Return ret = WINPR_C_ARRAY_INIT;

  WINPR_ASSERT(smartcard);
  WINPR_ASSERT(operation);

  LocateCardsByATRW_Call* call = &operation->call.locateCardsByATRW;
  LPSCARD_READERSTATEW states =
      (LPSCARD_READERSTATEW)calloc(call->cReaders, sizeof(SCARD_READERSTATEW));

  if (!states)
    return STATUS_NO_MEMORY;

  for (UINT32 i = 0; i < call->cReaders; i++)
  {
    const LPSCARD_READERSTATEW cstate = &call->rgReaderStates[i];
    LPSCARD_READERSTATEW state = &states[i];

    state->szReader = cstate->szReader;
    state->dwCurrentState = cstate->dwCurrentState;
    state->dwEventState = cstate->dwEventState;
    state->cbAtr = cstate->cbAtr;

    if (state->cbAtr > sizeof(state->rgbAtr))
    {
      WLog_WARN(SCARD_TAG, "[%" PRIu32 "] val->cbAtr=%" PRIu32 ", max=%" PRIuz, i,
                state->cbAtr, sizeof(state->rgbAtr));
      goto fail;
    }
    CopyMemory(&(state->rgbAtr), &(cstate->rgbAtr), sizeof(cstate->rgbAtr));
  }

  status = ret.ReturnCode = wrap(smartcard, SCardGetStatusChangeW, operation->hContext,
                                 0x000001F4, states, call->cReaders);

  scard_log_status_error_wlog(smartcard->log, "SCardGetStatusChangeW", status);
  for (UINT32 i = 0; i < call->cAtrs; i++)
  {
    for (UINT32 j = 0; j < call->cReaders; j++)
    {
      const LocateCards_ATRMask* mask = &call->rgAtrMasks[i];
      for (UINT32 k = 0; k < mask->cbAtr; k++)
      {
        if ((mask->rgbAtr[k] & mask->rgbMask[k]) !=
            (states[j].rgbAtr[k] & mask->rgbMask[k]))
        {
          break;
        }

        states[j].dwEventState |= SCARD_STATE_ATRMATCH;
      }
    }
  }

  ret.rgReaderStates = nullptr;

  if (call->cReaders > 0)
    ret.rgReaderStates =
        (ReaderState_Return*)calloc(call->cReaders, sizeof(ReaderState_Return));

  if (!ret.rgReaderStates)
  {
    status = STATUS_NO_MEMORY;
    goto fail;
  }

  ret.cReaders = call->cReaders;

  status = SCARD_E_INVALID_ATR;
  for (UINT32 i = 0; i < ret.cReaders; i++)
  {
    const LPSCARD_READERSTATEW state = &states[i];
    ReaderState_Return* cur = &ret.rgReaderStates[i];

    cur->dwCurrentState = state->dwCurrentState;
    cur->dwEventState = state->dwEventState;
    cur->cbAtr = state->cbAtr;
    CopyMemory(&(cur->rgbAtr), &(state->rgbAtr), sizeof(cur->rgbAtr));

    if (!smartcard_reader_state_return_is_valid(i, cur))
      goto fail;
  }

  status = smartcard_pack_get_status_change_return(out, &ret, FALSE);

fail:
  free(states);
  free(ret.rgReaderStates);
  if (status != SCARD_S_SUCCESS)
    return status;
  return ret.ReturnCode;
}

LONG smartcard_irp_device_control_call(scard_call_context* ctx, wStream* out, NTSTATUS* pIoStatus,
                                       SMARTCARD_OPERATION* operation)
{
  LONG result = 0;
  UINT32 offset = 0;
  size_t objectBufferLength = 0;

  WINPR_ASSERT(ctx);
  WINPR_ASSERT(out);
  WINPR_ASSERT(pIoStatus);
  WINPR_ASSERT(operation);

  const UINT32 ioControlCode = operation->ioControlCode;
  /**
   * [MS-RDPESC] 3.2.5.1: Sending Outgoing Messages:
   * the output buffer length SHOULD be set to 2048
   *
   * Since it's a SHOULD and not a MUST, we don't care
   * about it, but we still reserve at least 2048 bytes.
   */
  const size_t outMaxLen = MAX(2048, operation->outputBufferLength);
  if (!Stream_EnsureRemainingCapacity(out, outMaxLen))
    return SCARD_E_NO_MEMORY;

  /* Device Control Response */
  Stream_Write_UINT32(out, 0);                            /* OutputBufferLength (4 bytes) */
  Stream_Zero(out, SMARTCARD_COMMON_TYPE_HEADER_LENGTH);  /* CommonTypeHeader (8 bytes) */
  Stream_Zero(out, SMARTCARD_PRIVATE_TYPE_HEADER_LENGTH); /* PrivateTypeHeader (8 bytes) */
  Stream_Write_UINT32(out, 0);                            /* Result (4 bytes) */

  /* Call */
  switch (ioControlCode)
  {
    case SCARD_IOCTL_ESTABLISHCONTEXT:
      result = smartcard_EstablishContext_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_RELEASECONTEXT:
      result = smartcard_ReleaseContext_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_ISVALIDCONTEXT:
      result = smartcard_IsValidContext_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_LISTREADERGROUPSA:
      result = smartcard_ListReaderGroupsA_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_LISTREADERGROUPSW:
      result = smartcard_ListReaderGroupsW_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_LISTREADERSA:
      result = smartcard_ListReadersA_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_LISTREADERSW:
      result = smartcard_ListReadersW_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_INTRODUCEREADERGROUPA:
      result = smartcard_IntroduceReaderGroupA_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_INTRODUCEREADERGROUPW:
      result = smartcard_IntroduceReaderGroupW_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_FORGETREADERGROUPA:
      result = smartcard_ForgetReaderA_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_FORGETREADERGROUPW:
      result = smartcard_ForgetReaderW_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_INTRODUCEREADERA:
      result = smartcard_IntroduceReaderA_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_INTRODUCEREADERW:
      result = smartcard_IntroduceReaderW_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_FORGETREADERA:
      result = smartcard_ForgetReaderA_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_FORGETREADERW:
      result = smartcard_ForgetReaderW_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_ADDREADERTOGROUPA:
      result = smartcard_AddReaderToGroupA_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_ADDREADERTOGROUPW:
      result = smartcard_AddReaderToGroupW_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_REMOVEREADERFROMGROUPA:
      result = smartcard_RemoveReaderFromGroupA_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_REMOVEREADERFROMGROUPW:
      result = smartcard_RemoveReaderFromGroupW_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_LOCATECARDSA:
      result = smartcard_LocateCardsA_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_LOCATECARDSW:
      result = smartcard_LocateCardsW_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_GETSTATUSCHANGEA:
      result = smartcard_GetStatusChangeA_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_GETSTATUSCHANGEW:
      result = smartcard_GetStatusChangeW_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_CANCEL:
      result = smartcard_Cancel_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_CONNECTA:
      result = smartcard_ConnectA_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_CONNECTW:
      result = smartcard_ConnectW_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_RECONNECT:
      result = smartcard_Reconnect_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_DISCONNECT:
      result = smartcard_Disconnect_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_BEGINTRANSACTION:
      result = smartcard_BeginTransaction_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_ENDTRANSACTION:
      result = smartcard_EndTransaction_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_STATE:
      result = smartcard_State_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_STATUSA:
      result = smartcard_StatusA_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_STATUSW:
      result = smartcard_StatusW_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_TRANSMIT:
      result = smartcard_Transmit_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_CONTROL:
      result = smartcard_Control_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_GETATTRIB:
      result = smartcard_GetAttrib_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_SETATTRIB:
      result = smartcard_SetAttrib_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_ACCESSSTARTEDEVENT:
      result = smartcard_AccessStartedEvent_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_LOCATECARDSBYATRA:
      result = smartcard_LocateCardsByATRA_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_LOCATECARDSBYATRW:
      result = smartcard_LocateCardsByATRW_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_READCACHEA:
      result = smartcard_ReadCacheA_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_READCACHEW:
      result = smartcard_ReadCacheW_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_WRITECACHEA:
      result = smartcard_WriteCacheA_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_WRITECACHEW:
      result = smartcard_WriteCacheW_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_GETTRANSMITCOUNT:
      result = smartcard_GetTransmitCount_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_RELEASETARTEDEVENT:
      result = smartcard_ReleaseStartedEvent_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_GETREADERICON:
      result = smartcard_GetReaderIcon_Call(ctx, out, operation);
      break;

    case SCARD_IOCTL_GETDEVICETYPEID:
      result = smartcard_GetDeviceTypeId_Call(ctx, out, operation);
      break;

    default:
      result = STATUS_UNSUCCESSFUL;
      break;
  }

  /**
   * [MS-RPCE] 2.2.6.3 Primitive Type Serialization
   * The type MUST be aligned on an 8-byte boundary. If the size of the
   * primitive type is not a multiple of 8 bytes, the data MUST be padded.
   */

  if ((ioControlCode != SCARD_IOCTL_ACCESSSTARTEDEVENT) &&
      (ioControlCode != SCARD_IOCTL_RELEASETARTEDEVENT))
  {
    offset = (RDPDR_DEVICE_IO_RESPONSE_LENGTH + RDPDR_DEVICE_IO_CONTROL_RSP_HDR_LENGTH);
    const LONG rc = smartcard_pack_write_size_align(out, Stream_GetPosition(out) - offset, 8);
    if (rc != SCARD_S_SUCCESS)
      result = rc;
  }

  if ((result != SCARD_S_SUCCESS) && (result != SCARD_E_TIMEOUT) &&
      (result != SCARD_E_NO_READERS_AVAILABLE) && (result != SCARD_E_NO_SERVICE) &&
      (result != SCARD_W_CACHE_ITEM_NOT_FOUND) && (result != SCARD_W_CACHE_ITEM_STALE))
  {
    scard_log_status_error_wlog(ctx->log, "IRP failure: %s (0x%08" PRIX32 ")", result,
                                scard_get_ioctl_string(ioControlCode, TRUE), ioControlCode);
  }

  *pIoStatus = STATUS_SUCCESS;

  if ((result & 0xC0000000L) == 0xC0000000L)
  {
    /* NTSTATUS error */
    *pIoStatus = result;

    scard_log_status_error_wlog(ctx->log, "IRP failure: %s (0x%08" PRIX32 ")", result,
                                scard_get_ioctl_string(ioControlCode, TRUE), ioControlCode);
  }

  Stream_SealLength(out);
  size_t outputBufferLength = Stream_Length(out);
  size_t dataEndPos = outputBufferLength;

  WINPR_ASSERT(outputBufferLength >= RDPDR_DEVICE_IO_RESPONSE_LENGTH + 4U);
  outputBufferLength -= (RDPDR_DEVICE_IO_RESPONSE_LENGTH + 4U);
  WINPR_ASSERT(outputBufferLength >= RDPDR_DEVICE_IO_RESPONSE_LENGTH);
  objectBufferLength = outputBufferLength - RDPDR_DEVICE_IO_RESPONSE_LENGTH;
  WINPR_ASSERT(outputBufferLength <= UINT32_MAX);
  WINPR_ASSERT(objectBufferLength <= UINT32_MAX);
  if (!Stream_SetPosition(out, RDPDR_DEVICE_IO_RESPONSE_LENGTH))
    return SCARD_E_BAD_SEEK;

  /* [MS-RDPESC] 3.2.5.2 Processing Incoming Replies
   *
   * if the output buffer is too small, reply with STATUS_BUFFER_TOO_SMALL
   * and a outputBufferLength of 0.
   * The message should then be retransmitted from the server with a doubled
   * buffer size.
   */
  if (outputBufferLength > operation->outputBufferLength)
  {
    WLog_Print(ctx->log, WLOG_DEBUG,
               "IRP  warn: expected outputBufferLength %" PRIuz ", but current limit %" PRIu32
               ", respond with STATUS_BUFFER_TOO_SMALL for retransmit with larger buffer",
               outputBufferLength, operation->outputBufferLength);

    *pIoStatus = STATUS_BUFFER_TOO_SMALL;
    result = *pIoStatus;
    outputBufferLength = 0;
    objectBufferLength = 0;
  }
  else
  {
    WLog_Print(ctx->log, WLOG_TRACE, "IRP trace: outputBufferLength %" PRIuz ", limit %" PRIu32,
               outputBufferLength, operation->outputBufferLength);
  }

  /* Device Control Response */
  Stream_Write_UINT32(out, (UINT32)outputBufferLength); /* OutputBufferLength (4 bytes) */
  smartcard_pack_common_type_header(out);               /* CommonTypeHeader (8 bytes) */
  smartcard_pack_private_type_header(
      out, (UINT32)objectBufferLength); /* PrivateTypeHeader (8 bytes) */
  Stream_Write_INT32(out, result);      /* Result (4 bytes) */
  if (result == STATUS_BUFFER_TOO_SMALL)
    Stream_SealLength(out);
  else if (!Stream_SetPosition(out, dataEndPos))
    return SCARD_E_BAD_SEEK;
  return SCARD_S_SUCCESS;
}

void context_free(void* arg)
{
  struct s_scard_context_element* element = arg;
  if (!arg)
    return;

  if (element->fn_free)
    element->fn_free(element->context);
  free(element);
}

#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
scard_call_context* smartcard_call_context_new(const rdpSettings* settings)
{
  const freerdp* inst = freerdp_settings_get_pointer(settings, FreeRDP_instance);
  if (!inst || !inst->context)
    return nullptr;
  return smartcard_call_context_new_with_context(inst->context);
}
#endif

scard_call_context* smartcard_call_context_new_with_context(rdpContext* context)
{
  WINPR_ASSERT(context);
  scard_call_context* ctx = calloc(1, sizeof(scard_call_context));
  if (!ctx)
    goto fail;

  ctx->context = context;

  const rdpSettings* settings = context->settings;
  WINPR_ASSERT(settings);

  ctx->log = WLog_Get(SCARD_TAG);
  WINPR_ASSERT(ctx->log);

  ctx->stopEvent = CreateEventA(nullptr, TRUE, FALSE, nullptr);
  if (!ctx->stopEvent)
    goto fail;

  ctx->names = LinkedList_New();
  if (!ctx->names)
    goto fail;

#if defined(WITH_SMARTCARD_EMULATE)
  ctx->useEmulatedCard = freerdp_settings_get_bool(settings, FreeRDP_SmartcardEmulation);
#endif

  if (ctx->useEmulatedCard)
  {
#if defined(WITH_SMARTCARD_EMULATE)
    ctx->emulation = Emulate_New(settings);
    if (!ctx->emulation)
      goto fail;
#else
    WLog_Print(ctx->log, WLOG_ERROR, "Smartcard emulation requested, but not supported!");
    goto fail;
#endif
  }
  else
  {
    const char* WinSCardModule = freerdp_settings_get_string(settings, FreeRDP_WinSCardModule);
    if (WinSCardModule)
    {
      ctx->hWinSCardLibrary = LoadLibraryX(WinSCardModule);

      if (!ctx->hWinSCardLibrary)
      {
        WLog_Print(ctx->log, WLOG_ERROR, "Failed to load WinSCard library: '%s'",
                   WinSCardModule);
        goto fail;
      }

      if (!WinSCard_LoadApiTableFunctions(&ctx->WinSCardApi, ctx->hWinSCardLibrary))
        goto fail;
      ctx->pWinSCardApi = &ctx->WinSCardApi;
    }
    else
    {
      ctx->pWinSCardApi = WinPR_GetSCardApiFunctionTable();
    }

    if (!ctx->pWinSCardApi)
    {
      WLog_Print(ctx->log, WLOG_ERROR, "Failed to load WinSCard API!");
      goto fail;
    }
  }

  ctx->rgSCardContextList = HashTable_New(FALSE);
  if (!ctx->rgSCardContextList)
    goto fail;

  {
    wObject* obj = HashTable_ValueObject(ctx->rgSCardContextList);
    WINPR_ASSERT(obj);
    obj->fnObjectFree = context_free;
  }

  return ctx;
fail:
  WINPR_PRAGMA_DIAG_PUSH
  WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
  smartcard_call_context_free(ctx);
  WINPR_PRAGMA_DIAG_POP
  return nullptr;
}

void smartcard_call_context_free(scard_call_context* ctx)
{
  if (!ctx)
    return;

  smartcard_call_context_signal_stop(ctx, FALSE);

  LinkedList_Free(ctx->names);
  if (ctx->StartedEvent)
  {
    WINPR_ASSERT(ctx->useEmulatedCard || ctx->pWinSCardApi);
    wrap_raw(ctx, SCardReleaseStartedEvent);
  }

  if (ctx->useEmulatedCard)
  {
#ifdef WITH_SMARTCARD_EMULATE
    if (ctx->emulation)
    {
      Emulate_Free(ctx->emulation);
      ctx->emulation = nullptr;
    }
#endif
  }

  if (ctx->hWinSCardLibrary)
  {
    ZeroMemory(&ctx->WinSCardApi, sizeof(SCardApiFunctionTable));
    FreeLibrary(ctx->hWinSCardLibrary);
    ctx->hWinSCardLibrary = nullptr;
  }

  ctx->pWinSCardApi = nullptr;

  HashTable_Free(ctx->rgSCardContextList);
  (void)CloseHandle(ctx->stopEvent);
  free(ctx);
}

BOOL smartcard_call_context_add(scard_call_context* ctx, const char* name)
{
  WINPR_ASSERT(ctx);
  WINPR_ASSERT(name);
  return LinkedList_AddLast(ctx->names, name);
}

BOOL smartcard_call_cancel_context(scard_call_context* ctx, SCARDCONTEXT hContext)
{
  WINPR_ASSERT(ctx);
  if (wrap(ctx, SCardIsValidContext, hContext) == SCARD_S_SUCCESS)
  {
    wrap(ctx, SCardCancel, hContext);
  }
  return TRUE;
}

BOOL smartcard_call_release_context(scard_call_context* ctx, SCARDCONTEXT hContext)
{
  WINPR_ASSERT(ctx);
  wrap(ctx, SCardReleaseContext, hContext);
  return TRUE;
}

BOOL smartcard_call_cancel_all_context(scard_call_context* ctx)
{
  if (!ctx)
    return FALSE;

  HashTable_Clear(ctx->rgSCardContextList);
  return TRUE;
}

BOOL smarcard_call_set_callbacks(scard_call_context* ctx, void* userdata,
                                 void* (*fn_new)(void*, SCARDCONTEXT), void (*fn_free)(void*))
{
  WINPR_ASSERT(ctx);
  ctx->userdata = userdata;
  ctx->fn_new = fn_new;
  ctx->fn_free = fn_free;
  return TRUE;
}

void* smartcard_call_get_context(scard_call_context* ctx, SCARDCONTEXT hContext)
{
  struct s_scard_context_element* element = nullptr;

  WINPR_ASSERT(ctx);
  element = HashTable_GetItemValue(ctx->rgSCardContextList, (void*)hContext);
  if (!element)
    return nullptr;
  return element->context;
}

BOOL smartcard_call_is_configured(scard_call_context* ctx)
{
  WINPR_ASSERT(ctx);

#if defined(WITH_SMARTCARD_EMULATE)
  if (ctx->useEmulatedCard)
    return Emulate_IsConfigured(ctx->emulation);
#endif

  return FALSE;
}

BOOL smartcard_call_context_signal_stop(scard_call_context* ctx, BOOL reset)
{
  WINPR_ASSERT(ctx);

  if (!ctx->stopEvent)
    return TRUE;

  if (reset)
    return ResetEvent(ctx->stopEvent);
  else
    return SetEvent(ctx->stopEvent);
}

Coverage Report

Created: 2026-09-14 06:32