Feature/mfa integration by gioraping · Pull Request #161 · ForgeRock/ping-ios-sdk

gioraping · 2026-05-27T07:56:00Z

P14C-82521

JIRA "Add PingOneMFA module to the orchestratio SDK on iOS"

Description

New PingOneMFA module — a clean async/await wrapper around the binary PingOneSDK (PingOneSDK XCFramework). Bridges all callback-based PingOneSDK APIs to async throws functions via withCheckedThrowingContinuation, using a @globalActor (PingOneMFAActor) for thread-safe state. Exposed surface: initialize(geo:), setDeviceToken(_:), pair(pairingKey:), getDeviceInfo(), getOneTimePasscode(), processRemoteNotification(userInfo:), processRemoteNotificationAction(identifier:authenticationMethod:userInfo:), generateMobilePayload(), getNotificationCategories().
Actionable push notifications — registers UNNotificationCategory objects from PingOneSDK so Approve/Deny banner actions work without the app being foregrounded; routes UNUserNotificationCenterDelegate actions through processRemoteNotificationAction.
PingExample sample app integration — adds a full MFA section: QR-code scanner for device pairing, paired accounts list, live-countdown OTP screen, push notification modal (approve/deny with number-matching support), and mobile payload view.
https://pingidentity.atlassian.net/browse/P14C-86659
Unit tests — AccountParserTests, PingOneMFATests, PingOneMFAErrorTests, and a MockPingOneMFA covering initialization, pairing, token registration, OTP, push processing, and error bridging.
Package.swift / Package.resolved updates — adds PingOneMFA as a new library target and pulls in the PingOneSDK binary dependency.

Testing

Set-up native application in PingOne environment

Pairing: tap QR Code Registration → scan a PingOne pairing QR → success dialog → accounts list shows the paired account
OTP: tap One-Time Passcode → code displays with countdown; refreshes automatically at zero
Payload: tap Mobile Payload → payload shown; Copy button writes to clipboard
Push (foreground): trigger a push from PingOne while app is open → approval screen appears; approve/deny shows success dialog
Push (background): trigger a push while app is backgrounded → system banner with Allow/Deny buttons → tapping either completes the request
Cancellation: approve on a second device while the approval screen is open → screen dismisses automatically

Checklist:

I ran all unit tests and they pass
I added test case coverage for my changes

… and PingExample sample app — including category registration, banner-action and foreground push routing, and an approve/deny modal with number-matching UI. ## What Was Built Add PingOneMFA actionable push notification support to the SDK module and PingExample sample app — including category registration, banner-action and foreground push routing, and an approve/deny modal with number-matching UI. ## Key Decisions - Category routing via runtime Set<UNNotificationCategory> (no hardcoded strings) - Number selection IS approval for SELECT_NUMBER/ENTER_MANUALLY flows - authenticationMethod: "user" hardcoded per InternalApp reference - Modal-only — no new tab or navigation destination - willPresent and didReceive retry initializePingOneMFAClient() when SDK is uninitialized ## Changes - PingOneMFA/PingOneMFA/PingOneMFA.swift — getNotificationCategories(), processNotificationAction(), parseAPNSAlert helper - PingOneMFA/PingOneMFA/PushNotification.swift — numberMatchingOptions, numberMatchingType, Identifiable conformance - PingOneMFA/PingOneMFATests/ — mock tracking state + test21/22/23 - SampleApps/PingExample/PingExample/AppDelegate.swift — full PingOneMFA push wiring - SampleApps/PingExample/PingExample/PingOneMFANotificationView.swift — new approve/deny modal - SampleApps/PingExample/PingExample/ContentView.swift — ShowPingOneMFANotification sheet Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

…otificationView Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

…class name collision PingOneMFA.PushNotification is ambiguous at call sites that import PingOneMFA because Swift resolves 'PingOneMFA' as the class, not the module. MFAPushNotification is an unambiguous alias used in AppDelegate and ContentView. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

…moteNotificationsWithDeviceToken Matches the PingPush getInitializedPushClient() pattern: extract ensurePingOneMFAInitialized() helper and call it in the token handler and notification delegates instead of silently skipping when not yet initialized. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

passing geo diretcly to initialize

# Conflicts: # SampleApps/PingExample/PingExample.xcodeproj/project.pbxproj # SampleApps/PingExample/PingExample/ContentView.swift

george-bafaloukas-forgerock

Thanks for this — it's a substantial, well-structured module and the doc comments across the public surface are genuinely excellent. 🙏 I've left inline comments below from a fairly pedantic pass focused on the new PingOneMFA SDK code (plus the README, tests, and the sample-app integration).

A few things I really liked: the Geo enum cleanly isolates PingOneGeo so consumers never import PingOneSDK, the same goes for not leaking NSError/PingOneSDKError, and getDeviceInfo()'s "neither data nor errors" branch correctly avoids hanging the continuation — exactly the defensive resume that prevents continuation-leak crashes. The AccountParserTests edge-case coverage is thorough too.

The handful of items I'd consider blocking before merge:

Racy idempotency in initialize(geo:) that contradicts its documented guarantee.
Background banner actions can be lost because completionHandler() fires before the async approve/deny completes.
README example for getDeviceInfo() doesn't compile (wrong return type).
Two tests that don't test what they claim — including a data race inside the "thread safety" test.

Everything else is lower-stakes polish. Really nice work overall — happy to talk through any of these. 🚀

# Conflicts: # SampleApps/PingExample/PingExample.xcodeproj/project.pbxproj

george-bafaloukas-forgerock

Few more comments. Please confirm the lack of Podspec and maybe add a line in the Changelog

george-bafaloukas-forgerock

A few small follow-ups from the latest push-flow changes — all minor/doc-level, nothing blocking. The redaction, Equatable, and the .dry sheet check all look good; thanks for those. 🙏 Left the specifics inline. (Also re: the podspec — saw the note that PingOneSDK is SPM-only, so disregard my earlier CocoaPods-parity comment; that's a reasonable constraint.)

george-bafaloukas-forgerock · 2026-06-23T13:42:47Z

+    /// The interaction model required by this notification.
+    ///
+    /// Use this to determine the UI flow:
+    /// - `.silent` — no user interaction needed; the authentication completes silently.


This should be .dry right?

george-bafaloukas-forgerock

Looks good to me, please see the 1 new open comment. I would not merge this one yet, unless it has been cleared by QA

gioraping and others added 23 commits May 25, 2026 17:55

fix(PingExample): use iOS 16-compatible .onChange(of:) in PingOneMFAN…

0ecfd9c

…otificationView Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

fix project files

d3cdc58

fix

f2e1550

string fixes

3120dad

uneeded metadata removed

ddcf9eb

removing config API

f47763c

passing geo diretcly to initialize

renaming public SDK api

86f62ec

remving reference

b38a1ae

refactoring

57fc057

added readme file

5a7d46b

account ui small change

4004d8c

show detailed error messages

977d154

documination

e26db05

added fixes to readme

09c6dc6

added link

e5ccd5c

fix

647eaef

Merge branch 'develop' into feature/mfa-integration

41bd9b5

# Conflicts: # SampleApps/PingExample/PingExample.xcodeproj/project.pbxproj # SampleApps/PingExample/PingExample/ContentView.swift

api refactor returning list of errors

82ecd8f

dismissh notification view in case push isCancelAuth

1a975ee

better success message in case of deny

bd0b0bf

gioraping marked this pull request as ready for review June 1, 2026 15:19

gioraping added 5 commits June 2, 2026 15:40

refactoring setDeviceToken and getDeviceInfo API

1f8d111

fix inline

3801831

fix

2fa71a5

fix

35d3f58

fix

a46f8d1

george-bafaloukas-forgerock requested changes Jun 15, 2026

View reviewed changes

gioraping added 12 commits June 16, 2026 12:49

handle race condition during initialize

59536a7

Add PingOneMFADeviceInfo result type

2c063eb

fixes

d875db2

better handling of parsing exceptions

be0a62a

fixes in PingMFAError class

6be1c9c

tests fixes

1a0e196

test fixes

2be1e5d

readme updated

5ba0c2d

fix sample app issues

27819d7

fix PushNotification

b9b507e

Merge branch 'develop' into feature/mfa-integration

8c0573c

# Conflicts: # SampleApps/PingExample/PingExample.xcodeproj/project.pbxproj

fix test

2629ab9

george-bafaloukas-forgerock reviewed Jun 22, 2026

View reviewed changes

gioraping added 4 commits June 22, 2026 16:55

fix comments

e108fc3

fix

7aaec5f

fixes in handling push notification flow

bee7e2c

no message

5e5368b

george-bafaloukas-forgerock reviewed Jun 23, 2026

View reviewed changes

Comment thread PingOneMFA/PingOneMFA/PingOneMfaAccount.swift Outdated

Comment thread PingOneMFA/PingOneMFA/PingOneMFA.swift Outdated

Comment thread PingOneMFA/README.md Outdated

Comment thread PingOneMFA/README.md Outdated

Comment thread SampleApps/PingExample/PingExample/AppDelegate.swift

readme fixes

3aa73e1

george-bafaloukas-forgerock reviewed Jun 23, 2026

View reviewed changes

george-bafaloukas-forgerock approved these changes Jun 23, 2026

View reviewed changes

Conversation

gioraping commented May 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

P14C-82521

Description

Testing

Checklist:

Uh oh!

george-bafaloukas-forgerock left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

george-bafaloukas-forgerock left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

george-bafaloukas-forgerock left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

george-bafaloukas-forgerock Jun 23, 2026

Choose a reason for hiding this comment

Uh oh!

george-bafaloukas-forgerock left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

gioraping commented May 27, 2026 •

edited

Loading