Menerapkan server OAuth 2.0

Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

Setiap integrasi Cloud-to-cloud harus menyertakan mekanisme untuk melakukan autentikasi pengguna.

Autentikasi memungkinkan Anda menautkan Akun Google pengguna dengan akun pengguna di sistem autentikasi. Hal ini memungkinkan Anda mengidentifikasi pengguna saat fulfillment menerima intent smart home. Smart home Google hanya mendukung OAuth dengan alur kode otorisasi.

Halaman ini menjelaskan cara menyiapkan server OAuth 2.0 agar berfungsi dengan integrasi Cloud-to-cloud Anda.

Penautan Akun Google dengan OAuth

Dalam alur kode otorisasi, Anda memerlukan dua endpoint:

• Endpoint otorisasi, yang menampilkan UI login kepada pengguna Anda yang belum login. Endpoint otorisasi juga membuat kode otorisasi yang memiliki masa aktif singkat untuk mencatat izin pengguna atas akses yang diminta.

• Endpoint pertukaran token, yang bertanggung jawab atas dua jenis pertukaran:

  1. Menukarkan kode otorisasi dengan token refresh yang memiliki masa aktif lama dan token akses yang memiliki masa aktif singkat. Pertukaran ini terjadi saat pengguna melalui alur penautan akun.
  2. Menukar token refresh yang memiliki masa aktif lama dengan token akses yang memiliki masa aktif singkat. Pertukaran ini terjadi ketika Google memerlukan token akses baru karena token yang sudah kedaluwarsa.

Panduan desain

Bagian ini menjelaskan persyaratan dan rekomendasi desain untuk layar pengguna yang Anda hosting untuk alur penautan OAuth. Setelah dipanggil oleh aplikasi Google, platform Anda akan menampilkan halaman login ke Google dan layar izin penautan akun kepada pengguna. Pengguna diarahkan kembali ke aplikasi Google setelah memberikan izin untuk menautkan akun.

Persyaratan

1. Anda harus memberitahukan bahwa akun pengguna akan ditautkan ke Google, bukan produk Google tertentu seperti Google Home atau Asisten Google.
2. Anda harus memiliki pernyataan otorisasi Google, seperti "Dengan login, Anda mengizinkan Google untuk mengontrol perangkat Anda". Lihat bagian Otorisasi Kontrol Perangkat Google dalam Kebijakan Developer Google Home.
3. Anda harus menyediakan cara bagi pengguna untuk kembali atau membatalkan, jika mereka memilih untuk tidak menautkan.
4. Anda harus membuka halaman penautan Web OAuth dan memastikan pengguna memiliki metode yang jelas untuk login ke Akun Google mereka, seperti kolom untuk nama pengguna dan sandi mereka. Jangan gunakan metode Login dengan Google (GSI) yang memungkinkan pengguna menautkan tanpa diarahkan ke halaman Penautan OAuth Web. Tindakan ini merupakan pelanggaran kebijakan Google.

Rekomendasi

Sebaiknya Anda melakukan hal berikut:

1. Menampilkan Kebijakan Privasi Google. Sertakan link ke Kebijakan Privasi Google di layar izin.

2. Data untuk dibagikan. Gunakan bahasa yang jelas dan ringkas untuk memberi tahu pengguna data apa yang diperlukan Google dan alasannya.

3. Pesan ajakan (CTA) yang jelas. Nyatakan pesan ajakan (CTA) yang jelas di layar izin, seperti "Setuju dan tautkan". Hal ini karena pengguna perlu memahami data apa yang perlu mereka bagikan kepada Google untuk menautkan akun mereka.

4. Kemampuan untuk membatalkan tautan. Menawarkan mekanisme bagi pengguna untuk membatalkan tautan, seperti URL ke setelan akun mereka di platform Anda. Atau, Anda dapat menyertakan link ke Akun Google tempat pengguna dapat mengelola akun tertaut mereka.

5. Kemampuan untuk mengubah akun pengguna. Sarankan metode bagi pengguna untuk beralih akun. Hal ini sangat bermanfaat jika pengguna cenderung memiliki beberapa akun.

   • Jika pengguna harus menutup layar izin untuk beralih akun, kirim error yang dapat dipulihkan ke Google agar pengguna dapat login ke akun yang diinginkan menggunakan penautan OAuth.

6. Sertakan logo Anda. Tampilkan logo perusahaan Anda di layar izin. Gunakan panduan gaya untuk menempatkan logo Anda. Jika Anda juga ingin menampilkan logo Google, lihat Logo dan merek dagang.

Alur kode otorisasi

Implementasi server OAuth 2.0 untuk alur kode otorisasi terdiri dari dua endpoint, yang disediakan oleh layanan Anda melalui HTTPS. Endpoint pertama adalah endpoint otorisasi, yang bertanggung jawab untuk menemukan atau mendapatkan izin dari pengguna untuk akses data. Endpoint otorisasi menampilkan UI login kepada pengguna Anda yang belum login dan mencatat izin untuk akses yang diminta. Endpoint kedua adalah endpoint pertukaran token, yang digunakan untuk mendapatkan string terenkripsi, yang disebut token, yang memberikan otorisasi kepada pengguna untuk mengakses layanan Anda.

Saat aplikasi Google perlu memanggil salah satu API layanan Anda, Google menggunakan endpoint ini secara bersamaan untuk mendapatkan izin dari pengguna Anda untuk memanggil API ini atas nama mereka.

Sesi alur kode otorisasi OAuth 2.0 yang dimulai oleh Google memiliki alur berikut:

1. Google akan membuka endpoint otorisasi Anda di browser pengguna. Jika alur dimulai di perangkat khusus suara untuk Action, Google akan mentransfer eksekusi ke ponsel.
2. Pengguna akan login, jika belum login, dan memberikan izin kepada Google untuk mengakses data mereka dengan API Anda, jika mereka belum memberikan izin.
3. Layanan Anda membuat kode otorisasi dan menampilkannya ke Google. Untuk melakukannya, arahkan browser pengguna kembali ke Google dengan kode otorisasi yang dilampirkan ke permintaan.
4. Google mengirimkan kode otorisasi ke endpoint pertukaran token Anda, yang memverifikasi keaslian kode dan menampilkan token akses dan token refresh. Token akses adalah token berumur pendek yang diterima layanan Anda sebagai kredensial untuk mengakses API. Token refresh adalah token dengan masa berlaku lama yang dapat disimpan dan digunakan Google untuk memperoleh token akses baru saat masa berlakunya berakhir.
5. Setelah pengguna menyelesaikan alur penautan akun, setiap permintaan berikutnya yang dikirim dari Google akan berisi token akses.

Menangani permintaan otorisasi

Jika Anda perlu melakukan penautan akun menggunakan alur kode otorisasi OAuth 2.0, Google akan mengarahkan pengguna ke endpoint otorisasi Anda dengan permintaan yang menyertakan parameter berikut:

Misalnya, jika endpoint otorisasi Anda tersedia di https://myservice.example.com/auth, permintaan mungkin terlihat seperti berikut:

GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&scope=REQUESTED_SCOPES&response_type=code&user_locale=LOCALE

Agar endpoint otorisasi Anda dapat menangani permintaan login, lakukan langkah-langkah berikut:

1. Pastikan client_id cocok dengan Client ID yang Anda tetapkan ke Google, dan redirect_uri cocok dengan URL alihan yang disediakan oleh Google untuk layanan Anda. Pemeriksaan ini penting untuk mencegah pemberian akses ke aplikasi klien yang tidak disengaja atau salah dikonfigurasi. Jika Anda mendukung beberapa alur OAuth 2.0, konfirmasi juga bahwa response_type adalah code.
2. Periksa apakah pengguna login ke layanan Anda. Jika pengguna tidak login, selesaikan alur login atau pendaftaran layanan Anda.
3. Buat kode otorisasi yang akan digunakan Google untuk mengakses API Anda. Kode otorisasi dapat berupa nilai string apa pun, tetapi harus mewakili pengguna, klien yang menggunakan token, dan waktu habis masa berlaku kode secara unik, dan tidak boleh dapat ditebak. Anda biasanya mengeluarkan kode otorisasi yang masa berlakunya berakhir setelah sekitar 10 menit.
4. Pastikan URL yang ditentukan oleh parameter redirect_uri memiliki format berikut:

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
     https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
     

5. Alihkan browser pengguna ke URL yang ditentukan oleh parameter redirect_uri. Sertakan kode otorisasi yang baru saja Anda buat dan nilai status asli yang tidak diubah saat Anda mengalihkan dengan menambahkan parameter code dan state. Berikut adalah contoh URL yang dihasilkan:

   https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING

Menangani permintaan pertukaran token

Endpoint pertukaran token layanan Anda bertanggung jawab atas dua jenis pertukaran token:

• Menukar kode otorisasi untuk token akses dan token refresh
• Menukar token refresh dengan token akses

Permintaan pertukaran token menyertakan parameter berikut:

Mengonfigurasi cara Google mengirim kredensial ke server Anda

Bergantung pada implementasinya, server otorisasi Anda mengharapkan untuk menerima kredensial klien dalam isi permintaan, atau dalam header permintaan.

Secara default, Google mengirimkan kredensial dalam isi permintaan. Jika server otorisasi Anda mewajibkan kredensial klien berada di header permintaan, Anda harus mengonfigurasi integrasi Cloud-to-cloud sesuai dengan hal tersebut:

Buka Konsol Play

1. Dari daftar project, klik Buka di samping project yang ingin Anda kerjakan.

2. Di bagian Cloud-to-Cloud, pilih Develop.

3. Klik Buka di samping integrasi Anda.

4. Scroll ke bawah ke bagian Izin (opsional), lalu centang kotak Minta Google mengirimkan Client ID dan secret melalui header autentikasi dasar HTTP.

5. Klik Simpan untuk menyimpan perubahan.

Menukar kode otorisasi untuk token akses dan token refresh

Setelah pengguna login dan endpoint otorisasi Anda menampilkan kode otorisasi berumur singkat ke Google, Google akan mengirimkan permintaan ke endpoint pertukaran token Anda untuk menukarkan kode otorisasi dengan token akses dan token refresh.

Untuk permintaan ini, nilai grant_type adalah authorization_code, dan nilai code adalah nilai kode otorisasi yang sebelumnya Anda berikan ke Google. Berikut adalah contoh permintaan untuk menukar kode otorisasi dengan token akses dan token refresh:

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=authorization_code&code=AUTHORIZATION_CODE&redirect_uri=REDIRECT_URI

Untuk menukar kode otorisasi dengan token akses dan token refresh, endpoint pertukaran token Anda akan merespons permintaan POST dengan menjalankan langkah-langkah berikut:

1. Verifikasi bahwa client_id mengidentifikasi asal permintaan sebagai origin yang diotorisasi, dan bahwa client_secret cocok dengan nilai yang diharapkan.
2. Pastikan kode otorisasi valid dan belum habis masa berlakunya, serta bahwa client ID yang ditentukan dalam permintaan cocok dengan client ID yang terkait dengan kode otorisasi.
3. Pastikan URL yang ditentukan oleh parameter redirect_uri identik dengan nilai yang digunakan dalam permintaan otorisasi awal.
4. Jika Anda tidak dapat memverifikasi semua kriteria di atas, tampilkan error HTTP 400 Permintaan Buruk dengan {"error": "invalid_grant"} sebagai isi.
5. Jika tidak, gunakan ID pengguna dari kode otorisasi untuk membuat token refresh dan token akses. Token ini dapat berupa nilai string apa pun, tetapi harus secara unik mewakili pengguna dan klien yang menjadi tujuan token, dan tidak boleh dapat ditebak. Untuk token akses, catat juga waktu habis masa berlaku token, yang biasanya satu jam setelah Anda menerbitkan token. Token refresh tidak memiliki masa berlaku.
6. Tampilkan objek JSON berikut dalam isi respons HTTPS:

   {
   "token_type": "Bearer",
   "access_token": "ACCESS_TOKEN",
   "refresh_token": "REFRESH_TOKEN",
   "expires_in": SECONDS_TO_EXPIRATION
   }

Google menyimpan token akses dan token refresh untuk pengguna serta mencatat masa berlaku token akses. Saat masa berlaku token akses berakhir, Google akan menggunakan token refresh untuk mendapatkan token akses baru dari endpoint pertukaran token Anda.

Menukar token refresh dengan token akses

Saat masa berlaku token akses berakhir, Google akan mengirimkan permintaan ke endpoint pertukaran token Anda untuk menukarkan token refresh dengan token akses baru.

Untuk permintaan ini, nilai grant_type adalah refresh_token, dan nilai refresh_token adalah nilai token refresh yang sebelumnya Anda berikan kepada Google. Berikut adalah contoh permintaan untuk menukarkan token refresh dengan token akses:

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=refresh_token&refresh_token=REFRESH_TOKEN

Untuk menukarkan token refresh dengan token akses, endpoint pertukaran token Anda akan merespons permintaan POST dengan menjalankan langkah-langkah berikut:

1. Pastikan client_id mengidentifikasi asal permintaan sebagai Google, dan client_secret cocok dengan nilai yang diharapkan.
2. Pastikan token refresh valid, dan client ID yang ditentukan dalam permintaan cocok dengan client ID yang terkait dengan token refresh.
3. Jika Anda tidak dapat memverifikasi semua kriteria di atas, tampilkan error Permintaan Buruk HTTP 400 dengan {"error": "invalid_grant"} sebagai isi.
4. Jika tidak, gunakan ID pengguna dari token refresh untuk membuat token akses. Token ini dapat berupa nilai string apa pun, tetapi harus mewakili pengguna dan klien yang menjadi tujuan token secara unik, dan tidak boleh dapat ditebak. Untuk token akses, catat juga waktu habis masa berlaku token, biasanya satu jam setelah Anda menerbitkan token.
5. Tampilkan objek JSON berikut dalam isi respons HTTPS:

   {
   "token_type": "Bearer",
   "access_token": "ACCESS_TOKEN",
   "expires_in": SECONDS_TO_EXPIRATION
   }

Menangani permintaan info pengguna

Endpoint userinfo adalah resource yang dilindungi OAuth 2.0 yang menampilkan klaim tentang pengguna yang ditautkan. Menerapkan dan menghosting endpoint userinfo bersifat opsional, kecuali untuk kasus penggunaan berikut:

• Login dengan Akun Tertaut dengan Google One Ketuk.
• Langganan tanpa hambatan di Android TV.

Setelah token akses berhasil diambil dari endpoint token Anda, Google akan mengirimkan permintaan ke endpoint userinfo Anda untuk mengambil informasi profil dasar tentang pengguna yang ditautkan.

Misalnya, jika endpoint userinfo Anda tersedia di https://myservice.example.com/userinfo, permintaan mungkin akan terlihat seperti berikut:

GET /userinfo HTTP/1.1
Host: myservice.example.com
Authorization: Bearer ACCESS_TOKEN

Agar endpoint userinfo Anda dapat menangani permintaan, lakukan langkah-langkah berikut:

1. Ekstrak token akses dari header Otorisasi dan tampilkan informasi untuk pengguna yang terkait dengan token akses.
2. Jika token akses tidak valid, tampilkan error HTTP 401 Tidak Sah dengan menggunakan Header Respons WWW-Authenticate. Berikut adalah contoh respons error userinfo:

   HTTP/1.1 401 Unauthorized
   WWW-Authenticate: error="invalid_token",
   error_description="The Access Token expired"
   

   Jika pesan error 401 Tidak Sah, atau respons error lainnya yang tidak berhasil ditampilkan selama proses penautan, error tersebut tidak akan dapat dipulihkan, token yang diambil akan dihapus dan pengguna harus memulai proses penautan lagi.

3. Jika token akses valid, tampilkan dan respons HTTP 200 dengan objek JSON berikut dalam isi HTTPS Respons:

   {
   "sub": "USER_UUID",
   "email": "EMAIL_ADDRESS",
   "given_name": "FIRST_NAME",
   "family_name": "LAST_NAME",
   "name": "FULL_NAME",
   "picture": "PROFILE_PICTURE",
   }
   

   Jika endpoint userinfo Anda menampilkan respons sukses HTTP 200, token dan klaim yang diambil akan didaftarkan terhadap Akun Google pengguna.

   respons endpoint userinfo
   sub	ID unik yang mengidentifikasi pengguna di sistem Anda.
   email	Alamat email pengguna.
   given_name	Opsional: Nama depan pengguna.
   family_name	Opsional: Nama belakang pengguna.
   name	Opsional: Nama lengkap pengguna.
   picture	Opsional: Foto profil pengguna.