Auth: C++ API support for existing Generic IDP implementation on iOS.

Googler · a-maurice · commit ba34419e40a2 · 2019-08-14T13:48:17.000-07:00
C++ API implementation calls into the Objective C Firebase Auth iOS SDK.  Includes updates to the ios_testapp, integration tests, and a new ios_util function to handle converting Vectors of strings to NSMutableArrays.

Moved the GetProviderId functions of the C++ providers to the header so that the implementation is common across all targets.

Currently iOS does not support User linkWithProvider and reauthenticateWithProvider, but it's in the works.  For now the implementation gets a credential and the uses that to linke/reauthenticate before returning the SignInResult.

PiperOrigin-RevId: 262596855
diff --git a/app/src/util_ios.h b/app/src/util_ios.h
@@ -138,6 +138,10 @@ typedef BOOL (
 // blacklist we keep).
 void ForEachAppDelegateClass(void (^block)(Class));
 
+ // Convert a string array into an NSMutableArray.
+NSMutableArray *StringVectorToNSMutableArray(
+    const std::vector<std::string> &vector);
+
 // Convert a string map to NSDictionary.
 NSDictionary *StringMapToNSDictionary(
     const std::map<std::string, std::string> &string_map);
diff --git a/app/src/util_ios.mm b/app/src/util_ios.mm
@@ -157,6 +157,14 @@ void ForEachAppDelegateClass(void (^block)(Class)) {
     std::string();
 }
 
+NSMutableArray *StringVectorToNSMutableArray(const std::vector<std::string> &vector) {
+  NSMutableArray<NSString *> *array = [[NSMutableArray alloc] initWithCapacity:vector.size()];
+  for (auto &element : vector) {
+    [array addObject:StringToNSString(element)];
+  }
+  return array;
+}
+
 NSMutableArray* StdVectorToNSMutableArray(const std::vector<Variant>& vector) {
   NSMutableArray* array =
       [[NSMutableArray alloc] initWithCapacity:vector.size()];
diff --git a/auth/src/data.h b/auth/src/data.h
@@ -38,8 +38,6 @@ enum AuthApiFunction {
   kAuthFn_SignInAnonymously,
   kAuthFn_SignInWithEmailAndPassword,
   kAuthFn_SignInWithProvider,
-  kAuthFn_LinkWithProvider,
-  kAuthFn_ReauthenticateWithProvider,
   kAuthFn_CreateUserWithEmailAndPassword,
   kAuthFn_SendPasswordResetEmail,
 
@@ -54,6 +52,8 @@ enum AuthApiFunction {
   kUserFn_UpdateUserProfile,
   kUserFn_LinkWithCredential,
   kUserFn_LinkAndRetrieveDataWithCredential,
+  kUserFn_LinkWithProvider,
+  kUserFn_ReauthenticateWithProvider,
   kUserFn_Unlink,
   kUserFn_UpdatePhoneNumberCredential,
   kUserFn_Reload,
diff --git a/auth/src/desktop/auth_providers/facebook_auth_provider.cc b/auth/src/desktop/auth_providers/facebook_auth_provider.cc
@@ -29,10 +29,5 @@ Credential FacebookAuthProvider::GetCredential(const char* const access_token) {
       new CredentialImpl{new FacebookAuthCredential(access_token)}};
 }
 
-// static
-const char* FacebookAuthProvider::GetProviderId()  {
-  return "facebook.com";
-}
-
 }  // namespace auth
 }  // namespace firebase
diff --git a/auth/src/desktop/auth_providers/federated_auth_provider.cc b/auth/src/desktop/auth_providers/federated_auth_provider.cc
@@ -59,7 +59,7 @@ Future<SignInResult> CreateAuthFuture(AuthData* auth_data,
     auth_data->future_impl.CompleteWithResult(
         handle, kAuthErrorFederatedProviderAreadyInUse,
         "Provider operation already in progress.",
-        /*SignInResult=*/{});
+        /*result=*/{});
     return MakeFuture(&auth_data->future_impl, handle);
   } else if (future_base.status() == kFutureStatusInvalid) {
     // initialize the future.
@@ -94,7 +94,7 @@ Future<SignInResult> FederatedOAuthProvider::Link(AuthData* auth_data) {
   assert(auth_data);
   FIREBASE_ASSERT_RETURN(Future<SignInResult>(), handler_);
   Future<SignInResult> future =
-      CreateAuthFuture(auth_data, kAuthFn_LinkWithProvider);
+      CreateAuthFuture(auth_data, kUserFn_LinkWithProvider);
   if (future.status() == kFutureStatusPending) {
     AuthCompletionHandle* auth_completion_handle = new AuthCompletionHandle(
         SafeFutureHandle<SignInResult>(future.GetHandle()), auth_data);
@@ -108,7 +108,7 @@ Future<SignInResult> FederatedOAuthProvider::Reauthenticate(
   assert(auth_data);
   FIREBASE_ASSERT_RETURN(Future<SignInResult>(), handler_);
   Future<SignInResult> future =
-      CreateAuthFuture(auth_data, kAuthFn_ReauthenticateWithProvider);
+      CreateAuthFuture(auth_data, kUserFn_ReauthenticateWithProvider);
   if (future.status() == kFutureStatusPending) {
     AuthCompletionHandle* auth_completion_handle = new AuthCompletionHandle(
         SafeFutureHandle<SignInResult>(future.GetHandle()), auth_data);
diff --git a/auth/src/desktop/auth_providers/github_auth_provider.cc b/auth/src/desktop/auth_providers/github_auth_provider.cc
@@ -28,10 +28,5 @@ Credential GitHubAuthProvider::GetCredential(const char* const token) {
   return Credential{new CredentialImpl{new GitHubAuthCredential(token)}};
 }
 
-// static
-const char* GitHubAuthProvider::GetProviderId() {
-  return "github.com";
-}
-
 }  // namespace auth
 }  // namespace firebase
diff --git a/auth/src/desktop/auth_providers/google_auth_provider.cc b/auth/src/desktop/auth_providers/google_auth_provider.cc
@@ -37,10 +37,5 @@ Credential GoogleAuthProvider::GetCredential(const char* const id_token,
   }
 }
 
-// static
-const char* GoogleAuthProvider::GetProviderId() {
-  return "google.com";
-}
-
 }  // namespace auth
 }  // namespace firebase
diff --git a/auth/src/desktop/auth_providers/playgames_auth_provider.cc b/auth/src/desktop/auth_providers/playgames_auth_provider.cc
@@ -30,10 +30,5 @@ Credential PlayGamesAuthProvider::GetCredential(
       new CredentialImpl{new PlayGamesAuthCredential(server_auth_code)}};
 }
 
-// static
-const char* PlayGamesAuthProvider::GetProviderId() {
-  return "playgames.google.com";
-}
-
 }  // namespace auth
 }  // namespace firebase
diff --git a/auth/src/desktop/auth_providers/twitter_auth_provider.cc b/auth/src/desktop/auth_providers/twitter_auth_provider.cc
@@ -30,10 +30,5 @@ Credential TwitterAuthProvider::GetCredential(const char* const token,
       new CredentialImpl{new TwitterAuthCredential(token, secret)}};
 }
 
-// static
-const char* TwitterAuthProvider::GetProviderId() {
-  return "twitter.com";
-}
-
 }  // namespace auth
 }  // namespace firebase
diff --git a/auth/src/include/firebase/auth/credential.h b/auth/src/include/firebase/auth/credential.h
@@ -151,7 +151,7 @@ class FacebookAuthProvider {
   /// @see Auth::SignInWithProvider
   /// @see User::ReauthenticateWithProvider
   /// @see User::LinkWithProvider
-  static const char* GetProviderId();
+  static const char* GetProviderId() { return "facebook.com"; }
 #endif  // INTERNAL_EXPERIMENTAL
 };
 
@@ -173,7 +173,7 @@ class GitHubAuthProvider {
   /// @see Auth::SignInWithProvider
   /// @see User::ReauthenticateWithProvider
   /// @see User::LinkWithProvider
-  static const char* GetProviderId();
+  static const char* GetProviderId() { return "github.com"; }
 #endif  // INTERNAL_EXPERIMENTAL
 };
 
@@ -197,7 +197,7 @@ class GoogleAuthProvider {
   /// @see Auth::SignInWithProvider
   /// @see User::ReauthenticateWithProvider
   /// @see User::LinkWithProvider
-  static const char* GetProviderId();
+  static const char* GetProviderId() { return "google.com"; }
 #endif  // INTERNAL_EXPERIMENTAL
 };
 
@@ -219,7 +219,7 @@ class PlayGamesAuthProvider {
   /// @see Auth::SignInWithProvider
   /// @see User::ReauthenticateWithProvider
   /// @see User::LinkWithProvider
-  static const char* GetProviderId();
+  static const char* GetProviderId() { return "playgames.google.com"; }
 #endif  // INTERNAL_EXPERIMENTAL
 };
 
@@ -242,7 +242,7 @@ class TwitterAuthProvider {
   /// @see Auth::SignInWithProvider
   /// @see User::ReauthenticateWithProvider
   /// @see User::LinkWithProvider
-  static const char* GetProviderId();
+  static const char* GetProviderId()  { return "twitter.com"; }
 #endif  // INTERNAL_EXPERIMENTAL
 };
 
diff --git a/auth/src/include/firebase/auth/types.h b/auth/src/include/firebase/auth/types.h
@@ -367,6 +367,10 @@ enum AuthError {
   /// Indicates that one or more fields of the provided AuthenticatedUserData
   /// are invalid.
   kAuthErrorInvalidAuthenticatedUserData,
+
+  /// Indicates that an error occurred during a Federated Auth UI Flow when the
+  /// user was prompted to enter their credentials.
+  kAuthErrorFederatedSignInUserInteractionFailure,
 #endif  // INTERNAL_EXEPERIMENTAL
 };
 
diff --git a/auth/src/ios/auth_ios.mm b/auth/src/ios/auth_ios.mm
@@ -97,6 +97,8 @@ @implementation FIRCPPAuthListenerHandle
     {FIRAuthErrorCodeWebContextCancelled, kAuthErrorWebContextCancelled},
     {FIRAuthErrorCodeWrongPassword, kAuthErrorWrongPassword},
     {FIRAuthErrorCodeInvalidProviderID, kAuthErrorInvalidProviderId},
+    {FIRAuthErrorCodeWebSignInUserInteractionFailure,
+     kAuthErrorFederatedSignInUserInteractionFailure},
     // TODO(b/137141080): Handle New Thick Client Error
     // Uncomment once support for MISSING_CLIENT_IDENTIFIER is added to the iOS SDK.
     // {FIRAuthErrorCodeMissingClientIdentifier, kAuthErrorMissingClientIdentifier},
@@ -337,6 +339,11 @@ void SignInResultCallback(FIRAuthDataResult *_Nullable auth_result, NSError *_Nu
   return MakeFuture(&futures, handle);
 }
 
+Future<SignInResult> Auth::SignInWithProvider(FederatedAuthProvider* provider) {
+  FIREBASE_ASSERT_RETURN(Future<SignInResult>(), provider);
+  return provider->SignIn(auth_data_);
+}
+
 Future<User *> Auth::SignInAnonymously() {
   ReferenceCountedFutureImpl &futures = auth_data_->future_impl;
   const auto handle = auth_data_->future_impl.SafeAlloc<User *>(kAuthFn_SignInAnonymously, nullptr);
diff --git a/auth/src/ios/credential_ios.mm b/auth/src/ios/credential_ios.mm
@@ -23,12 +23,13 @@
 
 #import "FIREmailAuthProvider.h"
 #import "FIRFacebookAuthProvider.h"
+#import "FIRFederatedAuthProvider.h"
+#import "FIRGameCenterAuthProvider.h"
 #import "FIRGitHubAuthProvider.h"
 #import "FIRGoogleAuthProvider.h"
 #import "FIROAuthProvider.h"
 #import "FIRPhoneAuthProvider.h"
 #import "FIRTwitterAuthProvider.h"
-#import "FIRGameCenterAuthProvider.h"
 
 // This object is shared between the PhoneAuthProvider::Listener and the blocks in
 // @ref VerifyPhoneNumber. It exists for as long as one of those two lives. We use Objective-C
@@ -295,5 +296,141 @@ explicit PhoneAuthProviderData(FIRPhoneAuthProvider* objc_provider)
   return provider;
 }
 
+// FederatedAuthHandlers
+FederatedOAuthProvider::FederatedOAuthProvider() { }
+
+FederatedOAuthProvider::~FederatedOAuthProvider() { }
+
+void FederatedOAuthProvider::SetProviderData(const FederatedOAuthProviderData& provider_data) {
+  provider_data_ = provider_data;
+}
+
+// Callback to funnel a result from a GetCredential request to linkWithCredential request. This
+// fulfills User::LinkWithProvider functionality on iOS, which currently isn't accessible via their
+// current API.
+void LinkWithProviderGetCredentialCallback(FIRAuthCredential* _Nullable credential,
+                                           NSError* _Nullable error,
+                                           SafeFutureHandle<SignInResult> handle,
+                                           AuthData* auth_data,
+                                           const FederatedOAuthProviderData& provider_data) {
+  if (error && error.code != 0) {
+    ReferenceCountedFutureImpl& futures = auth_data->future_impl;
+    futures.CompleteWithResult(handle, AuthErrorFromNSError(error),
+                               util::NSStringToString(error.localizedDescription).c_str(),
+                               SignInResult());
+  } else {
+    [UserImpl(auth_data)
+        linkWithCredential:credential
+                completion:^(FIRAuthDataResult* _Nullable auth_result, NSError* _Nullable error) {
+                  SignInResultCallback(auth_result, error, handle, auth_data);
+                }];
+  }
+}
+
+// Callback to funnel a result from a GetCredential request to reauthetnicateWithCredential request.
+// This fulfills User::ReauthenticateWithProvider functionality on iOS, which currently isn't
+// accessible via their current API.
+void ReauthenticateWithProviderGetCredentialCallback(
+    FIRAuthCredential* _Nullable credential, NSError* _Nullable error,
+    SafeFutureHandle<SignInResult> handle, AuthData* auth_data,
+    const FederatedOAuthProviderData& provider_data) {
+  if (error && error.code != 0) {
+    ReferenceCountedFutureImpl& futures = auth_data->future_impl;
+    futures.CompleteWithResult(handle, AuthErrorFromNSError(error),
+                               util::NSStringToString(error.localizedDescription).c_str(),
+                               SignInResult());
+  } else {
+    [UserImpl(auth_data)
+        reauthenticateWithCredential:credential
+                completion:^(FIRAuthDataResult* _Nullable auth_result, NSError* _Nullable error) {
+                  SignInResultCallback(auth_result, error, handle, auth_data);
+                }];
+  }
+}
+
+Future<SignInResult> FederatedOAuthProvider::SignIn(AuthData* auth_data) {
+  assert(auth_data);
+  ReferenceCountedFutureImpl &futures = auth_data->future_impl;
+  const auto handle =
+      futures.SafeAlloc<SignInResult>(kAuthFn_SignInWithProvider, SignInResult());
+  FIROAuthProvider* ios_provider = (FIROAuthProvider*)[FIROAuthProvider
+      providerWithProviderID:@(provider_data_.provider_id.c_str())
+                        auth:AuthImpl(auth_data)];
+  if (ios_provider != nullptr) {
+    ios_provider.customParameters = util::StringMapToNSDictionary(provider_data_.custom_parameters);
+    ios_provider.scopes = util::StringVectorToNSMutableArray(provider_data_.scopes);
+    [AuthImpl(auth_data)
+        signInWithProvider:ios_provider
+                UIDelegate:nullptr
+                completion:^(FIRAuthDataResult* _Nullable auth_result, NSError* _Nullable error) {
+                  SignInResultCallback(auth_result, error, handle, auth_data);
+                }];
+    return MakeFuture(&futures, handle);
+  } else {
+    Future<SignInResult> future = MakeFuture(&futures, handle);
+    futures.CompleteWithResult(handle, kAuthErrorFailure, "Internal error constructing provider.",
+                           SignInResult());
+    return future;
+  }
+}
+
+Future<SignInResult> FederatedOAuthProvider::Link(AuthData* auth_data) {
+  assert(auth_data);
+  ReferenceCountedFutureImpl &futures = auth_data->future_impl;
+  auto handle =
+      futures.SafeAlloc<SignInResult>(kUserFn_LinkWithProvider, SignInResult());
+  FIROAuthProvider* ios_provider = (FIROAuthProvider*)[FIROAuthProvider
+      providerWithProviderID:@(provider_data_.provider_id.c_str())
+                        auth:AuthImpl(auth_data)];
+  if (ios_provider != nullptr) {
+    ios_provider.customParameters = util::StringMapToNSDictionary(provider_data_.custom_parameters);
+    ios_provider.scopes = util::StringVectorToNSMutableArray(provider_data_.scopes);
+    // TODO(b/138788092) invoke FIRUser linkWithProvider instead, once that method is added to the
+    // iOS SDK.
+    [ios_provider
+        getCredentialWithUIDelegate:nullptr
+                         completion:^(FIRAuthCredential* _Nullable credential,
+                                      NSError* _Nullable error) {
+                           LinkWithProviderGetCredentialCallback(
+                               credential, error, handle, auth_data, provider_data_);
+                         }];
+    return MakeFuture(&futures, handle);
+  } else {
+    Future<SignInResult> future = MakeFuture(&futures, handle);
+    futures.CompleteWithResult(handle, kAuthErrorFailure, "Internal error constructing provider.",
+                               SignInResult());
+    return future;
+  }
+}
+
+Future<SignInResult> FederatedOAuthProvider::Reauthenticate(AuthData* auth_data) {
+  assert(auth_data);
+  ReferenceCountedFutureImpl &futures = auth_data->future_impl;
+  auto handle =
+      futures.SafeAlloc<SignInResult>(kUserFn_LinkWithProvider, SignInResult());
+  FIROAuthProvider* ios_provider = (FIROAuthProvider*)[FIROAuthProvider
+      providerWithProviderID:@(provider_data_.provider_id.c_str())
+                        auth:AuthImpl(auth_data)];
+  if (ios_provider != nullptr) {
+    ios_provider.customParameters = util::StringMapToNSDictionary(provider_data_.custom_parameters);
+    ios_provider.scopes = util::StringVectorToNSMutableArray(provider_data_.scopes);
+    // TODO(b/138788092) invoke FIRUser:reuthenticateWithProvider instead, once that method is added
+    // to the iOS SDK.
+    [ios_provider
+        getCredentialWithUIDelegate:nullptr
+                         completion:^(FIRAuthCredential* _Nullable credential,
+                                      NSError* _Nullable error) {
+                           ReauthenticateWithProviderGetCredentialCallback(
+                               credential, error, handle, auth_data, provider_data_);
+                         }];
+    return MakeFuture(&futures, handle);
+  } else {
+    Future<SignInResult> future = MakeFuture(&futures, handle);
+    futures.CompleteWithResult(handle, kAuthErrorFailure, "Internal error constructing provider.",
+                               SignInResult());
+    return future;
+  }
+}
+
 }  // namespace auth
 }  // namespace firebase
diff --git a/auth/src/ios/user_ios.mm b/auth/src/ios/user_ios.mm

Original file line number	Diff line number	Diff line change
`@@ -37,10 +37,5 @@ Credential GoogleAuthProvider::GetCredential(const char* const id_token,`
`37`	`37`	`}`
`38`	`38`	`}`
`39`	`39`
`40`		`-// static`
`41`		`-const char* GoogleAuthProvider::GetProviderId() {`
`42`		`- return "google.com";`
`43`		`-}`
`44`		`-`
`45`	`40`	`} // namespace auth`
`46`	`41`	`} // namespace firebase`