Bagikan melalui

Mengonfigurasi autentikasi di aplikasi web sampel yang memanggil API web menggunakan Azure AD B2C

  • Artikel

Artikel ini menggunakan sampel aplikasi web ASP.NET yang memproses API web untuk mengilustrasikan cara menambahkan autentikasi Azure Active Directory B2C (Azure AD B2C) ke aplikasi web Anda.

Penting

Sampel aplikasi web ASP.NET yang direferensikan dalam artikel ini digunakan untuk memanggil API web dengan token pembawa. Untuk aplikasi web yang tidak memanggil API web, lihat Mengonfigurasi autentikasi dalam sampel aplikasi web menggunakan Azure AD B2C.

Gambaran Umum

OpenID Connect (OIDC) adalah protokol autentikasi yang dibuat di OAuth 2.0. Anda dapat menggunakan OIDC untuk memasukkan pengguna ke aplikasi dengan aman. Sampel aplikasi web ini menggunakan Microsoft Identity Web. Microsoft Identity Web adalah kumpulan pustaka ASP.NET Core yang menyederhanakan penambahan dukungan autentikasi dan otorisasi ke aplikasi web yang dapat memanggil API web yang aman.

Alur rincian masuk melibatkan langkah berikut:

  1. Pengguna membuka aplikasi web dan memilih Masuk.

  2. Aplikasi memulai permintaan autentikasi dan mengarahkan pengguna ke Azure AD B2C.

  3. Pengguna mendaftar atau masuk dan mengatur ulang sandi. Atau, mereka dapat masuk dengan akun sosial.

  4. Setelah pengguna masuk, Azure AD B2C mengembalikan kode otorisasi ke aplikasi.

  5. Aplikasi kemudian melakukan hal berikut:

    a. Itu menukar kode otorisasi ke token ID, token akses, dan token refresh.
    b. Itu membaca klaim token ID, dan mempertahankan cookie otorisasi aplikasi.
    c. Ini menyimpan token refresh dalam cache dalam memori untuk digunakan nanti.

Ringkasan pendaftaran aplikasi

Untuk memungkinkan aplikasi masuk menggunakan Azure AD B2C dan memproses API web, Anda harus mendaftarkan dua aplikasi dalam direktori Azure AD B2C.

  • Pendaftaran aplikasi web memungkinkan aplikasi Anda untuk masuk menggunakan Azure AD B2C. Selama pendaftaran, Anda menentukan URI pengalihan. URI pengalihan adalah titik akhir di mana pengguna diarahkan oleh Azure AD B2C setelah autentikasi mereka dengan Azure AD B2C selesai. Proses pendaftaran aplikasi menghasilkan ID aplikasi, juga disebut ID klien, yang menjadi ID aplikasi Anda. Anda juga membuat rahasia klien, yang digunakan aplikasi Anda untuk memperoleh token dengan aman.

  • Pendaftaran API web memungkinkan aplikasi Anda memproses API web dengan aman. Pendaftaran mencakup cakupanAPI web. Cakupan menyediakan cara untuk mengelola izin ke sumber daya yang dilindungi seperti API web Anda. Anda memberikan izin aplikasi web ke cakupan API web. Ketika token akses diminta, aplikasi menentukan izin yang diinginkan dalam parameter cakupan permintaan.

Arsitektur dan pendaftaran aplikasi diilustrasikan dalam diagram berikut:

Diagram of a web app with web API call registrations and tokens.

Memanggil API web

Setelah autentikasi selesai, pengguna berinteraksi dengan aplikasi, yang memanggil API web yang dilindungi. API web menggunakan autentikasi token pembawa. Token pembawa adalah token akses yang diperoleh aplikasi dari Azure AD B2C. Aplikasi melewati token di header otorisasi permintaan HTTPS.

Authorization: Bearer <access token>

Jika cakupan token akses tidak cocok dengan cakupan API web, pustaka autentikasi memperoleh token akses baru dengan cakupan yang benar.

Keluar

Alur proses keluar meliputi langkah-langkah berikut:

  1. Dari aplikasi, pengguna keluar.
  2. Aplikasi menghapus objek sesinya, dan pustaka autentikasi menghapus cache tokennya.
  3. Aplikasi mengalihkan pengguna ke titik akhir keluar Azure Active Directory B2C untuk mengakhiri sesi Azure Active Directory B2C.
  4. Pengguna dialihkan kembali ke aplikasi.

Prasyarat

Komputer yang menjalankan baik:

Langkah 1: Mengonfigurasi alur pengguna

Saat pengguna mencoba masuk ke aplikasi Anda, aplikasi memulai permintaan autentikasi ke titik akhir otorisasi melalui alur pengguna. Alur pengguna mendefinisikan dan mengontrol pengalaman pengguna. Setelah pengguna menyelesaikan alur pengguna, Azure Active Directory B2C membuat token dan kemudian mengarahkan pengguna kembali ke aplikasi Anda.

Jika Anda belum melakukannya, buat alur pengguna atau kebijakan kustom. Ulangi langkah-langkah tersebut untuk membuat tiga alur pengguna terpisah sebagai berikut:

  • Gabungan alur pengguna daftar dan masuk, seperti susi. Alur pengguna ini juga mendukung pengalaman Lupa kata sandi Anda.
  • Alur pengguna Pengeditan profil, seperti edit_profile.
  • Alur pengguna Pengaturan ulang kata sandi, seperti reset_password.

Azure AD B2C menambahkan B2C_1_ ke nama alur pengguna. Misalnya, susi menjadi B2C_1_susi.

Langkah 2: Mendaftarkan aplikasi web

Dalam langkah ini, Anda membuat aplikasi web dan pendaftaran aplikasi API web, dan menentukan cakupan API web.

Langkah 2.1: Mendaftarkan aplikasi API web

Untuk membuat pendaftaran aplikasi API web (ID Aplikasi: 2), ikuti langkah-langkah berikut:

  1. Masuk ke portal Azure.

  2. Pastikan Anda menggunakan direktori yang berisi penyewa AAD B2C Anda. Pilih ikon Direktori + langganan di bilah alat portal.

  3. Pada Setelan portal | Direktori + langganan, temukan direktori Azure AD B2C Anda di daftar Nama direktori, lalu pilih Beralih.

  4. Di portal Microsoft Azure, cari dan pilih AAD B2C.

  5. Pilih Pendaftaran aplikasi, lalu pilih Pendaftaran baru.

  6. Untuk Nama, masukkan nama untuk aplikasi (misalnya, my-api1). Biarkan nilai default untuk URI Pengalihan dan Jenis akun yang didukung.

  7. Pilih Daftarkan.

  8. Setelah pendaftaran aplikasi selesai, pilih Ringkasan.

  9. Catat nilai ID Aplikasi (klien) untuk digunakan nanti, saat Anda mengonfigurasi aplikasi web.

    Screenshot that demonstrates how to get a web A P I application I D.

Langkah 2.2: Mengonfigurasi cakupan aplikasi API web

  1. Pilih aplikasi my-api1 yang Anda buat (ID Aplikasi: 2) untuk membuka halaman Ringkasannya.

  2. Di bagian Kelola, pilih Ekspos API.

  3. Di samping URI ID Aplikasi, pilih tautan Set. Ganti nilai default (GUID) dengan nama yang unik (misalnya, tasks-api ), kemudian pilih Simpan .

    Ketika aplikasi web Anda meminta token akses untuk API, ia harus menambahkan URI ini sebagai awalan bagi setiap cakupan yang Anda tentukan untuk API.

  4. Di bagian Cakupan yang ditentukan oleh API ini, pilih Tambahkan cakupan.

  5. Untuk membuat cakupan yang menentukan akses baca ke API:

    1. Untuk Nama cakupan, masukkan tasks.read.
    2. Untuk Nama tampilan perizinan admin, masukkan Akses baca ke API tugas.
    3. Untuk Deskripsi perizinan admin, masukkan Izinkan akses baca ke API tugas.

  6. Pilih Tambahkan cakupan.

  7. Pilih Tambahkan cakupan, lalu tambahkan cakupan yang menentukan akses tulis ke API:

    1. Untuk Nama cakupan, masukkan tasks.write.
    2. Untuk Nama tampilan perizinan admin, masukkan Akses tulis ke API tugas.
    3. Untuk Deskripsi perizinan admin, masukkan Izinkan akses tulis ke API tugas.

  8. Pilih Tambahkan cakupan.

Langkah 2.3: Mendaftarkan aplikasi web

Untuk membuat pendaftaran aplikasi web, lakukan hal berikut:

  1. Pilih Pendaftaran aplikasi, lalu pilih Pendaftaran baru.

  2. Di bawah Nama, masukkan nama untuk aplikasi (misalnya, webapp1).

  3. Di bagian Tipe akun yang didukung, pilih Akun di penyedia identitas atau direktori organisasi apa pun (untuk mengautentikasi pengguna dengan alur pengguna).

  4. Di bawah URI Pengalihan, pilih Web lalu, di kotak URL, masukkan https://localhost:5000/signin-oidc.

  5. Di bagian Izin, pilih kotak centang Berikan persetujuan admin untuk openid dan izin akses offline.

  6. Pilih Daftarkan.

  7. Setelah pendaftaran aplikasi selesai, pilih Ringkasan.

  8. Rekam ID Aplikasi (klien) untuk digunakan nanti, saat Anda mengonfigurasi aplikasi web.

    Screenshot of the web app Overview page for recording your web application ID.

Langkah 2.4: Membuat rahasia klien aplikasi web

Buat rahasia klien untuk aplikasi web terdaftar. Aplikasi web menggunakan rahasia klien untuk membuktikan identitasnya saat meminta token.

  1. Di bagian Kelola, pilih Sertifikat & rahasia.
  2. Pilih Rahasia klien baru.
  3. Di kotak Deskripsi, masukkan deskripsi rahasia klien (misalnya, clientsecret1).
  4. Di bawahKedaluwarsa, pilih durasi yang membuat rahasia tersebut valid, lalu pilih Tambahkan.
  5. Catat Nilai rahasia. Anda akan menggunakan nilai ini untuk konfigurasi pada langkah selanjutnya.

Langkah 2.5: Memberikan izin aplikasi web untuk API web

Untuk memberi izin kepada aplikasi Anda (ID Aplikasi: 1), ikuti langkah-langkah berikut:

  1. Pilih Pendaftaran aplikasi, lalu pilih aplikasi yang Anda buat (ID Aplikasi: 1).

  2. Di bagian Kelola, pilih Izin API.

  3. Di Izin yang dikonfigurasi, pilih Tambahkan izin.

  4. Pilih tab API Saya.

  5. Pilih API (ID Aplikasi: 2) yang aplikasi webnya akan diberi akses. Contohnya, masukkan my-api1.

  6. Di bagian Izin, luaskan tugas, lalu pilih cakupan yang Anda tentukan sebelumnya (misalnya, tasks.read dan tasks.write).

  7. Pilih Tambahkan izin.

  8. Pilih Beri persetujuan admin untuk <nama penyewa Anda>.

  9. Pilih Ya.

  10. Pilih Refresh, lalu pastikan bahwa Diberikan untuk ... muncul di bawah Status untuk kedua cakupan.

  11. Dari daftar Izin akses yang dikonfigurasi, pilih cakupan Anda, lalu salin nama lengkap cakupan.

    Screenshot of the configured permissions pane, showing that read access permissions are granted.

Langkah 3: Mendapatkan sampel aplikasi web

Unduh file zip, atau jalankan perintah Bash berikut untuk mengkloning sampel aplikasi web dari GitHub.

git clone https://github.com/Azure-Samples/active-directory-aspnetcore-webapp-openidconnect-v2

Ekstrak file sampel ke folder dengan total panjang jalur 260 karakter atau kurang.

Langkah 4: Mengonfigurasi sampel API web

Dalam sampel folder, dalam folder 4-WebApp-your-API/4-2-B2C/TodoListService, buka proyek TodoListService.csproj dengan Visual Studio atau Visual Studio Code.

Di bawah folder akar proyek, buka file appsettings.json. File ini memuat informasi tentang penyedia identitas Azure AD B2C Anda. Aplikasi API web menggunakan informasi ini untuk memvalidasi token akses yang diberikan aplikasi web sebagai token pembawa. Perbarui properti pengaturan aplikasi berikut:

Bagian Tombol Nilai
AzureAdB2C Instans Bagian pertama dari nama penyewa Azure AD B2C Anda. Contohnya, https://contoso.b2clogin.com.
AzureAdB2C Domain Nama lengkap penyewa Azure AD B2C Anda. Contohnya, contoso.onmicrosoft.com.
AzureAdB2C ClientId ID aplikasi API web dari langkah 2.1.
AzureAdB2C SignUpSignInPolicyId Alur pengguna, atau kebijakan kustom yang Anda buat di langkah 1.

File konfigurasi final akan terlihat seperti JSON berikut:

{
  "AzureAdB2C": {
    "Instance": "https://contoso.b2clogin.com",
    "Domain": "contoso.onmicrosoft.com",
    "ClientId": "<web-api-app-application-id>",
    "SignedOutCallbackPath": "/signout/<your-sign-up-in-policy>",
    "SignUpSignInPolicyId": "<your-sign-up-in-policy>"
  },
  // More settings here
}

Langkah 4.1: Menetapkan kebijakan izin

API web memverifikasi bahwa pengguna diautentikasi dengan token pembawa, dan token pembawa memiliki cakupan yang diterima dan dikonfigurasi. Jika token pembawa tidak memiliki cakupan yang diterima, API web menampilkan kode status HTTP 403 (Terlarang) dan menulis ke badan respons pesan yang memberi tahu cakupan mana yang diharapkan dalam token.

Untuk mengonfigurasi cakupan yang diterima, buka kelas Controller/TodoListController.cs, dan tetapkan nama cakupan, tanpa URI lengkap.

[RequiredScope("tasks.read")]

Langkah 4.2: Menjalankan sampel aplikasi API web

Untuk mengizinkan aplikasi web memanggil sampel API web, jalankan API web dengan melakukan hal berikut:

  1. Jika Anda diminta untuk melakukannya, pulihkan dependensi.
  2. Buat dan jalankan proyek.
  3. Setelah proyek dibuat, Visual Studio atau Visual Studio Code memulai API web di browser dengan alamat berikut: https://localhost:44332.

Langkah 5: Mengonfigurasi sampel aplikasi web

Di folder sampel, pada folder 4-WebApp-your-API/4-2-B2C/Client, buka proyek TodoListService.csproj dengan Visual Studio atau Visual Studio Code.

Di bawah folder akar proyek, buka file appsettings.json. File ini memuat informasi tentang penyedia identitas Azure AD B2C Anda. Aplikasi web menggunakan informasi ini untuk membangun hubungan kepercayaan dengan Azure AD B2C, membuat pengguna masuk dan keluar, memperoleh token, dan memvalidasinya. Perbarui properti pengaturan aplikasi berikut:

Bagian Tombol Nilai
AzureAdB2C Instans Bagian pertama dari nama penyewa Azure AD B2C Anda (misalnya, https://contoso.b2clogin.com).
AzureAdB2C Domain Nama penyewa lengkap penyewa Azure AD B2C Anda (misalnya, contoso.onmicrosoft.com).
AzureAdB2C ClientId ID aplikasi web dari langkah 2.3.
AzureAdB2C ClientSecret Rahasia aplikasi web dari langkah 2.4.
AzureAdB2C SignUpSignInPolicyId Alur pengguna, atau kebijakan kustom yang Anda buat di langkah 1.
TodoList TodoListScope Cakupan API web yang Anda buat di langkah 2.5.
TodoList TodoListBaseAddress URI dasar API web Anda (misalnya https://localhost:44332).

File konfigurasi final akan terlihat seperti JSON berikut ini:

{
  "AzureAdB2C": {
    "Instance": "https://contoso.b2clogin.com",
    "Domain": "contoso.onmicrosoft.com",
    "ClientId": "<web-app-application-id>",
    "ClientSecret": "<web-app-application-secret>",  
    "SignedOutCallbackPath": "/signout/<your-sign-up-in-policy>",
    "SignUpSignInPolicyId": "<your-sign-up-in-policy>"
  },
  "TodoList": {
    "TodoListScope": "https://contoso.onmicrosoft.com/api/demo.read",
    "TodoListBaseAddress": "https://localhost:44332"
  }
}

Langkah 6: Jalankan sampel aplikasi web

  1. Buat dan jalankan proyek.
  2. Telusuri https://localhost:5000.
  3. Selesaikan proses pendaftaran atau masuk.

Setelah autentikasi berhasil, Anda akan melihat nama tampilan Anda di bilah navigasi. Untuk melihat klaim yang token Azure AD B2C kembalikan ke aplikasi Anda, pilih TodoList.

Screenshot of the web app token claims.

Menyebarkan aplikasi Anda

Dalam aplikasi produksi, URI pengalihan pendaftaran aplikasi biasanya merupakan titik akhir yang dapat diakses publik tempat aplikasi Anda berjalan, seperti https://contoso.com/signin-oidc.

Anda dapat menambahkan dan mengubah URI pengalihan di aplikasi Anda yang telah terdaftar kapan saja. Pembatasan berikut berlaku untuk mengalihkan URI:

  • URL balasan harus dimulai dengan skema https.
  • URL balasan peka huruf besar/kecil. Ukuran huruf harus sesuai dengan ukuran huruf pada jalur URL pada aplikasi berjalan.

Cache token untuk aplikasi web

Contoh aplikasi web menggunakan serialisasi cache token dalam memori. Implementasi ini sangat bagus dalam sampel. Ini juga baik dalam aplikasi produksi, asalkan Anda tidak keberatan jika cache token hilang saat aplikasi web dimulai ulang.

Untuk lingkungan produksi, kami sarankan Anda menggunakan cache memori terdistribusi. Misalnya, cache Redis, NCache, atau cache SQL Server. Untuk detail tentang implementasi cache memori terdistribusi, lihat Serialisasi cache token.

Langkah berikutnya