Как выполнить аутентификацию с помощью Yahoo на платформах Apple

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

Подготовка

Чтобы пользователи могли входить в аккаунт с помощью Yahoo, сначала включите Yahoo в качестве поставщика услуг входа для проекта Firebase:

  1. Добавьте Firebase в свой проект Apple.
  2. В консоли Firebase выберите Безопасность > Аутентификация.
  3. На вкладке Способ входа включите поставщика для входа через Yahoo.
  4. Добавьте идентификатор клиента и секретный код клиента из консоли разработчика поставщика в конфигурацию поставщика:
    1. Чтобы зарегистрировать клиент OAuth Yahoo, следуйте инструкциям в документации для разработчиков Yahoo о том, как зарегистрировать веб-приложение в Yahoo.

      Выберите два разрешения OpenID Connect API:profile и email.

    2. При регистрации приложений у этих поставщиков обязательно укажите домен *.firebaseapp.com для своего проекта в качестве домена переадресации для приложения.
  5. Нажмите Сохранить.

Как обрабатывать процесс входа с помощью Firebase SDK

Чтобы реализовать процесс входа с помощью Firebase SDK для платформ Apple, выполните следующие действия:

  1. Добавьте в проект Xcode специальные схемы URL:

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

      Закодированный идентификатор приложения можно найти в консоли Firebase. Для этого перейдите на вкладку Настройки > Общие и прокрутите страницу вниз до раздела Ваши приложения, чтобы посмотреть сведения о приложении для iOS.

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

      Скриншот интерфейса настройки специальной схемы URL в Xcode

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

    Swift

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

    Objective-C

    FIROAuthProvider *provider = [FIROAuthProvider providerWithProviderID:@"yahoo.com"];
        
  3. Необязательно. Укажите дополнительные специальные параметры OAuth, которые вы хотите отправить с запросом OAuth.

    Swift

    provider.customParameters = [
    "prompt": "login",
    "language": "fr"
    ]
        

    Objective-C

    [provider setCustomParameters:@{@"prompt": @"login", @"language": @"fr"}];
        

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

  4. Необязательно. Укажите дополнительные области действия OAuth 2.0, помимо profile и email, которые вы хотите запросить у поставщика услуг аутентификации. Если вашему приложению требуется доступ к закрытым пользовательским данным из Yahoo API, вам нужно запросить разрешения для Yahoo API в разделе API Permissions консоли разработчика Yahoo. Запрашиваемые области действия OAuth должны точно соответствовать предварительно настроенным областям в разрешениях API приложения. Например, если приложению требуется доступ на чтение и запись к контактам пользователя и это разрешение предварительно настроено в API приложения, то вместо области действия OAuth sdct-r (только чтение) необходимо передать значение sdct-w. В противном случае процесс будет прерван и конечному пользователю будет показано сообщение об ошибке.

    Swift

    // Request access to Yahoo Mail API.
    // Request read/write access to user contacts.
    // This must be preconfigured in the app's API permissions.
    provider.scopes = ["mail-r", "sdct-w"]
        

    Objective-C

    // Request access to Yahoo Mail API.
    // Request read/write access to user contacts.
    // This must be preconfigured in the app's API permissions.
    [provider setScopes:@[@"mail-r", @"sdct-w"]];
        

    Подробнее о запросах Yahoo…

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

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

    Swift

    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.
      // Yahoo OAuth access token can also be retrieved by:
      // (authResult.credential as? OAuthCredential)?.accessToken
      // Yahoo OAuth ID token can be retrieved by calling:
      // (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.
      // Yahoo OAuth access token can also be retrieved by:
      // ((FIROAuthCredential *)authResult.credential).accessToken
      // Yahoo OAuth ID token can be retrieved by calling:
      // ((FIROAuthCredential *)authResult.credential).idToken
    }];
    }
    }];
        

    С помощью токена доступа OAuth можно вызывать Yahoo API.

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

    https://social.yahooapis.com/v1/user/YAHOO_USER_UID/profile?format=json

    где YAHOO_USER_UID – идентификатор пользователя Yahoo, который можно получить из поля Auth.auth.currentUser.providerData[0].uid или из authResult.additionalUserInfo.profile.

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

    Swift

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

    Objective-C

    [[FIRAuth auth].currentUser
    linkWithCredential:credential
            completion:^(FIRAuthDataResult * _Nullable authResult, NSError * _Nullable error) {
    if (error) {
    // Handle error.
    }
    // Yahoo credential is linked to the current user.
    // IdP data available in authResult.additionalUserInfo.profile.
    // Yahoo OAuth access token is can also be retrieved by:
    // ((FIROAuthCredential *)authResult.credential).accessToken
    // Yahoo OAuth ID token can be retrieved by calling:
    // ((FIROAuthCredential *)authResult.credential).idToken
    }];
        
  8. Аналогичный шаблон можно использовать с reauthenticateWithPopup/reauthenticateWithRedirect, чтобы получать новые учетные данные для операций, связанных с безопасностью и требующих недавнего входа в систему.

    Swift

    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 is can also be retrieved by:
    // (authResult.credential as? OAuthCredential)?.accessToken
    // Yahoo OAuth ID token can be retrieved by calling:
    // (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 is can also be retrieved by:
    // ((FIROAuthCredential *)authResult.credential).accessToken
    // Yahoo OAuth ID token can be retrieved by calling:
    // ((FIROAuthCredential *)authResult.credential).idToken
    }];
        

Дальнейшие действия

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

  • В своих приложениях вы можете получать основную информацию профиля пользователя из объекта User . Подробнее о том, как управлять пользователями…

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

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

Чтобы выйти из аккаунта пользователя, вызовите функцию signOut:.

Swift

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;
}

Также рекомендуем добавить код обработки ошибок для всех возможных ошибок аутентификации. Подробнее об обработке ошибок…