Halaman ini diterjemahkan oleh Cloud Translation API.

Otentikasi Menggunakan GitHub dengan JavaScript

Anda dapat mengizinkan pengguna mengautentikasi dengan Firebase menggunakan akun GitHub mereka dengan mengintegrasikan autentikasi GitHub ke dalam aplikasi Anda. Anda dapat mengintegrasikan autentikasi GitHub dengan menggunakan Firebase SDK untuk menjalankan alur masuk, atau dengan menjalankan alur GitHub OAuth 2.0 secara manual dan meneruskan token akses yang dihasilkan ke Firebase.

Sebelum kamu memulai

Tambahkan Firebase ke proyek JavaScript Anda .
Di konsol Firebase , buka bagian Auth .
Pada tab Metode masuk , aktifkan penyedia GitHub .
Tambahkan ID Klien dan Rahasia Klien dari konsol pengembang penyedia tersebut ke konfigurasi penyedia:
1. Daftarkan aplikasi Anda sebagai aplikasi pengembang di GitHub dan dapatkan ID Klien dan Rahasia Klien OAuth 2.0 aplikasi Anda.
2. Pastikan URI pengalihan Firebase OAuth Anda (misalnya my-app-12345.firebaseapp.com/__/auth/handler ) disetel sebagai URL callback Authorization Anda di halaman setelan aplikasi Anda di konfigurasi aplikasi GitHub Anda.
Klik Simpan .

Tangani alur masuk dengan Firebase SDK

Jika Anda membuat aplikasi web, cara termudah untuk mengautentikasi pengguna Anda dengan Firebase menggunakan akun GitHub mereka adalah menangani alur masuk dengan Firebase JavaScript SDK. (Jika Anda ingin mengautentikasi pengguna di Node.js atau lingkungan non-browser lainnya, Anda harus menangani alur masuk secara manual.)

Untuk menangani alur masuk dengan Firebase JavaScript SDK, ikuti langkah berikut:

Buat instance objek penyedia GitHub:

Web version 9

import { GithubAuthProvider } from "firebase/auth";

const provider = new GithubAuthProvider();auth_github_provider_create.js

Web version 8

var provider = new firebase.auth.GithubAuthProvider();github.js

Opsional : Tentukan cakupan OAuth 2.0 tambahan yang ingin Anda minta dari penyedia autentikasi. Untuk menambahkan cakupan, panggil addScope . Sebagai contoh:
Web version 9
Pelajari lebih lanjut SDK modular Web v9 yang dapat diguncang pohon dan tingkatkan dari versi 8.
```
provider.addScope('repo');auth_github_provider_scopes.js
```
Web version 8
```
provider.addScope('repo');github.js
```
Lihat dokumentasi penyedia autentikasi .
Opsional : Tentukan parameter penyedia OAuth khusus tambahan yang ingin Anda kirim dengan permintaan OAuth. Untuk menambahkan parameter khusus, panggil setCustomParameters pada penyedia yang diinisialisasi dengan objek berisi kunci seperti yang ditentukan oleh dokumentasi penyedia OAuth dan nilai yang sesuai. Sebagai contoh:
Web version 9
Pelajari lebih lanjut SDK modular Web v9 yang dapat diguncang pohon dan tingkatkan dari versi 8.
```
provider.setCustomParameters({
  'allow_signup': 'false'
});auth_github_provider_params.js
```
Web version 8
```
provider.setCustomParameters({
  'allow_signup': 'false'
});github.js
```
Parameter OAuth wajib yang dicadangkan tidak diizinkan dan akan diabaikan. Lihat referensi penyedia autentikasi untuk detail lebih lanjut.

Autentikasi dengan Firebase menggunakan objek penyedia GitHub. Anda dapat meminta pengguna untuk masuk dengan akun GitHub mereka dengan membuka jendela pop-up atau dengan mengarahkan ulang ke halaman masuk. Metode pengalihan lebih disukai di perangkat seluler.

Untuk masuk dengan jendela pop-up, panggil signInWithPopup :

Web version 9

import { getAuth, signInWithPopup, GithubAuthProvider } from "firebase/auth";

const auth = getAuth();
signInWithPopup(auth, provider)
  .then((result) => {
    // This gives you a GitHub Access Token. You can use it to access the GitHub API.
    const credential = GithubAuthProvider.credentialFromResult(result);
    const token = credential.accessToken;

    // The signed-in user info.
    const user = result.user;
    // ...
  }).catch((error) => {
    // Handle Errors here.
    const errorCode = error.code;
    const errorMessage = error.message;
    // The email of the user's account used.
    const email = error.customData.email;
    // The AuthCredential type that was used.
    const credential = GithubAuthProvider.credentialFromError(error);
    // ...
  });auth_github_signin_popup.js

Web version 8

firebase
  .auth()
  .signInWithPopup(provider)
  .then((result) => {
    /** @type {firebase.auth.OAuthCredential} */
    var credential = result.credential;

    // This gives you a GitHub Access Token. You can use it to access the GitHub API.
    var token = credential.accessToken;

    // The signed-in user info.
    var user = result.user;
    // ...
  }).catch((error) => {
    // Handle Errors here.
    var errorCode = error.code;
    var errorMessage = error.message;
    // The email of the user's account used.
    var email = error.email;
    // The firebase.auth.AuthCredential type that was used.
    var credential = error.credential;
    // ...
  });github.js

Perhatikan juga bahwa Anda dapat mengambil token OAuth penyedia GitHub yang dapat digunakan untuk mengambil data tambahan menggunakan API GitHub.

Ini juga tempat Anda dapat menangkap dan menangani kesalahan. Untuk daftar kode kesalahan, lihat Auth Reference Docs .

Untuk masuk dengan mengalihkan ke laman masuk, panggil signInWithRedirect : Ikuti praktik terbaik saat menggunakan `signInWithRedirect`.

Web version 9

import { getAuth, signInWithRedirect } from "firebase/auth";

const auth = getAuth();
signInWithRedirect(auth, provider);auth_signin_redirect.js

Web version 8

firebase.auth().signInWithRedirect(provider);index.js

Kemudian, Anda juga dapat mengambil token OAuth penyedia GitHub dengan memanggil getRedirectResult saat halaman Anda dimuat:

Web version 9

import { getAuth, getRedirectResult, GithubAuthProvider } from "firebase/auth";

const auth = getAuth();
getRedirectResult(auth)
  .then((result) => {
    const credential = GithubAuthProvider.credentialFromResult(result);
    if (credential) {
      // This gives you a GitHub Access Token. You can use it to access the GitHub API.
      const token = credential.accessToken;
      // ...
    }

    // The signed-in user info.
    const user = result.user;
  }).catch((error) => {
    // Handle Errors here.
    const errorCode = error.code;
    const errorMessage = error.message;
    // The email of the user's account used.
    const email = error.customData.email;
    // The AuthCredential type that was used.
    const credential = GithubAuthProvider.credentialFromError(error);
    // ...
  });auth_github_signin_redirect_result.js

Web version 8

firebase.auth()
  .getRedirectResult()
  .then((result) => {
    if (result.credential) {
      /** @type {firebase.auth.OAuthCredential} */
      var credential = result.credential;

      // This gives you a GitHub Access Token. You can use it to access the GitHub API.
      var token = credential.accessToken;
      // ...
    }

    // The signed-in user info.
    var user = result.user;
  }).catch((error) => {
    // Handle Errors here.
    var errorCode = error.code;
    var errorMessage = error.message;
    // The email of the user's account used.
    var email = error.email;
    // The firebase.auth.AuthCredential type that was used.
    var credential = error.credential;
    // ...
  });github.js

Ini juga tempat Anda dapat menangkap dan menangani kesalahan. Untuk daftar kode kesalahan, lihat Auth Reference Docs .

Menangani Kesalahan akun-ada-dengan-kredensial-berbeda

Jika Anda mengaktifkan setelan Satu akun per alamat email di konsol Firebase , saat pengguna mencoba masuk ke penyedia (seperti GitHub) dengan email yang sudah ada untuk penyedia pengguna Firebase lain (seperti Google), kesalahan auth/account-exists-with-different-credential dilemparkan bersama dengan objek AuthCredential (token akses GitHub). Untuk menyelesaikan proses masuk ke penyedia yang dituju, pengguna harus masuk terlebih dahulu ke penyedia yang ada (Google) lalu menautkan ke AuthCredential sebelumnya (token akses GitHub).

Jika Anda menggunakan signInWithPopup , Anda dapat menangani kesalahan auth/account-exists-with-different-credential dengan kode seperti contoh berikut:


// Step 1.
// User tries to sign in to GitHub.
auth.signInWithPopup(new firebase.auth.GithubAuthProvider()).catch(function(error) {
  // An error happened.
  if (error.code === 'auth/account-exists-with-different-credential') {
    // Step 2.
    // User's email already exists.
    // The pending GitHub credential.
    var pendingCred = error.credential;
    // The provider account's email address.
    var email = error.email;
    // Get sign-in methods for this email.
    auth.fetchSignInMethodsForEmail(email).then(function(methods) {
      // Step 3.
      // If the user has several sign-in methods,
      // the first method in the list will be the "recommended" method to use.
      if (methods[0] === 'password') {
        // Asks the user their password.
        // In real scenario, you should handle this asynchronously.
        var password = promptUserForPassword(); // TODO: implement promptUserForPassword.
        auth.signInWithEmailAndPassword(email, password).then(function(result) {
          // Step 4a.
          return result.user.linkWithCredential(pendingCred);
        }).then(function() {
          // GitHub account successfully linked to the existing Firebase user.
          goToApp();
        });
        return;
      }
      // All the other cases are external providers.
      // Construct provider object for that provider.
      // TODO: implement getProviderForProviderId.
      var provider = getProviderForProviderId(methods[0]);
      // At this point, you should let the user know that they already have an account
      // but with a different provider, and let them validate the fact they want to
      // sign in with this provider.
      // Sign in to provider. Note: browsers usually block popup triggered asynchronously,
      // so in real scenario you should ask the user to click on a "continue" button
      // that will trigger the signInWithPopup.
      auth.signInWithPopup(provider).then(function(result) {
        // Remember that the user may have signed in with an account that has a different email
        // address than the first one. This can happen as Firebase doesn't control the provider's
        // sign in flow and the user is free to login using whichever account they own.
        // Step 4b.
        // Link to GitHub credential.
        // As we have access to the pending credential, we can directly call the link method.
        result.user.linkAndRetrieveDataWithCredential(pendingCred).then(function(usercred) {
          // GitHub account successfully linked to the existing Firebase user.
          goToApp();
        });
      });
    });
  }
});

Modus pengalihan

Kesalahan ini ditangani dengan cara serupa dalam mode pengalihan, dengan perbedaan bahwa kredensial yang tertunda harus di-cache di antara pengalihan halaman (misalnya, menggunakan penyimpanan sesi).

Tangani alur masuk secara manual

Anda juga dapat mengautentikasi dengan Firebase menggunakan akun GitHub dengan menangani alur login dengan memanggil titik akhir GitHub OAuth 2.0:

Integrasikan autentikasi GitHub ke dalam aplikasi Anda dengan mengikuti dokumentasi developer . Di akhir alur masuk GitHub, Anda akan menerima token akses OAuth 2.0.
Jika Anda perlu masuk ke aplikasi Node.js, kirimkan token akses OAuth ke aplikasi Node.js.
Setelah pengguna berhasil masuk dengan GitHub, tukarkan token akses OAuth 2.0 dengan kredensial Firebase:
Web version 9
Pelajari lebih lanjut SDK modular Web v9 yang dapat diguncang pohon dan tingkatkan dari versi 8.
```
import { GithubAuthProvider } from "firebase/auth";

const credential = GithubAuthProvider.credential(token);auth_github_provider_credential.js
```
Web version 8
```
var credential = firebase.auth.GithubAuthProvider.credential(token);github.js
```

Autentikasi dengan Firebase menggunakan kredensial Firebase:

Web version 9

import { getAuth, signInWithCredential } from "firebase/auth";

// Sign in with the credential from the user.
const auth = getAuth();
signInWithCredential(auth, credential)
  .then((result) => {
    // Signed in 
    // ...
  })
  .catch((error) => {
    // Handle Errors here.
    const errorCode = error.code;
    const errorMessage = error.message;
    // The email of the user's account used.
    const email = error.customData.email;
    // ...
  });auth_signin_credential.js

Web version 8

// Sign in with the credential from the user.
firebase.auth()
  .signInWithCredential(credential)
  .then((result) => {
    // Signed in 
    // ...
  })
  .catch((error) => {
    // Handle Errors here.
    const errorCode = error.code;
    const errorMessage = error.message;
    // The email of the user's account used.
    const email = error.email;
    // ...
  });index.js

Autentikasi dengan Firebase di ekstensi Chrome

Jika Anda membuat aplikasi ekstensi Chrome, Anda harus menambahkan ID ekstensi Chrome Anda:

Buka proyek Anda di konsol Firebase .
Di bagian Autentikasi , buka halaman Metode masuk .
Tambahkan URI seperti berikut ke daftar Authorized Domains:
```
chrome-extension://CHROME_EXTENSION_ID
```

Hanya operasi popup ( signInWithPopup , linkWithPopup , dan reauthenticateWithPopup ) yang tersedia untuk ekstensi Chrome, karena ekstensi Chrome tidak dapat menggunakan pengalihan HTTP. Anda harus memanggil metode ini dari skrip halaman latar belakang daripada popup tindakan browser, karena popup autentikasi akan membatalkan popup tindakan browser. Metode sembulan hanya dapat digunakan dalam ekstensi yang menggunakan Manifest V2 . Manifest V3 yang lebih baru hanya mengizinkan skrip latar belakang dalam bentuk pekerja layanan, yang tidak dapat melakukan operasi sembulan sama sekali.

Di file manifes ekstensi Chrome, pastikan Anda menambahkan URL https://apis.google.com ke daftar yang diizinkan content_security_policy .

Pada pembuatan proyek, Firebase akan menyediakan subdomain unik untuk proyek Anda: https://my-app-12345.firebaseapp.com .

Ini juga akan digunakan sebagai mekanisme pengalihan untuk login OAuth. Domain tersebut harus diizinkan untuk semua penyedia OAuth yang didukung. Namun, ini berarti pengguna dapat melihat domain tersebut saat masuk ke GitHub sebelum mengalihkan kembali ke aplikasi: Lanjutkan ke: https://my-app-12345.firebaseapp.com .

Agar subdomain tidak ditampilkan, Anda dapat menyiapkan domain khusus dengan Firebase Hosting:

Ikuti langkah 1 sampai 3 di Menyiapkan domain Anda untuk Hosting . Saat Anda memverifikasi kepemilikan domain, Hosting menyediakan sertifikat SSL untuk domain kustom Anda.
Tambahkan domain khusus Anda ke daftar domain resmi di konsol Firebase : auth.custom.domain.com .
Di konsol pengembang GitHub atau halaman penyiapan OAuth, daftar putih URL halaman pengalihan, yang akan dapat diakses di domain kustom Anda: https://auth.custom.domain.com/__/auth/handler .

Saat Anda menginisialisasi pustaka JavaScript, tentukan domain khusus Anda dengan bidang authDomain : l10n

var config = {
  apiKey: '...',
  // Changed from 'my-app-12345.firebaseapp.com'.
  authDomain: 'auth.custom.domain.com',
  databaseURL: 'https://my-app-12345.firebaseio.com',
  projectId: 'my-app-12345',
  storageBucket: 'my-app-12345.appspot.com',
  messagingSenderId: '1234567890'
};
firebase.initializeApp(config);

Langkah selanjutnya

Setelah pengguna masuk untuk pertama kali, akun pengguna baru dibuat dan ditautkan ke kredensial—yaitu, nama pengguna dan sandi, nomor telepon, atau informasi penyedia autentikasi—yang digunakan pengguna untuk masuk. Akun baru ini disimpan sebagai bagian dari project Firebase Anda, dan dapat digunakan untuk mengidentifikasi pengguna di setiap aplikasi dalam project Anda, terlepas dari cara pengguna login.

Di aplikasi Anda, cara yang disarankan untuk mengetahui status autentikasi pengguna Anda adalah dengan menyetel pengamat pada objek Auth . Anda kemudian bisa mendapatkan informasi profil dasar pengguna dari objek User . Lihat Kelola Pengguna .
Dalam Aturan Keamanan Firebase Realtime Database dan Cloud Storage, Anda bisa mendapatkan ID pengguna unik pengguna yang masuk dari variabel auth , dan menggunakannya untuk mengontrol data apa yang dapat diakses pengguna.

Anda dapat mengizinkan pengguna masuk ke aplikasi Anda menggunakan beberapa penyedia autentikasi dengan menautkan kredensial penyedia autentikasi ke akun pengguna yang ada.

Untuk mengeluarkan pengguna, panggil signOut :

Web version 9

import { getAuth, signOut } from "firebase/auth";

const auth = getAuth();
signOut(auth).then(() => {
  // Sign-out successful.
}).catch((error) => {
  // An error happened.
});auth_sign_out.js

Web version 8

firebase.auth().signOut().then(() => {
  // Sign-out successful.
}).catch((error) => {
  // An error happened.
});index.js

Otentikasi Menggunakan GitHub dengan JavaScript

Sebelum kamu memulai

Tangani alur masuk dengan Firebase SDK

Web version 9

Web version 8

Web version 9

Web version 8

Web version 9

Web version 8

Web version 9

Web version 8

Web version 9

Web version 8

Web version 9

Web version 8

Menangani Kesalahan akun-ada-dengan-kredensial-berbeda

Modus munculan

Modus pengalihan

Tangani alur masuk secara manual

Web version 9

Web version 8

Web version 9

Web version 8

Autentikasi dengan Firebase di ekstensi Chrome

Menyesuaikan domain redirect untuk masuk GitHub

Langkah selanjutnya

Web version 9

Web version 8