Аутентификация с помощью Yahoo на Android

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

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

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

1. Добавьте Firebase в свой проект Android .

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

   1. Чтобы зарегистрировать клиент Yahoo OAuth, следуйте документации разработчика Yahoo по регистрации веб-приложения в Yahoo .

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

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

6. Если вы еще не указали отпечаток SHA-1 своего приложения, сделайте это на странице настроек консоли Firebase . Подробную информацию о том, как получить отпечаток SHA-1 вашего приложения, см. в разделе Аутентификация вашего клиента .

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

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

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

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

   Kotlin+KTX

   val provider = OAuthProvider.newBuilder("yahoo.com")
   GenericIdpActivity.kt

   Java

   OAuthProvider.Builder provider = OAuthProvider.newBuilder("yahoo.com");
   GenericIdpActivity.java

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

   Kotlin+KTX

   // Prompt user to re-authenticate to Yahoo.
   provider.addCustomParameter("prompt", "login")
   
   // Localize to French.
   provider.addCustomParameter("language", "fr")
   GenericIdpActivity.kt

   Java

   // Prompt user to re-authenticate to Yahoo.
   provider.addCustomParameter("prompt", "login");
   
   // Localize to French.
   provider.addCustomParameter("language", "fr");
   GenericIdpActivity.java

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

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

   Kotlin+KTX

   // Request read access to a user's email addresses.
   // This must be preconfigured in the app's API permissions.
   provider.scopes = listOf("mail-r", "sdct-w")
   GenericIdpActivity.kt

   Java

   // Request read access to a user's email addresses.
   // This must be preconfigured in the app's API permissions.
   List<String> scopes =
           new ArrayList<String>() {
               {
                   // Request access to Yahoo Mail API.
                   add("mail-r");
                   // This must be preconfigured in the app's API permissions.
                   add("sdct-w");
               }
           };
   provider.setScopes(scopes);
   GenericIdpActivity.java

   Чтобы узнать больше, обратитесь к документации по областям Yahoo .

4. Аутентификация в Firebase с использованием объекта провайдера OAuth. Обратите внимание, что в отличие от других операций FirebaseAuth, эта операция возьмет на себя управление вашим пользовательским интерфейсом, открыв специальную вкладку Chrome . В результате не ссылайтесь на свою активность в прикрепленных вами OnSuccessListeners и OnFailureListeners, поскольку они немедленно отсоединятся, когда операция запустит пользовательский интерфейс.

   Сначала вам следует проверить, получили ли вы уже ответ. При входе в систему с помощью этого метода ваша активность переходит в фоновый режим, а это означает, что система может вернуть ее во время входа в систему. Чтобы убедиться, что вы не заставите пользователя повторить попытку, если это произойдет, вам следует проверить, присутствует ли уже результат.

   Чтобы проверить, есть ли ожидающий результат, вызовите getPendingAuthResult :

   Kotlin+KTX

   val pendingResultTask = firebaseAuth.pendingAuthResult
   if (pendingResultTask != null) {
       // There's something already here! Finish the sign-in for your user.
       pendingResultTask
           .addOnSuccessListener {
               // User is signed in.
               // IdP data available in
               // authResult.getAdditionalUserInfo().getProfile().
               // The OAuth access token can also be retrieved:
               // ((OAuthCredential)authResult.getCredential()).getAccessToken().
               // The OAuth secret can be retrieved by calling:
               // ((OAuthCredential)authResult.getCredential()).getSecret().
           }
           .addOnFailureListener {
               // Handle failure.
           }
   } else {
       // There's no pending result so you need to start the sign-in flow.
       // See below.
   }
   GenericIdpActivity.kt

   Java

   Task<AuthResult> pendingResultTask = firebaseAuth.getPendingAuthResult();
   if (pendingResultTask != null) {
       // There's something already here! Finish the sign-in for your user.
       pendingResultTask
               .addOnSuccessListener(
                       new OnSuccessListener<AuthResult>() {
                           @Override
                           public void onSuccess(AuthResult authResult) {
                               // User is signed in.
                               // IdP data available in
                               // authResult.getAdditionalUserInfo().getProfile().
                               // The OAuth access token can also be retrieved:
                               // ((OAuthCredential)authResult.getCredential()).getAccessToken().
                               // The OAuth secret can be retrieved by calling:
                               // ((OAuthCredential)authResult.getCredential()).getSecret().
                           }
                       })
               .addOnFailureListener(
                       new OnFailureListener() {
                           @Override
                           public void onFailure(@NonNull Exception e) {
                               // Handle failure.
                           }
                       });
   } else {
       // There's no pending result so you need to start the sign-in flow.
       // See below.
   }
   GenericIdpActivity.java

   Чтобы запустить процесс входа, вызовите startActivityForSignInWithProvider :

   Kotlin+KTX

   firebaseAuth
       .startActivityForSignInWithProvider(activity, provider.build())
       .addOnSuccessListener {
           // User is signed in.
           // IdP data available in
           // authResult.getAdditionalUserInfo().getProfile().
           // The OAuth access token can also be retrieved:
           // ((OAuthCredential)authResult.getCredential()).getAccessToken().
           // The OAuth secret can be retrieved by calling:
           // ((OAuthCredential)authResult.getCredential()).getSecret().
       }
       .addOnFailureListener {
           // Handle failure.
       }
   GenericIdpActivity.kt

   Java

   firebaseAuth
           .startActivityForSignInWithProvider(/* activity= */ this, provider.build())
           .addOnSuccessListener(
                   new OnSuccessListener<AuthResult>() {
                       @Override
                       public void onSuccess(AuthResult authResult) {
                           // User is signed in.
                           // IdP data available in
                           // authResult.getAdditionalUserInfo().getProfile().
                           // The OAuth access token can also be retrieved:
                           // ((OAuthCredential)authResult.getCredential()).getAccessToken().
                           // The OAuth secret can be retrieved by calling:
                           // ((OAuthCredential)authResult.getCredential()).getSecret().
                       }
                   })
           .addOnFailureListener(
                   new OnFailureListener() {
                       @Override
                       public void onFailure(@NonNull Exception e) {
                           // Handle failure.
                       }
                   });
   GenericIdpActivity.java

   При успешном завершении токен доступа OAuth, связанный с поставщиком, может быть получен из возвращенного объекта OAuthCredential .

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

   Где YAHOO_USER_UID — это идентификатор пользователя Yahoo, который можно проанализировать из firebaseAuth.getCurrentUser().getProviderData().get(0).getUid() или из authResult.getAdditionalUserInfo().getProfile() .

5. Хотя приведенные выше примеры посвящены потокам входа в систему, у вас также есть возможность связать поставщика Yahoo с существующим пользователем с помощью startActivityForLinkWithProvider . Например, вы можете связать несколько поставщиков с одним и тем же пользователем, позволяя им входить в систему с любым из них.

   Kotlin+KTX

   // The user is already signed-in.
   val firebaseUser = firebaseAuth.currentUser!!
   firebaseUser
       .startActivityForLinkWithProvider(activity, provider.build())
       .addOnSuccessListener {
           // Provider credential is linked to the current user.
           // IdP data available in
           // authResult.getAdditionalUserInfo().getProfile().
           // The OAuth access token can also be retrieved:
           // authResult.getCredential().getAccessToken().
           // The OAuth secret can be retrieved by calling:
           // authResult.getCredential().getSecret().
       }
       .addOnFailureListener {
           // Handle failure.
       }
   GenericIdpActivity.kt

   Java

   // The user is already signed-in.
   FirebaseUser firebaseUser = firebaseAuth.getCurrentUser();
   
   firebaseUser
           .startActivityForLinkWithProvider(/* activity= */ this, provider.build())
           .addOnSuccessListener(
                   new OnSuccessListener<AuthResult>() {
                       @Override
                       public void onSuccess(AuthResult authResult) {
                           // Provider credential is linked to the current user.
                           // IdP data available in
                           // authResult.getAdditionalUserInfo().getProfile().
                           // The OAuth access token can also be retrieved:
                           // authResult.getCredential().getAccessToken().
                           // The OAuth secret can be retrieved by calling:
                           // authResult.getCredential().getSecret().
                       }
                   })
           .addOnFailureListener(
                   new OnFailureListener() {
                       @Override
                       public void onFailure(@NonNull Exception e) {
                           // Handle failure.
                       }
                   });
   GenericIdpActivity.java

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

   Kotlin+KTX

   // The user is already signed-in.
   val firebaseUser = firebaseAuth.currentUser!!
   firebaseUser
       .startActivityForReauthenticateWithProvider(activity, provider.build())
       .addOnSuccessListener {
           // User is re-authenticated with fresh tokens and
           // should be able to perform sensitive operations
           // like account deletion and email or password
           // update.
       }
       .addOnFailureListener {
           // Handle failure.
       }
   GenericIdpActivity.kt

   Java

   // The user is already signed-in.
   FirebaseUser firebaseUser = firebaseAuth.getCurrentUser();
   
   firebaseUser
           .startActivityForReauthenticateWithProvider(/* activity= */ this, provider.build())
           .addOnSuccessListener(
                   new OnSuccessListener<AuthResult>() {
                       @Override
                       public void onSuccess(AuthResult authResult) {
                           // User is re-authenticated with fresh tokens and
                           // should be able to perform sensitive operations
                           // like account deletion and email or password
                           // update.
                       }
                   })
           .addOnFailureListener(
                   new OnFailureListener() {
                       @Override
                       public void onFailure(@NonNull Exception e) {
                           // Handle failure.
                       }
                   });
   GenericIdpActivity.java

Дополнительно: обработка процесса входа вручную.

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

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

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

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

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

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

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

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

Kotlin+KTX

Firebase.auth.signOut()
MainActivity.kt

Java

FirebaseAuth.getInstance().signOut();
MainActivity.java