OpenID Connect

API OAuth 2.0 Google dapat digunakan untuk autentikasi dan otorisasi. Dokumen ini menjelaskan implementasi OAuth 2.0 kami untuk autentikasi, yang sesuai dengan spesifikasi OpenID Connect, dan Tersertifikasi OpenID. Dokumentasi yang ada di Menggunakan OAuth 2.0 untuk Mengakses Google API juga berlaku untuk layanan ini. Jika Anda ingin mempelajari protokol ini secara interaktif, sebaiknya gunakan Google OAuth 2.0 Playground. Untuk mendapatkan bantuan terkait Stack Overflow, beri tag pertanyaan Anda dengan 'google-oauth'.

Menyiapkan OAuth 2.0

Sebelum aplikasi Anda dapat menggunakan sistem autentikasi OAuth 2.0 Google untuk login pengguna, Anda harus menyiapkan project di Google API Console untuk mendapatkan kredensial OAuth 2.0, menetapkan URI pengalihan, dan (opsional) menyesuaikan informasi branding yang dilihat pengguna pada layar izin pengguna. Anda juga dapat menggunakan API Console untuk membuat akun layanan, mengaktifkan penagihan, menyiapkan pemfilteran, dan melakukan tugas lainnya. Untuk detail selengkapnya, lihat Bantuan Google API Console.

Mendapatkan kredensial OAuth 2.0

Anda memerlukan kredensial OAuth 2.0, termasuk client ID dan rahasia klien, untuk mengautentikasi pengguna dan mendapatkan akses ke API Google.

Untuk melihat ID klien dan rahasia klien untuk kredensial OAuth 2.0 yang diberikan, klik teks berikut: Pilih kredensial . Di jendela yang terbuka, pilih proyek Anda dan kredensial yang Anda inginkan, lalu klik Lihat .

Atau, lihat ID klien Anda dan rahasia klien dari halaman Kredensial di API Console :

  1. Go to the Credentials page.
  2. Klik nama kredensial Anda atau ikon pensil ( ). ID dan rahasia klien Anda ada di bagian atas halaman.

Menetapkan URI pengalihan

URI pengalihan yang Anda tetapkan di API Console akan menentukan tujuan Google mengirimkan respons ke permintaan autentikasi Anda.

Untuk membuat, melihat, atau mengedit URI redirect untuk kredensial OAuth 2.0 yang diberikan, lakukan hal berikut:

  1. Go to the Credentials page.
  2. Di bagian OAuth 2.0 klien ID halaman, klik kredensial.
  3. Lihat atau edit URI pengalihan.

Jika tidak ada bagian ID klien OAuth 2.0 di halaman Kredensial, maka proyek Anda tidak memiliki kredensial OAuth. Untuk membuatnya, klik Buat kredensial .

Menyesuaikan layar izin pengguna

Untuk pengguna Anda, pengalaman autentikasi OAuth 2.0 menyertakan layar izin yang menjelaskan informasi yang dirilis pengguna dan persyaratan yang berlaku. Misalnya, saat login, pengguna mungkin diminta untuk memberi aplikasi Anda akses ke alamat email dan informasi dasar akun mereka. Anda meminta akses ke informasi ini menggunakan parameter scope, yang disertakan aplikasi Anda dalam permintaan autentikasi. Anda juga dapat menggunakan cakupan untuk meminta akses ke Google API lainnya.

Layar izin pengguna juga menampilkan informasi branding seperti nama produk, logo, dan URL halaman beranda. Anda mengontrol informasi branding di API Console.

Untuk mengaktifkan layar persetujuan proyek Anda:

  1. Buka Consent Screen page di Google API Console .
  2. If prompted, select a project, or create a new one.
  3. Isi formulir dan klik Simpan .

Dialog izin berikut menunjukkan hal yang akan dilihat pengguna jika kombinasi cakupan OAuth 2.0 dan Google Drive ada dalam permintaan. (Dialog umum ini dibuat menggunakan Google OAuth 2.0 Playground, sehingga tidak menyertakan informasi branding yang akan ditetapkan di API Console.)

Screenshot halaman izin

Mengakses layanan

Google dan pihak ketiga menyediakan library yang dapat Anda gunakan untuk menangani berbagai detail implementasi terkait autentikasi pengguna dan mendapatkan akses ke Google API. Contohnya mencakup Layanan Identitas Google dan library klien Google, yang tersedia untuk berbagai platform.

Jika Anda memilih untuk tidak menggunakan library, ikuti petunjuk di bagian selanjutnya dari dokumen ini, yang menjelaskan alur permintaan HTTP yang mendasari library yang tersedia.

Mengautentikasi pengguna

Mengautentikasi pengguna melibatkan perolehan token ID dan memvalidasinya. Token ID adalah fitur standar dari OpenID Connect yang dirancang untuk digunakan dalam berbagi pernyataan identitas di internet.

Pendekatan yang paling umum digunakan untuk mengautentikasi pengguna dan mendapatkan token ID disebut alur "server" dan alur "implicit". Alur server memungkinkan server back-end aplikasi memverifikasi identitas orang tersebut menggunakan browser atau perangkat seluler. Alur implisit digunakan saat aplikasi sisi klien (biasanya aplikasi JavaScript yang berjalan di browser) perlu mengakses API secara langsung, bukan melalui server back-end-nya.

Dokumen ini menjelaskan cara melakukan alur server untuk mengautentikasi pengguna. Alur implisit menjadi jauh lebih rumit karena adanya risiko keamanan dalam menangani dan menggunakan token pada sisi klien. Jika Anda perlu mengimplementasikan alur implisit, sebaiknya gunakan Layanan Identitas Google.

Alur server

Pastikan Anda menyiapkan aplikasi di API Console agar dapat menggunakan protokol ini dan mengautentikasi pengguna. Saat pengguna mencoba login dengan Google, Anda perlu:

  1. Membuat token status anti-pemalsuan
  2. Mengirim permintaan autentikasi ke Google
  3. Mengonfirmasi token status anti-pemalsuan
  4. Tukar code untuk token akses dan token ID
  5. Mendapatkan informasi pengguna dari token ID
  6. Mengautentikasi pengguna

1. Membuat token status anti-pemalsuan

Anda harus melindungi keamanan pengguna dengan mencegah serangan pemalsuan permintaan. Langkah pertama adalah membuat token sesi unik yang menyimpan status antara aplikasi Anda dan klien pengguna. Kemudian, Anda akan mencocokkan token sesi unik ini dengan respons autentikasi yang ditampilkan oleh layanan Login Google OAuth untuk memverifikasi bahwa pengguna yang membuat permintaan dan bukan penyerang berbahaya. Token ini sering disebut sebagai token pemalsuan permintaan lintas situs (CSRF).

Salah satu pilihan yang tepat untuk token status adalah string berisi 30 karakter atau lebih yang dibuat menggunakan generator angka acak berkualitas tinggi. Lainnya adalah hash yang dihasilkan dengan menandatangani beberapa variabel status sesi dengan kunci yang dirahasiakan di back-end Anda.

Kode berikut menunjukkan pembuatan token sesi unik.

PHP

Anda harus mendownload library klien Google API untuk PHP agar dapat menggunakan contoh ini.

// Create a state token to prevent request forgery.
// Store it in the session for later validation.
$state = bin2hex(random_bytes(128/8));
$app['session']->set('state', $state);
// Set the client ID, token state, and application name in the HTML while
// serving it.
return $app['twig']->render('index.html', array(
    'CLIENT_ID' => CLIENT_ID,
    'STATE' => $state,
    'APPLICATION_NAME' => APPLICATION_NAME
));

Java

Anda harus mendownload library klien Google API untuk Java agar dapat menggunakan contoh ini.

// Create a state token to prevent request forgery.
// Store it in the session for later validation.
String state = new BigInteger(130, new SecureRandom()).toString(32);
request.session().attribute("state", state);
// Read index.html into memory, and set the client ID,
// token state, and application name in the HTML before serving it.
return new Scanner(new File("index.html"), "UTF-8")
    .useDelimiter("\\A").next()
    .replaceAll("[{]{2}\\s*CLIENT_ID\\s*[}]{2}", CLIENT_ID)
    .replaceAll("[{]{2}\\s*STATE\\s*[}]{2}", state)
    .replaceAll("[{]{2}\\s*APPLICATION_NAME\\s*[}]{2}",
    APPLICATION_NAME);

Python

Anda harus mendownload library klien Google API untuk Python agar dapat menggunakan contoh ini.

# Create a state token to prevent request forgery.
# Store it in the session for later validation.
state = hashlib.sha256(os.urandom(1024)).hexdigest()
session['state'] = state
# Set the client ID, token state, and application name in the HTML while
# serving it.
response = make_response(
    render_template('index.html',
                    CLIENT_ID=CLIENT_ID,
                    STATE=state,
                    APPLICATION_NAME=APPLICATION_NAME))

2. Mengirim permintaan autentikasi ke Google

Langkah berikutnya adalah membuat permintaan GET HTTPS dengan parameter URI yang sesuai. Perhatikan penggunaan HTTPS, bukan HTTP di semua langkah proses ini; koneksi HTTP ditolak. Anda harus mengambil URI dasar dari Dokumen penemuan menggunakan nilai metadata authorization_endpoint. Diskusi berikut mengasumsikan URI dasar adalah https://accounts.google.com/o/oauth2/v2/auth.

Untuk permintaan dasar, tentukan parameter berikut:

  • client_id, yang Anda dapatkan dari API Console Credentials page .
  • response_type, yang dalam permintaan alur kode otorisasi dasar harus berupa code. (Baca selengkapnya di response_type.)
  • scope, yang dalam permintaan dasar harus berupa openid email. (Baca selengkapnya di scope.)
  • redirect_uri harus menjadi endpoint HTTP di server Anda yang akan menerima respons dari Google. Nilai harus sama persis dengan salah satu URI pengalihan yang diberi otorisasi untuk klien OAuth 2.0, yang Anda konfigurasi di API Console Credentials page. Jika nilai ini tidak cocok dengan URI yang diberi otorisasi, permintaan akan gagal dengan error redirect_uri_mismatch.
  • state harus menyertakan nilai token sesi unik anti-pemalsuan, serta informasi lain apa pun yang diperlukan untuk memulihkan konteks saat pengguna kembali ke aplikasi Anda, misalnya, URL awal. (Baca selengkapnya di state.)
  • nonce adalah nilai acak yang dihasilkan oleh aplikasi Anda yang memungkinkan perlindungan replay saat ada.
  • login_hint dapat berupa alamat email pengguna atau string sub, yang setara dengan ID Google pengguna. Jika Anda tidak memberikan login_hint dan pengguna saat ini login, layar izin akan menyertakan permintaan persetujuan untuk merilis alamat email pengguna ke aplikasi Anda. (Baca selengkapnya di login_hint.)
  • Gunakan parameter hd untuk mengoptimalkan alur OpenID Connect bagi pengguna domain tertentu yang terkait dengan organisasi Google Cloud. (Baca selengkapnya di hd.)

Berikut adalah contoh URI autentikasi OpenID Connect yang lengkap, dengan jeda baris dan spasi agar mudah dibaca:

https://accounts.google.com/o/oauth2/v2/auth?
 response_type=code&
 client_id=424911365001.apps.googleusercontent.com&
 scope=openid%20email&
 redirect_uri=https%3A//oauth2.example.com/code&
 state=security_token%3D138r5719ru3e1%26url%3Dhttps%3A%2F%2Foauth2-login-demo.example.com%2FmyHome&
 login_hint=jsmith@example.com&
 nonce=0394852-3190485-2490358&
 hd=example.com

Pengguna wajib memberikan izin jika aplikasi Anda meminta informasi baru tentang mereka, atau jika aplikasi Anda meminta akses akun yang belum mereka setujui sebelumnya.

3. Konfirmasi token status anti-pemalsuan

Respons akan dikirim ke redirect_uri yang Anda tentukan dalam permintaan. Semua respons ditampilkan dalam string kueri, seperti ditunjukkan di bawah ini:

https://oauth2.example.com/code?state=security_token%3D138r5719ru3e1%26url%3Dhttps%3A%2F%2Foa2cb.example.com%2FmyHome&code=4/P7q7W91a-oMsCeLvIaQm6bTrgtp7&scope=openid%20email%20https://www.googleapis.com/auth/userinfo.email

Di server, Anda harus mengonfirmasi bahwa state yang diterima dari Google cocok dengan token sesi yang Anda buat di Langkah 1. Verifikasi dua arah ini membantu memastikan bahwa pengguna yang membuat permintaan, bukan skrip berbahaya.

Kode berikut menunjukkan konfirmasi token sesi yang Anda buat di Langkah 1:

PHP

Anda harus mendownload library klien Google API untuk PHP agar dapat menggunakan contoh ini.

// Ensure that there is no request forgery going on, and that the user
// sending us this connect request is the user that was supposed to.
if ($request->get('state') != ($app['session']->get('state'))) {
  return new Response('Invalid state parameter', 401);
}

Java

Anda harus mendownload library klien Google API untuk Java agar dapat menggunakan contoh ini.

// Ensure that there is no request forgery going on, and that the user
// sending us this connect request is the user that was supposed to.
if (!request.queryParams("state").equals(
    request.session().attribute("state"))) {
  response.status(401);
  return GSON.toJson("Invalid state parameter.");
}

Python

Anda harus mendownload library klien Google API untuk Python agar dapat menggunakan contoh ini.

# Ensure that the request is not a forgery and that the user sending
# this connect request is the expected user.
if request.args.get('state', '') != session['state']:
  response = make_response(json.dumps('Invalid state parameter.'), 401)
  response.headers['Content-Type'] = 'application/json'
  return response

4. Tukarkan code dengan token akses dan token ID

Responsnya mencakup parameter code, kode otorisasi sekali pakai yang dapat ditukar oleh server Anda dengan token akses dan token ID. Server Anda membuat pertukaran ini dengan mengirimkan permintaan POST HTTPS. Permintaan POST dikirim ke endpoint token, yang harus Anda ambil dari Dokumen penemuan menggunakan nilai metadata token_endpoint. Diskusi berikut mengasumsikan endpoint-nya adalah https://oauth2.googleapis.com/token. Permintaan harus menyertakan parameter berikut dalam isi POST:

Kolom
code Kode otorisasi yang ditampilkan dari permintaan awal.
client_id Client ID yang Anda peroleh dari API Console Credentials page, seperti yang dijelaskan dalam Mendapatkan kredensial OAuth 2.0.
client_secret Rahasia klien yang Anda peroleh dari API Console Credentials page, seperti yang dijelaskan dalam Mendapatkan kredensial OAuth 2.0.
redirect_uri URI pengalihan yang diotorisasi untuk client_id tertentu yang ditentukan dalam API Console Credentials page, seperti yang dijelaskan dalam Menetapkan URI pengalihan.
grant_type Kolom ini harus berisi nilai authorization_code, seperti yang ditentukan dalam spesifikasi OAuth 2.0.

Permintaan yang sebenarnya mungkin terlihat seperti contoh berikut:

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

code=4/P7q7W91a-oMsCeLvIaQm6bTrgtp7&
client_id=your-client-id&
client_secret=your-client-secret&
redirect_uri=https%3A//oauth2.example.com/code&
grant_type=authorization_code

Respons yang berhasil terhadap permintaan ini akan berisi kolom berikut dalam array JSON:

Kolom
access_token Token yang dapat dikirim ke Google API.
expires_in Sisa masa berlaku token akses dalam hitungan detik.
id_token JWT yang berisi informasi identitas tentang pengguna yang ditandatangani secara digital oleh Google.
scope Cakupan akses yang diberikan oleh access_token yang dinyatakan sebagai daftar string yang dipisahkan spasi dan peka huruf besar/kecil.
token_type Mengidentifikasi jenis token yang ditampilkan. Saat ini, kolom ini selalu memiliki nilai Bearer.
refresh_token (opsional)

Kolom ini hanya ada jika parameter access_type ditetapkan ke offline dalam permintaan autentikasi. Untuk mengetahui detailnya, baca Token refresh.

5. Mendapatkan informasi pengguna dari token ID

Token ID adalah JWT (Token Web JSON), yaitu objek JSON yang dienkode menggunakan Base64 yang ditandatangani secara kriptografis. Biasanya, Anda harus memvalidasi token ID sebelum menggunakannya, tetapi karena Anda berkomunikasi langsung dengan Google melalui saluran HTTPS bebas perantara dan menggunakan rahasia klien untuk mengautentikasi diri Anda ke Google, dapat dipastikan bahwa token yang Anda terima benar-benar berasal dari Google dan valid. Jika server Anda meneruskan token ID ke komponen lain aplikasi Anda, komponen lain harus memvalidasi token sebelum menggunakannya.

Karena sebagian besar library API menggabungkan validasi dengan tugas mendekode nilai berenkode base64url dan mengurai JSON di dalamnya, Anda mungkin akan tetap memvalidasi token saat mengakses klaim dalam token ID.

Payload token ID

Token ID adalah objek JSON yang berisi serangkaian pasangan nama/nilai. Berikut ini contoh, yang diformat agar mudah dibaca:

{
  "iss": "https://accounts.google.com",
  "azp": "1234987819200.apps.googleusercontent.com",
  "aud": "1234987819200.apps.googleusercontent.com",
  "sub": "10769150350006150715113082367",
  "at_hash": "HK6E_P6Dh8Y93mRNtsDB1Q",
  "hd": "example.com",
  "email": "jsmith@example.com",
  "email_verified": "true",
  "iat": 1353601026,
  "exp": 1353604926,
  "nonce": "0394852-3190485-2490358"
}

Token ID Google dapat berisi kolom berikut (dikenal sebagai claims):

Klaim Tersedia Deskripsi
aud selalu Audiens yang dituju oleh token ID ini. ID ini harus berupa salah satu client ID OAuth 2.0 aplikasi Anda.
exp selalu Waktu habis masa berlaku saat atau setelahnya token ID tidak boleh diterima. Direpresentasikan dalam waktu Unix (detik integer).
iat selalu Waktu token ID dikeluarkan. Direpresentasikan dalam waktu Unix (detik bilangan bulat).
iss selalu ID Penerbit untuk Penerbit respons. Selalu https://accounts.google.com atau accounts.google.com untuk token ID Google.
sub selalu ID untuk pengguna, unik di antara semua Akun Google, dan tidak pernah digunakan kembali. Akun Google dapat memiliki beberapa alamat email pada waktu yang berbeda, tetapi nilai sub tidak pernah berubah. Gunakan sub dalam aplikasi Anda sebagai kunci ID unik untuk pengguna. Panjang maksimum 255 karakter ASCII yang peka huruf besar/kecil.
at_hash Hash token akses. Memberikan validasi bahwa token akses terkait dengan token identitas. Jika token ID dikeluarkan dengan nilai access_token dalam alur server, klaim ini selalu disertakan. Klaim ini dapat digunakan sebagai mekanisme alternatif untuk memberikan perlindungan dari serangan pemalsuan permintaan lintas situs, tetapi jika Anda mengikuti Langkah 1 dan Langkah 3, Anda tidak perlu memverifikasi token akses.
azp client_id presenter yang diotorisasi. Klaim ini hanya diperlukan jika pihak yang meminta token ID tidak sama dengan audience token ID. Hal ini mungkin terjadi di Google untuk aplikasi hybrid jika aplikasi web dan aplikasi Android memiliki client_id OAuth 2.0 yang berbeda, tetapi memiliki project Google API yang sama.
email Alamat email pengguna. Nilai ini mungkin tidak unik untuk pengguna ini dan tidak cocok untuk digunakan sebagai kunci utama. Hanya diberikan jika cakupan Anda menyertakan nilai cakupan email.
email_verified True jika alamat email pengguna telah diverifikasi; jika tidak, salah.
family_name Nama belakang atau nama belakang pengguna. Mungkin diberikan jika ada klaim name.
given_name Nama depan atau nama depan pengguna. Mungkin diberikan jika ada klaim name.
hd Domain yang terkait dengan organisasi Google Cloud pengguna. Hanya diberikan jika pengguna adalah bagian dari organisasi Google Cloud.
locale Lokalitas pengguna, diwakili oleh tag bahasa BCP 47. Mungkin diberikan saat ada klaim name.
name Nama lengkap pengguna, dalam bentuk yang dapat ditampilkan. Mungkin diberikan jika:
  • Cakupan permintaan menyertakan string "profile"
  • Token ID ditampilkan dari refresh token

Jika ada klaim name, Anda dapat menggunakannya untuk memperbarui data pengguna aplikasi. Perhatikan bahwa klaim ini tidak pernah dijamin akan ada.

nonce Nilai nonce yang diberikan oleh aplikasi Anda dalam permintaan autentikasi. Anda harus menerapkan perlindungan terhadap serangan replay dengan memastikannya hanya ditampilkan sekali.
picture URL foto profil pengguna. Mungkin diberikan jika:
  • Cakupan permintaan menyertakan string "profile"
  • Token ID ditampilkan dari refresh token

Jika ada klaim picture, Anda dapat menggunakannya untuk memperbarui data pengguna aplikasi. Perhatikan bahwa klaim ini tidak pernah dijamin akan ada.

profile URL halaman profil pengguna. Mungkin diberikan jika:
  • Cakupan permintaan menyertakan string "profile"
  • Token ID ditampilkan dari refresh token

Jika ada klaim profile, Anda dapat menggunakannya untuk memperbarui data pengguna aplikasi. Perhatikan bahwa klaim ini tidak pernah dijamin akan ada.

6. Mengautentikasi pengguna

Setelah mendapatkan informasi pengguna dari token ID, Anda harus membuat kueri database pengguna aplikasi Anda. Jika pengguna sudah ada dalam database, Anda harus memulai sesi aplikasi untuk pengguna tersebut jika semua persyaratan login terpenuhi oleh respons Google API.

Jika pengguna tidak ada dalam database pengguna, Anda harus mengalihkan pengguna ke alur pendaftaran pengguna baru. Anda mungkin dapat mendaftarkan pengguna secara otomatis berdasarkan informasi yang Anda terima dari Google, atau setidaknya Anda dapat mengisi otomatis banyak kolom yang diperlukan pada formulir pendaftaran. Selain informasi dalam token ID, Anda bisa mendapatkan informasi profil pengguna tambahan di endpoint profil pengguna kami.

Topik lanjutan

Bagian berikut menjelaskan Google OAuth 2.0 API secara lebih mendetail. Informasi ini ditujukan bagi developer yang memiliki persyaratan lanjutan seputar autentikasi dan otorisasi.

Akses ke Google API lainnya

Salah satu keuntungan menggunakan OAuth 2.0 untuk autentikasi adalah aplikasi Anda dapat memperoleh izin untuk menggunakan Google API lain atas nama pengguna (seperti YouTube, Google Drive, Kalender, atau Kontak) bersamaan dengan mengautentikasi pengguna. Untuk melakukannya, sertakan cakupan lain yang Anda perlukan dalam permintaan autentikasi yang Anda kirim ke Google. Misalnya, untuk menambahkan kelompok usia pengguna ke permintaan autentikasi, teruskan parameter cakupan openid email https://www.googleapis.com/auth/profile.agerange.read. Pengguna akan dimintai dengan tepat pada layar izin. Token akses yang Anda terima kembali dari Google memungkinkan Anda mengakses semua API yang terkait dengan cakupan akses yang Anda minta dan diberikan.

Token refresh

Dalam permintaan untuk akses API, Anda dapat meminta token refresh agar ditampilkan selama penukaran code. Token refresh memberi aplikasi Anda akses berkelanjutan ke Google API saat pengguna tidak ada dalam aplikasi Anda. Untuk meminta token refresh, tambahkan parameter access_type ke offline dalam permintaan autentikasi Anda.

Pertimbangan:

  • Pastikan untuk menyimpan token refresh dengan aman dan permanen, karena Anda hanya bisa mendapatkan token refresh saat pertama kali melakukan alur pertukaran kode.
  • Ada batasan jumlah token refresh yang dikeluarkan: satu batas per kombinasi klien/pengguna, dan satu batas per pengguna untuk seluruh klien. Jika aplikasi Anda meminta terlalu banyak token refresh, aplikasi tersebut dapat mencapai batas ini, dalam hal ini token refresh yang lebih lama akan berhenti berfungsi.

Untuk mengetahui informasi selengkapnya, baca Memuat ulang token akses (akses offline).

Anda dapat meminta pengguna untuk memberikan otorisasi ulang aplikasi dengan menetapkan parameter prompt ke consent dalam permintaan autentikasi. Jika prompt=consent disertakan, layar izin akan ditampilkan setiap kali aplikasi meminta otorisasi cakupan akses, meskipun semua cakupan sebelumnya telah diberikan ke project Google API Anda. Karena alasan ini, sertakan prompt=consent hanya jika diperlukan.

Untuk mengetahui parameter prompt selengkapnya, lihat prompt dalam tabel Parameter URI Authentication.

Parameter URI Autentikasi

Tabel berikut memberikan deskripsi yang lebih lengkap tentang parameter yang diterima oleh API autentikasi OAuth 2.0 Google.

Parameter Wajib Deskripsi
client_id (Wajib diisi) String client ID yang Anda peroleh dari API Console Credentials page, seperti yang dijelaskan dalam Mendapatkan kredensial OAuth 2.0.
nonce (Wajib diisi) Nilai acak yang dibuat oleh aplikasi Anda yang memungkinkan perlindungan replay.
response_type (Wajib diisi) Jika nilainya code, akan meluncurkan Alur kode otorisasi dasar, yang memerlukan POST ke endpoint token untuk mendapatkan token. Jika nilainya token id_token atau id_token token, akan meluncurkan Implicit flow, yang mewajibkan penggunaan JavaScript pada URI pengalihan untuk mengambil token dari ID #fragment URI.
redirect_uri (Wajib diisi) Menentukan tujuan pengiriman respons. Nilai parameter ini harus sama persis dengan salah satu nilai pengalihan yang sah yang Anda tetapkan di API Console Credentials page (termasuk skema, kasus, kasus, dan tanda '/' di akhir, jika ada).
scope (Wajib diisi)

Parameter cakupan harus diawali dengan nilai openid, lalu menyertakan nilai profile, nilai email, atau keduanya.

Jika nilai cakupan profile ada, token ID mungkin (tetapi tidak dijamin) menyertakan klaim profile default pengguna.

Jika nilai cakupan email ada, token ID akan menyertakan klaim email dan email_verified.

Selain cakupan khusus OpenID ini, argumen cakupan Anda juga dapat menyertakan nilai cakupan lainnya. Semua nilai cakupan harus dipisahkan spasi. Misalnya, jika Anda menginginkan akses per file ke Google Drive pengguna, parameter cakupan Anda mungkin adalah openid profile email https://www.googleapis.com/auth/drive.file.

Untuk informasi tentang cakupan yang tersedia, lihat Cakupan OAuth 2.0 untuk Google API atau dokumentasi untuk Google API yang ingin Anda gunakan.

state (Opsional, tetapi sangat direkomendasikan)

String buram yang bolak-balik dalam protokol; dengan kata lain, string ini ditampilkan sebagai parameter URI dalam alur Dasar, dan dalam ID #fragment URI dalam alur Implisit.

state dapat berguna untuk menghubungkan permintaan dan respons. Karena redirect_uri dapat ditebak, penggunaan nilai state dapat meningkatkan keyakinan Anda bahwa koneksi yang masuk adalah hasil dari permintaan autentikasi yang dimulai oleh aplikasi Anda. Jika Anda membuat string acak atau mengenkode hash beberapa status klien (misalnya, cookie) dalam variabel state ini, Anda dapat memvalidasi respons untuk juga memastikan bahwa permintaan dan respons berasal dari browser yang sama. Hal ini memberikan perlindungan terhadap serangan, seperti pemalsuan permintaan lintas situs.

access_type (Opsional) Nilai yang diizinkan adalah offline dan online. Efeknya didokumentasikan dalam Akses Offline; jika token akses diminta, klien tidak akan menerima token refresh kecuali jika nilai offline ditentukan.
display (Opsional) Nilai string ASCII untuk menentukan cara server otorisasi menampilkan halaman antarmuka pengguna untuk autentikasi dan izin. Nilai berikut ditentukan, dan diterima oleh server Google, tetapi tidak memengaruhi perilakunya: page, popup, touch, dan wap.
hd (Opsional)

Sederhanakan proses login untuk akun milik organisasi Google Cloud. Dengan menyertakan domain organisasi Google Cloud (misalnya, mycollege.edu), Anda dapat menunjukkan bahwa UI pemilihan akun harus dioptimalkan untuk akun di domain tersebut. Untuk mengoptimalkan akun organisasi Google Cloud secara umum, bukan hanya satu domain organisasi Google Cloud, tetapkan nilai tanda bintang (*): hd=*.

Jangan mengandalkan pengoptimalan UI ini untuk mengontrol siapa yang dapat mengakses aplikasi Anda karena permintaan sisi klien dapat diubah. Pastikan untuk validate bahwa token ID yang ditampilkan memiliki nilai klaim hd yang sesuai dengan yang Anda harapkan (misalnya, mycolledge.edu). Berbeda dengan parameter permintaan, klaim ID hd token terdapat dalam token keamanan dari Google sehingga nilainya dapat dipercaya.

include_granted_scopes (Opsional) Jika parameter ini diberikan dengan nilai true, dan permintaan otorisasi disetujui, otorisasi akan mencakup otorisasi sebelumnya yang diberikan pada kombinasi pengguna/aplikasi ini untuk cakupan lainnya; lihat Otorisasi inkremental.

Perhatikan bahwa Anda tidak dapat melakukan otorisasi tambahan dengan alur Aplikasi Terinstal.

login_hint (Opsional) Jika mengetahui pengguna yang ingin diautentikasi, aplikasi Anda dapat memberikan parameter ini sebagai petunjuk bagi server autentikasi. Meneruskan petunjuk ini akan menyembunyikan pemilih akun dan mengisi otomatis kotak email pada formulir login, atau memilih sesi yang tepat (jika pengguna menggunakan multi-login), sehingga dapat membantu Anda menghindari masalah yang terjadi jika aplikasi login ke akun pengguna yang salah. Nilainya dapat berupa alamat email atau string sub, yang setara dengan ID Google pengguna.
prompt (Opsional) Daftar nilai string yang dipisahkan spasi yang menentukan apakah server otorisasi akan meminta autentikasi ulang dan izin kepada pengguna. Kemungkinan nilainya adalah:
  • none

    Server otorisasi tidak menampilkan layar autentikasi atau izin pengguna; server akan menampilkan error jika pengguna belum diautentikasi dan belum mengonfigurasi izin untuk cakupan yang diminta. Anda dapat menggunakan none untuk memeriksa autentikasi dan/atau izin yang ada.

  • consent

    Server otorisasi meminta persetujuan pengguna sebelum menampilkan informasi kepada klien.

  • select_account

    Server otorisasi meminta pengguna untuk memilih akun pengguna. Hal ini memungkinkan pengguna yang memiliki beberapa akun di server otorisasi untuk memilih di antara beberapa akun yang sesinya mungkin saat ini mereka miliki.

Jika tidak ada nilai yang ditentukan dan pengguna belum pernah mengizinkan akses, layar izin akan ditampilkan kepada pengguna.

Memvalidasi token ID

Anda perlu memvalidasi semua token ID di server Anda, kecuali jika Anda mengetahui bahwa token tersebut berasal langsung dari Google. Misalnya, server Anda harus melakukan verifikasi autentikasi apa pun dengan token ID yang diterimanya dari aplikasi klien.

Berikut adalah situasi umum saat Anda dapat mengirim token ID ke server:

  • Mengirim token ID dengan permintaan yang perlu diautentikasi. Token ID memberi tahu Anda kepada pengguna tertentu yang membuat permintaan dan klien mana token ID tersebut diberikan.

Token ID bersifat sensitif dan dapat disalahgunakan jika disadap. Anda harus memastikan bahwa token ini ditangani secara aman dengan mengirimkannya hanya melalui HTTPS dan hanya melalui data POST atau dalam header permintaan. Jika Anda menyimpan token ID di server, Anda juga harus menyimpannya dengan aman.

Satu hal yang membuat token ID berguna adalah fakta bahwa Anda dapat meneruskannya ke berbagai komponen aplikasi. Komponen ini dapat menggunakan token ID sebagai mekanisme autentikasi ringan yang mengautentikasi aplikasi dan pengguna. Namun, sebelum dapat menggunakan informasi dalam token ID atau mengandalkan informasi tersebut sebagai pernyataan bahwa pengguna telah diautentikasi, Anda harus memvalidasinya.

Validasi token ID memerlukan beberapa langkah:

  1. Verifikasi bahwa token ID ditandatangani dengan benar oleh penerbit. Token yang diterbitkan Google ditandatangani menggunakan salah satu sertifikat yang ditemukan di URI yang ditentukan dalam nilai metadata jwks_uri pada Dokumen discovery.
  2. Verifikasi bahwa nilai klaim iss di token ID sama dengan https://accounts.google.com atau accounts.google.com.
  3. Verifikasi bahwa nilai klaim aud di token ID sama dengan client ID aplikasi Anda.
  4. Pastikan masa berlaku (exp klaim) token ID belum berlalu.
  5. Jika Anda menentukan nilai parameter hd dalam permintaan, pastikan token ID tersebut memiliki klaim hd yang cocok dengan domain yang diterima, yang terkait dengan organisasi Google Cloud.

Langkah 2 hingga 5 hanya melibatkan perbandingan string dan tanggal yang cukup mudah, jadi kami tidak akan menjelaskannya di sini.

Langkah pertama lebih kompleks, dan melibatkan pemeriksaan tanda tangan kriptografi. Untuk tujuan proses debug, Anda dapat menggunakan endpoint tokeninfo Google untuk membandingkan dengan pemrosesan lokal yang diimplementasikan di server atau perangkat Anda. Misalnya nilai token ID Anda adalah XYZ123. Kemudian, Anda akan membatalkan referensi URI https://oauth2.googleapis.com/tokeninfo?id_token=XYZ123. Jika tanda tangan token valid, responsnya akan berupa payload JWT dalam bentuk objek JSON yang didekode.

Endpoint tokeninfo berguna untuk proses debug, tetapi untuk tujuan produksi, ambil kunci publik Google dari endpoint kunci dan lakukan validasi secara lokal. Anda harus mengambil URI kunci dari Dokumen penemuan menggunakan nilai metadata jwks_uri. Permintaan ke endpoint proses debug dapat di-throttle atau akan mengalami error yang terputus-putus.

Karena Google jarang mengubah kunci publiknya, Anda dapat meng-cache-nya menggunakan perintah cache dari respons HTTP dan, dalam sebagian besar kasus, melakukan validasi lokal dengan jauh lebih efisien daripada menggunakan endpoint tokeninfo. Validasi ini memerlukan pengambilan dan penguraian sertifikat, serta lakukan panggilan kriptografi yang sesuai untuk memeriksa tanda tangan. Untungnya, ada library yang di-debug dengan baik dan tersedia dalam berbagai bahasa untuk mencapai hal ini (lihat jwt.io).

Memperoleh informasi profil pengguna

Untuk memperoleh informasi profil tambahan tentang pengguna, Anda dapat menggunakan token akses (yang diterima aplikasi Anda selama alur autentikasi) dan standar OpenID Connect:

  1. Agar mematuhi OpenID, Anda harus menyertakan nilai cakupan openid profile dalam permintaan autentikasi Anda.

    Jika ingin menyertakan alamat email pengguna, Anda dapat menentukan nilai cakupan tambahan email. Untuk menentukan profile dan email, Anda dapat menyertakan parameter berikut dalam URI permintaan autentikasi:

    scope=openid%20profile%20email
  2. Tambahkan token akses ke header otorisasi dan buat permintaan GET HTTPS ke endpoint userinfo, yang harus Anda ambil dari dokumen Discovery menggunakan nilai metadata userinfo_endpoint. Respons userinfo menyertakan informasi tentang pengguna, seperti yang dijelaskan dalam OpenID Connect Standard Claims dan nilai metadata claims_supported dari dokumen Discovery. Pengguna atau organisasinya dapat memilih untuk menyediakan atau menahan kolom tertentu, sehingga Anda mungkin tidak mendapatkan informasi untuk setiap kolom untuk cakupan akses Anda yang telah diberi otorisasi.

Dokumen Discovery

Protokol OpenID Connect memerlukan penggunaan beberapa endpoint untuk mengautentikasi pengguna, dan untuk meminta resource termasuk token, informasi pengguna, dan kunci publik.

Untuk menyederhanakan implementasi dan meningkatkan fleksibilitas, OpenID Connect memungkinkan penggunaan "Dokumen discovery", yakni dokumen JSON yang ditemukan di lokasi terkenal yang berisi key-value pair yang memberikan detail mengenai konfigurasi penyedia OpenID Connect, termasuk URI otorisasi, token, pencabutan, userinfo, dan endpoint kunci publik. Dokumen Discovery untuk layanan OpenID Connect Google dapat diambil dari:

https://accounts.google.com/.well-known/openid-configuration

Untuk menggunakan layanan OpenID Connect Google, Anda harus melakukan hard code URI dokumen Discovery (https://accounts.google.com/.well-known/openid-configuration) ke dalam aplikasi. Aplikasi Anda mengambil dokumen, menerapkan aturan penyimpanan dalam cache dalam respons, lalu mengambil URI endpoint dari tempat tersebut sesuai kebutuhan. Misalnya, untuk mengautentikasi pengguna, kode Anda akan mengambil nilai metadata authorization_endpoint (https://accounts.google.com/o/oauth2/v2/auth dalam contoh di bawah) sebagai URI dasar untuk permintaan autentikasi yang dikirim ke Google.

Berikut ini contoh dokumen; nama kolom adalah nama yang ditentukan dalam OpenID Connect Discovery 1.0 (lihat dokumen tersebut untuk mengetahui artinya). Nilai ini hanyalah ilustrasi dan dapat berubah, meskipun disalin dari versi terbaru dokumen Google Discovery sebenarnya:

{
  "issuer": "https://accounts.google.com",
  "authorization_endpoint": "https://accounts.google.com/o/oauth2/v2/auth",
  "device_authorization_endpoint": "https://oauth2.googleapis.com/device/code",
  "token_endpoint": "https://oauth2.googleapis.com/token",
  "userinfo_endpoint": "https://openidconnect.googleapis.com/v1/userinfo",
  "revocation_endpoint": "https://oauth2.googleapis.com/revoke",
  "jwks_uri": "https://www.googleapis.com/oauth2/v3/certs",
  "response_types_supported": [
    "code",
    "token",
    "id_token",
    "code token",
    "code id_token",
    "token id_token",
    "code token id_token",
    "none"
  ],
  "subject_types_supported": [
    "public"
  ],
  "id_token_signing_alg_values_supported": [
    "RS256"
  ],
  "scopes_supported": [
    "openid",
    "email",
    "profile"
  ],
  "token_endpoint_auth_methods_supported": [
    "client_secret_post",
    "client_secret_basic"
  ],
  "claims_supported": [
    "aud",
    "email",
    "email_verified",
    "exp",
    "family_name",
    "given_name",
    "iat",
    "iss",
    "locale",
    "name",
    "picture",
    "sub"
  ],
  "code_challenge_methods_supported": [
    "plain",
    "S256"
  ]
}

Anda dapat menghindari dua arah HTTP dengan menyimpan nilai dalam cache dari dokumen Discovery. Header cache HTTP standar digunakan dan harus dipatuhi.

Library klien

Library klien berikut menyederhanakan penerapan OAuth 2.0 dengan mengintegrasikan framework populer:

Kepatuhan OpenID Connect

Sistem autentikasi OAuth 2.0 Google mendukung fitur wajib dari spesifikasi OpenID Connect Core. Setiap klien yang dirancang untuk berfungsi dengan OpenID Connect harus dapat saling beroperasi dengan layanan ini (kecuali untuk Objek Permintaan OpenID).