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

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

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

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

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

Используйте Swift Package Manager для установки и управления зависимостями Firebase.

  1. В Xcode, с приложением проекта открыто, перейдите в меню Файл> Swift пакеты> Добавить пакет Завис.
  2. При появлении запроса добавьте репозиторий Firebase Apple Platform SDK:
  3.   https://github.com/firebase/firebase-ios-sdk
      
  4. Выберите библиотеку Firebase Authentication.
  5. По завершении Xcode автоматически начнет разрешение и загрузку ваших зависимостей в фоновом режиме.

Теперь выполните несколько шагов по настройке:

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

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

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

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

    1. Откройте конфигурацию проекта: дважды щелкните имя проекта в левом древовидном представлении. Выберите приложение из раздела мишеней, а затем выберите вкладку Info, и разверните раздел Типы URL.
    2. Нажмите кнопку +, и добавить схему URL для обратимого идентификатора клиента. Чтобы найти это значение, откройте GoogleService-Info.plist конфигурационный файл, и внешний вид для REVERSED_CLIENT_ID ключа. Скопируйте значение этого ключа, и вставьте его в URL схема поля на странице конфигурации. Остальные поля оставьте пустыми.

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

  2. Создание экземпляра OAuthProvider с помощью провайдера ID github.com.

    Быстрый

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

    Цель-C

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

    Быстрый

        provider.customParameters = [
          "allow_signup": "false"
        ]
        

    Цель-C

        [provider setCustomParameters:@{@"allow_signup": @"false"}];
        

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

  4. Необязательно: Укажите дополнительные 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.
        provider.scopes = ["user:email"]
        

    Цель-C

        // Request read access to a user's email addresses.
        // This must be preconfigured in the app's API permissions.
        [provider setScopes:@[@"user:email"]];
        

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

  5. Необязательно: Если вы хотите , чтобы настроить способ вашего приложение представляет SFSafariViewController или UIWebView при отображении ReCaptcha пользователя, создать пользовательский класс , который соответствует требованиям FIRAuthUIDelegate протокола, и передать его в getCredentialWithUIDelegate:completion: .

  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.
    
              guard let oauthCredential = authResult.credential as? OAuthCredential else { return }
              // GitHub OAuth access token can also be retrieved by:
              // oauthCredential.accessToken
              // GitHub OAuth ID token can be retrieved by calling:
              // oauthCredential.idToken
            }
          }
        }
        

    Цель-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.
    
              FIROAuthCredential *oauthCredential = (FIROAuthCredential *)authResult.credential;
              // GitHub OAuth access token can also be retrieved by:
              // oauthCredential.accessToken
              // GitHub OAuth ID token can be retrieved by calling:
              // oauthCredential.idToken
            }];
          }
        }];
        

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

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

    https://api.github.com/user
    
  7. Хотя приведенные выше примеры сосредоточены на потоках входа, у вас также есть возможность связать поставщика GitHub с существующим пользователем. Например, вы можете связать нескольких поставщиков с одним и тем же пользователем, позволяя им входить в систему с любым из них.

    Быстрый

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

    Цель-C

        [[FIRAuth auth].currentUser
            linkWithCredential:credential
                    completion:^(FIRAuthDataResult * _Nullable authResult, NSError * _Nullable error) {
          if (error) {
            // Handle error.
          }
          // GitHub credential is linked to the current user.
          // IdP data available in authResult.additionalUserInfo.profile.
          // GitHub OAuth access token is can also be retrieved by:
          // authResult.credential.accessToken
          // GitHub OAuth ID token can be retrieved by calling:
          // 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 is can also be retrieved by:
          // authResult.credential.accessToken
          // GitHub OAuth ID token can be retrieved by calling:
          // authResult.credential.idToken
        }
        

    Цель-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:
          // authResult.credential.accessToken
          // GitHub OAuth ID token can be retrieved by calling:
          // authResult.credential.idToken
        }];
        

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

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

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

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

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

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

Быстрый

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

Цель-C

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

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