Google berkomitmen untuk mendorong terwujudnya keadilan ras bagi komunitas Kulit Hitam. Lihat caranya.

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

  1. Tambahkan Firebase ke proyek JavaScript Anda .
  2. Di Firebase console , buka bagian Auth .
  3. Pada tab Metode masuk , aktifkan penyedia GitHub .
  4. Tambahkan ID Klien dan Rahasia Klien dari konsol pengembang penyedia itu 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 OAuth Firebase Anda (mis my-app-12345.firebaseapp.com/__/auth/handler ) disetel sebagai URL panggilan balik Otorisasi di halaman setelan aplikasi pada konfigurasi aplikasi GitHub Anda.
  5. 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 dengan 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-langkah berikut:

  1. Buat instance objek penyedia GitHub:

    Web version 9

    import { GithubAuthProvider } from "firebase/auth";
    
    const provider = new GithubAuthProvider();

    Web version 8

    var provider = new firebase.auth.GithubAuthProvider();
  2. Opsional : Tentukan cakupan OAuth 2.0 tambahan yang ingin Anda minta dari penyedia autentikasi. Untuk menambahkan cakupan, panggil addScope . Sebagai contoh:

    Web version 9

    provider.addScope('repo');

    Web version 8

    provider.addScope('repo');
    Lihat dokumentasi penyedia otentikasi .
  3. 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 yang berisi kunci seperti yang ditentukan oleh dokumentasi penyedia OAuth dan nilai yang sesuai. Sebagai contoh:

    Web version 9

    provider.setCustomParameters({
      'allow_signup': 'false'
    });

    Web version 8

    provider.setCustomParameters({
      'allow_signup': 'false'
    });
    Parameter OAuth wajib yang dicadangkan tidak diizinkan dan akan diabaikan. Lihat referensi penyedia otentikasi untuk lebih jelasnya.
  4. Mengautentikasi dengan Firebase menggunakan objek penyedia GitHub. Anda dapat meminta pengguna Anda untuk masuk dengan akun GitHub mereka baik dengan membuka jendela pop-up atau dengan mengarahkan ulang ke halaman masuk. Metode pengalihan lebih disukai pada 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);
          // ...
        });

      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;
          // ...
        });
      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 Dokumen Referensi Auth .

    • Untuk masuk dengan mengalihkan ke halaman masuk, panggil signInWithRedirect :

      Web version 9

      import { getAuth, signInWithRedirect } from "firebase/auth";
      
      const auth = getAuth();
      signInWithRedirect(auth, provider);

      Web version 8

      firebase.auth().signInWithRedirect(provider);
      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);
          // ...
        });

      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;
          // ...
        });
      Ini juga tempat Anda dapat menangkap dan menangani kesalahan. Untuk daftar kode kesalahan, lihat Dokumen Referensi Auth .

Tangani alur masuk secara manual

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

  1. Integrasikan autentikasi GitHub ke dalam aplikasi Anda dengan mengikuti dokumentasi pengembang . Di akhir alur masuk GitHub, Anda akan menerima token akses OAuth 2.0.
  2. Jika Anda perlu masuk ke aplikasi Node.js, kirim token akses OAuth ke aplikasi Node.js.
  3. Setelah pengguna berhasil masuk dengan GitHub, tukarkan token akses OAuth 2.0 dengan kredensial Firebase:

    Web version 9

    import { GithubAuthProvider } from "firebase/auth";
    
    const credential = GithubAuthProvider.credential(token);

    Web version 8

    var credential = firebase.auth.GithubAuthProvider.credential(token);
  4. Mengautentikasi 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;
        // ...
      });

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

Otentikasi dengan Firebase di ekstensi Chrome

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

  1. Buka proyek Anda di konsol Firebase .
  2. Di bagian Otentikasi , buka halaman Metode masuk .
  3. Tambahkan URI seperti berikut ke daftar Domain Resmi:
    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 otentikasi akan membatalkan popup tindakan browser. Metode popup 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 popup sama sekali.

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

Langkah selanjutnya

Setelah pengguna masuk untuk pertama kalinya, 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 proyek Firebase Anda, dan dapat digunakan untuk mengidentifikasi pengguna di setiap aplikasi dalam proyek Anda, terlepas dari cara pengguna masuk.

  • 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.
});

Web version 8

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