Menggunakan Firebase untuk mengautentikasi pengguna

Halaman ini menjelaskan cara mendukung autentikasi pengguna di Cloud Endpoints.

Untuk mengautentikasi pengguna, aplikasi klien harus mengirimkan Token Web JSON (JWT) di header otorisasi permintaan HTTP ke backend API Anda. Extensible Service Proxy (ESP) memvalidasi token atas nama API Anda, sehingga Anda tidak perlu menambahkan kode apa pun di API untuk memproses autentikasi. Namun, Anda perlu mengonfigurasi dokumen OpenAPI untuk mendukung metode autentikasi yang Anda pilih.

ESP memvalidasi JWT secara berperforma tinggi dengan menggunakan kunci publik penerbit JWT. ESP menyimpan kunci publik dalam cache selama lima menit. Selain itu, ESP menyimpan JWT yang divalidasi dalam cache selama lima menit atau hingga JWT berakhir masa berlakunya, mana pun yang terjadi lebih dulu.

Sebelum memulai

  • Tambahkan kode autentikasi ke aplikasi klien Anda dengan mengikuti dokumentasi Firebase Authentication. Firebase mendukung autentikasi menggunakan sandi, nomor telepon, dan penyedia identitas gabungan populer seperti Google, Facebook, dan Twitter.

  • Saat aplikasi klien Anda mengirim permintaan HTTP, header otorisasi dalam permintaan harus berisi klaim JWT berikut:
    • iss (penerbit)
    • sub (subjek)
    • aud (audiens)
    • iat (dikeluarkan di)
    • exp (waktu habis masa berlaku)

Mengonfigurasi dokumen OpenAPI

Anda harus memiliki objek persyaratan keamanan dan objek definisi keamanan dalam dokumen OpenAPI agar ESP dapat memvalidasi klaim dalam JWT yang ditandatangani.

Untuk mendukung Firebase Authentication:

  1. Tambahkan hal berikut ke definisi keamanan dalam dokumen OpenAPI Anda:

      securityDefinitions:
    firebase:
      authorizationUrl: ""
      flow: "implicit"
      type: "oauth2"
      # Replace YOUR-PROJECT-ID with your project ID
      x-google-issuer: "https://securetoken.google.com/YOUR-PROJECT-ID"
      x-google-jwks_uri: "https://www.googleapis.com/service_accounts/v1/metadata/x509/securetoken@system.gserviceaccount.com"
      x-google-audiences: "YOUR-PROJECT-ID"

  2. Tambahkan bagian keamanan di tingkat API untuk diterapkan ke seluruh API, atau di tingkat metode untuk diterapkan ke metode tertentu.

      security:
    - firebase: []

Anda dapat menentukan beberapa definisi keamanan dalam dokumen OpenAPI, tetapi setiap definisi harus memiliki penerbit yang berbeda. Jika Anda menggunakan bagian keamanan di tingkat API dan tingkat metode, setelan tingkat metode akan menggantikan setelan tingkat API.

Anda juga dapat menyesuaikan lokasi JWT dengan menambahkan x-google-extensions. Untuk mengetahui detailnya, lihat ekstensi openAPI.

Melakukan panggilan terautentikasi ke Endpoints API

Saat Anda mengirim permintaan menggunakan token autentikasi, demi alasan keamanan, sebaiknya Anda menempatkan token di header Authorization:Bearer. Misalnya:

curl -H "Authorization: Bearer ${TOKEN}" "${ENDPOINTS_HOST}/echo"

Di sini, ENDPOINTS_HOST dan TOKEN adalah variabel lingkungan yang masing-masing berisi nama host API dan token autentikasi Anda. Lihat Membuat permintaan yang diautentikasi ke Endpoints API. untuk contoh kode yang mengirim permintaan menggunakan header Authorization:Bearer.

Jika tidak dapat menggunakan header saat mengirim permintaan, Anda dapat menempatkan token autentikasi dalam parameter kueri yang disebut access_token. Contoh:

curl "${ENDPOINTS_HOST}/echo?access_token=${TOKEN}"

Menerima hasil yang diautentikasi di API Anda

ESP biasanya meneruskan semua header yang diterimanya. Namun, header Authorization asli akan diganti jika alamat backend ditentukan oleh x-google-backend dalam spesifikasi OpenAPI atau BackendRule dalam konfigurasi layanan gRPC.

ESP akan mengirimkan hasil autentikasi di X-Endpoint-API-UserInfo ke backend API. Sebaiknya gunakan header ini, bukan header Authorization asli. Header ini adalah string yang mengodekan objek JSON base64url. Format objek JSON berbeda antara ESPv2 dan ESP. Untuk ESPv2, objek JSON adalah payload JWT asli. Untuk ESP, objek JSON menggunakan nama kolom yang berbeda dan menempatkan payload JWT asli di kolom claims. Lihat Menangani JWT di layanan backend untuk mengetahui informasi selengkapnya tentang formatnya.

Langkah berikutnya