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

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

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

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

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

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

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

Управляйте процессом входа в систему с помощью Firebase SDK

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

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

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

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

      Снимок экрана: интерфейс настройки пользовательской схемы URL-адресов Xcode.

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

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

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

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

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

    // 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"]
        
    // 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.

    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
    }
    }
    }
        
    [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, вы можете вызвать API Yahoo .

    Например, чтобы получить базовую информацию профиля, вы можете вызвать 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 . Например, вы можете связать нескольких поставщиков с одним и тем же пользователем, позволяя им входить в систему с любым из них.

    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
    }
        
    [[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 , который можно использовать для получения новых учетных данных для конфиденциальных операций, требующих недавнего входа в систему.

    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
    }
        
    [[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 , когда пользователь пытается войти в систему у провайдера (например, Yahoo) с адресом электронной почты, который уже существует для другого провайдера пользователя Firebase (например, Google), возникает ошибка. FIRAuthErrorCodeAccountExistsWithDifferentCredential создается вместе с временным объектом FIRAuthCredential (учетные данные Yahoo). Чтобы завершить вход в систему предполагаемого поставщика, пользователь должен сначала войти в систему существующего поставщика (Google), а затем связать его с бывшим FIRAuthCredential (учетными данными Yahoo). Это будет выглядеть так, как показано ниже:

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

  
  // 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 не поддерживает те же возможности для таких провайдеров, как Yahoo, из-за неспособности Сервер Firebase Auth для проверки аудитории токенов доступа Yahoo OAuth. Это критическое требование безопасности, которое может подвергнуть приложения и веб-сайты повторным атакам, когда токен доступа Yahoo OAuth, полученный для одного проекта (злоумышленника), может использоваться для входа в другой проект (жертва). Вместо этого Firebase Auth предлагает возможность обрабатывать весь поток OAuth и обмен кодами авторизации, используя идентификатор клиента OAuth и секрет, настроенные в консоли Firebase. Поскольку код авторизации можно использовать только в сочетании с определенным идентификатором/секретом клиента, код авторизации, полученный для одного проекта, не может использоваться с другим.

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

Следующие шаги

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

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

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

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

Чтобы выйти из системы, вызовите signOut: .

let firebaseAuth = Auth.auth()
do {
  try firebaseAuth.signOut()
} catch let signOutError as NSError {
  print("Error signing out: %@", signOutError)
}
NSError *signOutError;
BOOL status = [[FIRAuth auth] signOut:&signOutError];
if (!status) {
  NSLog(@"Error signing out: %@", signOutError);
  return;
}

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