Firebase 将于 4 月 9 日至 11 日重返 Cloud Next 大会。立即报名。

Эта страница переведена с помощью Cloud Translation API.

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

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

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

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

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

В Xcode, открыв проект приложения, выберите «Файл» > «Добавить пакеты» .
При появлении запроса добавьте репозиторий Firebase SDK для платформ Apple:

  https://github.com/firebase/firebase-ios-sdk.git

Выберите библиотеку Firebase Authentication .
Добавьте флаг -ObjC в раздел «Другие флаги компоновщика» настроек сборки вашей цели.
По завершении Xcode автоматически начнет разрешать и загружать ваши зависимости в фоновом режиме.

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

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

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

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

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

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

Быстрый

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

Цель-C

    FIROAuthProvider *provider = [FIROAuthProvider providerWithProviderID:@"github.com"];

Необязательно : укажите дополнительные пользовательские параметры OAuth, которые вы хотите отправить с запросом OAuth.
Быстрый
```
    provider.customParameters = [
      "allow_signup": "false"
    ]
    
```
Цель-C
```
    [provider setCustomParameters:@{@"allow_signup": @"false"}];
    
```
Параметры, которые поддерживает GitHub, см. в документации GitHub OAuth . Обратите внимание: вы не можете передавать параметры, необходимые для Firebase, с помощью setCustomParameters . Этими параметрами являются client_id , redirect_uri , response_type , область действия и состояние .
Необязательно : укажите дополнительные области OAuth 2.0 помимо базового профиля, которые вы хотите запросить у поставщика аутентификации. Если вашему приложению требуется доступ к частным данным пользователя из API GitHub, вам необходимо запросить разрешения на доступ к API GitHub в разделе «Разрешения 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 .
Необязательно : если вы хотите настроить способ представления SFSafariViewController или UIWebView в вашем приложении при отображении reCAPTCHA пользователю, создайте собственный класс, соответствующий протоколу AuthUIDelegate , и передайте его credentialWithUIDelegate .

Аутентификация в 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

Хотя приведенные выше примеры посвящены процессам входа в систему, у вас также есть возможность связать поставщика 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 as? OAuthCredential)?.accessToken
      // GitHub OAuth ID token can be retrieved by calling:
      // (authResult.credential as? OAuthCredential)?.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:
      // ((FIROAuthCredential *)authResult.credential).accessToken
      // GitHub OAuth ID token can be retrieved by calling:
      // ((FIROAuthCredential *)authResult.credential).idToken
    }];

Тот же шаблон можно использовать с 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 as? OAuthCredential)?.accessToken
      // GitHub OAuth ID token can be retrieved by calling:
      // (authResult.credential as? OAuthCredential)?.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:
      // ((FIROAuthCredential *)authResult.credential).accessToken
      // GitHub OAuth ID token can be retrieved by calling:
      // ((FIROAuthCredential *)authResult.credential).idToken
    }];

Обработка ошибок «учетная запись существует с разными учетными данными»

Если вы включили параметр «Одна учетная запись на адрес электронной почты» в консоли Firebase , когда пользователь пытается войти в систему у провайдера (например, GitHub) с адресом электронной почты, который уже существует для другого провайдера пользователя Firebase (например, Google), возникает ошибка. FIRAuthErrorCodeAccountExistsWithDifferentCredential создается вместе с временным объектом FIRAuthCredential (учетные данные GitHub). Чтобы завершить вход в систему предполагаемого поставщика, пользователь должен сначала войти в систему существующего поставщика (Google), а затем связать его с бывшим FIRAuthCredential (учетными данными GitHub). Это будет выглядеть так, как показано ниже:

Быстрый

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

Цель-C

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

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

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

Цель-C

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

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