feat(auth, apple): create a credential with idToken, rawNonce & appleFullPersonName (#12356)

Author: russellwheatley

packages/firebase_auth/firebase_auth/ios/Classes/FLTFirebaseAuthPlugin.m

@@ -52,6 +52,12 @@
 NSString *const kArgumentVerificationId = @"verificationId";
 NSString *const kArgumentSmsCode = @"smsCode";
 NSString *const kArgumentActionCodeSettings = @"actionCodeSettings";
+NSString *const kArgumentFamilyName = @"familyName";
+NSString *const kArgumentGivenName = @"givenName";
+NSString *const kArgumentMiddleName = @"middleName";
+NSString *const kArgumentNickname = @"nickname";
+NSString *const kArgumentNamePrefix = @"namePrefix";
+NSString *const kArgumentNameSuffix = @"nameSuffix";
 
 // MultiFactor
 NSString *const kArgumentMultiFactorHints = @"multiFactorHints";
@@ -754,7 +760,31 @@ - (void)getFIRAuthCredentialFromArguments:(NSDictionary *)arguments
     return;
 #endif
   }
-
+  // Apple Auth
+  if ([signInMethod isEqualToString:kSignInMethodApple]) {
+    if (idToken && rawNonce) {
+      // Credential with idToken, rawNonce and fullName
+      NSPersonNameComponents *fullName = [[NSPersonNameComponents alloc] init];
+      fullName.givenName =
+          arguments[kArgumentGivenName] == [NSNull null] ? nil : arguments[kArgumentGivenName];
+      fullName.familyName =
+          arguments[kArgumentFamilyName] == [NSNull null] ? nil : arguments[kArgumentFamilyName];
+      fullName.nickname =
+          arguments[kArgumentNickname] == [NSNull null] ? nil : arguments[kArgumentNickname];
+      fullName.namePrefix =
+          arguments[kArgumentNamePrefix] == [NSNull null] ? nil : arguments[kArgumentNamePrefix];
+      fullName.nameSuffix =
+          arguments[kArgumentNameSuffix] == [NSNull null] ? nil : arguments[kArgumentNameSuffix];
+      fullName.middleName =
+          arguments[kArgumentMiddleName] == [NSNull null] ? nil : arguments[kArgumentMiddleName];
+
+      completion([FIROAuthProvider appleCredentialWithIDToken:idToken
+                                                     rawNonce:rawNonce
+                                                     fullName:fullName],
+                 nil);
+      return;
+    }
+  }
   // OAuth
   if ([signInMethod isEqualToString:kSignInMethodOAuth]) {
     NSString *providerId = arguments[kArgumentProviderId];

packages/firebase_auth/firebase_auth/lib/firebase_auth.dart

@@ -34,6 +34,7 @@ export 'package:firebase_auth_platform_interface/firebase_auth_platform_interfac
         AuthCredential,
         AuthProvider,
         AppleAuthProvider,
+        AppleFullPersonName,
         AppleAuthCredential,
         EmailAuthProvider,
         EmailAuthCredential,

packages/firebase_auth/firebase_auth_platform_interface/lib/src/providers/apple_auth.dart

@@ -46,6 +46,19 @@ class AppleAuthProvider extends AuthProvider {
     );
   }
 
+  /// Create a new [AppleAuthCredential] from a provided [idToken], [rawNonce] and [appleFullPersonName];
+  static OAuthCredential credentialWithIDToken(
+    String idToken,
+    String rawNonce,
+    AppleFullPersonName appleFullPersonName,
+  ) {
+    return AppleAuthCredential._credentialWithIDToken(
+      idToken,
+      rawNonce,
+      appleFullPersonName,
+    );
+  }
+
   /// This corresponds to the sign-in method identifier.
   static String get APPLE_SIGN_IN_METHOD {
     return _kProviderId;
@@ -89,13 +102,52 @@ class AppleAuthProvider extends AuthProvider {
 /// [AppleAuthProvider.credential].
 class AppleAuthCredential extends OAuthCredential {
   AppleAuthCredential._({
-    required String accessToken,
+    String? accessToken,
+    String? rawNonce,
+    String? idToken,
+    AppleFullPersonName? appleFullPersonName,
   }) : super(
-            providerId: _kProviderId,
-            signInMethod: _kProviderId,
-            accessToken: accessToken);
+          providerId: _kProviderId,
+          signInMethod: _kProviderId,
+          accessToken: accessToken,
+          appleFullPersonName: appleFullPersonName,
+          rawNonce: rawNonce,
+          idToken: idToken,
+        );
 
   factory AppleAuthCredential._credential(String accessToken) {
-    return AppleAuthCredential._(accessToken: accessToken);
+    return AppleAuthCredential._(
+      accessToken: accessToken,
+    );
+  }
+
+  factory AppleAuthCredential._credentialWithIDToken(
+    String idToken,
+    String rawNonce,
+    AppleFullPersonName appleFullPersonName,
+  ) {
+    return AppleAuthCredential._(
+      idToken: idToken,
+      rawNonce: rawNonce,
+      appleFullPersonName: appleFullPersonName,
+    );
   }
 }
+
+class AppleFullPersonName {
+  AppleFullPersonName({
+    this.givenName,
+    this.familyName,
+    this.middleName,
+    this.nickname,
+    this.namePrefix,
+    this.nameSuffix,
+  });
+
+  final String? givenName;
+  final String? familyName;
+  final String? middleName;
+  final String? nickname;
+  final String? namePrefix;
+  final String? nameSuffix;
+}

packages/firebase_auth/firebase_auth_platform_interface/lib/src/providers/oauth.dart

@@ -82,6 +82,7 @@ class OAuthCredential extends AuthCredential {
     this.secret,
     this.rawNonce,
     this.serverAuthCode,
+    this.appleFullPersonName,
   }) : super(
           providerId: providerId,
           signInMethod: signInMethod,
@@ -104,6 +105,12 @@ class OAuthCredential extends AuthCredential {
   /// the server auth code for Play Games credential.
   final String? serverAuthCode;
 
+  /// The full name of the user. Used to create an AuthCredential for the
+  /// Sign in with Apple OAuth 2 provider identified by ID token, raw nonce,
+  /// and full name. This method is specific to the Sign in with Apple OAuth 2
+  /// provider as this provider requires the full name to be passed explicitly.
+  final AppleFullPersonName? appleFullPersonName;
+
   @override
   Map<String, String?> asMap() {
     return <String, String?>{
@@ -114,6 +121,12 @@ class OAuthCredential extends AuthCredential {
       'secret': secret,
       'rawNonce': rawNonce,
       'serverAuthCode': serverAuthCode,
+      'familyName': appleFullPersonName?.familyName,
+      'givenName': appleFullPersonName?.givenName,
+      'middleName': appleFullPersonName?.middleName,
+      'nickname': appleFullPersonName?.nickname,
+      'namePrefix': appleFullPersonName?.namePrefix,
+      'nameSuffix': appleFullPersonName?.nameSuffix,
     };
   }
 }