Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tracking delegate and improve error handling #234

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add tracking delegate and improve error handling #234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
66967ce
NFC-286 Remove auto-formatting
laurageiger-mohemian May 2, 2024
de11f70
[NFC-386] Add changes requested in PR
laurageiger-mohemian May 6, 2024
f1b13a7
[NFC-395] Add delegate for tracking NFC detection (#2)
laurageiger-mohemian May 24, 2024
6dddb83
[AXC-3089] Add more tracking for chip access phase (#3)
daniel-moh Jul 1, 2024
e1ff262
Improve error handling
mikahautz-mohemian Nov 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Sources/NFCPassportReader/Errors.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ public enum NFCPassportReaderError: Error {
case NotImplemented
case TagNotValid
case ConnectionError
case TimeOutError
case UserCanceled
case InvalidMRZKey
case MoreThanOneTagFound
Expand Down Expand Up @@ -64,6 +65,7 @@ public enum NFCPassportReaderError: Error {
case .NotImplemented: return "NotImplemented"
case .TagNotValid: return "TagNotValid"
case .ConnectionError: return "ConnectionError"
case .TimeOutError: return "TimeOutError"
case .UserCanceled: return "UserCanceled"
case .InvalidMRZKey: return "InvalidMRZKey"
case .MoreThanOneTagFound: return "MoreThanOneTagFound"
Expand Down
69 changes: 63 additions & 6 deletions Sources/NFCPassportReader/PassportReader.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,36 @@ import OSLog
import UIKit
import CoreNFC

@available(iOS 15, *)
public protocol PassportReaderTrackingDelegate: AnyObject {
func nfcTagDetected()
func readCardAccess(cardAccess: CardAccess)
func paceStarted()
func paceSucceeded()
func paceFailed()
func bacStarted()
func bacSucceeded()
func bacFailed()
}

@available(iOS 15, *)
extension PassportReaderTrackingDelegate {
func nfcTagDetected() { /* default implementation */ }
func readCardAccess(cardAccess: CardAccess) { /* default implementation */ }
func paceStarted() { /* default implementation */ }
func paceSucceeded() { /* default implementation */ }
func paceFailed() { /* default implementation */ }
func bacStarted() { /* default implementation */ }
func bacSucceeded() { /* default implementation */ }
func bacFailed() { /* default implementation */ }
}

@available(iOS 15, *)
public class PassportReader : NSObject {
private typealias NFCCheckedContinuation = CheckedContinuation<NFCPassportModel, Error>
private var nfcContinuation: NFCCheckedContinuation?

public weak var trackingDelegate: PassportReaderTrackingDelegate?
private var passport : NFCPassportModel = NFCPassportModel()

private var readerSession: NFCTagReaderSession?
Expand Down Expand Up @@ -135,6 +160,9 @@ extension PassportReader : NFCTagReaderSessionDelegate {
case NFCReaderError.readerSessionInvalidationErrorUserCanceled:
Logger.passportReader.error( " - User cancelled session" )
userError = NFCPassportReaderError.UserCanceled
case NFCReaderError.readerSessionInvalidationErrorSessionTimeout:
Logger.passportReader.error(" - Session timeout")
userError = NFCPassportReaderError.TimeOutError
default:
Logger.passportReader.error( " - some other error - \(readerError.localizedDescription)" )
userError = NFCPassportReaderError.UnexpectedError
Expand Down Expand Up @@ -199,10 +227,20 @@ extension PassportReader : NFCTagReaderSessionDelegate {
} catch let error as NFCPassportReaderError {
let errorMessage = NFCViewDisplayMessage.error(error)
self.invalidateSession(errorMessage: errorMessage, error: error)
} catch let error {
} catch {
Logger.passportReader.debug( "tagReaderSession:failed to connect to tag - \(error.localizedDescription)" )
let errorMessage = NFCViewDisplayMessage.error(NFCPassportReaderError.ConnectionError)
self.invalidateSession(errorMessage: errorMessage, error: NFCPassportReaderError.Unknown(error))

// .readerTransceiveErrorTagResponseError is thrown when a "connection lost" scenario is forced by moving the phone away from the NFC chip
// .readerTransceiveErrorTagConnectionLost is never thrown for this scenario, but added for the sake of completeness
if let nfcError = error as? NFCReaderError,
nfcError.errorCode == NFCReaderError.readerTransceiveErrorTagResponseError.rawValue ||
nfcError.errorCode == NFCReaderError.readerTransceiveErrorTagConnectionLost.rawValue {
let errorMessage = NFCViewDisplayMessage.error(NFCPassportReaderError.ConnectionError)
self.invalidateSession(errorMessage: errorMessage, error: NFCPassportReaderError.ConnectionError)
} else {
let errorMessage = NFCViewDisplayMessage.error(NFCPassportReaderError.Unknown(error))
self.invalidateSession(errorMessage: errorMessage, error: NFCPassportReaderError.Unknown(error))
}
}
}
}
Expand All @@ -216,21 +254,30 @@ extension PassportReader : NFCTagReaderSessionDelegate {
extension PassportReader {

func startReading(tagReader : TagReader) async throws -> NFCPassportModel {
trackingDelegate?.nfcTagDetected()

if !skipPACE {
do {
trackingDelegate?.paceStarted()

let data = try await tagReader.readCardAccess()
Logger.passportReader.debug( "Read CardAccess - data \(binToHexRep(data))" )
let cardAccess = try CardAccess(data)
passport.cardAccess = cardAccess


trackingDelegate?.readCardAccess(cardAccess: cardAccess)

Logger.passportReader.info( "Starting Password Authenticated Connection Establishment (PACE)" )

let paceHandler = try PACEHandler( cardAccess: cardAccess, tagReader: tagReader )
try await paceHandler.doPACE(mrzKey: mrzKey )
passport.PACEStatus = .success
Logger.passportReader.debug( "PACE Succeeded" )

trackingDelegate?.paceSucceeded()
} catch {
trackingDelegate?.paceFailed()

passport.PACEStatus = .failed
Logger.passportReader.error( "PACE Failed - falling back to BAC" )
}
Expand All @@ -240,7 +287,17 @@ extension PassportReader {

// If either PACE isn't supported, we failed whilst doing PACE or we didn't even attempt it, then fall back to BAC
if passport.PACEStatus != .success {
try await doBACAuthentication(tagReader : tagReader)
do {
trackingDelegate?.bacStarted()

try await doBACAuthentication(tagReader : tagReader)

trackingDelegate?.bacSucceeded()
} catch {
trackingDelegate?.bacFailed()

throw error
}
Comment on lines +290 to +300
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider removing empty lines here

Suggested change
do {
trackingDelegate?.bacStarted()
try await doBACAuthentication(tagReader : tagReader)
trackingDelegate?.bacSucceeded()
} catch {
trackingDelegate?.bacFailed()
throw error
}
do {
trackingDelegate?.bacStarted()
try await doBACAuthentication(tagReader : tagReader)
trackingDelegate?.bacSucceeded()
} catch {
trackingDelegate?.bacFailed()
throw error
}

}

// Now to read the datagroups
Expand Down Expand Up @@ -276,7 +333,7 @@ extension PassportReader {

func doBACAuthentication(tagReader : TagReader) async throws {
self.currentlyReadingDataGroup = nil

Logger.passportReader.info( "Starting Basic Access Control (BAC)" )

self.passport.BACStatus = .failed
Expand Down