Аутентификация с помощью Microsoft на платформах Apple

Вы можете разрешить пользователям аутентифицироваться в Firebase с помощью поставщиков OAuth, таких как Microsoft Azure Active Directory, интегрировав в свое приложение веб-интерфейс авторизации на основе OAuth с использованием SDK Firebase для обеспечения сквозного процесса входа в систему.

Прежде чем начать

Для авторизации пользователей с использованием учетных записей Microsoft (Azure Active Directory и личных учетных записей Microsoft) необходимо сначала включить Microsoft в качестве поставщика авторизации для вашего проекта Firebase:

1. Добавьте Firebase в свой проект Apple .
2. В консоли Firebase перейдите в раздел Безопасность > Аутентификация .
3. На вкладке «Способ входа» включите поставщик входа Microsoft .
4. Добавьте идентификатор клиента (Client ID) и секретный ключ клиента (Client Secret) из консоли разработчика соответствующего поставщика в конфигурацию поставщика:
   1. Для регистрации клиента Microsoft OAuth следуйте инструкциям в разделе «Быстрый старт: Регистрация приложения в конечной точке Azure Active Directory v2.0» . Обратите внимание, что эта конечная точка поддерживает вход в систему с использованием как личных учетных записей Microsoft, так и учетных записей Azure Active Directory. Подробнее об Azure Active Directory v2.0 можно узнать здесь.
   2. При регистрации приложений у этих провайдеров обязательно зарегистрируйте домен *.firebaseapp.com для вашего проекта в качестве домена перенаправления для вашего приложения.
5. Нажмите « Сохранить ».

Обрабатывайте процесс авторизации с помощью Firebase SDK.

Для обработки процесса авторизации с помощью SDK Firebase Apple Platforms выполните следующие действия:

1. Добавьте пользовательские схемы URL-адресов в свой проект Xcode:

   1. Откройте конфигурацию проекта: дважды щелкните имя проекта в левом древовидном представлении. Выберите свое приложение в разделе «ЦЕЛИ» , затем перейдите на вкладку «Информация» и разверните раздел «Типы URL» .
   2. Нажмите кнопку «+» и добавьте свой закодированный идентификатор приложения в качестве схемы URL. Остальные поля оставьте пустыми.

      Вы можете найти свой закодированный идентификатор приложения в консоли Firebase : перейдите в... > Вкладка «Общие» , затем прокрутите вниз до раздела «Ваши приложения» , чтобы просмотреть подробную информацию о вашем приложении iOS.

      После завершения настройки ваш конфигурационный файл должен выглядеть примерно так (но с учетом значений, специфичных для вашего приложения):

      

2. Создайте экземпляр OAuthProvider , используя идентификатор поставщика microsoft.com .

   Быстрый

       var provider = OAuthProvider(providerID: "microsoft.com")
       

   Objective-C

       FIROAuthProvider *provider = [FIROAuthProvider providerWithProviderID:@"microsoft.com"];
       

3. Необязательно : укажите дополнительные пользовательские параметры OAuth, которые вы хотите отправить вместе с запросом OAuth.

   Быстрый

       provider.customParameters = [
         "prompt": "consent",
         "login_hint": "[e-mail]"
       ]
       

   Objective-C

       [provider setCustomParameters:@{@"prompt": @"consent", @"login_hint": @"[e-mail]"}];
       

   Информацию о параметрах, поддерживаемых Microsoft, см. в документации Microsoft OAuth . Обратите внимание, что с помощью setCustomParameters нельзя передавать параметры, необходимые для Firebase. К таким параметрам относятся client_id , response_type , redirect_uri , state , scope и response_mode .

   Чтобы разрешить вход в приложение только пользователям из определенного клиента Azure AD, можно использовать либо понятное доменное имя клиента Azure AD, либо GUID-идентификатор клиента. Это можно сделать, указав поле "tenant" в объекте пользовательских параметров.

   Быстрый

       provider.customParameters = [
         // Optional "tenant" parameter in case you are using an Azure AD
         // tenant. eg. '8eaef023-2b34-4da1-9baa-8bc8c9d6a490' or
         // 'contoso.onmicrosoft.com' or "common" for tenant-independent
         // tokens. The default value is "common".
         "tenant": "TENANT_ID"
       ]
       

   Objective-C

       // Optional "tenant" parameter in case you are using an Azure AD tenant.
       // eg. '8eaef023-2b34-4da1-9baa-8bc8c9d6a490' or
       // 'contoso.onmicrosoft.com' or "common" for tenant-independent tokens.
       // The default value is "common".
       provider.customParameters = @{@"tenant": @"TENANT_ID"};
       

4. Необязательно : укажите дополнительные области действия OAuth 2.0, помимо базового профиля, которые вы хотите запросить у поставщика аутентификации.

   Быстрый

       provider.scopes = ["mail.read", "calendars.read"]
       

   Objective-C

       [provider setScopes:@[@"mail.read", @"calendars.read"]];
       

   Для получения более подробной информации обратитесь к документации Microsoft по разрешениям и согласиям .

5. Необязательно : если вы хотите настроить способ отображения SFSafariViewController или UIWebView при показе reCAPTCHA пользователю, создайте пользовательский класс, соответствующий протоколу AuthUIDelegate , и передайте его в credentialWithUIDelegate .

6. Аутентификация в Firebase осуществляется с помощью объекта поставщика OAuth.

   Быстрый

       // Replace nil with the custom class that conforms to AuthUIDelegate
       // you created in last step to use a customized web view.
       provider.getCredentialWith(nil) { credential, error in
         if error != nil {
           // Handle error.
         }
         if credential != nil {
           Auth().signIn(with: credential) { authResult, error in
             if error != nil {
               // Handle error.
             }
             // User is signed in.
             // IdP data available in authResult.additionalUserInfo.profile.
             // OAuth access token can also be retrieved:
             // (authResult.credential as? OAuthCredential)?.accessToken
             // OAuth ID token can also be retrieved:
             // (authResult.credential as? OAuthCredential)?.idToken
           }
         }
       }
       

   Objective-C

       [provider getCredentialWithUIDelegate:nil
                                  completion:^(FIRAuthCredential *_Nullable credential, NSError *_Nullable error) {
         if (error) {
          // Handle error.
         }
         if (credential) {
           [[FIRAuth auth] signInWithCredential:credential
                                     completion:^(FIRAuthDataResult *_Nullable authResult, NSError *_Nullable error) {
             if (error) {
               // Handle error.
             }
             // User is signed in.
             // IdP data available in authResult.additionalUserInfo.profile.
             // OAuth access token can also be retrieved:
             // ((FIROAuthCredential *)authResult.credential).accessToken
             // OAuth ID token can also be retrieved:
             // ((FIROAuthCredential *)authResult.credential).idToken
           }];
         }
       }];
       

   Используя токен доступа OAuth, вы можете вызвать API Microsoft Graph .

   Например, для получения основной информации о профиле можно вызвать REST API, передав токен доступа в заголовке Authorization :

   https://graph.microsoft.com/v1.0/me

   В отличие от других поставщиков, поддерживаемых Firebase Auth, Microsoft не предоставляет URL-адрес фотографии, и вместо этого двоичные данные для фотографии профиля необходимо запрашивать через Microsoft Graph API .

   В дополнение к токену доступа OAuth, токен идентификатора OAuth пользователя также можно получить из объекта OAuthCredential . sub в токене идентификатора является специфичным для приложения и не будет совпадать с федеративным идентификатором пользователя, используемым Firebase Auth и доступным через user.providerData[0].uid . Вместо этого следует использовать поле утверждения oid . При использовании клиента Azure AD для входа в систему поле утверждения oid будет точно совпадать. Однако в случае, когда клиент не использует клиент, поле oid дополняется. Для федеративного идентификатора 4b2eabcdefghijkl , oid будет иметь форму 00000000-0000-0000-4b2e-abcdefghijkl .

7. Хотя приведенные выше примеры сосредоточены на процессах входа в систему, у вас также есть возможность связать поставщика Microsoft с существующим пользователем с помощью linkWithCredential . Например, вы можете связать несколько поставщиков с одним и тем же пользователем, позволяя ему входить в систему с помощью любого из них.

   Быстрый

       Auth().currentUser.link(withCredential: credential) { authResult, error in
         if error != nil {
           // Handle error.
         }
         // Microsoft credential is linked to the current user.
         // IdP data available in authResult.additionalUserInfo.profile.
         // OAuth access token can also be retrieved:
         // (authResult.credential as? OAuthCredential)?.accessToken
         // OAuth ID token can also be retrieved:
         // (authResult.credential as? OAuthCredential)?.idToken
       }
       

   Objective-C

       [[FIRAuth auth].currentUser
           linkWithCredential:credential
                   completion:^(FIRAuthDataResult * _Nullable authResult, NSError * _Nullable error) {
         if (error) {
           // Handle error.
         }
         // Microsoft credential is linked to the current user.
         // IdP data available in authResult.additionalUserInfo.profile.
         // OAuth access token can also be retrieved:
         // ((FIROAuthCredential *)authResult.credential).accessToken
         // OAuth ID token can also be retrieved:
         // ((FIROAuthCredential *)authResult.credential).idToken
       }];
       

8. Аналогичный подход можно использовать с reauthenticateWithCredential , которая позволяет получить актуальные учетные данные для выполнения конфиденциальных операций, требующих недавнего входа в систему.

   Быстрый

       Auth().currentUser.reauthenticateWithCredential(withCredential: credential) { authResult, error in
         if error != nil {
           // Handle error.
         }
         // User is re-authenticated with fresh tokens minted and
         // should be able to perform sensitive operations like account
         // deletion and email or password update.
         // IdP data available in result.additionalUserInfo.profile.
         // Additional OAuth access token can also be retrieved:
         // (authResult.credential as? OAuthCredential)?.accessToken
         // OAuth ID token can also be retrieved:
         // (authResult.credential as? OAuthCredential)?.idToken
       }
       

   Objective-C

       [[FIRAuth auth].currentUser
           reauthenticateWithCredential:credential
                             completion:^(FIRAuthDataResult * _Nullable authResult, NSError * _Nullable error) {
         if (error) {
           // Handle error.
         }
         // User is re-authenticated with fresh tokens minted and
         // should be able to perform sensitive operations like account
         // deletion and email or password update.
         // IdP data available in result.additionalUserInfo.profile.
         // Additional OAuth access token can also be retrieved:
         // ((FIROAuthCredential *)authResult.credential).accessToken
         // OAuth ID token can also be retrieved:
         // ((FIROAuthCredential *)authResult.credential).idToken
       }];
       

Обработка ошибок, связанных с существованием учетной записи с разными учетными данными.

Если в консоли Firebase включена настройка « Одна учетная запись на один адрес электронной почты» , то при попытке входа пользователя в систему у провайдера (например, Microsoft) с использованием адреса электронной почты, уже существующего у другого провайдера Firebase (например, Google), возникает ошибка FIRAuthErrorCodeAccountExistsWithDifferentCredential , а также создается временный объект FIRAuthCredential (учетные данные Microsoft). Для завершения входа в систему у нужного провайдера пользователю необходимо сначала войти в существующую учетную запись (Google), а затем связать ее с прежним объектом FIRAuthCredential (учетные данные Microsoft). Это будет выглядеть так, как показано ниже:

Быстрый

  // Sign-in with an OAuth credential.
  provider.getCredentialWith(nil) { credential, error in
    // An account with the same email already exists.
    if (error as NSError?)?.code == AuthErrorCode.accountExistsWithDifferentCredential.rawValue {
      // Get pending credential and email of existing account.
      let existingAcctEmail = (error! as NSError).userInfo[AuthErrorUserInfoEmailKey] as! String
      let pendingCred = (error! as NSError).userInfo[AuthErrorUserInfoUpdatedCredentialKey] as! AuthCredential
      // Lookup existing account identifier by the email.
      Auth.auth().fetchProviders(forEmail:existingAcctEmail) { providers, error in
        // Existing email/password account.
        if (providers?.contains(EmailAuthProviderID))! {
          // Existing password account for email. Ask user to provide the password of the
          // existing account.
          // Sign in with existing account.
          Auth.auth().signIn(withEmail:existingAcctEmail, password:password) { user, error in
            // Successfully signed in.
            if user != nil {
              // Link pending credential to account.
              Auth.auth().currentUser?.linkAndRetrieveData(with: pendingCred) { result, error in
                // ...
              }
            }
          }
        }
      }
      return
    }

    // Other errors.
    if error != nil {
      // handle the error.
      return
    }

    // Sign in with the credential.
    if credential != nil {
      Auth.auth().signInAndRetrieveData(with: credential!) { result, error in
        if error != nil {
          // handle the error.
          return
        }
      }
    }
  }

  

Objective-C

  // Sign-in with an OAuth credential.
  [provider getCredentialWithUIDelegate:nil
                             completion:^(FIRAuthCredential *_Nullable credential, NSError *_Nullable error) {
    // An account with the same email already exists.
    if (error.code == FIRAuthErrorCodeAccountExistsWithDifferentCredential) {
      // Get pending credential and email of existing account.
      NSString *existingAcctEmail = error.userInfo[FIRAuthErrorUserInfoEmailKey];
      FIRAuthCredential *pendingCred = error.userInfo[FIRAuthErrorUserInfoUpdatedCredentialKey];
      // Lookup existing account identifier by the email.
      [[FIRAuth auth] fetchProvidersForEmail:existingAcctEmail
                                 completion:^(NSArray<NSString *> *_Nullable providers,
                                              NSError *_Nullable error) {
        // Existing email/password account.
        if ( [providers containsObject:FIREmailAuthProviderID] ) {
          // Existing password account for email. Ask user to provide the password of the
          // existing account.

          // Sign in with existing account.
          [[FIRAuth auth] signInWithEmail:existingAcctEmail
                                 password:password
                               completion:^(FIRUser *user, NSError *error) {
            // Successfully signed in.
            if (user) {
              // Link pending credential to account.
              [[FIRAuth auth].currentUser linkWithCredential:pendingCred
                                                  completion:^(FIRUser *_Nullable user,
                                                               NSError *_Nullable error) {
                // ...
              }];
            }
          }];
        }
      }];
      return;
    }

    // Other errors.
    if (error) {
      // handle the error.
      return;
    }

    // Sign in with the credential.
    if (credential) {
      [[FIRAuth auth] signInAndRetrieveDataWithCredential:credential
          completion:^(FIRAuthDataResult *_Nullable authResult,
                       NSError *_Nullable error) {
        if (error) {
          // handle the error.
          return;
        }
      }];
    }
  }];
  

Расширенные настройки: Обработка процесса входа в систему вручную

В отличие от других OAuth-провайдеров, поддерживаемых Firebase, таких как Google, Facebook и Twitter, где вход в систему может осуществляться напрямую с помощью учетных данных на основе токенов доступа OAuth, Firebase Auth не поддерживает аналогичную возможность для таких провайдеров, как Microsoft, из-за невозможности сервера Firebase Auth проверять целевую аудиторию токенов доступа Microsoft OAuth. Это критически важное требование безопасности, которое может сделать приложения и веб-сайты уязвимыми для атак повторного воспроизведения, когда токен доступа Microsoft OAuth, полученный для одного проекта (злоумышленник), может быть использован для входа в другой проект (жертва). Вместо этого Firebase Auth предлагает возможность обрабатывать весь поток OAuth и обмен кодами авторизации, используя идентификатор клиента OAuth и секрет, настроенные в консоли Firebase. Поскольку код авторизации может использоваться только с определенным идентификатором клиента/секретом, код авторизации, полученный для одного проекта, не может быть использован с другим.

Если эти поставщики необходимо использовать в неподдерживаемых средах, потребуется использовать стороннюю библиотеку OAuth и пользовательскую аутентификацию Firebase . Первая необходима для аутентификации у поставщика, а вторая — для обмена учетных данных поставщика на пользовательский токен.

После первого входа пользователя в систему создается новая учетная запись, которая связывается с учетными данными — то есть именем пользователя и паролем, номером телефона или информацией о поставщике аутентификации, — которые пользователь использовал для входа. Эта новая учетная запись хранится как часть вашего проекта Firebase и может использоваться для идентификации пользователя во всех приложениях вашего проекта, независимо от способа входа пользователя.

• В ваших приложениях вы можете получить основную информацию профиля пользователя из объекта User . См. раздел «Управление пользователями» .

• В правилах безопасности Firebase Realtime Database и Cloud Storage вы можете получить уникальный идентификатор пользователя, вошедшего в систему, из переменной auth и использовать его для управления доступом пользователя к данным.

Вы можете разрешить пользователям входить в ваше приложение, используя несколько поставщиков аутентификации, связав учетные данные поставщика аутентификации с существующей учетной записью пользователя.

Для выхода из системы пользователя вызовите signOut: .

Быстрый

let firebaseAuth = Auth.auth()
do {
  try firebaseAuth.signOut()
} catch let signOutError as NSError {
  print("Error signing out: %@", signOutError)
}

Objective-C

NSError *signOutError;
BOOL status = [[FIRAuth auth] signOut:&signOutError];
if (!status) {
  NSLog(@"Error signing out: %@", signOutError);
  return;
}

Также может потребоваться добавить код обработки ошибок для всего спектра ошибок аутентификации. См. раздел «Обработка ошибок» .