Pengantar OAuth 2.0

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

Beranda OAuth: Lihat halaman beranda OAuth untuk mengetahui tampilan tingkat atas panduan OAuth yang kami berikan.

Topik ini memberikan ringkasan dasar tentang OAuth 2.0 di Apigee.

Apa itu OAuth 2.0?

Ada banyak buku, blog, dan situs yang membahas OAuth 2.0. Sebaiknya Anda mulai dengan meninjau spesifikasi IETF OAuth 2.0. Berikut adalah definisi OAuth 2.0 dari spesifikasi IETF OAuth 2.0 itu sendiri:

"Framework otorisasi OAuth 2.0 memungkinkan aplikasi pihak ketiga mendapatkan akses terbatas ke layanan HTTP, baik atas nama pemilik resource dengan mengatur interaksi persetujuan antara pemilik resource dan layanan HTTP, atau dengan mengizinkan aplikasi pihak ketiga mendapatkan akses atas namanya sendiri."

Hal utama yang perlu Anda ketahui adalah OAuth 2.0 menyediakan cara bagi aplikasi untuk mendapatkan akses terbatas ke resource pengguna yang dilindungi (pikirkan rekening bank atau informasi sensitif lainnya yang mungkin ingin diakses pengguna dari aplikasi) tanpa perlu pengguna mengungkapkan kredensial login mereka ke aplikasi.

Tips: Katakanlah Anda menemukan aplikasi yang memungkinkan Anda mengakses beberapa rekening bank. Mungkin aplikasi tersebut digunakan untuk membantu mengurus pajak, atau mengelola anggaran Anda. Anda memiliki tiga rekening bank yang ingin Anda kelola dengan aplikasi, dan Anda memiliki nama pengguna dan sandi yang berbeda untuk setiap rekening. Sekarang, agar aplikasi dapat mengakses rekening bank Anda, aplikasi memerlukan kredensial sensitif tersebut. Pada dasarnya, Anda memberikan informasi sensitif ini kepada aplikasi. Apakah Anda memercayai aplikasi tersebut untuk memiliki sandi dan nama pengguna Anda? Bagaimana jika aplikasi diretas? Sekarang, Anda harus ingat untuk mengubah kredensial bank untuk setiap akun. Ini adalah masalah mendasar yang diselesaikan oleh OAuth 2.0. Baca terus untuk mempelajari caranya.

Alur OAuth 2.0

Berikut adalah alur umum untuk framework keamanan OAuth 2.0. Kita akan membahas alur ini secara lebih mendetail dalam topik ini, dimulai dengan diagram, yang menggambarkan banyak hal tentang cara kerja OAuth 2.0. Jika Anda belum memahami istilah yang digunakan dalam diagram ini, baca bagian ini untuk pengantar singkat.

Istilah yang sebaiknya Anda ketahui

• Klien: Juga disebut aplikasi. Klien dapat berupa aplikasi yang berjalan di perangkat seluler atau aplikasi web tradisional. Aplikasi membuat permintaan ke server resource untuk aset yang dilindungi atas nama pemilik resource. Pemilik resource harus memberi aplikasi izin untuk mengakses resource yang dilindungi.
• Pemilik resource: Juga disebut pengguna akhir. Ini umumnya adalah orang (atau entitas lain) yang dapat memberikan akses ke resource yang dilindungi. Misalnya, jika aplikasi perlu menggunakan data dari salah satu situs media sosial Anda, maka Anda adalah pemilik resource -- satu-satunya orang yang dapat memberikan akses aplikasi ke data Anda.
• Server resource: Anggap server resource sebagai layanan seperti Facebook, Google, atau Twitter; atau layanan HR di intranet Anda; atau layanan partner di ekstranet B2B Anda. Apigee adalah server resource setiap kali validasi token OAuth diperlukan untuk memproses permintaan API. Server resource memerlukan semacam otorisasi sebelum menyajikan resource yang dilindungi ke aplikasi.
• Server otorisasi: Server otorisasi diimplementasikan sesuai dengan spesifikasi OAuth 2.0, dan bertanggung jawab untuk memvalidasi pemberian otorisasi dan menerbitkan token akses yang memberi aplikasi akses ke data pengguna di server resource. Anda dapat mengonfigurasi endpoint token di Apigee, yang dalam hal ini Apigee mengambil peran sebagai server otorisasi.
• Pemberian otorisasi: Memberi aplikasi izin untuk mengambil token akses atas nama pengguna akhir. OAuth 2.0 menentukan empat "jenis pemberian izin" tertentu. Lihat Apa saja jenis pemberian izin OAuth 2.0.
• Token akses: String karakter panjang yang berfungsi sebagai kredensial yang digunakan untuk mengakses resource yang dilindungi. Lihat Apa yang dimaksud dengan token akses?.
• Resource yang dilindungi: Data yang dimiliki oleh pemilik resource. Misalnya, daftar kontak pengguna, informasi akun, atau data sensitif lainnya.

Peran Apigee

Anda dapat melindungi API apa pun yang di-proxy-kan melalui Apigee dengan OAuth 2.0. Apigee menyertakan implementasi server otorisasi, dan dengan demikian, dapat membuat dan memvalidasi token akses. Developer memulai dengan mendaftarkan aplikasi mereka ke Apigee. Aplikasi terdaftar dapat meminta token akses melalui salah satu dari empat interaksi jenis pemberian.

Apigee menyediakan kebijakan OAuthV2 multifaset yang menerapkan detail setiap jenis pemberian, sehingga relatif mudah untuk menyiapkan OAuth di Apigee. Misalnya, Anda dapat mengonfigurasi kebijakan yang menerima permintaan token akses, mengevaluasi semua kredensial yang diperlukan, dan menampilkan token akses jika kredensialnya valid.

Perhatikan bahwa server resource apa pun yang dipanggil oleh proxy API aman Anda harus berada di balik firewall (artinya, resource tidak boleh dapat diakses melalui cara apa pun selain proxy API atau API lain yang diamankan dengan baik).

Catatan: Hindari mengekspos endpoint API yang tidak diautentikasi yang menerbitkan token akses, token OAuth, JWT, atau token keamanan lainnya, atau menampilkan data sensitif di lingkungan produksi. Developer proxy API bertanggung jawab untuk mengamankan semua endpoint API di Apigee menggunakan kebijakan keamanan yang sesuai.

Apa yang dimaksud dengan jenis pemberian izin OAuth 2.0?

Anggap jenis pemberian sebagai jalur atau interaksi berbeda yang dapat dilakukan aplikasi untuk mendapatkan token akses. Setiap jenis pemberian menangani satu atau beberapa kasus penggunaan, dan Anda harus memilih jenis pemberian yang akan digunakan berdasarkan kebutuhan Anda sendiri. Secara umum, setiap jenis pemberian memiliki kelebihan dan kekurangan, dan Anda harus mempertimbangkan konsekuensinya berdasarkan kasus penggunaan bisnis Anda. Satu pertimbangan penting adalah kepercayaan terhadap aplikasi yang akan mengakses data Anda. Umumnya, aplikasi pihak ketiga kurang dapat dipercaya dibandingkan aplikasi yang dikembangkan dan digunakan dalam perusahaan.

Apigee mendukung empat jenis pemberian OAuth 2.0 utama:

• authorization code -- Dianggap sebagai jenis pemberian yang paling aman. Sebelum server otorisasi menerbitkan token akses, aplikasi harus menerima kode otorisasi terlebih dahulu dari server resource. Anda telah melihat alur ini setiap kali aplikasi Anda membuka browser ke halaman login server resource dan mengundang Anda untuk login ke akun Anda yang sebenarnya (misalnya, Facebook atau Twitter).

Jika Anda berhasil login, aplikasi akan menerima kode otorisasi yang dapat digunakan untuk menegosiasikan token akses dengan server otorisasi. Biasanya, jenis pemberian ini digunakan saat aplikasi berada di server, bukan di klien. Jenis pemberian ini dianggap sangat aman karena aplikasi klien tidak pernah menangani atau melihat nama pengguna atau sandi pengguna untuk server resource (misalnya, aplikasi tidak pernah melihat atau menangani kredensial Twitter Anda). Alur jenis pemberian ini juga disebut OAuth three-legged.

• implicit -- Dianggap sebagai versi kode otorisasi yang disederhanakan. Biasanya, jenis pemberian ini digunakan saat aplikasi berada di klien. Misalnya, kode aplikasi diimplementasikan di browser menggunakan JavaScript atau bahasa skrip lainnya (bukan berada dan berjalan di server web terpisah). Dalam alur jenis pemberian ini, server otorisasi menampilkan token akses secara langsung saat pengguna diautentikasi, bukan mengeluarkan kode otorisasi terlebih dahulu. Pemberian implisit dapat meningkatkan responsivitas aplikasi dalam beberapa kasus, tetapi keuntungan ini perlu dipertimbangkan terhadap kemungkinan implikasi keamanan seperti yang dijelaskan dalam spesifikasi IETF.
• kredensial sandi pemilik resource -- Dalam alur ini, klien diberi token akses saat nama pengguna/sandi pengguna divalidasi oleh server otorisasi. Alur ini direkomendasikan untuk aplikasi yang sangat tepercaya. Keuntungan dari alur ini dibandingkan, misalnya, autentikasi dasar, adalah pengguna hanya perlu memberikan nama pengguna/sandi sekali. Sejak saat itu, token akses akan digunakan.
• kredensial klien -- Sebaiknya gunakan untuk situasi saat aplikasi klien bertindak atas namanya sendiri. Artinya, klien juga merupakan pemilik resource. Jenis pemberian izin ini biasanya digunakan saat aplikasi perlu mengakses layanan penyimpanan data backend, misalnya. Aplikasi perlu menggunakan layanan untuk melakukan tugasnya, dan layanan tersebut tidak terlihat oleh pengguna akhir. Dengan jenis pemberian ini, aplikasi dapat menerima token akses dengan menampilkan client ID dan kunci rahasia klien ke server otorisasi. Tidak perlu langkah lebih lanjut. menyediakan solusi kredensial klien siap pakai yang mudah diterapkan untuk proxy API apa pun.

Apa yang dimaksud dengan token akses?

Token akses adalah string karakter panjang yang berfungsi sebagai kredensial yang digunakan untuk mengakses resource yang dilindungi. Token resource (juga disebut token pemilik) diteruskan di header Authorization, seperti ini:

$ curl -H "Authorization: Bearer UAj2yiGAcMZGxfN2DhcUbl9v8WsR" \
  http://myorg-test.apigee.net/v0/weather/forecastrss?w=12797282

Server resource memahami bahwa token akses menggantikan kredensial seperti nama pengguna dan sandi. Selain itu, token akses dapat diterbitkan dengan batasan, sehingga, misalnya, aplikasi dapat membaca, tetapi tidak dapat menulis atau menghapus data di server resource. Perhatikan bahwa token akses dapat dicabut jika, misalnya, aplikasi disusupi. Dalam hal ini, Anda harus mendapatkan token akses baru untuk terus menggunakan aplikasi; namun, Anda tidak perlu mengubah nama pengguna atau sandi di server resource yang dilindungi (misalnya, Facebook atau Twitter).

Token akses umumnya memiliki masa berlaku (karena alasan keamanan). Beberapa jenis pemberian izin memungkinkan server otorisasi menerbitkan token refresh, yang memungkinkan aplikasi mengambil token akses baru saat token lama habis masa berlakunya. Untuk mengetahui detail selengkapnya tentang token akses dan token refresh, lihat spesifikasi IETF OAuth 2.0.

Akses terbatas melalui cakupan

Melalui mekanisme cakupan, OAuth 2.0 dapat memberi aplikasi akses terbatas ke resource yang dilindungi. Misalnya, aplikasi mungkin hanya memiliki akses ke resource tertentu, dapat memperbarui resource, atau hanya diberi akses hanya baca. Dalam alur OAuth yang disebut three-legged, pengguna biasanya menentukan tingkat akses melalui halaman izin (misalnya, halaman web tempat pengguna memilih cakupan dengan kotak centang atau mekanisme lainnya).

Mendaftarkan aplikasi

Semua klien (aplikasi) harus mendaftar ke server otorisasi OAuth 2.0 yang akan dimintai token akses. Saat mendaftarkan aplikasi, Anda akan menerima kembali serangkaian kunci. Salah satunya adalah kunci publik yang disebut ID klien, dan yang lainnya adalah kunci rahasia yang disebut rahasia klien. Tanpa kunci ini, aplikasi tidak dapat mengeluarkan permintaan kode otorisasi atau token akses ke server otorisasi. Perhatikan bahwa meskipun spesifikasi OAuth IETF menyebut kunci ini sebagai client ID dan rahasia klien, UI Apigee menyebutnya sebagai ID Konsumen dan Consumer secret. Keduanya setara.

Ringkasan kasus penggunaan OAuth 2.0

Alur jenis pemberian OAuth 2.0 yang Anda pilih untuk diterapkan bergantung pada kasus penggunaan spesifik Anda, karena beberapa jenis pemberian lebih aman daripada yang lain. Pilihan jenis pemberian Anda bergantung pada kepercayaan aplikasi klien dan memerlukan pertimbangan yang sangat cermat, seperti yang dijelaskan dalam tabel berikut:

Kasus Penggunaan	Kredibilitas	Jenis Pemberian Izin Otorisasi OAuth 2.0 yang Disarankan	Deskripsi
B2B (ekstranet), intranet, lainnya	Aplikasi yang sangat tepercaya, yang ditulis oleh developer internal atau developer yang memiliki hubungan bisnis tepercaya dengan penyedia API. Aplikasi yang perlu mengakses resource atas nama mereka sendiri.	Kredensial klien	Biasanya, aplikasi juga merupakan pemilik resource Memerlukan kunci Client ID dan rahasia klien Memerlukan pendaftaran aplikasi ke penyedia layanan
Situs intranet, portal	Aplikasi tepercaya yang ditulis oleh developer pihak ketiga internal atau tepercaya. Contoh yang baik adalah login ke situs HR perusahaan Anda untuk memilih asuransi, mengirimkan ulasan, atau mengubah informasi pribadi.	Sandi Implisit	Memerlukan client ID dan rahasia klien, serta nama pengguna dan sandi Memerlukan pendaftaran aplikasi ke penyedia layanan
Aplikasi yang tersedia untuk publik	Aplikasi yang tidak tepercaya ditulis oleh developer pihak ketiga yang tidak memiliki hubungan bisnis tepercaya dengan penyedia API. Misalnya, developer yang mendaftar ke program API publik umumnya tidak boleh dipercaya.	Kode otorisasi	Mengharuskan pengguna login ke penyedia resource pihak ketiga (misalnya, Twitter, Facebook) Aplikasi tidak pernah melihat nama pengguna dan sandi pengguna Memerlukan pendaftaran aplikasi ke penyedia layanan
B2C	Ada pengguna akhir perorangan (pengguna seluler) yang terlibat, dan kredensial pengguna disimpan di perangkat seluler.	Implisit	Mengharuskan aplikasi terdaftar di penyedia layanan. Kredensial pengguna disimpan di perangkat yang menjalankan aplikasi.

Keamanan OAuth 2.0 vs. kunci API

Validasi kunci API mengharuskan aplikasi mengirim kunci ke Apigee. Kunci tersebut harus berupa kunci konsumen yang valid dari aplikasi developer Apigee yang terkait dengan proxy API. Jika karena alasan tertentu Anda perlu mencabut izin aplikasi klien untuk melakukan panggilan ke proxy, Anda harus mencabut kunci konsumen tersebut. Setiap aplikasi klien yang menggunakan kunci tersebut juga tidak akan dapat mengakses proxy API. Di sisi lain, token OAuth dapat dicabut kapan saja tanpa mencabut kunci aplikasi. Aplikasi dapat meminta token baru atas nama pengguna, dan jika token diberikan, aplikasi dapat terus menggunakan proxy API.

Perbedaan lain antara kunci API dan token adalah token dapat menyertakan atribut metadata yang dapat Anda ambil dan gunakan nanti. Misalnya, Anda dapat menyimpan ID pengguna yang melakukan panggilan API dan menggunakannya untuk menyesuaikan panggilan ke layanan target backend.

Untuk mengetahui detail tentang validasi kunci API, lihat Kunci API. Untuk mengetahui informasi tentang cara menggunakan atribut kustom dengan token OAuth, lihat Menyesuaikan Token dan Kode Otorisasi.

Dampak masa berlaku token dan waktu penghapusan pada penyimpanan disk

Catatan: Bagian ini hanya berlaku untuk pelanggan Apigee hybrid.

Saat membuat token OAuth baru dengan kebijakan OAuthV2, Anda dapat menetapkan waktu habis masa berlaku untuk token dengan atribut ExpiresIn. Secara default, token akan dihapus permanen dari penyimpanan tiga hari setelah masa berlakunya berakhir. Jika Anda menetapkan waktu habis masa berlaku yang lama, seperti 48 jam, Anda mungkin akan melihat peningkatan penggunaan kapasitas disk yang tidak terduga untuk Cassandra. Untuk menghindari penggunaan kapasitas disk yang berlebihan, Anda dapat menetapkan waktu habis masa berlaku yang lebih singkat (disarankan satu jam) dan/atau menetapkan konfigurasi yang mengubah penundaan pasca-habis masa berlaku selama tiga hari menjadi jangka waktu yang lebih singkat.

Pelanggan Apigee hybrid dapat mengubah waktu penghapusan default dengan menetapkan konfigurasi berikut dalam file penggantian mereka:

runtime:
  cwcAppend:
    "conf_keymanagement_oauth.access.token.purge.after.seconds": "SECONDS"

Dengan SECONDS adalah jumlah detik yang akan ditunggu Apigee untuk menghapus permanen token setelah masa berlakunya habis. Pastikan untuk menyertakan stanza ini persis seperti yang tertulis, termasuk tanda petiknya.

Misalnya, untuk menetapkan waktu penghapusan permanen menjadi satu jam setelah masa berlaku berakhir:

runtime:
  cwcAppend:
    "conf_keymanagement_oauth.access.token.purge.after.seconds": "3600"

Referensi yang direkomendasikan

Membaca

Lihat Mempelajari OAuth 2.0.