Support Apple's PCSC.framework

Although Apple's PCSC.framework is derived from pcsc-lite, it lacks
various definitions and doesn't support PC/SC Part 10 features at all.
It is therefore better to unset USE_PCSCLITE when compiling for Apple's
PCSC.framework and skipping the PC/SC Part 10 features entirely.

Author: leonlynch

README.md

@@ -68,10 +68,10 @@ Dependencies
   [MacOS / Windows](#macos--windows)). Use the `BUILD_EMV_DECODE` and
   `BUILD_EMV_TOOL` options to prevent `emv-decode` and  `emv-tool` from being
   built and avoid the dependency on `argp`.
-* `emv-tool` requires PC/SC, either provided by `WinSCard` on Windows or by
-  [PCSCLite](https://pcsclite.apdu.fr/) on Linux/MacOS. Use the
-  `BUILD_EMV_TOOL` option to prevent `emv-tool` from being built and avoid the
-  dependency on PC/SC.
+* `emv-tool` requires PC/SC, either provided by `WinSCard` on Windows, by
+  PCSC.framework on MacOS, or by [PCSCLite](https://pcsclite.apdu.fr/) on
+  Linux. Use the `BUILD_EMV_TOOL` option to prevent `emv-tool` from being built
+  and avoid the dependency on PC/SC.
 * `emv-viewer` can _optionally_ be built if [Qt](https://www.qt.io/) (see
   [Qt](#qt) for details) is available at build-time. If it is not available,
   `emv-viewer` will not be built. Use the `BUILD_EMV_VIEWER` option to ensure

src/pcsc.c

@@ -2,7 +2,7 @@
  * @file pcsc.c
  * @brief PC/SC abstraction
  *
- * Copyright 2021-2022, 2024 Leon Lynch
+ * Copyright 2021-2022, 2024, 2026 Leon Lynch
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -198,6 +198,11 @@ static int pcsc_reader_populate_features(struct pcsc_reader_t* reader)
 		&protocol
 	);
 	if (result != SCARD_S_SUCCESS) {
+#ifdef __APPLE__
+		// Apple's PCSC.framework does not support PC/SC Part 10 features at
+		// all and there is little value in showing an error message
+		return 1;
+#endif
 		fprintf(stderr, "SCardConnect(SCARD_SHARE_DIRECT) failed; result=0x%x [%s]\n", (unsigned int)result, pcsc_stringify_error(result));
 		return -2;
 	}

src/pcsc_compat.h

@@ -2,7 +2,7 @@
  * @file pcsc_compat.h
  * @brief PC/SC compatibility helpers
  *
- * Copyright 2024 Leon Lynch
+ * Copyright 2024, 2026 Leon Lynch
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -26,12 +26,22 @@
 #include <stdint.h>
 #include <stdio.h>
 
+// Some pscs-lite implementations do not include this header by default
+#ifndef _WIN32
+#include <wintypes.h>
+#endif
+
 __BEGIN_DECLS
 
-#if !defined(SCARD_CTL_CODE) && defined(CTL_CODE)
+#ifndef SCARD_CTL_CODE
+#ifdef CTL_CODE
 // Not all implementations define SCARD_CTL_CODE but it can be derived
-// from CTL_CODE when available
+// from CTL_CODE when available (eg Windows)
 #define SCARD_CTL_CODE(code) CTL_CODE(FILE_DEVICE_SMARTCARD, (code), METHOD_BUFFERED, FILE_ANY_ACCESS)
+#else
+// All pcsc-lite derivates agree on this definition of SCARD_CTL_CODE
+#define SCARD_CTL_CODE(code) (0x42000000 + (code))
+#endif
 #endif
 
 // See PC/SC Part 10 Rev 2.02.09, 2.2
@@ -69,13 +79,16 @@ typedef struct {
 } __attribute__((packed))
 PIN_PROPERTIES_STRUCTURE;
 
-// Only PCSCLite provides pcsc_stringify_error()
+#ifndef __APPLE__
+// Apple's PCSC.framework is incomplete, requiring USE_PCSCLITE to be unset,
+// but nonetheless provides pcsc_stringify_error()
 static const char* pcsc_stringify_error(unsigned int result)
 {
 	static char str[16];
 	snprintf(str, sizeof(str), "0x%08X", result);
 	return str;
 }
+#endif
 
 #endif // USE_PCSCLITE
 

tools/CMakeLists.txt

@@ -1,5 +1,5 @@
 ##############################################################################
-# Copyright 2022-2025 Leon Lynch
+# Copyright 2022-2026 Leon Lynch
 #
 # This file is licensed under the terms of the LGPL v2.1 license.
 # See LICENSE file.
@@ -27,20 +27,33 @@ if(NOT argp_FOUND)
 	endif()
 endif()
 
-# Check for PC/SC API using PCSCLite on Linux and MacOS or Win32 API on Windows
+# Check for PC/SC API using Win32 API on Windows, PCSC.framework on MacOS,
+# and PCSCLite on Linux
 if(WIN32)
 	include(CheckIncludeFile)
 	check_include_file(winscard.h HAVE_WINSCARD_H)
 	if(NOT HAVE_WINSCARD_H AND BUILD_EMV_TOOL)
 		message(FATAL_ERROR "Could NOT find winscard.h. This is required to build emv-tool.")
 	endif()
 	set(PCSC_LIBRARIES WinSCard)
+elseif(APPLE)
+	# Apple's PCSC framework is incompatible with upstream pcsc-lite
+	find_library(PCSC_FRAMEWORK PCSC)
+	if(NOT PCSC_FRAMEWORK AND BUILD_EMV_TOOL)
+		message(FATAL_ERROR "Could NOT find PCSC.framework. This is required to build emv-tool.")
+	endif()
+	find_path(PCSC_FRAMEWORK_INCLUDE_DIR NAMES winscard.h)
+	if(NOT PCSC_FRAMEWORK_INCLUDE_DIR AND BUILD_EMV_TOOL)
+		message(FATAL_ERROR "Could NOT find winscard.h in PCSC.framework. This is required to build emv-tool.")
+	endif()
+	if(PCSC_FRAMEWORK AND PCSC_FRAMEWORK_INCLUDE_DIR)
+		message(STATUS "Found PCSC.framework: ${PCSC_FRAMEWORK}")
+	endif()
+	set(PCSC_LIBRARIES "${PCSC_FRAMEWORK}")
 else()
 	find_package(PCSCLite 1.8)
-	if(NOT PCSCLite_FOUND)
-		if(BUILD_EMV_TOOL)
-			message(FATAL_ERROR "Could NOT find PCSCLite. This is required to build emv-tool.")
-		endif()
+	if(NOT PCSCLite_FOUND AND BUILD_EMV_TOOL)
+		message(FATAL_ERROR "Could NOT find PCSCLite. This is required to build emv-tool.")
 	endif()
 	set(PCSC_LIBRARIES PCSCLite::PCSCLite)
 endif()
@@ -107,6 +120,12 @@ if(BUILD_EMV_TOOL)
 	endif()
 
 	add_executable(emv-tool emv-tool.c ../src/pcsc.c)
+	if(PCSC_FRAMEWORK_INCLUDE_DIR)
+		# Avoid conflicts between Apple's PCSC.h and this project's pcsc.h by
+		# adding the Apple PCSC framework as a system include directory to
+		# allow the project include directories to take precedence.
+		target_include_directories(emv-tool SYSTEM PRIVATE ${PCSC_FRAMEWORK_INCLUDE_DIR})
+	endif()
 	target_link_libraries(emv-tool PRIVATE print_helpers emv emv_strings)
 	if(TARGET libargp::argp)
 		target_link_libraries(emv-tool PRIVATE libargp::argp)