Autenticazione mediante GitHub su Android

Puoi consentire agli utenti di autenticarsi con Firebase utilizzando i loro account GitHub integrando l'accesso OAuth generico basato sul web nella tua app utilizzando l'SDK Firebase per eseguire il flusso di accesso end-to-end.

Prima di iniziare

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

Se non l'hai già fatto, aggiungi Firebase al tuo progetto Android.
Nella Firebase console, apri la sezione Autenticazione.
Nella scheda Metodo di accesso, attiva il provider GitHub.
Aggiungi l'ID cliente e il client secret dalla console per sviluppatori del provider alla configurazione del provider:
1. Registra la tua app come applicazione per sviluppatori su GitHub e ottieni l'ID cliente OAuth 2.0 della tua app Client ID e Client Secret.
2. Assicurati che l'URI di reindirizzamento OAuth di Firebase (ad es. my-app-12345.firebaseapp.com/__/auth/handler) sia impostato come URL di callback dell'autorizzazione nella pagina delle impostazioni dell'app nella configurazione dell'app GitHub.
Fai clic su Salva.
Nel file Gradle del modulo (a livello di app) (in genere <project>/<app-module>/build.gradle.kts o <project>/<app-module>/build.gradle), aggiungi la dipendenza per la libreria Firebase Authentication per Android. Ti consigliamo di utilizzare la Firebase Android BoM per controllare il controllo delle versioni della libreria.
```
dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:34.10.0"))

    // Add 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")
}
```
Con la Firebase Android BoM, la tua app utilizzerà sempre versioni compatibili delle librerie Firebase Android.
(Alternativa) Aggiungere dipendenze della libreria Firebase senza utilizzare la BoM

Se scegli di non utilizzare la Firebase BoM, devi specificare la versione di ogni libreria Firebase nella riga di dipendenza.

Tieni presente che, se utilizzi più librerie Firebase nella tua app, ti consigliamo vivamente di utilizzare la BoM per gestire le versioni delle librerie, in modo da garantire che tutte le versioni siano compatibili.
```
dependencies {
    // Add 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:24.0.1")
}
```
Se non hai ancora specificato l'impronta SHA-1 della tua app, fallo dalla pagina Impostazioni della Firebase console. Per informazioni dettagliate su come ottenere l'impronta SHA-1 della tua app, consulta Autenticare il client.

Gestire il flusso di accesso con l'SDK Firebase

Se stai creando un'app Android, il modo più semplice per autenticare gli utenti con Firebase utilizzando i loro account GitHub è gestire l'intero flusso di accesso con l'SDK Firebase Android.

Per gestire il flusso di accesso con l'SDK Firebase Android:

Crea un'istanza di un OAuthProvider utilizzando il relativo Builder con l' ID provider github.com.

Kotlin

val provider = OAuthProvider.newBuilder("github.com")GenericIdpActivity.kt

Java

OAuthProvider.Builder provider = OAuthProvider.newBuilder("github.com");GenericIdpActivity.java

Facoltativo: specifica altri parametri OAuth personalizzati che vuoi inviare con la richiesta OAuth.
Kotlin
```
// Target specific email with login hint.
provider.addCustomParameter("login", "your-email@gmail.com")GenericIdpActivity.kt
```
Java
```
// Target specific email with login hint.
provider.addCustomParameter("login", "your-email@gmail.com");GenericIdpActivity.java
```
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, response_type, redirect_uri, state, scope e response_mode.

Facoltativo: specifica altri ambiti OAuth 2.0 oltre al profilo di base che vuoi 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 di GitHub. Gli ambiti OAuth richiesti devono corrispondere esattamente a quelli preconfigurati nelle autorizzazioni API dell'app.

Kotlin

// Request read access to a user's email addresses.
// This must be preconfigured in the app's API permissions.
provider.scopes = listOf("user:email")GenericIdpActivity.kt

Java

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

Esegui l'autenticazione con Firebase utilizzando l'oggetto del provider OAuth. Tieni presente che, a differenza di altre operazioni FirebaseAuth , questa operazione prenderà il controllo dell'interfaccia utente visualizzando una scheda personalizzata di Chrome. Di conseguenza, non fare riferimento alla tua attività in OnSuccessListener e OnFailureListener che alleghi, perché verranno scollegati immediatamente quando l'operazione avvia l'interfaccia utente.

Devi prima verificare se hai già ricevuto una risposta. L'accesso tramite questo metodo mette l'attività in background, il che significa che può essere recuperata dal sistema durante il flusso di accesso. Per assicurarti che l'utente non riprovi se ciò accade, devi verificare se è già presente un risultato.

Per verificare se è presente un risultato in attesa, chiama getPendingAuthResult:

Kotlin

val pendingResultTask = firebaseAuth.pendingAuthResult
if (pendingResultTask != null) {
    // There's something already here! Finish the sign-in for your user.
    pendingResultTask
        .addOnSuccessListener {
            // User is signed in.
            // IdP data available in
            // authResult.getAdditionalUserInfo().getProfile().
            // The OAuth access token can also be retrieved:
            // ((OAuthCredential)authResult.getCredential()).getAccessToken().
            // The OAuth secret can be retrieved by calling:
            // ((OAuthCredential)authResult.getCredential()).getSecret().
        }
        .addOnFailureListener {
            // Handle failure.
        }
} else {
    // There's no pending result so you need to start the sign-in flow.
    // See below.
}GenericIdpActivity.kt

Java

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:
                            // ((OAuthCredential)authResult.getCredential()).getAccessToken().
                            // The OAuth secret can be retrieved by calling:
                            // ((OAuthCredential)authResult.getCredential()).getSecret().
                        }
                    })
            .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.
}GenericIdpActivity.java

Per avviare il flusso di accesso, chiama startActivityForSignInWithProvider:

Kotlin

firebaseAuth
    .startActivityForSignInWithProvider(activity, provider.build())
    .addOnSuccessListener {
        // User is signed in.
        // IdP data available in
        // authResult.getAdditionalUserInfo().getProfile().
        // The OAuth access token can also be retrieved:
        // ((OAuthCredential)authResult.getCredential()).getAccessToken().
        // The OAuth secret can be retrieved by calling:
        // ((OAuthCredential)authResult.getCredential()).getSecret().
    }
    .addOnFailureListener {
        // Handle failure.
    }GenericIdpActivity.kt

Java

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:
                        // ((OAuthCredential)authResult.getCredential()).getAccessToken().
                        // The OAuth secret can be retrieved by calling:
                        // ((OAuthCredential)authResult.getCredential()).getSecret().
                    }
                })
        .addOnFailureListener(
                new OnFailureListener() {
                    @Override
                    public void onFailure(@NonNull Exception e) {
                        // Handle failure.
                    }
                });GenericIdpActivity.java

Al termine dell'operazione, il token di accesso OAuth associato al provider può essere recuperato dall'OAuthCredential oggetto restituito.

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

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

Sebbene gli esempi precedenti si concentrino sui flussi di accesso, hai anche la possibilità di collegare un provider GitHub a un utente esistente utilizzando startActivityForLinkWithProvider. Ad esempio, puoi collegare più provider allo stesso utente, consentendogli di accedere con uno dei due.

Kotlin

// The user is already signed-in.
val firebaseUser = firebaseAuth.currentUser!!
firebaseUser
    .startActivityForLinkWithProvider(activity, provider.build())
    .addOnSuccessListener {
        // Provider 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().
        // The OAuth secret can be retrieved by calling:
        // authResult.getCredential().getSecret().
    }
    .addOnFailureListener {
        // Handle failure.
    }GenericIdpActivity.kt

Java

// 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) {
                        // Provider 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().
                        // The OAuth secret can be retrieved by calling:
                        // authResult.getCredential().getSecret().
                    }
                })
        .addOnFailureListener(
                new OnFailureListener() {
                    @Override
                    public void onFailure(@NonNull Exception e) {
                        // Handle failure.
                    }
                });GenericIdpActivity.java

Lo stesso pattern può essere utilizzato con startActivityForReauthenticateWithProvider che può essere utilizzato per recuperare nuove credenziali per le operazioni sensibili che richiedono l'accesso recente.

Kotlin

// The user is already signed-in.
val firebaseUser = firebaseAuth.currentUser!!
firebaseUser
    .startActivityForReauthenticateWithProvider(activity, provider.build())
    .addOnSuccessListener {
        // User is re-authenticated with fresh tokens and
        // should be able to perform sensitive operations
        // like account deletion and email or password
        // update.
    }
    .addOnFailureListener {
        // Handle failure.
    }GenericIdpActivity.kt

Java

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

Passaggi successivi

Dopo che un utente ha eseguito l'accesso per la prima volta, viene creato un nuovo account utente e collegato alle credenziali (ovvero nome utente e password, numero di telefono o informazioni del provider di autenticazione) con cui l'utente ha eseguito l'accesso. Questo nuovo account viene memorizzato 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' FirebaseUser oggetto. Consulta Gestire gli utenti.
Nelle regole di sicurezza di Firebase Realtime Database e Cloud Storage , puoi ottenere l'ID utente univoco dell'utente che ha eseguito l'accesso dalla variabile auth, e utilizzarlo per controllare i dati a cui un utente può accedere.

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, chiama signOut:

Kotlin

Firebase.auth.signOut()MainActivity.kt

Java

FirebaseAuth.getInstance().signOut();MainActivity.java

Autenticazione mediante GitHub su Android Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Prima di iniziare

Gestire il flusso di accesso con l'SDK Firebase

Kotlin

Java

Kotlin

Java

Kotlin

Java

Kotlin

Java

Kotlin

Java

Kotlin

Java

Kotlin

Java

Passaggi successivi

Kotlin

Java

Autenticazione mediante GitHub su Android