Firebase Auth TOTP support #11261

Xiaoshouzi-gh · 2023-05-09T22:02:02Z

Added TOTP MFA support for iOS SDK

#11127) * Adding public header files for TOTP support

…equest (#11128) * Updated finalizeMfaSignInRequest to take TOTP factor. * Added request unit tests and marked finalizeMFASignInRequest tests as iOS only

google-oss-bot · 2023-05-09T22:04:48Z

	1 Warning
⚠️	New public headers were added, did you remember to add them to the umbrella header?

Generated by 🚫 Danger

TOTP Enrollment Flow

github-actions · 2023-05-31T20:39:25Z

Apple API Diff Report

Commit: 84f7dc4
Last updated: Fri Jun 23 12:15 PDT 2023
View workflow logs & download artifacts

FirebaseAuth

Classes

[ADDED] FIRTOTPMultiFactorGenerator

Objective-C:
+  @interface FIRTOTPMultiFactorGenerator : NSObject
+    + ( void ) generateSecretWithMultiFactorSession : ( nonnull FIRMultiFactorSession * ) session completion :( nonnull void ( ^ )( FIRTOTPSecret * _Nullable , NSError * _Nullable )) completion ;
+    + ( nonnull FIRTOTPMultiFactorAssertion * ) assertionForEnrollmentWithSecret :( nonnull FIRTOTPSecret * ) secret oneTimePassword :( nonnull NSString * ) oneTimePassword ;
+    + ( nonnull FIRTOTPMultiFactorAssertion * ) assertionForSignInWithEnrollmentID :( nonnull NSString * ) enrollmentID oneTimePassword :( nonnull NSString * ) oneTimePassword ;

[ADDED] FIRTOTPSecret

Swift:
+  class TOTPSecret : NSObject
+    func sharedSecretKey () -> String
+    func generateQRCodeURL ( withAccountName accountName : String , issuer : String ) -> String
+    func openInOTPApp ( withQRCodeURL QRCodeURL : String )
Objective-C:
+  @interface FIRTOTPSecret : NSObject
+    - ( nonnull NSString * ) sharedSecretKey ;
+    - ( nonnull NSString * ) generateQRCodeURLWithAccountName :( nonnull NSString * ) accountName issuer :( nonnull NSString * ) issuer ;
+    - ( void ) openInOTPAppWithQRCodeURL :( nonnull NSString * ) QRCodeURL ;

[ADDED] FIRTOTPMultiFactorAssertion

Objective-C:
+  @interface FIRTOTPMultiFactorAssertion : FIRMultiFactorAssertion

Constants

[ADDED] FIRTOTPMultiFactorID

Objective-C:
+  extern NSString * const _Nonnull FIRTOTPMultiFactorID

google-oss-bot · 2023-05-31T20:53:59Z

Size Report ¹

Affected Products

FirebaseAuth
Type Base (9143c4b) Merge (99319de) Diff
CocoaPods ? -51.5 kB ? (?)

Test Logs

Merge (99319de): https://github.com/firebase/firebase-ios-sdk/actions/runs/5137458360

https://storage.googleapis.com/firebase-sdk-metric-reports/uvZHj4OTHR.html

* Added TOTP Assertion and Generator logics

google-oss-bot · 2023-06-02T01:19:59Z

Coverage Report ¹

Affected Products

`FirebaseAuth-iOS-FirebaseAuth.framework`

Overall coverage changed from 69.44% (1ef1ea2) to 68.99% (84f7dc4) by -0.45%.

17 individual files with coverage change

Filename	Base (`1ef1ea2`)	Merge (`84f7dc4`)	Diff
FIRAuthBackend+MultiFactor.m	0.00%	37.89%	+37.89%
FIRAuthBackend.m	83.94%	82.20%	-1.73%
FIRAuthProtoFinalizeMFATOTPEnrollmentRequestInfo.m	?	100.00%	?
FIRAuthProtoFinalizeMFATOTPEnrollmentResponseInfo.m	?	0.00%	?
FIRAuthProtoFinalizeMFATOTPSignInRequestInfo.m	?	100.00%	?
FIRAuthProtoMFAEnrollment.m	100.00%	89.47%	-10.53%
FIRAuthProtoStartMFATOTPEnrollmentRequestInfo.m	?	100.00%	?
FIRAuthProtoStartMFATOTPEnrollmentResponseInfo.m	?	0.00%	?
FIRFinalizeMFAEnrollmentRequest.m	0.00%	64.29%	+64.29%
FIRFinalizeMFASignInRequest.m	0.00%	87.50%	+87.50%
FIRMultiFactor.m	12.45%	12.12%	-0.33%
FIRMultiFactorResolver.m	12.50%	11.34%	-1.16%
FIRStartMFAEnrollmentRequest.m	0.00%	62.16%	+62.16%
FIRTOTPMultiFactorAssertion.m	?	0.00%	?
FIRTOTPMultiFactorGenerator.m	?	0.00%	?
FIRTOTPMultiFactorInfo.m	?	0.00%	?
FIRTOTPSecret.m	?	0.00%	?

Test Logs

https://storage.googleapis.com/firebase-sdk-metric-reports/E4AP2b0s6t.html

* Adding unenroll support for TOTP on sample app * lint fixes

* provide missing TOTP factor type of error in the error hints * refactor all sign in with MFA code in all related workflow for Sample App

* updated invalid verification code error msg

Xiaoshouzi-gh · 2023-06-14T05:00:55Z

@kevinthecheung Hi Kevin, can you help with the documentation review? All code merged in this branch has already been approved by SWEs.

* changes to umbrella and changelog * Update CHANGELOG.md * Update version as per PR feedback

FirebaseAuth/Sources/Backend/FIRAuthBackend.m

FirebaseAuth/Sources/Backend/RPC/MultiFactor/Enroll/FIRFinalizeMFAEnrollmentResponse.m

FirebaseAuth/Sources/MultiFactor/TOTP/FIRTOTPSecret.m

FirebaseAuth/Sources/Public/FirebaseAuth/FIRTOTPMultiFactorAssertion.h

FirebaseAuth/Sources/Backend/FIRAuthBackend.m

renkelvin

Great, thanks!

FirebaseAuth/Sources/Utilities/FIRAuthErrorUtils.m

FirebaseAuth/Sources/Public/FirebaseAuth/FIRTOTPSecret.h

FirebaseAuth/Sources/Public/FirebaseAuth/FIRTOTPMultiFactorGenerator.h

FirebaseAuth/Sources/Public/FirebaseAuth/FIRTOTPMultiFactorAssertion.h

Co-authored-by: Kevin Cheung <[email protected]>

Xiaoshouzi-gh added 2 commits May 9, 2023 14:56

[ SignIn#1]Adding sign-in related public header files for TOTP support (

9fdf7e1

#11127) * Adding public header files for TOTP support

[ SignIn#2]Update Finalize MFA Sign In request to accommodates TOTP r…

2ceb2e3

…equest (#11128) * Updated finalizeMfaSignInRequest to take TOTP factor. * Added request unit tests and marked finalizeMFASignInRequest tests as iOS only

google-oss-bot added api: auth public-api-change labels May 9, 2023

Totp enrollment (#11114)

978f6d7

TOTP Enrollment Flow

Added TOTP MFA Assertion logics (#11380)

b8c33e1

* Added TOTP Assertion and Generator logics

github-actions bot removed the public-api-change label Jun 2, 2023

google-oss-bot added the public-api-change label Jun 2, 2023

url-fix: adding hashing algorithm and remove log (#11383)

32defce

github-actions bot removed the public-api-change label Jun 2, 2023

google-oss-bot added the public-api-change label Jun 2, 2023

add totp sign in example to sample app (#11384)

88e121e

github-actions bot removed the public-api-change label Jun 2, 2023

google-oss-bot added the public-api-change label Jun 2, 2023

Withdraw mfa (#11388)

db89233

* Adding unenroll support for TOTP on sample app * lint fixes

github-actions bot added public-api-change and removed public-api-change labels Jun 3, 2023

provide missing TOTP factor type of error in the error code (#11392)

0db2d0f

* provide missing TOTP factor type of error in the error hints * refactor all sign in with MFA code in all related workflow for Sample App

github-actions bot removed the public-api-change label Jun 5, 2023

google-oss-bot added the public-api-change label Jun 5, 2023

updated invalid verification code error msg (#11395)

10709b2

* updated invalid verification code error msg

github-actions bot removed the public-api-change label Jun 5, 2023

google-oss-bot added the public-api-change label Jun 5, 2023

Add unit tests (#11399)

a152bf7

github-actions bot removed the public-api-change label Jun 13, 2023

google-oss-bot added the public-api-change label Jun 13, 2023

Xiaoshouzi-gh marked this pull request as ready for review June 14, 2023 05:01

Changes to umbrella and changelog (#11450)

3d546cb

* changes to umbrella and changelog * Update CHANGELOG.md * Update version as per PR feedback

github-actions bot removed the public-api-change label Jun 16, 2023

google-oss-bot added the public-api-change label Jun 16, 2023

Xiaoshouzi-gh requested a review from paulb777 June 20, 2023 17:31

paulb777 reviewed Jun 20, 2023

View reviewed changes

Adding swift API header and updating NSLog to FIRLog

47f33e1

github-actions bot removed the public-api-change label Jun 21, 2023

google-oss-bot added the public-api-change label Jun 21, 2023

Addressing mfaEnrollmentInfo logic feedback in all occurance

69ee1da

github-actions bot removed the public-api-change label Jun 21, 2023

Xiaoshouzi-gh requested a review from renkelvin June 21, 2023 21:54

google-oss-bot added the public-api-change label Jun 21, 2023

paulb777 reviewed Jun 22, 2023

View reviewed changes

FirebaseAuth/Sources/Public/FirebaseAuth/FIRTOTPMultiFactorAssertion.h Show resolved Hide resolved

FirebaseAuth/Sources/Backend/FIRAuthBackend.m Outdated Show resolved Hide resolved

update log error code

cdbd9ea

github-actions bot removed the public-api-change label Jun 22, 2023

google-oss-bot added the public-api-change label Jun 22, 2023

renkelvin approved these changes Jun 22, 2023

View reviewed changes

paulb777 approved these changes Jun 22, 2023

View reviewed changes

kevinthecheung approved these changes Jun 23, 2023

View reviewed changes

Apply TW suggestions from code review

e9892b2

Co-authored-by: Kevin Cheung <[email protected]>

github-actions bot added public-api-change and removed public-api-change labels Jun 23, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Firebase Auth TOTP support #11261

Firebase Auth TOTP support #11261

Uh oh!

Xiaoshouzi-gh commented May 9, 2023 •

edited

Loading

Uh oh!

google-oss-bot commented May 9, 2023 •

edited

Loading

Uh oh!

github-actions bot commented May 31, 2023 •

edited

Loading

Uh oh!

google-oss-bot commented May 31, 2023

`FirebaseAuth`

Uh oh!

google-oss-bot commented Jun 2, 2023 •

edited

Loading

`FirebaseAuth-iOS-FirebaseAuth.framework`

Uh oh!

Xiaoshouzi-gh commented Jun 14, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

renkelvin left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Firebase Auth TOTP support #11261

Firebase Auth TOTP support #11261

Uh oh!

Conversation

Xiaoshouzi-gh commented May 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

google-oss-bot commented May 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented May 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Apple API Diff Report

FirebaseAuth

Classes

[ADDED] FIRTOTPMultiFactorGenerator

[ADDED] FIRTOTPSecret

[ADDED] FIRTOTPMultiFactorAssertion

Constants

[ADDED] FIRTOTPMultiFactorID

Uh oh!

google-oss-bot commented May 31, 2023

Size Report 1

Affected Products

FirebaseAuth

Test Logs

Uh oh!

google-oss-bot commented Jun 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report 1

Affected Products

FirebaseAuth-iOS-FirebaseAuth.framework

Test Logs

Uh oh!

Xiaoshouzi-gh commented Jun 14, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

renkelvin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Xiaoshouzi-gh commented May 9, 2023 •

edited

Loading

google-oss-bot commented May 9, 2023 •

edited

Loading

github-actions bot commented May 31, 2023 •

edited

Loading

Size Report ¹

`FirebaseAuth`

google-oss-bot commented Jun 2, 2023 •

edited

Loading

Coverage Report ¹

`FirebaseAuth-iOS-FirebaseAuth.framework`