Puoi consentire agli utenti di autenticarsi su Firebase utilizzando i loro account GitHub integrando l'accesso OAuth generico basato sul web nella tua app tramite 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 fornitore di accesso per il tuo progetto Firebase:
Se non l'hai già fatto, aggiungi Firebase al tuo progetto Android.
- Nella console Firebase, apri la sezione Autorizzazione.
- Nella scheda Metodo di accesso, attiva il provider GitHub.
- Aggiungi l'ID cliente e il client secret della console per sviluppatori del provider alla configurazione del provider:
- Registra la tua app come applicazione per sviluppatori su GitHub e ottieni l'ID client e il client secret OAuth 2.0 della tua app.
- Assicurati che l'URI di reindirizzamento OAuth di Firebase (ad es.
my-app-12345.firebaseapp.com/__/auth/handler
) sia impostato come URL di callback di autorizzazione nella pagina delle impostazioni dell'app sul tuo Configurazione dell'app GitHub.
- Fai clic su Salva.
Nel file Gradle del modulo (a livello di app) (di solito
<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 Firebase Android BoM per controllare il controllo delle versioni delle librerie.dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.4.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 Firebase Android BoM, la tua app utilizzerà sempre versioni compatibili delle librerie Firebase per Android.
(alternativa) Aggiungi dipendenze della libreria Firebase senza utilizzare il BoM
Se scegli di non utilizzare Firebase BoM, devi specificare ogni versione della libreria Firebase nella riga di dipendenza.
Tieni presente che se nella tua app utilizzi più librerie Firebase, ti consigliamo vivamente di utilizzare BoM per gestire le versioni delle librerie, in modo da garantire la compatibilità di tutte le versioni.
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:23.0.0") }
Se non hai ancora specificato l'impronta SHA-1 dell'app, puoi farlo utilizzando Pagina Impostazioni della console Firebase. Consulta Autenticazione del cliente per maggiori dettagli su come ottenere l'impronta SHA-1 della tua app.
Gestire il flusso di accesso con l'SDK Firebase
Se stai creando un'app per Android, il modo più semplice per autenticare i tuoi utenti con Firebase che usa i loro account GitHub è gestire l'intero accesso con l'SDK Firebase per Android.
Per gestire il flusso di accesso con l'SDK Firebase per Android:
Costruisci un'istanza di un OAuthProvider utilizzando il relativo Builder con l'ID provider github.com
Kotlin+KTX
val provider = OAuthProvider.newBuilder("github.com")
Java
OAuthProvider.Builder provider = OAuthProvider.newBuilder("github.com");
Facoltativo: specifica i parametri OAuth aggiuntivi che vuoi personalizzare. da inviare con la richiesta OAuth.
Kotlin+KTX
// Target specific email with login hint. provider.addCustomParameter("login", "your-email@gmail.com")
Java
// Target specific email with login hint. provider.addCustomParameter("login", "your-email@gmail.com");
Per i parametri supportati da GitHub, consulta Documentazione relativa a OAuth di GitHub. Tieni presente che non puoi trasferire i parametri richiesti da Firebase con
setCustomParameters()
. Questi parametri sono client_id, response_type, redirect_uri, state, scope e response_mode.Facoltativo: specifica gli ambiti OAuth 2.0 aggiuntivi 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 dello sviluppatore GitHub. Gli ambiti OAuth richiesti devono essere corrispondenze esatte a quelli preconfigurati nelle autorizzazioni API dell'app.
Kotlin+KTX
// Request read access to a user's email addresses. // This must be preconfigured in the app's API permissions. provider.scopes = listOf("user:email")
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);
Esegui l'autenticazione con Firebase utilizzando l'oggetto provider OAuth. Tieni presente che, a differenza di altre operazioni di FirebaseAuth, questa acquisirà il controllo dell'interfaccia utente aprendo una scheda di Chrome personalizzata. Di conseguenza, non fare riferimento alla tua Attività nel
OnSuccessListener
eOnFailureListener
che colleghi perché si scollegheranno immediatamente quando l'operazione avvia la UI.Ti consigliamo innanzitutto di verificare se hai già ricevuto una risposta. Accesso tramite questo metodo mette la tua Attività in background, il che significa che può essere richiamato dal sistema durante il flusso di accesso. Per assicurarti di non chiedere all'utente di riprovare in caso di errore, devi controllare se è già presente un risultato.
Per verificare se è presente un risultato in sospeso, chiama
getPendingAuthResult
:Kotlin+KTX
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. }
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. }
Per avviare il flusso di accesso, chiama
startActivityForSignInWithProvider
:Kotlin+KTX
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. }
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. } });
Una volta completato, il token di accesso OAuth associato alla il provider può essere recuperato dall'oggetto
OAuthCredential
restituito.Utilizzando il token di accesso OAuth, puoi chiamare il metodo 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ù fornitori allo stesso utente consentendogli di accedere con uno dei due.Kotlin+KTX
// 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. }
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. } });
Lo stesso pattern può essere utilizzato con
startActivityForReauthenticateWithProvider
, che può essere utilizzato per recuperare credenziali aggiornate per operazioni sensibili che richiedono un accesso recente.Kotlin+KTX
// 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. }
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. } });
Passaggi successivi
Dopo che un utente ha eseguito l'accesso per la prima volta, viene creato un nuovo account utente e collegati alle credenziali, ovvero nome utente, password, numero o informazioni del provider di autenticazione, ovvero l'utente con cui ha eseguito l'accesso. Questo nuovo account viene archiviato nel tuo progetto Firebase e può essere utilizzato per identificare un utente in tutte le app del progetto, indipendentemente da come accede.
-
Nelle tue app puoi ottenere le informazioni di base del profilo dell'utente dal
FirebaseUser
. Vedi Gestisci utenti. In Firebase Realtime Database e Cloud Storage Regole di sicurezza, puoi ottieni l'ID utente unico dell'utente che ha eseguito l'accesso dalla variabile
auth
e usarli per controllare i dati a cui un utente può accedere.
Puoi consentire agli utenti di accedere alla tua app utilizzando più autenticazioni collegando le credenziali del provider di autenticazione a un a un account utente esistente.
Per disconnettere un utente, chiama
signOut
:
Kotlin+KTX
Firebase.auth.signOut()
Java
FirebaseAuth.getInstance().signOut();