How do I install NFCPassportReader using Swift Package Manager?

Add the GitHub repository URL to your Xcode project via Swift Package Manager, as recommended in the README. CocoaPods is deprecated, so SPM is the preferred method for new projects.

NFCPassportReader or another library – which is better for iOS passport reading?

NFCPassportReader is strong for Swift-native async/await implementations and ICAO compliance, but compare with alternatives like iOS-NFC-Debugger for debugging or check community support for stability, as this library has known bugs.

Why does NFCPassportReader fail with error code 0x63 0x00?

This error often indicates an incorrect MRZ key. Ensure you include all characters like '<' from the passport MRZ line, as detailed in the troubleshooting section, to properly format the key for BAC.

Does NFCPassportReader support JPEG2000 images from passports?

No, JPEG2000 images are currently unsupported. The library provides access to raw data, but you'll need to implement your own JPEG2000 decoding if passports use this format, which can be a limitation for some use cases.

How to set up passive authentication with NFCPassportReader?

You need CSCA certificates in PEM format from a master list. Use the scripts folder in the repo to obtain and create this file, then integrate it into your app to verify passport integrity, though the included sample file is only for demonstration.

What iOS version is required for NFCPassportReader?

It uses iOS 15 CoreNFC APIs, so you need iOS 15 or later. Ensure your deployment target is set accordingly, as older iOS versions won't support the NFC functionality required for passport reading.

Open-Awesome

NFCPassportReader

Q: Does NFCPassportReader support JPEG2000 images from passports?

No, JPEG2000 images are currently unsupported. The library provides access to raw data, but you'll need to implement your own JPEG2000 decoding if passports use this format, which can be a limitation for some use cases.

Q: How to set up passive authentication with NFCPassportReader?

You need CSCA certificates in PEM format from a master list. Use the scripts folder in the repo to obtain and create this file, then integrate it into your app to verify passport integrity, though the included sample file is only for demonstration.

Q: What iOS version is required for NFCPassportReader?

It uses iOS 15 CoreNFC APIs, so you need iOS 15 or later. Ensure your deployment target is set accordingly, as older iOS versions won't support the NFC functionality required for passport reading.

MITSwift

An iOS library for reading NFC-enabled passports using CoreNFC APIs, supporting BAC, PACE, and multiple data groups.

GitHub

865 stars338 forks0 contributors

What is NFCPassportReader?

NFCPassportReader is an open-source iOS library that allows developers to read and authenticate NFC-enabled passports using Apple's CoreNFC APIs. It solves the problem of securely extracting and verifying e-passport data such as MRZ information, biometric images, and cryptographic signatures directly on iOS devices. The library supports modern authentication protocols like BAC, PACE, and Chip Authentication.

Target Audience

iOS developers building applications that require secure passport reading, such as identity verification apps, travel solutions, or government services. It's aimed at those needing ICAO-compliant e-passport handling on iOS.

Value Proposition

Developers choose NFCPassportReader because it provides a comprehensive, Swift-native implementation of e-passport standards with async/await support, eliminating the need for low-level NFC handling. Its modular design and active maintenance make it a reliable alternative to building such functionality from scratch.

Overview

NFCPassportReader for iOS 13

Use Cases

Best For

Building identity verification apps for iOS
Implementing secure passport scanning in travel applications
Developing government or border control mobile tools
Creating biometric authentication systems using e-passports
Prototyping NFC-based passport readers for iOS
Educational projects on e-passport security and NFC communication

Not Ideal For

Cross-platform mobile projects requiring Android or web support
Applications needing full PACE authentication with all mapping types (only Generic Mapping is implemented)
High-stakes production systems where stability is critical, due to acknowledged bugs and unfinished features
Teams entrenched in CocoaPods dependency management, as support is deprecated and unsupported

Pros & Cons

Pros

Modern Async/Await Integration

Uses Swift's concurrency model for streamlined NFC communication, as version 2 prioritizes this over older callback patterns, making code cleaner and more efficient.

Comprehensive Data Extraction

Reads multiple ICAO data groups including MRZ, biometric images (DG2), and cryptographic signatures, supporting DG1, DG2, DG7, DG11, DG12, DG14, and DG15 for thorough passport data access.

Strong Security Protocols

Implements BAC, secure messaging, and authentication methods like Passive, Active, and Chip Authentication, adhering to e-passport standards for secure communication and verification.

Customizable NFC Experience

Allows extended mode reads for larger data chunks and custom session messages, providing flexibility to handle different passport types and improve user interaction.

Cons

Incomplete Feature Set

PACE support is limited to Generic Mapping, with IM and CAM modes still on the to-do list, reducing compatibility with some advanced passport security protocols.

Buggy and Unpolished

The author admits 'rough edges' and bugs, warning that mileage may vary, which can lead to unreliable behavior and require extra debugging in real-world scenarios.

Limited Image Format Support

JPEG2000 images are unsupported, forcing developers to handle raw data manually if passports use this format, adding complexity for biometric extraction.

Deprecated Installation Method

CocoaPods support is deprecated and unsupported, with plans to phase it out by end of 2026, pushing teams to migrate to Swift Package Manager or risk compatibility issues.

Frequently Asked Questions

Related Projects

DeviceKit

DeviceKit is a value-type replacement of UIDevice.

Stars4,732

Forks468

Last commit14 days ago

Device

Light weight tool for detecting the current device and screen size written in swift.

Stars1,731

Forks206

Last commit9 days ago

SDVersion

:iphone: Lightweight Cocoa library for detecting the running device's model and screen size.

Stars1,300

Forks209

Last commit9 months ago

MotionKit

Get the data from Accelerometer, Gyroscope and Magnetometer in only Two or a few lines of code. CoreMotion now made insanely simple :octocat: :satellite:

Stars1,080

Forks130

Last commit8 years ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub