Přidání, stažení a odstranění vlastních uživatelských dat do Identity projektu ASP.NET Core

Autor: Rick Anderson

V tomto článku se dozvíte, jak:

• Přidejte vlastní uživatelská data do webové aplikace ASP.NET Core.
• Označte vlastní datový model uživatele atributem PersonalDataAttribute , aby byl automaticky k dispozici ke stažení a odstranění. Zajištění toho, aby se data mohla stáhnout a odstranit, pomáhá splnit požadavky GDPR .

Ukázka projektu se vytvoří z Razor webové aplikace Pages, ale pokyny jsou podobné webové aplikaci ASP.NET Core MVC.

Zobrazení nebo stažení ukázkového kódu (postup stažení)

Požadavky

Sada .NET 6.0 SDK

Vytvoření Razor webové aplikace

Visual Studio

• V nabídce Soubor sady Visual Studio vyberte Nový>projekt. Projekt WebApp1 pojmenujte, pokud se má shodovat s oborem názvů ukázkového kódu pro stažení.
• Vyberte ASP.NET Ok webové aplikace>Core.
• Vyberte OK webové aplikace.>
• Sestavte a spusťte projekt.

.NET CLI

dotnet new webapp -o WebApp1

Identity Spuštění nástroje scaffolder

Visual Studio

• V Průzkumník řešení klikněte pravým tlačítkem myši na projekt> Přidat>novou vygenerovanou položku.
• V levém podokně dialogového okna Přidat generování uživatelského rozhraní vyberteIdentity> Přidat.
• V dialogovém okně Přidat Identity následující možnosti:
  • Výběr existujícího souboru rozložení ~/Pages/Shared/_Layout.cshtml
  • Vyberte následující soubory, které chcete přepsat:
    • Účet nebo registrace
    • Účet, správa nebo index
  • + Výběrem tlačítka vytvořte novou třídu kontextu dat. Přijměte typ (WebApp1.Models.WebApp1Context , pokud má projekt název WebApp1).
  • Výběrem tlačítka + vytvořte novou třídu User. Přijměte typ (WebApp1User , pokud má projekt název WebApp1) >Přidat.
• Vyberte Přidat.

.NET CLI

Pokud jste ještě nenainstalovali ASP.NET core scaffolder, nainstalujte ho teď:

dotnet tool install -g dotnet-aspnet-codegenerator

Poznámka:

Ve výchozím nastavení architektura binárních souborů .NET, které se mají nainstalovat, představuje aktuálně spuštěnou architekturu operačního systému. Pokud chcete zadat jinou architekturu operačního systému, přečtěte si téma instalace nástroje dotnet, možnost --arch. Další informace najdete v tématu o problému GitHubu dotnet/AspNetCore.Docs #29262.

Přidejte odkaz na balíček pro Microsoft.VisualStudio.Web.CodeGeneration.Design do souboru projektu (.csproj). V adresáři projektu spusťte následující příkaz:

dotnet add package Microsoft.VisualStudio.Web.CodeGeneration.Design
dotnet restore

Spuštěním následujícího příkazu zobrazte seznam Identity možností nástroje scaffolder:

dotnet aspnet-codegenerator identity -h

Ve složce projektu spusťte Identity scaffolder:

dotnet aspnet-codegenerator identity -u WebApp1User -fi Account.Register;Account.Manage.Index

PowerShell jako oddělovač příkazů používá středník. Při použití PowerShellu uvozujte středníky v seznamu souborů nebo vložte seznam souborů do dvojitých uvozovek.

Postupujte podle pokynů v migracích, useAuthentication a rozložení a proveďte následující kroky:

• Vytvořte migraci a aktualizujte databázi.
• Přidání UseAuthentication do Program.cs
• Přidejte <partial name="_LoginPartial" /> do souboru rozložení.
• Otestujte aplikaci:
  • Registrace uživatele
  • Vyberte nové uživatelské jméno (vedle odkazu Pro odhlášení ). Možná budete muset okno rozbalit nebo vybrat ikonu navigačního panelu, aby se zobrazilo uživatelské jméno a další odkazy.
  • Vyberte kartu Osobní údaje.
  • Vyberte tlačítko Stáhnout a prověřte PersonalData.json soubor.
  • Otestujte tlačítko Odstranit, které odstraní přihlášeného uživatele.

Přidání vlastních uživatelských dat do Identity databáze

Aktualizujte odvozenou IdentityUser třídu vlastními vlastnostmi. Pokud jste projekt WebApp1 pojmenovali, soubor se jmenuje Areas/Identity/Data/WebApp1User.cs. Aktualizujte soubor následujícím kódem:

using Microsoft.AspNetCore.Identity;

namespace WebApp1.Areas.Identity.Data;

public class WebApp1User : IdentityUser
{
    [PersonalData]
    public string? Name { get; set; }
    [PersonalData]
    public DateTime DOB { get; set; }
}

Vlastnosti s atributem PersonalData jsou:

• Odstraněno při Areas/Identity/Pages/Account/Manage/DeletePersonalData.cshtmlRazor volání UserManager.Deletestránky .
• Součástí stažených dat stránkou Areas/Identity/Pages/Account/Manage/DownloadPersonalData.cshtmlRazor .

Account/Manage/Index.cshtml Aktualizace stránky

Aktualizujte ho InputModel Areas/Identity/Pages/Account/Manage/Index.cshtml.cs následujícím zvýrazněným kódem:

public class IndexModel : PageModel
{
    private readonly UserManager<WebApp1User> _userManager;
    private readonly SignInManager<WebApp1User> _signInManager;

    public IndexModel(
        UserManager<WebApp1User> userManager,
        SignInManager<WebApp1User> signInManager)
    {
        _userManager = userManager;
        _signInManager = signInManager;
    }

    /// <summary>
    ///     This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
    ///     directly from your code. This API may change or be removed in future releases.
    /// </summary>
    public string Username { get; set; }

    // Remaining API warnings ommited.

    [TempData]
    public string StatusMessage { get; set; }

    [BindProperty]
    public InputModel Input { get; set; }

    public class InputModel
    {
        [Required]
        [DataType(DataType.Text)]
        [Display(Name = "Full name")]
        public string Name { get; set; }

        [Required]
        [Display(Name = "Birth Date")]
        [DataType(DataType.Date)]
        public DateTime DOB { get; set; }

        [Phone]
        [Display(Name = "Phone number")]
        public string PhoneNumber { get; set; }
    }

    private async Task LoadAsync(WebApp1User user)
    {
        var userName = await _userManager.GetUserNameAsync(user);
        var phoneNumber = await _userManager.GetPhoneNumberAsync(user);

        Username = userName;

        Input = new InputModel
        {
            Name = user.Name,
            DOB = user.DOB,
            PhoneNumber = phoneNumber
        };
    }

    public async Task<IActionResult> OnGetAsync()
    {
        var user = await _userManager.GetUserAsync(User);
        if (user == null)
        {
            return NotFound($"Unable to load user with ID '{_userManager.GetUserId(User)}'.");
        }

        await LoadAsync(user);
        return Page();
    }

    public async Task<IActionResult> OnPostAsync()
    {
        var user = await _userManager.GetUserAsync(User);
        if (user == null)
        {
            return NotFound($"Unable to load user with ID '{_userManager.GetUserId(User)}'.");
        }

        if (!ModelState.IsValid)
        {
            await LoadAsync(user);
            return Page();
        }

        var phoneNumber = await _userManager.GetPhoneNumberAsync(user);
        if (Input.PhoneNumber != phoneNumber)
        {
            var setPhoneResult = await _userManager.SetPhoneNumberAsync(user, Input.PhoneNumber);
            if (!setPhoneResult.Succeeded)
            {
                StatusMessage = "Unexpected error when trying to set phone number.";
                return RedirectToPage();
            }
        }

        if (Input.Name != user.Name)
        {
            user.Name = Input.Name;
        }

        if (Input.DOB != user.DOB)
        {
            user.DOB = Input.DOB;
        }

        await _userManager.UpdateAsync(user);
        await _signInManager.RefreshSignInAsync(user);
        StatusMessage = "Your profile has been updated";
        return RedirectToPage();
    }
}

Areas/Identity/Pages/Account/Manage/Index.cshtml Aktualizujte následující zvýrazněnou značku:

@page
@model IndexModel
@{
    ViewData["Title"] = "Profile";
    ViewData["ActivePage"] = ManageNavPages.Index;
}

<h3>@ViewData["Title"]</h3>
<partial name="_StatusMessage" for="StatusMessage" />
<div class="row">
    <div class="col-md-6">
        <form id="profile-form" method="post">
            <div asp-validation-summary="ModelOnly" class="text-danger"></div>
            <div class="form-floating">
                <input asp-for="Username" class="form-control" disabled />
                <label asp-for="Username" class="form-label"></label>
            </div>
            <div class="form-floating">
                <input asp-for="Input.Name" class="form-control" />
                <label asp-for="Input.Name" class="form-label"></label>
            </div>
            <div class="form-floating">
                <input asp-for="Input.DOB" class="form-control" />
                <label asp-for="Input.DOB" class="form-label"></label>
            </div>
            <div class="form-floating">
                <input asp-for="Input.PhoneNumber" class="form-control" />
                <label asp-for="Input.PhoneNumber" class="form-label"></label>
                <span asp-validation-for="Input.PhoneNumber" class="text-danger"></span>
            </div>
            <button id="update-profile-button" type="submit" class="w-100 btn btn-lg btn-primary">Save</button>
        </form>
    </div>
</div>

@section Scripts {
    <partial name="_ValidationScriptsPartial" />
}

Account/Register.cshtml Aktualizace stránky

Aktualizujte ho InputModel Areas/Identity/Pages/Account/Register.cshtml.cs následujícím zvýrazněným kódem:

    public class RegisterModel : PageModel
    {
        private readonly SignInManager<WebApp1User> _signInManager;
        private readonly UserManager<WebApp1User> _userManager;
        private readonly IUserStore<WebApp1User> _userStore;
        private readonly IUserEmailStore<WebApp1User> _emailStore;
        private readonly ILogger<RegisterModel> _logger;
        private readonly IEmailSender _emailSender;

        public RegisterModel(
            UserManager<WebApp1User> userManager,
            IUserStore<WebApp1User> userStore,
            SignInManager<WebApp1User> signInManager,
            ILogger<RegisterModel> logger,
            IEmailSender emailSender)
        {
            _userManager = userManager;
            _userStore = userStore;
            _emailStore = GetEmailStore();
            _signInManager = signInManager;
            _logger = logger;
            _emailSender = emailSender;
        }

        /// <summary>
        ///     This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
        ///     directly from your code. This API may change or be removed in future releases.
        /// </summary>
        [BindProperty]
        public InputModel Input { get; set; }

        // Remaining API warnings ommited.
        public string ReturnUrl { get; set; }

        public IList<AuthenticationScheme> ExternalLogins { get; set; }

        public class InputModel
        {
            [Required]
            [DataType(DataType.Text)]
            [Display(Name = "Full name")]
            public string Name { get; set; }

            [Required]
            [Display(Name = "Birth Date")]
            [DataType(DataType.Date)]
            public DateTime DOB { get; set; }

            [Required]
            [EmailAddress]
            [Display(Name = "Email")]
            public string Email { get; set; }

            [Required]
            [StringLength(100, ErrorMessage = "The {0} must be at least {2} and at max {1} characters long.", MinimumLength = 6)]
            [DataType(DataType.Password)]
            [Display(Name = "Password")]
            public string Password { get; set; }

            [DataType(DataType.Password)]
            [Display(Name = "Confirm password")]
            [Compare("Password", ErrorMessage = "The password and confirmation password do not match.")]
            public string ConfirmPassword { get; set; }
        }


        public async Task OnGetAsync(string returnUrl = null)
        {
            ReturnUrl = returnUrl;
            ExternalLogins = (await _signInManager.GetExternalAuthenticationSchemesAsync()).ToList();
        }

        public async Task<IActionResult> OnPostAsync(string returnUrl = null)
        {
            returnUrl ??= Url.Content("~/");
            ExternalLogins = (await _signInManager.GetExternalAuthenticationSchemesAsync()).ToList();
            if (ModelState.IsValid)
            {
                var user = CreateUser();

                user.Name = Input.Name;
                user.DOB = Input.DOB;

                await _userStore.SetUserNameAsync(user, Input.Email, CancellationToken.None);
                await _emailStore.SetEmailAsync(user, Input.Email, CancellationToken.None);
                var result = await _userManager.CreateAsync(user, Input.Password);

                if (result.Succeeded)
                {
                    _logger.LogInformation("User created a new account with password.");

                    var userId = await _userManager.GetUserIdAsync(user);
                    var code = await _userManager.GenerateEmailConfirmationTokenAsync(user);
                    code = WebEncoders.Base64UrlEncode(Encoding.UTF8.GetBytes(code));
                    var callbackUrl = Url.Page(
                        "/Account/ConfirmEmail",
                        pageHandler: null,
                        values: new { area = "Identity", userId = userId, code = code, returnUrl = returnUrl },
                        protocol: Request.Scheme);

                    await _emailSender.SendEmailAsync(Input.Email, "Confirm your email",
                        $"Please confirm your account by <a href='{HtmlEncoder.Default.Encode(callbackUrl)}'>clicking here</a>.");

                    if (_userManager.Options.SignIn.RequireConfirmedAccount)
                    {
                        return RedirectToPage("RegisterConfirmation", new { email = Input.Email, returnUrl = returnUrl });
                    }
                    else
                    {
                        await _signInManager.SignInAsync(user, isPersistent: false);
                        return LocalRedirect(returnUrl);
                    }
                }
                foreach (var error in result.Errors)
                {
                    ModelState.AddModelError(string.Empty, error.Description);
                }
            }

            // If we got this far, something failed, redisplay form
            return Page();
        }

        private WebApp1User CreateUser()
        {
            try
            {
                return Activator.CreateInstance<WebApp1User>();
            }
            catch
            {
                throw new InvalidOperationException($"Can't create an instance of '{nameof(WebApp1User)}'. " +
                    $"Ensure that '{nameof(WebApp1User)}' is not an abstract class and has a parameterless constructor, or alternatively " +
                    $"override the register page in /Areas/Identity/Pages/Account/Register.cshtml");
            }
        }

        private IUserEmailStore<WebApp1User> GetEmailStore()
        {
            if (!_userManager.SupportsUserEmail)
            {
                throw new NotSupportedException("The default UI requires a user store with email support.");
            }
            return (IUserEmailStore<WebApp1User>)_userStore;
        }
    }
}

Areas/Identity/Pages/Account/Register.cshtml Aktualizujte následující zvýrazněnou značku:

@page
@model RegisterModel
@{
    ViewData["Title"] = "Register";
}

<h1>@ViewData["Title"]</h1>

<div class="row">
    <div class="col-md-4">
        <form id="registerForm" asp-route-returnUrl="@Model.ReturnUrl" method="post">
            <h2>Create a new account.</h2>
            <hr />
            <div asp-validation-summary="ModelOnly" class="text-danger"></div>

            <div class="form-floating">
                <input asp-for="Input.Name" class="form-control" />
                <label asp-for="Input.Name"></label>
                <span asp-validation-for="Input.Name" class="text-danger"></span>
            </div>
            <div class="form-floating">
                <input asp-for="Input.DOB" class="form-control" />
                <label asp-for="Input.DOB"></label>
                <span asp-validation-for="Input.DOB" class="text-danger"></span>
            </div>

            <div class="form-floating">
                <input asp-for="Input.Email" class="form-control" autocomplete="username" aria-required="true" />
                <label asp-for="Input.Email"></label>
                <span asp-validation-for="Input.Email" class="text-danger"></span>
            </div>
            <div class="form-floating">
                <input asp-for="Input.Password" class="form-control" autocomplete="new-password" aria-required="true" />
                <label asp-for="Input.Password"></label>
                <span asp-validation-for="Input.Password" class="text-danger"></span>
            </div>
            <div class="form-floating">
                <input asp-for="Input.ConfirmPassword" class="form-control" autocomplete="new-password" aria-required="true" />
                <label asp-for="Input.ConfirmPassword"></label>
                <span asp-validation-for="Input.ConfirmPassword" class="text-danger"></span>
            </div>
            <button id="registerSubmit" type="submit" class="w-100 btn btn-lg btn-primary">Register</button>
        </form>
    </div>
    <div class="col-md-6 col-md-offset-2">
        <section>
            <h3>Use another service to register.</h3>
            <hr />
            @{
                if ((Model.ExternalLogins?.Count ?? 0) == 0)
                {
                    <div>
                        <p>
                            There are no external authentication services configured. See this <a href="https://go.microsoft.com/fwlink/?LinkID=532715">article
                            about setting up this ASP.NET application to support logging in via external services</a>.
                        </p>
                    </div>
                }
                else
                {
                    <form id="external-account" asp-page="./ExternalLogin" asp-route-returnUrl="@Model.ReturnUrl" method="post" class="form-horizontal">
                        <div>
                            <p>
                                @foreach (var provider in Model.ExternalLogins!)
                                {
                                    <button type="submit" class="btn btn-primary" name="provider" value="@provider.Name" title="Log in using your @provider.DisplayName account">@provider.DisplayName</button>
                                }
                            </p>
                        </div>
                    </form>
                }
            }
        </section>
    </div>
</div>

@section Scripts {
    <partial name="_ValidationScriptsPartial" />
}

Sestavte projekt.

Aktualizace rozložení

Pokyny pro přidání odkazů na přihlášení a odhlášení na každou stránku najdete v tématu Změny rozložení.

Přidání migrace pro vlastní uživatelská data

Visual Studio

V konzole sady Visual Studio Správce balíčků:

Add-Migration CustomUserData
Update-Database

.NET CLI

dotnet ef migrations add CustomUserData
dotnet ef database update

Testování vytvoření, zobrazení, stažení, odstranění vlastních uživatelských dat

Otestujte aplikaci:

• Zaregistrujte nového uživatele.
• Umožňuje zobrazit vlastní uživatelská data na /Identity/Account/Manage stránce.
• Stáhněte a zobrazte si osobní údaje uživatelů ze /Identity/Account/Manage/PersonalData stránky.