Ringkasan
Penautan Praktis Login dengan Google berbasis OAuth menambahkan Login dengan Google di atas Penautan OAuth. Hal ini memberikan pengalaman penautan yang lancar untuk Pengguna Google, dan juga memungkinkan pembuatan akun, yang memungkinkan pengguna untuk membuat akun baru di layanan Anda menggunakan akun Google mereka.
Untuk melakukan penautan akun dengan OAuth dan Login dengan Google, ikuti langkah-langkah langkah:
- Pertama, minta pengguna untuk memberikan izin agar dapat mengakses profil Google miliknya.
- Menggunakan informasi di profil mereka untuk memeriksa apakah akun pengguna ada.
- Untuk pengguna yang sudah ada, tautkan akun.
- Jika Anda tidak dapat menemukan kecocokan untuk pengguna Google di sistem autentikasi Anda, memvalidasi token ID yang diterima dari Google. Anda kemudian dapat membuat pengguna berbasis informasi profil yang terkandung dalam token ID.
Gambar 1. Penautan Akun di ponsel pengguna dengan Penautan yang Disederhanakan
Persyaratan untuk Penautan yang Disederhanakan
- Terapkan alur penautan OAuth web dasar. Layanan Anda harus mendukung OAuth 2.0 yang mematuhi kebijakan otorisasi dan pertukaran token.
- Endpoint token exchange Anda harus mendukung pernyataan JSON Web Token (JWT) dan menerapkan intent
check
,create
, danget
.
Mengimplementasikan server OAuth
Endpoint pertukaran token Anda harus mendukung intent check
, create
, get
. Di bawah ini menunjukkan langkah-langkah yang diselesaikan melalui alur penautan akun dan menunjukkan kapan intent yang berbeda dipanggil:
- Apakah pengguna memiliki akun di sistem otentikasi Anda? (Pengguna memutuskan dengan memilih YA atau TIDAK)
- YA : Apakah pengguna menggunakan email yang terkait dengan Akun Google-nya untuk login ke platform Anda? (Pengguna memutuskan dengan memilih YA atau TIDAK)
- YA : Apakah pengguna memiliki akun yang cocok di sistem autentikasi Anda? (
check intent
dipanggil untuk mengonfirmasi)- YA :
get intent
dipanggil dan akun ditautkan jika intent berhasil ditampilkan. - TIDAK : Buat Akun Baru? (Pengguna memutuskan dengan memilih YA atau TIDAK)
- YA :
create intent
dipanggil dan akun ditautkan jika intent pembuatan berhasil ditampilkan. - TIDAK : Alur Web OAuth dipicu, pengguna diarahkan ke browser, dan pengguna diberi opsi untuk menautkan dengan email yang berbeda.
- YA :
- YA :
- TIDAK : Alur OAuth Web dipicu, pengguna akan diarahkan ke browser, dan pengguna diberi opsi untuk menautkan dengan email yang berbeda.
- YA : Apakah pengguna memiliki akun yang cocok di sistem autentikasi Anda? (
- TIDAK : Apakah pengguna memiliki akun yang cocok di sistem autentikasi Anda? (
check intent
dipanggil untuk mengonfirmasi)- YA :
get intent
dipanggil dan akun ditautkan jika intent berhasil ditampilkan. - TIDAK :
create intent
dipanggil dan akun ditautkan jika intent pembuatan berhasil ditampilkan.
- YA :
- YA : Apakah pengguna menggunakan email yang terkait dengan Akun Google-nya untuk login ke platform Anda? (Pengguna memutuskan dengan memilih YA atau TIDAK)
Memeriksa akun pengguna yang ada (periksa intent)
Setelah pengguna memberikan izin untuk mengakses profil Google miliknya, Google akan mengirimkan yang berisi pernyataan bertanda tangan tentang identitas pengguna Google. Tujuan berisi informasi yang menyertakan ID Akun Google pengguna, nama, dan alamat email. Endpoint pertukaran token yang dikonfigurasi untuk project menangani permintaan tersebut.
Jika Akun Google yang sesuai sudah ada dalam autentikasi Anda
endpoint, endpoint pertukaran token akan merespons dengan account_found=true
. Jika
Akun Google tidak cocok dengan pengguna yang ada, endpoint pertukaran token Anda
menampilkan error HTTP 404 Not Found dengan account_found=false
.
Permintaan tersebut memiliki bentuk berikut:
POST /token HTTP/1.1 Host: oauth2.example.com Content-Type: application/x-www-form-urlencoded grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&intent=check&assertion=JWT&scope=SCOPES&client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET
Endpoint pertukaran token Anda harus dapat menangani parameter berikut:
Parameter endpoint token | |
---|---|
intent |
Untuk permintaan tersebut, nilai parameter ini adalah
check . |
grant_type |
Jenis token yang dipertukarkan. Untuk permintaan tersebut,
parameter memiliki nilai urn:ietf:params:oauth:grant-type:jwt-bearer . |
assertion |
JSON Web Token (JWT) yang menyediakan pernyataan bertanda tangan Google identitas pengguna. JWT berisi informasi yang memasukkan ID, nama, dan alamat email Akun Google. |
client_id |
Client ID yang Anda tetapkan ke Google. |
client_secret |
Rahasia klien yang Anda tetapkan ke Google. |
Untuk merespons permintaan intent check
, endpoint pertukaran token Anda harus melakukan langkah-langkah berikut:
- Validasi dan dekode pernyataan JWT.
- Periksa apakah Akun Google sudah ada dalam sistem autentikasi Anda.
Memvalidasi dan mendekode pernyataan JWT
Anda dapat memvalidasi dan mendekode pernyataan JWT menggunakan Library dekode JWT untuk bahasa Anda. Gunakan Kunci publik Google, tersedia di JWK atau format PEM, untuk memverifikasi tanda tangan token.
Saat didekode, pernyataan JWT akan terlihat seperti contoh berikut:
{ "sub": "1234567890", // The unique ID of the user's Google Account "iss": "https://accounts.google.com", // The assertion's issuer "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID "iat": 233366400, // Unix timestamp of the assertion's creation time "exp": 233370000, // Unix timestamp of the assertion's expiration time "name": "Jan Jansen", "given_name": "Jan", "family_name": "Jansen", "email": "jan@gmail.com", // If present, the user's email address "email_verified": true, // true, if Google has verified the email address "hd": "example.com", // If present, the host domain of the user's GSuite email address // If present, a URL to user's profile picture "picture": "https://lh3.googleusercontent.com/a-/AOh14GjlTnZKHAeb94A-FmEbwZv7uJD986VOF1mJGb2YYQ", "locale": "en_US" // User's locale, from browser or phone settings }
Selain memverifikasi tanda tangan token, verifikasi bahwa token
penerbit (kolom iss
) adalah https://accounts.google.com
, bahwa audiens
(kolom aud
) adalah client ID yang ditetapkan untuk Anda, dan masa berlaku token belum berakhir
(Kolom exp
).
Dengan menggunakan kolom email
, email_verified
, dan hd
, Anda dapat menentukan apakah
Google menghosting dan bersifat otoritatif untuk alamat email. Dalam kasus di mana Google
pengguna yang kredibel saat ini diketahui sebagai pemilik akun yang sah
dan Anda dapat melewati metode
{i>password<i} atau tantangan lainnya. Jika tidak, metode ini
dapat digunakan untuk memverifikasi akun sebelum penautan.
Kasus saat Google bersifat otoritatif:
email
memiliki akhiran@gmail.com
, ini adalah akun Gmail.email_verified
benar danhd
ditetapkan, ini adalah akun G Suite.
Pengguna dapat mendaftar ke Akun Google tanpa menggunakan Gmail atau G Suite. Kapan
email
tidak berisi akhiran @gmail.com
dan hd
tidak ada Google tidak
otoritatif, dan menggunakan {i>password<i}
atau metode verifikasi lainnya disarankan untuk
pengguna. email_verified
juga bisa benar karena Google awalnya memverifikasi
pengguna saat Akun Google dibuat, namun kepemilikan pihak ketiga
akun email Anda mungkin telah berubah.
Periksa apakah Akun Google sudah ada dalam sistem autentikasi Anda
Periksa apakah salah satu kondisi berikut terpenuhi:
- ID Akun Google, yang ada di kolom
sub
pernyataan, berada di pengguna Anda di skrip untuk menyiapkan database. - Alamat email dalam pernyataan cocok dengan pengguna di database pengguna Anda.
Jika salah satu kondisinya benar, pengguna sudah mendaftar. Dalam kasus tersebut, tampilkan respons seperti berikut:
HTTP/1.1 200 Success Content-Type: application/json;charset=UTF-8 { "account_found":"true", }
Jika ID Akun Google atau alamat email tidak disebutkan dalam
cocok dengan pengguna di database Anda, pengguna tersebut belum mendaftar. Di beberapa
dalam kasus ini, endpoint pertukaran token Anda harus membalas dengan error HTTP 404
yang menentukan "account_found": "false"
, seperti dalam contoh berikut:
HTTP/1.1 404 Not found Content-Type: application/json;charset=UTF-8 { "account_found":"false", }
Menangani penautan otomatis (mendapatkan intent)
Setelah pengguna memberikan izin untuk mengakses profil Google miliknya, Google akan mengirimkan yang berisi pernyataan bertanda tangan tentang identitas pengguna Google. Tujuan berisi informasi yang menyertakan ID Akun Google pengguna, nama, dan alamat email. Endpoint pertukaran token yang dikonfigurasi untuk project menangani permintaan tersebut.
Jika Akun Google yang sesuai sudah ada dalam autentikasi Anda
sistem, endpoint pertukaran token akan menampilkan token untuk pengguna. Jika
Akun Google tidak cocok dengan pengguna yang ada, endpoint pertukaran token Anda
menampilkan error linking_error
dan login_hint
opsional.
Permintaan tersebut memiliki bentuk berikut:
POST /token HTTP/1.1 Host: oauth2.example.com Content-Type: application/x-www-form-urlencoded grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&intent=get&assertion=JWT&scope=SCOPES&client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET
Endpoint pertukaran token Anda harus dapat menangani parameter berikut:
Parameter endpoint token | |
---|---|
intent |
Untuk permintaan ini, nilai parameter ini adalah get . |
grant_type |
Jenis token yang dipertukarkan. Untuk permintaan tersebut,
parameter memiliki nilai urn:ietf:params:oauth:grant-type:jwt-bearer . |
assertion |
JSON Web Token (JWT) yang menyediakan pernyataan bertanda tangan Google identitas pengguna. JWT berisi informasi yang memasukkan ID, nama, dan alamat email Akun Google. |
scope |
Opsional: Cakupan apa pun yang diminta oleh Google untuk diminta pelanggan. |
client_id |
Client ID yang Anda tetapkan ke Google. |
client_secret |
Rahasia klien yang Anda tetapkan ke Google. |
Untuk merespons permintaan intent get
, endpoint pertukaran token Anda harus melakukan langkah-langkah berikut:
- Validasi dan dekode pernyataan JWT.
- Periksa apakah Akun Google sudah ada dalam sistem autentikasi Anda.
Memvalidasi dan mendekode pernyataan JWT
Anda dapat memvalidasi dan mendekode pernyataan JWT menggunakan Library dekode JWT untuk bahasa Anda. Gunakan Kunci publik Google, tersedia di JWK atau format PEM, untuk memverifikasi tanda tangan token.
Saat didekode, pernyataan JWT akan terlihat seperti contoh berikut:
{ "sub": "1234567890", // The unique ID of the user's Google Account "iss": "https://accounts.google.com", // The assertion's issuer "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID "iat": 233366400, // Unix timestamp of the assertion's creation time "exp": 233370000, // Unix timestamp of the assertion's expiration time "name": "Jan Jansen", "given_name": "Jan", "family_name": "Jansen", "email": "jan@gmail.com", // If present, the user's email address "email_verified": true, // true, if Google has verified the email address "hd": "example.com", // If present, the host domain of the user's GSuite email address // If present, a URL to user's profile picture "picture": "https://lh3.googleusercontent.com/a-/AOh14GjlTnZKHAeb94A-FmEbwZv7uJD986VOF1mJGb2YYQ", "locale": "en_US" // User's locale, from browser or phone settings }
Selain memverifikasi tanda tangan token, verifikasi bahwa token
penerbit (kolom iss
) adalah https://accounts.google.com
, bahwa audiens
(kolom aud
) adalah client ID yang ditetapkan untuk Anda, dan masa berlaku token belum berakhir
(Kolom exp
).
Dengan menggunakan kolom email
, email_verified
, dan hd
, Anda dapat menentukan apakah
Google menghosting dan bersifat otoritatif untuk alamat email. Dalam kasus di mana Google
pengguna yang kredibel saat ini diketahui sebagai pemilik akun yang sah
dan Anda dapat melewati metode
{i>password<i} atau tantangan lainnya. Jika tidak, metode ini
dapat digunakan untuk memverifikasi akun sebelum penautan.
Kasus saat Google bersifat otoritatif:
email
memiliki akhiran@gmail.com
, ini adalah akun Gmail.email_verified
benar danhd
ditetapkan, ini adalah akun G Suite.
Pengguna dapat mendaftar ke Akun Google tanpa menggunakan Gmail atau G Suite. Kapan
email
tidak berisi akhiran @gmail.com
dan hd
tidak ada Google tidak
otoritatif, dan menggunakan {i>password<i}
atau metode verifikasi lainnya disarankan untuk
pengguna. email_verified
juga bisa benar karena Google awalnya memverifikasi
pengguna saat Akun Google dibuat, namun kepemilikan pihak ketiga
akun email Anda mungkin telah berubah.
Periksa apakah Akun Google sudah ada dalam sistem autentikasi Anda
Periksa apakah salah satu kondisi berikut terpenuhi:
- ID Akun Google, yang ada di kolom
sub
pernyataan, berada di pengguna Anda di skrip untuk menyiapkan database. - Alamat email dalam pernyataan cocok dengan pengguna di database pengguna Anda.
Jika akun ditemukan untuk pengguna, keluarkan token akses dan tampilkan nilai dalam objek JSON dalam isi respons HTTPS Anda, seperti pada contoh berikut:
{ "token_type": "Bearer", "access_token": "ACCESS_TOKEN", "expires_in": SECONDS_TO_EXPIRATION }
Dalam beberapa kasus, penautan akun berdasarkan token ID mungkin gagal bagi pengguna. Jika ya
melakukannya untuk alasan apa pun, endpoint pertukaran token Anda harus membalas dengan
Error 401 yang menentukan error=linking_error
, seperti yang ditampilkan dalam contoh berikut:
HTTP/1.1 401 Unauthorized Content-Type: application/json;charset=UTF-8 { "error":"linking_error", "login_hint":"foo@bar.com" }
Saat menerima respons error 401 dengan linking_error
, Google akan mengirimkan
pengguna ke endpoint otorisasi Anda dengan login_hint
sebagai parameter. Tujuan
pengguna menyelesaikan penautan akun menggunakan alur penautan OAuth di browser mereka.
Handle account creation via Google Sign-In (create intent)
When a user needs to create an account on your service, Google makes a request
to your token exchange endpoint that specifies intent=create
.
The request has the following form:
POST /token HTTP/1.1 Host: oauth2.example.com Content-Type: application/x-www-form-urlencoded response_type=token&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&scope=SCOPES&intent=create&assertion=JWT&client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET
Your token exchange endpoint must able to handle the following parameters:
Token endpoint parameters | |
---|---|
intent |
For these requests, the value of this parameter is create . |
grant_type |
The type of token being exchanged. For these requests, this
parameter has the value urn:ietf:params:oauth:grant-type:jwt-bearer . |
assertion |
A JSON Web Token (JWT) that provides a signed assertion of the Google user's identity. The JWT contains information that includes the user's Google Account ID, name, and email address. |
client_id |
The client ID you assigned to Google. |
client_secret |
The client secret you assigned to Google. |
The JWT within the assertion
parameter contains the user's Google Account ID,
name, and email address, which you can use to create a new account on your
service.
To respond to the create
intent requests, your token exchange endpoint must perform the following steps:
- Validate and decode the JWT assertion.
- Validate user information and create new account.
Memvalidasi dan mendekode pernyataan JWT
Anda dapat memvalidasi dan mendekode pernyataan JWT menggunakan Library dekode JWT untuk bahasa Anda. Gunakan Kunci publik Google, tersedia di JWK atau format PEM, untuk memverifikasi tanda tangan token.
Saat didekode, pernyataan JWT akan terlihat seperti contoh berikut:
{ "sub": "1234567890", // The unique ID of the user's Google Account "iss": "https://accounts.google.com", // The assertion's issuer "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID "iat": 233366400, // Unix timestamp of the assertion's creation time "exp": 233370000, // Unix timestamp of the assertion's expiration time "name": "Jan Jansen", "given_name": "Jan", "family_name": "Jansen", "email": "jan@gmail.com", // If present, the user's email address "email_verified": true, // true, if Google has verified the email address "hd": "example.com", // If present, the host domain of the user's GSuite email address // If present, a URL to user's profile picture "picture": "https://lh3.googleusercontent.com/a-/AOh14GjlTnZKHAeb94A-FmEbwZv7uJD986VOF1mJGb2YYQ", "locale": "en_US" // User's locale, from browser or phone settings }
Selain memverifikasi tanda tangan token, verifikasi bahwa token
penerbit (kolom iss
) adalah https://accounts.google.com
, bahwa audiens
(kolom aud
) adalah client ID yang ditetapkan untuk Anda, dan masa berlaku token belum berakhir
(Kolom exp
).
Dengan menggunakan kolom email
, email_verified
, dan hd
, Anda dapat menentukan apakah
Google menghosting dan bersifat otoritatif untuk alamat email. Dalam kasus di mana Google
pengguna yang kredibel saat ini diketahui sebagai pemilik akun yang sah
dan Anda dapat melewati metode
{i>password<i} atau tantangan lainnya. Jika tidak, metode ini
dapat digunakan untuk memverifikasi akun sebelum penautan.
Kasus saat Google bersifat otoritatif:
email
memiliki akhiran@gmail.com
, ini adalah akun Gmail.email_verified
benar danhd
ditetapkan, ini adalah akun G Suite.
Pengguna dapat mendaftar ke Akun Google tanpa menggunakan Gmail atau G Suite. Kapan
email
tidak berisi akhiran @gmail.com
dan hd
tidak ada Google tidak
otoritatif, dan menggunakan {i>password<i}
atau metode verifikasi lainnya disarankan untuk
pengguna. email_verified
juga bisa benar karena Google awalnya memverifikasi
pengguna saat Akun Google dibuat, namun kepemilikan pihak ketiga
akun email Anda mungkin telah berubah.
Validate user information and create new account
Check whether either of the following conditions are true:
- The Google Account ID, found in the assertion's
sub
field, is in your user database. - The email address in the assertion matches a user in your user database.
If either condition is true, prompt the user to link their existing account
with their Google Account. To do so, respond to the request with an HTTP 401 error
that specifies error=linking_error
and gives the user's email address as the
login_hint
. The following is a sample response:
HTTP/1.1 401 Unauthorized Content-Type: application/json;charset=UTF-8 { "error":"linking_error", "login_hint":"foo@bar.com" }
When Google receives a 401 error response with linking_error
, Google sends
the user to your authorization endpoint with login_hint
as a parameter. The
user completes account linking using the OAuth linking flow in their browser.
If neither condition is true, create a new user account with the information provided in the JWT. New accounts don't typically have a password set. It's recommended that you add Google Sign-In to other platforms to enable users to log in with Google across the surfaces of your application. Alternatively, you can email the user a link that starts your password recovery flow to allow the user to set a password to sign in on other platforms.
When the creation is completed, issue an access token and return the values in a JSON object in the body of your HTTPS response, like in the following example:
{ "token_type": "Bearer", "access_token": "ACCESS_TOKEN", "expires_in": SECONDS_TO_EXPIRATION }
Mendapatkan Client ID Google API
Anda akan diminta untuk memberikan Client ID Google API selama proses pendaftaran Penautan Akun.
Untuk mendapatkan Client ID API menggunakan project yang Anda buat saat menyelesaikan langkah-langkah Penautan OAuth. Caranya, selesaikan langkah-langkah berikut:
- Buka halaman Credentials pada Konsol API Google.
Buat atau pilih project Google API.
Jika proyek Anda tidak memiliki Client-ID untuk Jenis aplikasi Web, klik Buat kredensial > Client ID OAuth untuk membuatnya. Pastikan untuk menyertakan domain situs Anda di kotak Asal JavaScript yang sah. Saat Anda melakukan pengujian lokal atau pengembangan, Anda harus menambahkan
http://localhost
danhttp://localhost:<port_number>
ke kolom Asal JavaScript yang sah.
Memvalidasi implementasi
Anda dapat memvalidasi implementasi Anda dengan menggunakan OAuth 2.0 Playground alat.
Pada alat, lakukan langkah-langkah berikut:
- Klik Konfigurasi untuk membuka jendela Configuration OAuth 2.0.
- Di bidang aliran OAuth, pilih Client-side.
- Di bidang OAuth endpoint, pilih Custom.
- Tentukan titik akhir OAuth 2.0 dan ID klien yang Anda tetapkan ke Google di bidang yang sesuai.
- Pada bagian Langkah 1, tidak memilih lingkup Google. Sebagai gantinya, biarkan bidang ini kosong atau ketik cakupan yang valid untuk server Anda (atau string arbitrer jika Anda tidak menggunakan cakupan OAuth). Setelah selesai, klik Otorisasi API.
- Dalam Langkah 2 dan Langkah 3 bagian, melalui aliran OAuth 2.0 dan memverifikasi bahwa setiap langkah bekerja sebagaimana dimaksud.
Anda dapat memvalidasi implementasi Anda dengan menggunakan Akun Google Menghubungkan Demo alat.
Pada alat, lakukan langkah-langkah berikut:
- Klik Sign-in dengan tombol Google.
- Pilih akun yang ingin Anda tautkan.
- Masukkan ID layanan.
- Secara opsional, masukkan satu atau beberapa cakupan yang akan Anda minta aksesnya.
- Klik Mulai Demo.
- Saat diminta, konfirmasikan bahwa Anda dapat menyetujui dan menolak permintaan penautan.
- Konfirmasikan bahwa Anda dialihkan ke platform Anda.