Penautan yang Disederhanakan dengan OAuth dan Login dengan Google

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:

  1. Pertama, minta pengguna untuk memberikan izin agar dapat mengakses profil Google miliknya.
  2. Menggunakan informasi di profil mereka untuk memeriksa apakah akun pengguna ada.
  3. Untuk pengguna yang sudah ada, tautkan akun.
  4. 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 ini menunjukkan langkah-langkah bagi pengguna untuk menautkan Akun Google mereka menggunakan alur penautan yang disederhanakan. Screenshot pertama menunjukkan cara pengguna dapat memilih aplikasi Anda untuk ditautkan. Screenshot kedua memungkinkan pengguna mengonfirmasi apakah mereka sudah memiliki akun di layanan Anda atau tidak. Screenshot ketiga memungkinkan pengguna memilih Akun Google yang ingin mereka tautkan. Screenshot keempat menampilkan konfirmasi untuk menautkan Akun Google mereka dengan aplikasi Anda. Screenshot kelima menampilkan akun pengguna yang berhasil ditautkan di aplikasi Google.

Gambar 1. Penautan Akun di ponsel pengguna dengan Penautan yang Disederhanakan

Persyaratan untuk Penautan yang Disederhanakan

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:

  1. Apakah pengguna memiliki akun di sistem otentikasi Anda? (Pengguna memutuskan dengan memilih YA atau TIDAK)
    1. YA : Apakah pengguna menggunakan email yang terkait dengan Akun Google-nya untuk login ke platform Anda? (Pengguna memutuskan dengan memilih YA atau TIDAK)
      1. YA : Apakah pengguna memiliki akun yang cocok di sistem autentikasi Anda? (check intent dipanggil untuk mengonfirmasi)
        1. YA : get intent dipanggil dan akun ditautkan jika intent berhasil ditampilkan.
        2. TIDAK : Buat Akun Baru? (Pengguna memutuskan dengan memilih YA atau TIDAK)
          1. YA : create intent dipanggil dan akun ditautkan jika intent pembuatan berhasil ditampilkan.
          2. TIDAK : Alur Web OAuth dipicu, pengguna diarahkan ke browser, dan pengguna diberi opsi untuk menautkan dengan email yang berbeda.
      2. TIDAK : Alur OAuth Web dipicu, pengguna akan diarahkan ke browser, dan pengguna diberi opsi untuk menautkan dengan email yang berbeda.
    2. TIDAK : Apakah pengguna memiliki akun yang cocok di sistem autentikasi Anda? (check intent dipanggil untuk mengonfirmasi)
      1. YA : get intent dipanggil dan akun ditautkan jika intent berhasil ditampilkan.
      2. TIDAK : create intent dipanggil dan akun ditautkan jika intent pembuatan berhasil ditampilkan.

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 dan hd 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 dan hd 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.

Menangani pembuatan akun melalui Login dengan Google (membuat intent)

Jika pengguna perlu membuat akun di layanan Anda, Google akan membuat permintaan ke endpoint pertukaran token yang menentukan intent=create.

Permintaan tersebut memiliki bentuk berikut:

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

Endpoint pertukaran token Anda harus dapat menangani parameter berikut:

Parameter endpoint token
intent Untuk permintaan ini, nilai parameter ini adalah create.
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.

JWT dalam parameter assertion berisi ID Akun Google pengguna, nama, dan alamat email Anda, yang dapat Anda gunakan untuk membuat akun baru di layanan.

Untuk merespons permintaan intent create, endpoint pertukaran token Anda harus melakukan langkah-langkah berikut:

  • Validasi dan dekode pernyataan JWT.
  • Validasi informasi pengguna dan buat akun baru.
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 dan hd 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.

Memvalidasi informasi pengguna dan membuat akun baru

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, minta pengguna untuk menautkan akun miliknya yang sudah ada menggunakan Akun Google mereka. Untuk melakukannya, respons permintaan dengan error HTTP 401 yang menentukan error=linking_error dan memberikan alamat email pengguna sebagai login_hint. Berikut adalah contoh respons:

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.

Jika tidak ada kondisi yang benar, buat akun pengguna baru dengan informasi tersebut yang disediakan di JWT. Akun baru biasanya tidak diberi sandi. Penting menyarankan agar Anda menambahkan Login dengan Google ke platform lain untuk memungkinkan pengguna login dengan Google di seluruh platform aplikasi Anda. Atau, Anda dapat dapat mengirimkan email kepada pengguna berisi tautan yang memulai alur pemulihan {i>password<i} Anda untuk memungkinkan pengguna untuk mengatur {i>password<i} agar dapat masuk di platform lain.

Setelah pembuatan selesai, keluarkan token akses , lalu tampilkan nilai dalam objek JSON di isi respons HTTPS, seperti dalam contoh berikut: 

{
  "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:

  1. Buka halaman Credentials pada Konsol API Google.

  2. 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 dan http://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:

  1. Klik Konfigurasi untuk membuka jendela Configuration OAuth 2.0.
  2. Di bidang aliran OAuth, pilih Client-side.
  3. Di bidang OAuth endpoint, pilih Custom.
  4. Tentukan titik akhir OAuth 2.0 dan ID klien yang Anda tetapkan ke Google di bidang yang sesuai.
  5. 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.
  6. 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:

  1. Klik Sign-in dengan tombol Google.
  2. Pilih akun yang ingin Anda tautkan.
  3. Masukkan ID layanan.
  4. Secara opsional, masukkan satu atau beberapa cakupan yang akan Anda minta aksesnya.
  5. Klik Mulai Demo.
  6. Saat diminta, konfirmasikan bahwa Anda dapat menyetujui dan menolak permintaan penautan.
  7. Konfirmasikan bahwa Anda dialihkan ke platform Anda.