Penautan Akun Google dengan OAuth

Akun ditautkan menggunakan alur implisit dan kode otorisasi OAuth 2.0 standar industri.

Layanan Anda harus mendukung otorisasi yang kompatibel dengan OAuth 2.0 dan endpoint pertukaran token.

Dalam alur implisit, Google membuka endpoint otorisasi Anda di browser pengguna. Setelah berhasil login, Anda akan menampilkan token akses yang berlaku lama ke Google. Token akses ini kini disertakan dalam setiap permintaan yang dikirim dari Google.

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 berumur pendek 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 menjalani alur penautan akun.
2. Menukarkan token refresh yang memiliki masa aktif lama dengan token akses yang memiliki masa aktif singkat. Pertukaran ini terjadi saat Google memerlukan token akses baru karena masa berlaku token yang dimilikinya telah habis.

Memilih alur OAuth 2.0

Meskipun alur implisit lebih mudah diterapkan, Google merekomendasikan agar token akses yang dikeluarkan oleh alur implisit tidak pernah habis masa berlakunya. Hal ini karena pengguna dipaksa untuk menautkan akunnya lagi setelah token berakhir dengan alur implisit. Jika Anda memerlukan masa berlaku token karena alasan keamanan, sebaiknya gunakan alur kode otorisasi.

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.

Gambar ini menunjukkan langkah-langkah yang harus dilakukan pengguna untuk menautkan Akun Google mereka ke sistem autentikasi Anda. Screenshot pertama menunjukkan
penghubungan yang dimulai pengguna dari platform Anda. Gambar kedua menampilkan
login pengguna ke Google, sedangkan gambar ketiga menampilkan persetujuan dan
konfirmasi pengguna untuk menautkan Akun Google mereka dengan aplikasi Anda. Screenshot
terakhir menampilkan akun pengguna yang berhasil ditautkan di aplikasi
Google. — **Gambar 1.** Login pengguna penautan akun ke Google dan layar izin.

Persyaratan

Anda harus menginformasikan bahwa akun pengguna akan ditautkan ke Google, bukan produk Google tertentu seperti Google Home atau Asisten Google.

Rekomendasi

Sebaiknya Anda melakukan hal berikut:

Menampilkan Kebijakan Privasi Google. Sertakan link ke Kebijakan Privasi Google di layar izin.
Data yang akan dibagikan. Gunakan bahasa yang jelas dan ringkas untuk memberi tahu pengguna data apa yang diperlukan Google dari mereka dan alasannya.
Pesan ajakan yang jelas. Nyatakan pesan ajakan (CTA) yang jelas di layar izin Anda, seperti "Setuju dan tautkan". Hal ini karena pengguna perlu memahami data yang harus mereka bagikan kepada Google untuk menautkan akun mereka.
Kemampuan untuk membatalkan. Berikan cara bagi pengguna untuk kembali atau membatalkan, jika mereka memilih untuk tidak menautkan.
Proses login yang jelas. Pastikan pengguna memiliki metode yang jelas untuk login ke Akun Google mereka, seperti kolom untuk nama pengguna dan sandi mereka atau Login dengan Google.
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.
Kemampuan untuk mengubah akun pengguna. Sarankan metode bagi pengguna untuk mengganti akun mereka. Hal ini sangat bermanfaat jika pengguna cenderung memiliki beberapa akun.
- Jika pengguna harus menutup layar izin untuk beralih akun, kirimkan error yang dapat dipulihkan ke Google agar pengguna dapat login ke akun yang dipilih dengan penautan OAuth dan alur implisit.
Sertakan logo Anda. Menampilkan logo perusahaan Anda di layar izin. Gunakan panduan gaya Anda untuk menempatkan logo. Jika Anda ingin atau perlu menampilkan logo Google juga, lihat Logo dan merek dagang.

Membuat project

Untuk membuat project Anda agar dapat menggunakan penautan akun:

Buka Konsol Google API.
Klik Buat proyek.
Masukkan nama atau terima saran yang dibuat.
Konfirmasi atau edit kolom yang tersisa.
Klik Buat.

Untuk melihat project ID Anda:

Buka Konsol Google API.
Cari project Anda di tabel pada halaman landing. Project ID muncul di kolom ID.

Mengonfigurasi Layar Izin OAuth Anda

Proses Penautan Akun Google mencakup layar izin yang memberi tahu pengguna aplikasi yang meminta akses ke data mereka, jenis data yang diminta, dan persyaratan yang berlaku. Anda harus mengonfigurasi layar izin OAuth sebelum membuat ID klien Google API.

Buka halaman Layar izin OAuth di konsol API Google.
Jika diminta, pilih project yang baru saja Anda buat.
Di halaman "Layar izin OAuth", isi formulir, lalu klik tombol “Simpan”.

Nama aplikasi: Nama aplikasi yang meminta izin. Nama harus mencerminkan aplikasi Anda secara akurat dan konsisten dengan nama aplikasi yang dilihat pengguna di tempat lain. Nama aplikasi akan ditampilkan di layar izin Penautan Akun.

Logo aplikasi: Gambar di layar izin yang akan membantu pengguna mengenali aplikasi Anda. Logo ditampilkan di layar izin Penautan akun dan di setelan akun

Email dukungan: Agar pengguna dapat menghubungi Anda jika ada pertanyaan tentang izin mereka.

Cakupan untuk Google API: Cakupan memungkinkan aplikasi Anda mengakses data pribadi Google pengguna Anda. Untuk kasus penggunaan Penautan Akun Google, cakupan default (email, profil, openid) sudah cukup, Anda tidak perlu menambahkan cakupan sensitif. Secara umum, praktik terbaiknya adalah meminta cakupan secara bertahap, pada saat akses diperlukan, bukan di awal. Pelajari lebih lanjut.

Domain yang diizinkan: Guna melindungi Anda dan pengguna Anda, Google hanya mengizinkan aplikasi yang melakukan autentikasi menggunakan OAuth untuk menggunakan Domain yang Diizinkan. Link aplikasi Anda harus dihosting di Domain yang Diotorisasi. Pelajari lebih lanjut.

Link Halaman Beranda Aplikasi: Halaman beranda untuk aplikasi Anda. Harus dihosting di Domain yang Diotorisasi.

Link Kebijakan Privasi Aplikasi: Ditampilkan di layar izin Penautan Akun Google. Harus dihosting di Domain yang Diotorisasi.

Link Persyaratan Layanan Aplikasi (Opsional): Harus dihosting di Domain yang Diotorisasi.

Gambar 1. Layar Izin Penautan Akun Google untuk Aplikasi fiktif, Tunery
Periksa "Status Verifikasi", jika aplikasi Anda memerlukan verifikasi, klik tombol "Kirim Untuk Verifikasi" untuk mengirimkan aplikasi Anda untuk diverifikasi. Lihat persyaratan verifikasi OAuth untuk mengetahui detailnya.

Menerapkan server OAuth Anda

为了支持 OAuth 2.0 隐式流程，您的服务通过 HTTPS 提供授权端点。此端点负责身份验证和征得用户同意以获取数据访问权限。授权端点会向尚未登录的用户显示登录界面，并记录用户对所请求访问权限的同意情况。

当 Google 应用需要调用您服务的某个已获授权的 API 时，Google 会使用此端点来征得用户同意，以便代表用户调用这些 API。

Google 账号关联：OAuth 隐式授权流程

以下序列图详细说明了用户、Google 和您服务的端点之间的互动。

图 1. Google 账号关联的 OAuth 2.0 隐式流程中的事件序列。

角色和职责

下表定义了 Google 账号关联 (GAL) OAuth 隐式流程中各个参与者的角色和职责。请注意，在 GAL 中，Google 充当 OAuth 客户端，而您的服务充当身份/服务提供方。

执行者 / 组件	GAL 角色	职责
Google 应用 / 服务器	OAuth 客户端	启动流程，使用浏览器重定向接收访问令牌，并安全地存储该令牌以访问服务的 API。
您的授权端点	授权服务器	对用户进行身份验证，征得用户同意，并直接向 Google 签发长期有效的访问令牌。
Google 重定向 URI	回调端点	从授权服务接收用户重定向，其中包含网址 fragment 中的 `access_token` 和 `state` 值。

由 Google 发起的典型 OAuth 2.0 隐式流程会话具有以下流程：

Google 会在用户的浏览器中打开您的授权端点。用户登录（如果尚未登录），并授予 Google 权限以通过您的 API 访问其数据（如果尚未授予权限）。
您的服务会创建访问令牌并将其返回给 Google。为此，请将用户的浏览器重定向回 Google，并将访问令牌附加到请求中。
Google 会调用您服务的 API，并在每个请求中附加访问令牌。您的服务会验证该访问令牌是否授予了 Google 访问相应 API 的授权，然后完成 API 调用。

处理授权请求

当 Google 应用需要使用 OAuth 2.0 隐式流程执行账号关联时，Google 会将用户发送到您的授权端点，并发送包含以下参数的请求：

授权端点参数
`client_id`	您分配给 Google 的客户 ID。
`redirect_uri`	您将对此请求的响应发送到的网址。
`state`	一种簿记值，在重定向 URI 中原封不动地传递回 Google。
`response_type`	要在响应中返回的值的类型。对于 OAuth 2.0 隐式流程，响应类型始终为 `token`。
`user_locale`	Google 账号语言设置（采用 RFC5646 格式），用于以用户的首选语言本地化您的内容。

例如，如果您的授权端点位于 https://myservice.example.com/auth，则请求可能如下所示：

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

如需让授权端点处理登录请求，请执行以下步骤：

验证 client_id 和 redirect_uri 值，以防止向意外或配置错误的客户端应用授予访问权限：
- 确认 client_id 与您分配给 Google 的客户端 ID 相一致。
- 确认 redirect_uri 参数指定的网址具有以下格式：
```
https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
```
检查用户是否已登录您的服务。如果用户未登录，请完成服务的登录或注册流程。
生成供 Google 用于访问您的 API 的访问令牌。访问令牌可以是任何字符串值，但必须唯一表示用户和令牌所针对的客户端，并且不得是可猜测的值。
发送 HTTP 响应，将用户的浏览器重定向到 redirect_uri 参数指定的网址。在网址片段中包含以下所有参数：
- access_token：您刚刚生成的访问令牌
- token_type：字符串 bearer
- state：原始请求中的未修改状态值
以下是生成的网址示例：
```
https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING
```

Google 的 OAuth 2.0 重定向处理程序会接收访问令牌，并确认 state 值未发生变化。在 Google 为您的服务获取访问令牌后，Google 会将该令牌附加到后续对您的服务 API 的调用中。

处理 userinfo 请求

userinfo 端点是受 OAuth 2.0 保护的资源，会返回关联用户的声明。实现和托管 userinfo 端点是可选的，但以下用例除外：

使用 Google One Tap 登录关联的账号。
Android TV 提供顺畅的订阅体验。

从您的令牌端点成功检索到访问令牌后，Google 会向您的 userinfo 端点发送请求，以检索关联用户的基本个人资料信息。

userinfo 端点请求标头
`Authorization header`	Bearer 类型的访问令牌。

例如，如果您的 userinfo 端点可通过 https://myservice.example.com/userinfo 时，请求可能如下所示：

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

为了让 userinfo 端点能够处理请求，请执行以下步骤：

从 Authorization 标头中提取访问令牌，并返回与访问令牌相关联的用户的信息。
如果访问令牌无效，则使用 WWW-Authenticate 响应标头返回 HTTP 401 Unauthorized 错误。下面是一个 userinfo 错误响应示例：
```
HTTP/1.1 401 Unauthorized
WWW-Authenticate: error="invalid_token",
error_description="The Access Token expired"
```
如果在关联过程中返回 401 未经授权错误或任何其他失败的错误响应，该错误将无法恢复，检索到的令牌将被舍弃，并且用户必须重新开始关联流程。

如果访问令牌有效，则返回 HTTPS 正文中包含以下 JSON 对象的 HTTP 200 响应回答：

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

如果您的 userinfo 端点返回 HTTP 200 成功响应，则系统会针对用户的 Google 账号注册检索到的令牌和声明。

userinfo 端点响应
`sub`	系统中用于识别用户的唯一 ID。
`email`	用户的电子邮件地址。
`given_name`	可选：用户的名字。
`family_name`	可选：用户的姓氏。
`name`	可选：用户的全名。
`picture`	可选：用户的个人资料照片。

Memvalidasi implementasi

Anda dapat memvalidasi penerapan dengan menggunakan alat OAuth 2.0 Playground.

Di alat, lakukan langkah-langkah berikut:

Klik Konfigurasi untuk membuka jendela Konfigurasi OAuth 2.0.
Di kolom OAuth flow, pilih Client-side.
Di kolom OAuth Endpoints, pilih Custom.
Tentukan endpoint OAuth 2.0 dan client ID yang Anda tetapkan ke Google di kolom yang sesuai.
Di bagian Langkah 1, jangan pilih cakupan Google apa pun. Sebagai gantinya, biarkan kolom ini kosong atau ketik cakupan yang valid untuk server Anda (atau string arbitrer jika Anda tidak menggunakan cakupan OAuth). Setelah selesai, klik Izinkan API.
Di bagian Langkah 2 dan Langkah 3, ikuti alur OAuth 2.0 dan verifikasi bahwa setiap langkah berfungsi sebagaimana mestinya.

Anda dapat memvalidasi penerapan dengan menggunakan alat Demo Penautan Akun Google.