Menambahkan autentikasi ke aplikasi Windows (WinUI3) Anda

Dalam tutorial ini, Anda menambahkan autentikasi Microsoft ke proyek TodoApp menggunakan ID Microsoft Entra. Sebelum menyelesaikan tutorial ini, pastikan Anda telah membuat proyek dan menyebarkan backend.

Tip

Meskipun kami menggunakan ID Microsoft Entra untuk autentikasi, Anda dapat menggunakan pustaka autentikasi apa pun yang Anda inginkan dengan Azure Mobile Apps.

Menambahkan autentikasi ke layanan backend Anda

Layanan backend Anda adalah layanan standar ASP.NET 6. Tutorial apa pun yang menunjukkan kepada Anda cara mengaktifkan autentikasi untuk layanan ASP.NET 6 berfungsi dengan Azure Mobile Apps.

Untuk mengaktifkan autentikasi Microsoft Entra untuk layanan backend, Anda perlu:

• Daftarkan aplikasi dengan ID Microsoft Entra.
• Tambahkan pemeriksaan autentikasi ke proyek backend ASP.NET 6.

Mendaftarkan aplikasi

Pertama, daftarkan API web di penyewa Microsoft Entra Anda dan tambahkan cakupan dengan mengikuti langkah-langkah berikut:

1. Masuk ke portal Azure.

2. Jika Anda memiliki akses ke beberapa penyewa, gunakan filter Direktori + langganan di menu atas untuk beralih ke penyewa tempat Anda ingin mendaftarkan aplikasi.

3. Mencari dan memilih Microsoft Entra ID.

4. Di bagian Kelola, pilih Pendaftaran aplikasi>Pendaftaran baru.

   • Nama: masukkan nama untuk aplikasi Anda; misalnya, Mulai Cepat TodoApp. Pengguna aplikasi Anda akan melihat nama ini. Anda bisa mengubahnya nanti.
   • Jenis akun yang didukung: Akun di direktori organisasi apa pun (Direktori Microsoft Entra apa pun - Multipenyewa) dan akun Microsoft pribadi (misalnya Skype, Xbox)

5. Pilih Daftarkan.

6. Di bagian Kelola, pilih Ekspos API>Tambahkan cakupan.

7. Untuk URI ID Aplikasi, terima default dengan memilih Simpan dan lanjutkan.

8. Masukkan rincian berikut:

   • Nama cakupan: access_as_user
   • Siapa yang dapat menyetujui?: Admin dan pengguna
   • Nama tampilan persetujuan admin: Access TodoApp
   • Deskripsi persetujuan admin: Allows the app to access TodoApp as the signed-in user.
   • Nama tampilan persetujuan admin: Access TodoApp
   • Deskripsi persetujuan admin: Allow the app to access TodoApp on your behalf.
   • Status: Diaktifkan

9. Pilih Tambahkan cakupan untuk menyelesaikan penambahan cakupan.

10. Perhatikan nilai cakupan, mirip api://<client-id>/access_as_user dengan (disebut sebagai Cakupan API Web). Anda memerlukan cakupan saat mengonfigurasi klien.

11. Pilih Ikhtisar.

12. Perhatikan ID Aplikasi (klien) di bagian Esensial (disebut sebagai ID Aplikasi API Web). Anda memerlukan nilai ini untuk mengonfigurasi layanan backend.

Buka Visual Studio dan pilih TodoAppService.NET6 proyek.

1. Klik kanan pada TodoAppService.NET6 proyek, lalu pilih Kelola Paket NuGet....

2. Di tab baru, pilih Telusuri, lalu masukkan Microsoft.Identity.Web di kotak pencarian.

   

3. Microsoft.Identity.Web Pilih paket, lalu tekan Instal.

4. Ikuti perintah untuk menyelesaikan penginstalan paket.

5. Buka Program.cs. Tambahkan yang berikut ini ke daftar using pernyataan:

using Microsoft.AspNetCore.Authentication.JwtBearer;
using Microsoft.Identity.Web;

6. Tambahkan kode berikut tepat di atas panggilan ke builder.Services.AddDbContext():

builder.Services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
  .AddMicrosoftIdentityWebApi(builder.Configuration);
builder.Services.AddAuthorization();

7. Tambahkan kode berikut tepat di atas panggilan ke app.MapControllers():

app.UseAuthentication();
app.UseAuthorization();

Anda Program.cs sekarang akan terlihat seperti ini:

using Microsoft.AspNetCore.Datasync;
using Microsoft.EntityFrameworkCore;
using Microsoft.AspNetCore.Authentication.JwtBearer;
using Microsoft.Identity.Web;
using TodoAppService.NET6.Db;
  
var builder = WebApplication.CreateBuilder(args);
var connectionString = builder.Configuration.GetConnectionString("DefaultConnection");
  
if (connectionString == null)
{
  throw new ApplicationException("DefaultConnection is not set");
}
  
builder.Services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
  .AddMicrosoftIdentityWebApi(builder.Configuration);
builder.Services.AddAuthorization();
builder.Services.AddDbContext<AppDbContext>(options => options.UseSqlServer(connectionString));
builder.Services.AddDatasyncControllers();
  
var app = builder.Build();
  
// Initialize the database
using (var scope = app.Services.CreateScope())
{
  var context = scope.ServiceProvider.GetRequiredService<AppDbContext>();
  await context.InitializeDatabaseAsync().ConfigureAwait(false);
}
  
// Configure and run the web service.
app.UseAuthentication();
app.UseAuthorization();
app.MapControllers();
app.Run();

8. Controllers\TodoItemController.csEdit . [Authorize] Tambahkan atribut ke kelas . Kelas Anda akan terlihat seperti ini:

using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Datasync;
using Microsoft.AspNetCore.Datasync.EFCore;
using Microsoft.AspNetCore.Mvc;
using TodoAppService.NET6.Db;

namespace TodoAppService.NET6.Controllers
{
  [Authorize]
  [Route("tables/todoitem")]
  public class TodoItemController : TableController<TodoItem>
  {
    public TodoItemController(AppDbContext context)
      : base(new EntityTableRepository<TodoItem>(context))
    {
    }
  }
}

9. appsettings.jsonEdit . Tambahkan blok berikut:

  "AzureAd": {
    "Instance": "https://login.microsoftonline.com",
    "ClientId": "<client-id>",
    "TenantId": "common"
  },

<client-id> Ganti dengan ID Aplikasi API Web yang Anda rekam sebelumnya. Setelah selesai, akan terlihat seperti ini:

{
  "AzureAd": {
    "Instance": "https://login.microsoftonline.com",
    "ClientId": "<client-id>",
    "TenantId": "common"
  },
  "ConnectionStrings": {
    "DefaultConnection": "Server=(localdb)\\mssqllocaldb;Database=TodoApp;Trusted_Connection=True"
  },
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*"
}

Terbitkan layanan Anda ke Azure lagi:

1. Klik kanan pada TodoAppService.NET6 proyek, lalu pilih Terbitkan....
2. Pilih tombol Terbitkan di sudut kanan atas tab.

Buka browser ke https://yoursite.azurewebsites.net/tables/todoitem?ZUMO-API-VERSION=3.0.0. Perhatikan bahwa layanan sekarang mengembalikan 401 respons, yang menunjukkan bahwa autentikasi diperlukan.

Mendaftarkan aplikasi Anda dengan layanan identitas

Microsoft Data sync Framework memiliki dukungan bawaan untuk penyedia autentikasi apa pun yang menggunakan Json Web Token (JWT) dalam header transaksi HTTP. Aplikasi ini menggunakan Microsoft Authentication Library (MSAL) untuk meminta token tersebut dan mengotorisasi pengguna yang masuk ke layanan backend.

Mendaftarkan aplikasi klien asli

Anda dapat mendaftarkan klien asli untuk mengizinkan autentikasi ke Web API yang dihosting di aplikasi menggunakan pustaka klien seperti Microsoft Identity Library (MSAL).

1. Di portal Azure, pilih ID> Microsoft Entra Pendaftaran aplikasi> Pendaftaran baru.

2. Di halaman Daftarkan aplikasi :

   • masukkan Nama untuk pendaftaran aplikasi Anda. Anda mungkin ingin menggunakan nama native-quickstart untuk membedakan nama ini dari yang digunakan oleh layanan backend Anda.
   • Pilih Akun di direktori organisasi apa pun (Direktori Microsoft Entra apa pun - Multipenyewa) dan akun Microsoft pribadi (misalnya Skype, Xbox).
   • Di URI Pengalihan:
     • Pilih Klien publik (seluler & desktop)
     • Masukkan URL quickstart://auth

3. Pilih Daftarkan.

4. Pilih izin API>Tambahkan izin>API Saya.

5. Pilih pendaftaran aplikasi yang Anda buat sebelumnya untuk layanan backend Anda. Jika Anda tidak melihat pendaftaran aplikasi, pastikan Anda menambahkan cakupan access_as_user .

   

6. Di bawah Pilih izin, pilih access_as_user, lalu pilih Tambahkan izin.

7. Pilih Autentikasi>Seluler dan aplikasi desktop.

8. Pilih kotak di samping https://login.microsoftonline.com/common/oauth2/nativeclient.

9. Centang kotak di samping msal{client-id}://auth (mengganti {client-id} dengan ID aplikasi Anda).

10. Pilih Tambahkan URI, lalu tambahkan http://localhost di bidang untuk URI tambahan.

11. Pilih Simpan di bagian bawah halaman.

12. Pilih Ikhtisar. Catat ID Aplikasi (klien) (disebut sebagai ID Aplikasi Klien Asli) karena Anda membutuhkannya untuk mengonfigurasi aplikasi seluler.

Kami telah menentukan tiga URL pengalihan:

• http://localhost digunakan oleh aplikasi WPF.
• https://login.microsoftonline.com/common/oauth2/nativeclient digunakan oleh aplikasi UWP.
• msal{client-id}://auth digunakan oleh aplikasi seluler (Android dan iOS).

Menambahkan Klien Identitas Microsoft ke aplikasi Anda

TodoApp.sln Buka solusi di Visual Studio dan atur TodoApp.WinUIproyek sebagai proyek startup.

Tambahkan Microsoft Identity Library (MSAL) ke proyek platform:

1. Klik kanan proyek, lalu pilih Kelola Paket NuGet ....

2. Pilih tab Telusuri.

3. Masukkan Microsoft.Identity.Client di kotak penelusuran, dan tekan Enter.

4. Pilih hasil Microsoft.Identity.Client, lalu klik Pasang.

   

5. Terima perjanjian lisensi untuk melanjutkan instalasi.

Tambahkan ID klien asli dan cakupan backend ke konfigurasi.

TodoApp.Data Buka proyek dan edit Constants.cs file. Tambahkan konstanta untuk ApplicationId dan Scopes:

  public static class Constants
  {
      /// <summary>
      /// The base URI for the Datasync service.
      /// </summary>
      public static string ServiceUri = "https://demo-datasync-quickstart.azurewebsites.net";

      /// <summary>
      /// The application (client) ID for the native app within Microsoft Entra ID
      /// </summary>
      public static string ApplicationId = "<client-id>";

      /// <summary>
      /// The list of scopes to request
      /// </summary>
      public static string[] Scopes = new[]
      {
          "<scope>"
      };
  }

<client-id> Ganti dengan ID Aplikasi Klien Asli yang Anda terima saat mendaftarkan aplikasi klien di ID Microsoft Entra, dan <scope> dengan Cakupan API Web yang Anda salin saat Anda menggunakan Mengekspos API saat mendaftarkan aplikasi layanan.

MainWindow.xaml.cs Buka file dalam TodoApp.WinUI proyek.

Tambahkan pernyataan berikut using ke bagian atas file:

using Microsoft.Datasync.Client;
using Microsoft.Identity.Client;
using System.Diagnostics;
using System.Linq;

Sesuaikan konstruktor dan bidang untuk menambahkan referensi ke klien identitas sebagai berikut:

private readonly TodoListViewModel _viewModel;
private readonly ITodoService _service;
private IPublicClientApplication _identityClient;

public MainWindow()
{
    this.InitializeComponent();
    ResizeWindow(this, 480, 800);

    _service = new RemoteTodoService(GetAuthenticationToken);
    _viewModel = new TodoListViewModel(this, _service);
    mainContainer.DataContext = _viewModel;
}

public async Task<AuthenticationToken> GetAuthenticationToken()
{
    if (_identityClient == null) 
    {
        _identityClient = PublicClientApplicationBuilder.Create(Constants.ApplicationId)
            .WithAuthority(AzureCloudInstance.AzurePublic, "common")
            .WithRedirectUri("https://login.microsoftonline.com/common/oauth2/nativeclient")
            .Build();
    }
    var accounts = await _identityClient.GetAccountsAsync();
    AuthenticationResult? result = null;
    try
    {
        result = await _identityClient
            .AcquireTokenSilent(Constants.Scopes, accounts.FirstOrDefault())
            .ExecuteAsync();
    }
    catch (MsalUiRequiredException)
    {
        result = await _identityClient
            .AcquireTokenInteractive(Constants.Scopes)
            .ExecuteAsync();
    }
    catch (Exception ex)
    {
        // Display the error text - probably as a pop-up
        Debug.WriteLine($"Error: Authentication failed: {ex.Message}");
    }

    return new AuthenticationToken
    {
        DisplayName = result?.Account?.Username ?? "",
        ExpiresOn = result?.ExpiresOn ?? DateTimeOffset.MinValue,
        Token = result?.AccessToken ?? "",
        UserId = result?.Account?.Username ?? ""
    };
}

Metode ini GetAuthenticationToken() berfungsi dengan Microsoft Identity Library (MSAL) untuk mendapatkan token akses yang cocok untuk mengotorisasi pengguna yang masuk ke layanan backend. Fungsi ini kemudian diteruskan ke RemoteTodoService untuk membuat klien. Jika autentikasi berhasil, AuthenticationToken diproduksi dengan data yang diperlukan untuk mengotorisasi setiap permintaan. Jika tidak, maka token yang kedaluwarsa diproduksi sebagai gantinya. Token yang kedaluwarsa atau tidak valid menyebabkan operasi yang mendasar gagal dengan tepat.

Menguji aplikasi

Anda harus dapat menekan F5 untuk menjalankan aplikasi. Saat aplikasi berjalan, browser dibuka untuk meminta autentikasi kepada Anda. Saat pertama kali aplikasi berjalan, Anda diminta untuk menyetujui akses:

Tekan Ya untuk melanjutkan ke aplikasi Anda.

Langkah berikutnya

Selanjutnya, konfigurasikan aplikasi Anda untuk beroperasi secara offline dengan menerapkan penyimpanan offline.

Bacaan lebih lanjut

• Mulai cepat: Melindungi API web dengan platform identitas Microsoft
• Mulai cepat: Memperoleh token dan memanggil Microsoft Graph API dari aplikasi desktop
• platform identitas Microsoft: Tutorial Windows Presentation Foundation