Autenticazione utilizzando GitHub su piattaforme Apple

Puoi consentire ai tuoi utenti di autenticarsi con Firebase utilizzando provider OAuth come GitHub integrando l'accesso OAuth generico nella tua app utilizzando l'SDK Firebase per eseguire il flusso di accesso end-to-end.

Prima di iniziare

Per accedere agli utenti utilizzando gli account GitHub, devi prima abilitare GitHub come provider di accesso per il tuo progetto Firebase:

Utilizza Swift Package Manager per installare e gestire le dipendenze di Firebase.

  1. In Xcode, con il progetto dell'app aperto, vai a File > Add Packages .
  2. Quando richiesto, aggiungi il repository SDK delle piattaforme Apple Firebase:
  3.   https://github.com/firebase/firebase-ios-sdk.git
  4. Scegli la libreria di autenticazione Firebase.
  5. Aggiungi il flag -ObjC alla sezione Altri flag del linker delle impostazioni di build del tuo target.
  6. Al termine, Xcode inizierà automaticamente a risolvere e scaricare le tue dipendenze in background.

Ora, esegui alcuni passaggi di configurazione:

  1. Nella console Firebase , apri la sezione Autenticazione .
  2. Nella scheda Metodo di accesso abilitare il provider GitHub .
  3. Aggiungi l' ID client e il segreto client dalla console per sviluppatori di quel provider alla configurazione del provider:
    1. Registra la tua app come applicazione per sviluppatori su GitHub e ottieni l'ID client OAuth 2.0 e il segreto client della tua app.
    2. Assicurati che l'URI di reindirizzamento OAuth Firebase (ad esempio my-app-12345.firebaseapp.com/__/auth/handler ) sia impostato come URL di richiamata di autorizzazione nella pagina delle impostazioni dell'app nella configurazione dell'app GitHub .
  4. Fare clic su Salva .

Gestisci il flusso di accesso con l'SDK Firebase

Per gestire il flusso di accesso con l'SDK delle piattaforme Apple Firebase, procedi nel seguente modo:

  1. Aggiungi schemi URL personalizzati al tuo progetto Xcode:

    1. Apri la configurazione del tuo progetto: fai doppio clic sul nome del progetto nella visualizzazione ad albero a sinistra. Seleziona la tua app dalla sezione TARGETS , quindi seleziona la scheda Informazioni ed espandi la sezione Tipi di URL .
    2. Fai clic sul pulsante + e aggiungi il tuo ID app codificato come schema URL. Puoi trovare l'ID app codificata nella pagina Impostazioni generali della console Firebase, nella sezione relativa alla tua app iOS. Lascia vuoti gli altri campi.

      Una volta completata, la configurazione dovrebbe essere simile alla seguente (ma con i valori specifici dell'applicazione):

      Screenshot dell'interfaccia di configurazione dello schema URL personalizzato di Xcode

  2. Crea un'istanza di OAuthProvider utilizzando l'ID provider github.com .

    Veloce

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

    Obiettivo-C

        FIROAuthProvider *provider = [FIROAuthProvider providerWithProviderID:@"github.com"];
        
  3. Facoltativo : specifica parametri OAuth personalizzati aggiuntivi che desideri inviare con la richiesta OAuth.

    Veloce

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

    Obiettivo-C

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

    Per i parametri supportati da GitHub, consulta la documentazione di GitHub OAuth . Tieni presente che non puoi passare i parametri richiesti da Firebase con setCustomParameters . Questi parametri sono client_id , reindirizzamento_uri , risposta_tipo , ambito e stato .

  4. Facoltativo : specifica ulteriori ambiti OAuth 2.0 oltre al profilo di base che desideri richiedere al provider di autenticazione. Se la tua applicazione richiede l'accesso ai dati utente privati ​​dalle API GitHub, dovrai richiedere le autorizzazioni per accedere alle API GitHub in Autorizzazioni API nella console per sviluppatori GitHub. Gli ambiti OAuth richiesti devono corrispondere esattamente a quelli preconfigurati nelle autorizzazioni API dell'app.

    Veloce

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

    Obiettivo-C

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

    Per ulteriori informazioni, fare riferimento alla documentazione sugli ambiti GitHub .

  5. Facoltativo : se vuoi personalizzare il modo in cui la tua app presenta SFSafariViewController o UIWebView quando visualizza reCAPTCHA all'utente, crea una classe personalizzata conforme al protocollo AuthUIDelegate e passala a credentialWithUIDelegate .

  6. Autenticarsi con Firebase utilizzando l'oggetto provider OAuth.

    Veloce

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

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

    Utilizzando il token di accesso OAuth, puoi chiamare l' API GitHub .

    Ad esempio, per ottenere informazioni di base sul profilo, puoi chiamare l'API REST, passando il token di accesso nell'intestazione Authorization :

    https://api.github.com/user
    
  7. Sebbene gli esempi precedenti si concentrino sui flussi di accesso, hai anche la possibilità di collegare un provider GitHub a un utente esistente. Ad esempio, puoi collegare più fornitori allo stesso utente consentendo loro di accedere con entrambi.

    Veloce

        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
        }
        

    Obiettivo-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
        }];
        
  8. Lo stesso modello può essere utilizzato con reauthenticateWithCredential che può essere utilizzato per recuperare nuove credenziali per operazioni sensibili che richiedono un accesso recente.

    Veloce

        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
        }
        

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

Prossimi passi

Dopo che un utente accede per la prima volta, viene creato un nuovo account utente e collegato alle credenziali, ovvero nome utente e password, numero di telefono o informazioni sul provider di autenticazione, con cui l'utente ha effettuato l'accesso. Questo nuovo account viene archiviato come parte del tuo progetto Firebase e può essere utilizzato per identificare un utente in ogni app del tuo progetto, indipendentemente dalla modalità di accesso dell'utente.

  • Nelle tue app puoi ottenere le informazioni di base del profilo dell'utente dall'oggetto User . Vedi Gestisci utenti .

  • Nel tuo Firebase Realtime Database e Cloud Storage Security Rules , puoi ottenere l'ID utente univoco dell'utente che ha effettuato l'accesso dalla variabile auth e utilizzarlo per controllare a quali dati può accedere un utente.

Puoi consentire agli utenti di accedere alla tua app utilizzando più provider di autenticazione collegando le credenziali del provider di autenticazione a un account utente esistente.

Per disconnettere un utente, chiamare signOut: .

Veloce

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

Obiettivo-C

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

Potresti anche voler aggiungere un codice di gestione degli errori per l'intera gamma di errori di autenticazione. Consulta Gestire gli errori .