Mit GitHub auf Apple-Plattformen authentifizieren (original) (raw)

Sie können Nutzern die Authentifizierung mit Firebase über OAuth-Anbieter wie GitHub ermöglichen, indem Sie die generische OAuth-Anmeldung in Ihre App einbinden und das Firebase SDK verwenden, um den gesamten Anmeldevorgang durchzuführen.

Hinweis

Wenn Sie Nutzer mit GitHub-Konten anmelden möchten, müssen Sie GitHub zuerst als Anmeldeanbieter für Ihr Firebase-Projekt aktivieren:

Verwenden Sie Swift Package Manager, um Firebase-Abhängigkeiten zu installieren und zu verwalten.

Öffnen Sie Ihr App-Projekt und gehen Sie in Xcode zu File > Add Packages (Datei > Pakete hinzufügen). Fügen Sie bei entsprechender Aufforderung das Firebase Apple Platforms SDK-Repository hinzu: https://github.com/firebase/firebase-ios-sdk.git Wählen Sie die Firebase Authentication-Bibliothek aus. Fügen Sie das Flag -ObjC dem Abschnitt Other Linker Flags (Weitere Verknüpfungsmerker) der Build-Einstellungen Ihres Ziels hinzu. Wenn Sie fertig, beginnt Xcode automatisch, Ihre Abhängigkeiten im Hintergrund aufzulösen und herunterzuladen. Führen Sie nun einige Konfigurationsschritte aus:

Wechseln Sie in der Firebase-Konsole zu Sicherheit > Authentifizierung.
Aktivieren Sie auf dem Tab Anmeldemethode den Anmeldeanbieter GitHub.
Fügen Sie der Anbieterkonfiguration die Client-ID und das Client-Secret aus der Entwicklerkonsole des Anbieters hinzu:
1. Registrieren Sie Ihre App als Entwickleranwendung auf GitHub und rufen Sie die OAuth 2.0-Client-ID und den Clientschlüssel Ihrer App ab.
2. Achten Sie darauf, dass der OAuth-Weiterleitungs-URI von Firebase (z. B. my-app-12345.firebaseapp.com/__/auth/handler) als Callback-URL für die Autorisierung auf der Einstellungsseite Ihrer App in der Konfiguration Ihrer GitHub-App festgelegt ist.
Klicken Sie auf Speichern.

Anmeldevorgang mit dem Firebase SDK verarbeiten

So handhaben Sie den Anmeldevorgang mit dem Firebase Apple-Plattformen SDK:

Fügen Sie Ihrem Xcode-Projekt benutzerdefinierte URL-Schemas hinzu:
1. Öffnen Sie die Projektkonfiguration: Doppelklicken Sie in der linken Baumansicht auf den Projektnamen. Wählen Sie im Bereich ZIELE Ihre App aus, dann den Tab Informationen und maximieren Sie den Bereich URL-Typen.
2. Klicken Sie auf die Schaltfläche + und fügen Sie Ihre codierte App-ID als URL-Schema hinzu. Lassen Sie die anderen Felder leer.
  Sie finden die codierte App-ID in der Firebase-Konsole: Rufen Sie die -Einstellungen > Allgemein auf und scrollen Sie dann nach unten zum Abschnitt Meine Apps, um Details zu Ihrer iOS-App aufzurufen.
  Wenn Sie fertig sind, sollte Ihre Konfiguration in etwa so aussehen (aber mit Ihren anwendungsspezifischen Werten):
Erstellen Sie eine Instanz von OAuthProvider mit der Anbieter-ID github.com.

Swift

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

Objective-C

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

Optional: Geben Sie zusätzliche benutzerdefinierte OAuth-Parameter an, die Sie mit der OAuth-Anfrage senden möchten.

Swift

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

Objective-C

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

Informationen zu den von GitHub unterstützten Parametern finden Sie in der GitHub-OAuth-Dokumentation. Hinweis: Firebase-Parameter können nicht mit setCustomParameters übergeben werden. Diese Parameter sind client_id, redirect_uri, response_type, scope und state. 4. Optional: Geben Sie zusätzliche OAuth 2.0-Bereiche an, die Sie vom Authentifizierungsanbieter anfordern möchten. Wenn Ihre Anwendung Zugriff auf private Nutzerdaten über GitHub-APIs benötigt, müssen Sie in der GitHub-Entwicklerkonsole unter API-Berechtigungen Berechtigungen für den Zugriff auf GitHub-APIs anfordern. Die angeforderten OAuth-Bereiche müssen genau mit den vorkonfigurierten Bereichen in den API-Berechtigungen der App übereinstimmen.

Swift

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

Objective-C

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

Weitere Informationen finden Sie in der GitHub-Dokumentation zu Bereichen. 5. Optional: Wenn Sie anpassen möchten, wie Ihre App SFSafariViewController oder UIWebView darstellt, wenn das reCAPTCHA dem Nutzer angezeigt wird, erstellen Sie eine benutzerdefinierte Klasse, die dem AuthUIDelegate-Protokoll entspricht, und übergeben Sie sie an credentialWithUIDelegate. 6. Authentifizieren Sie sich mit Firebase über das OAuth-Anbieterobjekt.

Swift

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

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

Mit dem OAuth-Zugriffstoken können Sie die GitHub API aufrufen.
Wenn Sie beispielsweise grundlegende Profilinformationen abrufen möchten, können Sie die REST API aufrufen und das Zugriffstoken im Authorization-Header übergeben:
https://api.github.com/user 7. Die obigen Beispiele konzentrieren sich zwar auf Anmeldeabläufe, Sie haben aber auch die Möglichkeit, einen GitHub-Anbieter mit einem vorhandenen Nutzer zu verknüpfen. Sie können beispielsweise mehrere Anbieter mit demselben Nutzer verknüpfen, sodass er sich mit beiden anmelden kann.

Swift

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  
}

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

Dasselbe Muster kann mit reauthenticateWithCredential verwendet werden, um aktuelle Anmeldedaten für vertrauliche Vorgänge abzurufen, für die eine aktuelle Anmeldung erforderlich ist.

Swift

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  
}

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

Fehler „account-exists-with-different-credential“ bearbeiten

Wenn Sie in der Firebase-Konsole die Einstellung Ein Konto pro E-Mail-Adresse aktiviert haben und ein Nutzer versucht, sich bei einem Anbieter (z. B. GitHub) mit einer E-Mail-Adresse anzumelden, die bereits für den Anbieter eines anderen Firebase-Nutzers (z. B. Google) vorhanden ist, wird der Fehler FIRAuthErrorCodeAccountExistsWithDifferentCredential zusammen mit einem temporären FIRAuthCredential-Objekt (GitHub-Anmeldedaten) ausgelöst. Um die Anmeldung beim gewünschten Anbieter abzuschließen, muss sich der Nutzer zuerst beim bestehenden Anbieter (Google) anmelden und dann eine Verknüpfung zum ehemaligen FIRAuthCredential (GitHub-Anmeldedaten) herstellen. Das würde so aussehen:

Swift

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

}

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

}];

Nächste Schritte

Wenn sich ein Nutzer zum ersten Mal anmeldet, wird ein neues Nutzerkonto erstellt und mit den Anmeldedaten verknüpft, mit denen sich der Nutzer angemeldet hat, also mit dem Nutzernamen und Passwort, der Telefonnummer oder den Informationen des Authentifizierungsanbieters. Dieses neue Konto wird als Teil Ihres Firebase-Projekts gespeichert und kann verwendet werden, um einen Nutzer in allen Apps in Ihrem Projekt zu identifizieren, unabhängig davon, wie sich der Nutzer anmeldet.

In Ihren Apps können Sie die grundlegenden Profilinformationen des Nutzers aus dem User -Objekt abrufen. Weitere Informationen finden Sie unter Nutzer verwalten.
In Ihren Firebase Realtime Database- und Cloud Storage-Sicherheitsregeln können Sie die eindeutige Nutzer-ID des angemeldeten Nutzers aus der Variablen auth abrufen und damit steuern, auf welche Daten ein Nutzer zugreifen kann.

Sie können Nutzern erlauben, sich mit mehreren Authentifizierungsanbietern in Ihrer App anzumelden, indem Sie Anmeldedaten des Authentifizierungsanbieters mit einem vorhandenen Nutzerkonto verknüpfen.

Rufen Sie signOut: auf, um einen Nutzer abzumelden.

Swift

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

Objective-C

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

Möglicherweise möchten Sie auch Code zur Fehlerbehandlung für alle Authentifizierungsfehler hinzufügen. Weitere Informationen finden Sie unter Fehlerbehandlung.