Halaman ini menjelaskan cara menggunakan Batas Akses Kredensial untuk membuat token akses OAuth 2.0 dengan izin Cloud Storage yang diperkecil cakupannya.
Proses pembuatan token dengan izin yang diperkecil cakupannya mencakup langkah-langkah berikut:
- Berikan peran IAM yang tepat kepada pengguna atau akun layanan.
- Tentukan Batas Akses Kredensial yang menetapkan batas atas pada izin yang tersedia untuk pengguna atau akun layanan.
- Buat token akses OAuth 2.0 untuk akun pengguna atau layanan.
- Tukarkan token akses OAuth 2.0 dengan token baru yang mematuhi Batas Akses Kredensial.
Anda kemudian dapat menggunakan token akses OAuth 2.0 yang baru yang diperkecil cakupannya untuk melakukan autentikasi permintaan ke Cloud Storage.
Sebelum memulai
Sebelum Anda menggunakan Batas Akses Kredensial, pastikan Anda memenuhi persyaratan berikut:
Anda hanya perlu memperkecil cakupan izin untuk Cloud Storage, bukan untuk layananGoogle Cloud lainnya.
Jika Anda perlu memperkecil cakupan izin untuk layanan Google Cloud tambahan, Anda dapat membuat beberapa akun layanan dan memberikan serangkaian peran yang berbeda ke setiap akun layanan.
Anda dapat menggunakan token akses OAuth 2.0 untuk autentikasi. Jenis kredensial yang berlaku singkat lainnya tidak mendukung Batas Akses Kredensial.
Selain itu, Anda harus mengaktifkan API yang diperlukan:
-
Aktifkan IAM dan Security Token Service API, jika belum diaktifkan.
Peran yang diperlukan untuk mengaktifkan API
Untuk mengaktifkan API, Anda memerlukan izin
serviceusage.services.enable. Jika Anda membuat project, kemungkinan Anda sudah memiliki izin ini melalui peran Pemilik (roles/owner). Jika tidak, Anda bisa mendapatkan izin ini melalui peran Service Usage Admin (roles/serviceusage.serviceUsageAdmin). Pelajari cara memberikan peran.
Memberikan peran IAM
Batas Akses Kredensial menetapkan batas atas pada izin yang tersedia untuk resource. Hal tersebut dapat mengurangi izin dari akun utama, tetapi tidak dapat menambahkan izin yang belum dimiliki akun utama.
Oleh karena itu, Anda juga harus memberikan peran ke akun utama yang menyediakan izin yang mereka butuhkan, baik pada bucket Cloud Storage maupun pada resource dengan level yang lebih tinggi, seperti project.
Contohnya, Anda perlu membuat kredensial yang berlaku singkat yang diperkecil cakupannya yang mengizinkan akun layanan untuk membuat objek dalam bucket:
- Setidaknya, Anda harus memberikan peran ke akun layanan yang menyertakan
izin
storage.objects.create, seperti peran Pembuat Storage Object (roles/storage.objectCreator). Batas Akses Kredensial juga harus menyertakan izin ini. - Anda juga dapat memberikan peran yang mencakup lebih banyak izin, seperti peran Admin Storage
Object (
roles/storage.objectAdmin). Akun layanan hanya dapat menggunakan izin yang muncul dalam pemberian peran dan Batas Akses Kredensial.
Untuk mempelajari peran bawaan untuk Cloud Storage, lihat Peran Cloud Storage.
Menentukan Batas Akses Kredensial
Batas Akses Kredensial adalah objek yang berisi daftar aturan batas akses. Aturan ini terdiri dari parameter yang menentukan batas atas izin yang tersedia untuk pengguna atau akun layanan. Untuk menentukan Batas Akses Kredensial, buat objek JSON yang mencantumkan aturan batas akses dan parameternya.
Berikut adalah contoh Batas Akses Kredensial:
{
"accessBoundary": {
"accessBoundaryRules": [
{
"availablePermissions": [
"inRole:ROLE_ID"
],
"availableResource": "//storage.googleapis.com/projects/_/buckets/BUCKET_NAME",
"availabilityCondition": {
"expression" : "CONDITION"
}
}
]
}
}
Ganti kode berikut:
ROLE_ID: ID peran yang telah ditetapkan atau peran khusus yang menentukan batas atas pada izin yang tersedia untuk resource. Contoh,roles/storage.objectViewer. Untuk menentukan beberapa peran, tambahkan baris baru dengan awalaninRole:diikuti dengan ID peran. Hanya izin dalam peran yang ditentukan yang akan tersedia.BUCKET_NAME: Nama bucket Cloud Storage tempat aturan diterapkan.CONDITION: Opsional. Ekspresi kondisi yang menentukan objek Cloud Storage yang izinnya tersedia. Misalnya, kondisi berikut menyediakan izin untuk objek yang namanya diawali dengancustomer-a:resource.name.startsWith('projects/_/buckets/example-bucket/objects/customer-a')
Untuk mempelajari lebih lanjut cara membuat dan menyesuaikan batas akses kredensial, lihat Komponen Batas Akses Kredensial.
Untuk contoh potensi kasus penggunaan Batas Akses Kredensial, lihat Contoh Batas Akses Kredensial.
Membuat token akses OAuth 2.0
Sebelum membuat kredensial yang berlaku singkat yang diperkecil cakupannya, Anda harus membuat token akses
OAuth 2.0 normal. Kemudian, Anda dapat menukar kredensial normal dengan
kredensial yang diperkecil cakupannya. Saat Anda membuat token akses, gunakan
https://www.googleapis.com/auth/cloud-platform cakupan OAuth 2.0.
Untuk membuat token akses untuk akun layanan, Anda dapat menyelesaikan alur OAuth 2.0 server ke server, atau menggunakan Service Account Credentials API untuk membuat token akses OAuth 2.0.
Untuk membuat token akses bagi pengguna, lihat Mendapatkan token akses OAuth 2.0. Anda juga dapat menggunakan Playground OAuth 2.0 untuk membuat token akses untuk Akun Google Anda sendiri.
Menukarkan token akses OAuth 2.0
Setelah membuat token akses OAuth 2.0, Anda dapat menukar token akses tersebut dengan token yang diperkecil cakupannya yang mematuhi Batas Akses Kredensial. Proses ini biasanya melibatkan broker token dan konsumen token:
Broker token bertanggung jawab menentukan Batas Akses Kredensial dan menukar token akses untuk token yang diperkecil cakupannya.
Broker token dapat menggunakan library autentikasi yang didukung untuk menukar token akses secara otomatis, atau memanggil Security Token Service untuk menukar token secara manual.
Konsumen token meminta token akses yang diperkecil cakupannya dari broker token, lalu menggunakan token akses yang diperkecil cakupannya untuk melakukan tindakan lain.
Konsumen token dapat menggunakan library autentikasi yang didukung untuk memuat ulang token akses secara otomatis sebelum masa berlakunya habis. Selain itu, konsumen token dapat memuat ulang token secara manual, atau membiarkan masa berlaku token habis tanpa memuat ulang token tersebut.
Ada dua cara untuk menukar token akses dengan token yang diperkecil cakupannya:
Pertukaran token sisi klien (direkomendasikan): Klien mendapatkan materi kriptografis dari server Security Token Service API. Materi kriptografis memungkinkan klien membuat token yang diperkecil cakupannya dengan berbagai aturan Batas Akses Kredensial secara independen di sisi klien selama durasi yang ditetapkan (misalnya, 1 jam). Pendekatan ini mengurangi latensi dan meningkatkan efisiensi, terutama untuk klien yang memerlukan pembaruan aturan Batas Akses Kredensial yang sering. Hal ini juga lebih efisien untuk aplikasi yang perlu membuat banyak token unik dengan cakupan yang dipersempit. Ini adalah pendekatan yang direkomendasikan karena memberikan performa, skalabilitas, dan kompatibilitas fitur yang lebih baik di masa mendatang.
Pertukaran token sisi server: Klien meminta token baru dengan cakupan yang diperkecil dari server Security Token Service API setiap kali aturan Batas Akses Kredensial berubah. Pendekatan ini mudah, tetapi memerlukan perjalanan pulang pergi ke server API Security Token Service untuk setiap permintaan token yang dicakupkan. Pendekatan ini hanya direkomendasikan untuk pelanggan yang memerlukan library klien yang tidak mendukung pertukaran token sisi klien, karena adanya proses dua arah ke Security Token Service API untuk setiap permintaan token yang dicakupkan.
Pertukaran token sisi klien
Jika Anda membuat broker token dan konsumen token dengan bahasa berikut, Anda dapat menggunakan library autentikasi Google untuk menukar dan memuat ulang token secara otomatis melalui pendekatan sisi klien.
Java
Untuk Java, Anda dapat menukar dan memuat ulang token secara otomatis dengan
com.google.auth:google-auth-library-cab-token-generator artefak
versi 1.32.1 atau yang lebih baru.
Untuk memeriksa versi artefak, jalankan perintah Maven berikut di direktori aplikasi Anda:
mvn dependency:list -DincludeArtifactIds=google-auth-library-cab-token-generator
Contoh berikut menunjukkan bagaimana broker token dapat membuat token yang diperkecil cakupannya:
Contoh berikut menunjukkan bagaimana konsumen token dapat menggunakan pengendali refresh untuk secara otomatis memperoleh dan memuat ulang token yang diperkecil cakupannya:
Pertukaran token sisi server
Bagian ini menjelaskan metode berikut yang dapat Anda gunakan untuk menukar token melalui pendekatan sisi layanan:
- Menukarkan dan memperbarui token akses secara otomatis
- Menukar dan memperbarui token akses secara manual
Menukarkan dan memperbarui token akses secara otomatis menggunakan pendekatan sisi server
Jika Anda membuat broker token dan konsumen token dengan salah satu bahasa berikut, Anda dapat menggunakan library autentikasi Google untuk menukar dan memuat ulang token secara otomatis menggunakan pendekatan pembuatan token sisi server:
Go
Untuk Go, Anda dapat menukar dan memuat ulang token secara otomatis dengan versi
v0.0.0-20210819190943-2bc19b11175f atau yang lebih baru dari
paket golang.org/x/oauth2.
Untuk memeriksa versi paket, jalankan perintah berikut di direktori aplikasi Anda:
go list -m golang.org/x/oauth2
Contoh berikut menunjukkan bagaimana broker token dapat membuat token yang diperkecil cakupannya:
Contoh berikut menunjukkan bagaimana konsumen token dapat menggunakan pengendali refresh untuk secara otomatis memperoleh dan memuat ulang token yang diperkecil cakupannya:
Java
Untuk Java, Anda dapat menukar dan memuat ulang token secara otomatis dengan
com.google.auth:google-auth-library-oauth2-http artefak
versi 1.1.0 atau yang lebih baru.
Untuk memeriksa versi artefak, jalankan perintah Maven berikut di direktori aplikasi Anda:
mvn dependency:list -DincludeArtifactIds=google-auth-library-oauth2-http
Contoh berikut menunjukkan bagaimana broker token dapat membuat token yang diperkecil cakupannya:
Contoh berikut menunjukkan bagaimana konsumen token dapat menggunakan pengendali refresh untuk secara otomatis memperoleh dan memuat ulang token yang diperkecil cakupannya:
Node.js
Untuk Node.js, Anda dapat menukar dan memuat ulang token secara otomatis dengan
paket google-auth-library versi 7.9.0 atau yang lebih baru.
Untuk memeriksa versi paket, jalankan perintah berikut di direktori aplikasi Anda:
npm list google-auth-library
Contoh berikut menunjukkan bagaimana broker token dapat membuat token yang diperkecil cakupannya:
Contoh berikut menunjukkan bagaimana konsumen token dapat menyediakan pengendali refresh yang secara otomatis memperoleh dan memuat ulang token yang diperkecil cakupannya:
Python
Untuk Python, Anda dapat menukar dan memuat ulang token secara otomatis dengan
paket google-auth versi 2.0.0 atau yang lebih baru.
Untuk memeriksa versi paket Anda, jalankan perintah berikut di lingkungan tempat paket diinstal:
pip show google-auth
Contoh berikut menunjukkan bagaimana broker token dapat membuat token yang diperkecil cakupannya:
Contoh berikut menunjukkan bagaimana konsumen token dapat menyediakan pengendali refresh yang secara otomatis memperoleh dan memuat ulang token yang diperkecil cakupannya:
Menukar dan memperbarui token akses secara manual
Broker token dapat memanggil metode sts.token di
Security Token Service API (POST https://sts.googleapis.com/v1/token) untuk
menukar token akses OAuth 2.0 dengan token akses yang diperkecil cakupannya, lalu
memberikan token yang diperkecil cakupannya tersebut kepada konsumen token.
Perintah curl berikut menukar token akses menggunakan file Batas Akses Kredensial berformat JSON:
curl https://sts.googleapis.com/v1/token \
--header "Content-Type: application/x-www-form-urlencoded" \
--request POST \
--data-urlencode "grant_type=urn:ietf:params:oauth:grant-type:token-exchange" \
--data-urlencode "subject_token_type=urn:ietf:params:oauth:token-type:access_token" \
--data-urlencode "requested_token_type=urn:ietf:params:oauth:token-type:access_token" \
--data-urlencode "subject_token=ORIGINAL_TOKEN" \
--data-urlencode "options=$(cat ACCESS_BOUNDARY_FILE)"
Ganti kode berikut:
ORIGINAL_TOKEN: token akses OAuth 2.0 yang ingin Anda tukarkan.ACCESS_BOUNDARY_FILE: jalur ke file yang berisi Batas Akses Kredensial berformat JSON, seperti./access-boundary.json.
Untuk mengetahui detail lengkap tentang parameter permintaan dan kolom respons, lihat
referensi REST API sts.token.
Outputnya mirip dengan hal berikut ini:
{
"access_token": "ya29.dr.AbCDeFg-123456...",
"issued_token_type": "urn:ietf:params:oauth:token-type:access_token",
"token_type": "Bearer",
"expires_in": 3600
}
Kolom expires_in hanya muncul jika token akses asli mewakili
akun layanan. Jika token akses asli mewakili akun pengguna, respons akan menghilangkan expires_in, dan masa berlaku token yang diperkecil cakupannya akan berakhir pada saat yang sama dengan token akses asli.
Saat konsumen token meminta token yang diperkecil cakupannya, broker token merespons dengan token yang diperkecil cakupannya dan jumlah detik hingga masa berlakunya habis. Jika masa berlaku token telah berakhir, server akan menolak permintaan. Untuk memuat ulang token yang diperkecil cakupannya, konsumen dapat meminta token yang diperkecil cakupannya dari broker sebelum masa berlaku token yang ada habis.
Langkah berikutnya
- Pelajari tentang kontrol akses untuk Cloud Storage.
- Membuat kredensial akun layanan yang berlaku singkat.
- Buat token akses OAuth 2.0 untuk akun layanan dengan salah satu metode berikut:
- Membuat token akses OAuth 2.0 untuk pengguna.
- Lihat izin di setiap peran bawaan.
- Pelajari tentang peran khusus.