Catch up on everthing we announced at this year's Firebase Summit. Learn more

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

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

Прежде чем вы начнете

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

  1. Если вы еще не сделали, добавить Firebase в свой Android проекта .

  2. В Firebase консоли откройте раздел Auth.
  3. На вкладке Вход в методе, позволяют поставщику GitHub.
  4. Добавьте идентификатор клиента и секрет клиента от разработчиков консоли, поставщика к конфигурации поставщика:
    1. Зарегистрируйте свое приложение в качестве приложения для разработчиков на GitHub и получить ваше приложение OAuth 2.0 ID клиента и секрет клиента.
    2. Убедитесь , что ваш Firebase OAuth перенаправление URI (например , my-app-12345.firebaseapp.com/__/auth/handler ) устанавливаются в качестве авторизации обратного вызова URL в странице настроек вашего приложения на вашей конфигурации GitHub приложения .
  5. Нажмите кнопку Сохранить.
  6. Использование Firebase Android Банка Москвы , объявить зависимость для библиотеки Firebase аутентификации Android в вашем модуле (приложение уровня) Gradle файл (обычно app/build.gradle ).

    Джава

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:29.0.0')
    
        // Declare the dependency for the Firebase Authentication library
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-auth'
    }
    

    С помощью Firebase Android Банка Москвы , ваше приложение будет всегда использовать совместимые версии библиотек Firebase Android.

    (Альтернативный) Объявляет Firebase библиотеки зависимостей без использования спецификации

    Если вы решите не использовать Firebase BoM, вы должны указать каждую версию библиотеки Firebase в ее строке зависимости.

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

    dependencies {
        // Declare the dependency for the Firebase Authentication library
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-auth:21.0.1'
    }
    

    Котлин + KTX

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:29.0.0')
    
        // Declare the dependency for the Firebase Authentication library
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-auth-ktx'
    }
    

    С помощью Firebase Android Банка Москвы , ваше приложение будет всегда использовать совместимые версии библиотек Firebase Android.

    (Альтернативный) Объявляет Firebase библиотеки зависимостей без использования спецификации

    Если вы решите не использовать Firebase BoM, вы должны указать каждую версию библиотеки Firebase в ее строке зависимости.

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

    dependencies {
        // Declare the dependency for the Firebase Authentication library
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-auth-ktx:21.0.1'
    }
    

  7. Если вы еще не указаны ваше приложение SHA-1 отпечаток пальца, сделайте это с страницы Настройки консоли Firebase. Обратитесь к аутентификации своему клиента Подробных сведений о том , как получить свое приложение SHA-1 отпечаток палец.

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

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

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

  1. Построить экземпляр OAuthProvider с использованием его Builder с провайдером ID github.com

    OAuthProvider.Builder provider = OAuthProvider.newBuilder("github.com");
    
  2. Необязательно: Укажите дополнительные пользовательские параметры OAuth , которые вы хотите отправить с запросом OAuth.

    // Target specific email with login hint.
    provider.addCustomParameter("login", "your-email@gmail.com");
    

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

  3. Необязательно: Укажите дополнительные OAuth 2.0 областей за пределами основного профиля , который вы хотите , чтобы запрос от поставщика проверки подлинности. Если приложению требуется доступ к приватным данным пользователя из GitHub API , вы должны запроса разрешений на доступ к GitHub API , под API Права доступа к консоли разработчика GitHub. Запрошенные области OAuth должны точно соответствовать предварительно настроенным в разрешениях API приложения.

    // 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>() {
          {
            add("user:email");
          }
        };
    provider.setScopes(scopes);
    
  4. Выполните аутентификацию с помощью Firebase с помощью объекта поставщика OAuth. Обратите внимание , что в отличие от других операций FirebaseAuth, это взять под контроль своего UI, выскакивает настраиваемую вкладку Chrome . В результате, не ссылаются на вашу активность в OnSuccessListener и OnFailureListener , что Вы придаете как они будут немедленно отсоединить , когда начинается работа пользовательского интерфейса.

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

    Для того, чтобы проверить, есть ли в ожидании результата, вызовите getPendingAuthResult :

    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:
                  // authResult.getCredential().getAccessToken().
                }
              })
          .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.
    }
    

    Для того, чтобы начать знак в потоке, вызовите startActivityForSignInWithProvider :

    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:
                // authResult.getCredential().getAccessToken().
              }
            })
        .addOnFailureListener(
            new OnFailureListener() {
              @Override
              public void onFailure(@NonNull Exception e) {
                // Handle failure.
              }
            });
    

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

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

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

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

    // 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) {
                // GitHub 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().
              }
            })
        .addOnFailureListener(
            new OnFailureListener() {
              @Override
              public void onFailure(@NonNull Exception e) {
                // Handle failure.
              }
            });
    
    
  6. Та же модель может быть использована с startActivityForReauthenticateWithProvider , которые могут быть использованы для получения свежих учетных данных для чувствительных операций, требующих последней регистрацию.

    // 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.
              }
            });
    

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

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

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

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

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

Чтобы выйти пользователь, вызовите signOut :

Джава

FirebaseAuth.getInstance().signOut();

Котлин + KTX

Firebase.auth.signOut()