Adição de Identidade do ASP.NET a um projeto vazio ou existente do Web Forms

Este tutorial mostra como adicionar ASP.net Identity (o novo sistema de associação para ASP.net) a um aplicativo ASP.net.

Quando você cria um novo projeto Web Forms ou MVC no Visual Studio 2017 RTM com contas individuais, o Visual Studio instalará todos os pacotes necessários e adicionará todas as classes necessárias para você. Este tutorial ilustra as etapas para adicionar ASP.NET Identity suporte ao seu projeto Web Forms existente ou a um novo projeto vazio. Vou descrever todos os pacotes NuGet que você precisa instalar e as classes que precisa adicionar. Abordarei Web Forms de exemplo para registrar novos usuários e fazer logon enquanto realçar todas as APIs de ponto de entrada principal para gerenciamento e autenticação de usuários. Este exemplo usará o ASP.NET Identity implementação padrão para o armazenamento de dados SQL, que é criado em Entity Framework. Este tutorial, usaremos o LocalDB para o banco de dados SQL.

Introdução ao ASP.NET Identity

  1. Comece Instalando e executando o Visual Studio 2017.

  2. Selecione novo projeto na página inicial, ou você pode usar o menu e selecionar arquivoe, em seguida, novo projeto.

  3. No painel esquerdo, expanda Visual C# , selecione Webe, em seguida, aplicativo Web ASP.net (.NET Framework) . Nomeie seu projeto como "WebFormsIdentity" e selecione OK.

  4. Na caixa de diálogo novo projeto ASP.net , selecione o modelo vazio .

    Observe que o botão alterar autenticação está desabilitado e nenhum suporte de autenticação é fornecido neste modelo. Os modelos Web Forms, MVC e API Web permitem que você selecione a abordagem de autenticação.

Adicionar pacotes de identidade ao seu aplicativo

Em Gerenciador de Soluções, clique com o botão direito do mouse em seu projeto e selecione gerenciar pacotes NuGet. Procure e instale o pacote Microsoft. AspNet. Identity. EntityFramework .

Observe que esse pacote instalará os pacotes de dependência: EntityFramework e Microsoft ASP.net Identity Core.

Adicionar um formulário da Web para registrar usuários

  1. Em Gerenciador de soluções, clique com o botão direito do mouse no projeto e selecione Adicionare, em seguida, formulário da Web.

  2. Na caixa de diálogo especificar nome para o item , nomeie o novo registrode formulário da Web e, em seguida, selecione OK

  3. Substitua a marcação no arquivo Register. aspx gerado pelo código a seguir. As alterações de código são realçadas.

    <%@ Page Language="C#" AutoEventWireup="true" CodeBehind="Register.aspx.cs" Inherits="WebFormsIdentity.Register" %>
    
    <!DOCTYPE html>
    
    <html xmlns="http://www.w3.org/1999/xhtml">
    <head runat="server">
        <title></title>
    </head>
    <body style="font-family: Arial, Helvetica, sans-serif; font-size: small">
        <form id="form1" runat="server">
        <div>
            <h4 style="font-size: medium">Register a new user</h4>
            <hr />
            <p>
                <asp:Literal runat="server" ID="StatusMessage" />
            </p>                
            <div style="margin-bottom:10px">
                <asp:Label runat="server" AssociatedControlID="UserName">User name</asp:Label>
                <div>
                    <asp:TextBox runat="server" ID="UserName" />                
                </div>
            </div>
            <div style="margin-bottom:10px">
                <asp:Label runat="server" AssociatedControlID="Password">Password</asp:Label>
                <div>
                    <asp:TextBox runat="server" ID="Password" TextMode="Password" />                
                </div>
            </div>
            <div style="margin-bottom:10px">
                <asp:Label runat="server" AssociatedControlID="ConfirmPassword">Confirm password</asp:Label>
                <div>
                    <asp:TextBox runat="server" ID="ConfirmPassword" TextMode="Password" />                
                </div>
            </div>
            <div>
                <div>
                    <asp:Button runat="server" OnClick="CreateUser_Click" Text="Register" />
                </div>
            </div>
        </div>
        </form>
    </body>
    </html>
    

    Note

    Essa é apenas uma versão simplificada do arquivo Register. aspx que é criado quando você cria um novo projeto ASP.NET Web Forms. A marcação acima adiciona campos de formulário e um botão para registrar um novo usuário.

  4. Abra o arquivo Register.aspx.cs e substitua o conteúdo do arquivo pelo código a seguir:

    using Microsoft.AspNet.Identity;
    using Microsoft.AspNet.Identity.EntityFramework;
    using System;
    using System.Linq;
    
    namespace WebFormsIdentity
    {
       public partial class Register : System.Web.UI.Page
       {
          protected void CreateUser_Click(object sender, EventArgs e)
          {
             // Default UserStore constructor uses the default connection string named: DefaultConnection
             var userStore = new UserStore<IdentityUser>();
             var manager = new UserManager<IdentityUser>(userStore);
    
             var user = new IdentityUser() { UserName = UserName.Text };
             IdentityResult result = manager.Create(user, Password.Text);
    
             if (result.Succeeded)
             {
                StatusMessage.Text = string.Format("User {0} was created successfully!", user.UserName);
             }
             else
             {
                StatusMessage.Text = result.Errors.FirstOrDefault();
             }
          }
       }
    }
    

    Note

    1. O código acima é uma versão simplificada do arquivo Register.aspx.cs que é criada quando você cria um novo projeto de Web Forms do ASP.net.
    2. A classe IdentityUser é a implementação padrão do EntityFramework da interface IUser . A interface IUser é a interface mínima para um usuário no ASP.net Identity Core.
    3. A classe USERSTORE é a implementação padrão do EntityFramework de um armazenamento de usuário. Essa classe implementa as interfaces mínimas do ASP.NET Identity Core: IUserStore, IUserLoginStore, IUserClaimStore e IUserRoleStore.
    4. A classe usermanager expõe as APIs relacionadas ao usuário, que salvarão automaticamente as alterações no USERSTORE.
    5. A classe IdentityResult representa o resultado de uma operação de identidade.
  5. Em Gerenciador de soluções, clique com o botão direito do mouse em seu projeto e selecione Adicionar, Adicionar pasta ASP.net e, em seguida, aplicativos_dados.

  6. Abra o arquivo Web. config e adicione uma entrada de cadeia de conexão para o banco de dados que usaremos para armazenar informações do usuário. O banco de dados será criado em tempo de execução pelo EntityFramework para as entidades de identidade. A cadeia de conexão é semelhante a uma criada para você quando você cria um novo projeto de Web Forms. O código realçado mostra a marcação que você deve adicionar:

    <?xml version="1.0" encoding="utf-8"?>
    <!--
      For more information on how to configure your ASP.NET application, please visit
      https://go.microsoft.com/fwlink/?LinkId=169433
      -->
    <configuration>
      <configSections>
        <!-- For more information on Entity Framework configuration, visit https://go.microsoft.com/fwlink/?LinkID=237468 -->
        <section name="entityFramework" type="System.Data.Entity.Internal.ConfigFile.EntityFrameworkSection, EntityFramework, Version=6.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" />
      </configSections>
       <connectionStrings>
          <add name="DefaultConnection" connectionString="Data Source=(LocalDb)\v11.0;AttachDbFilename=|DataDirectory|\WebFormsIdentity.mdf;Initial Catalog=WebFormsIdentity;Integrated Security=True"
                providerName="System.Data.SqlClient" />
       </connectionStrings>
      <system.web>
        <compilation debug="true" targetFramework="4.5" />
        <httpRuntime targetFramework="4.5" />
      </system.web>
      <entityFramework>
        <defaultConnectionFactory type="System.Data.Entity.Infrastructure.LocalDbConnectionFactory, EntityFramework">
          <parameters>
            <parameter value="v11.0" />
          </parameters>
        </defaultConnectionFactory>
        <providers>
          <provider invariantName="System.Data.SqlClient" type="System.Data.Entity.SqlServer.SqlProviderServices, EntityFramework.SqlServer" />
        </providers>
      </entityFramework>
    </configuration>
    

    Note

    Para o Visual Studio 2015 ou superior, substitua (localdb)\v11.0 por (localdb)\MSSQLLocalDB na cadeia de conexão.

  7. Clique com o botão direito do mouse em File Register. aspx em seu projeto e selecione definir como página inicial. Pressione CTRL + F5 para compilar e executar o aplicativo Web. Insira um novo nome de usuário e senha e, em seguida, selecione registrar.

    Note

    ASP.NET Identity tem suporte para validação e, neste exemplo, você pode verificar o comportamento padrão nos validadores de usuário e senha que vêm do pacote de identidade principal. O validador padrão para o usuário (UserValidator) tem uma propriedade AllowOnlyAlphanumericUserNames que tem o valor padrão definido como true. O validador padrão para a senha (MinimumLengthValidator) garante que a senha tenha pelo menos 6 caracteres. Esses validadores são propriedades em UserManager que podem ser substituídas se você quiser ter validação personalizada,

Verificar o banco de dados de identidade LocalDb e as tabelas geradas por Entity Framework

  1. No menu Exibir , selecione Gerenciador de servidores.

  2. Expanda DefaultConnection (WebFormsIdentity) , expanda tabelas, clique com o botão direito do mouse em AspNetUsers e selecione Mostrar dados da tabela.


Configurar o aplicativo para autenticação OWIN

Neste ponto, adicionamos apenas suporte para a criação de usuários. Agora, vamos demonstrar como podemos adicionar autenticação para fazer logon em um usuário. ASP.NET Identity usa o middleware de autenticação OWIN da Microsoft para autenticação de formulários. A autenticação de cookie OWIN é um mecanismo de autenticação baseado em declarações e um cookie que pode ser usado por qualquer estrutura hospedada no OWIN ou no IIS. Com esse modelo, os mesmos pacotes de autenticação podem ser usados em várias estruturas, incluindo ASP.NET MVC e Web Forms. Para obter mais informações sobre o projeto Katana e como executar o middleware em um host independente, consulte introdução com o projeto Katana.

Instalar pacotes de autenticação em seu aplicativo

  1. Em Gerenciador de Soluções, clique com o botão direito do mouse em seu projeto e selecione gerenciar pacotes NuGet. Procure e instale o pacote Microsoft. AspNet. Identity. Owin .

  2. Procure e instale o pacote Microsoft. Owin. host. SystemWeb .

    Note

    O pacote Microsoft. AspNet. Identity. Owin contém um conjunto de classes de extensão Owin para gerenciar e configurar o middleware de autenticação Owin a ser consumido por pacotes de núcleo ASP.net Identity. O pacote Microsoft. Owin. host. SystemWeb contém um servidor Owin que permite que aplicativos baseados em Owin sejam executados no IIS usando o pipeline de solicitação ASP.net. Para obter mais informações, consulte middleware OWIN no pipeline integrado do IIS.

Adicionar classes de configuração de inicialização e autenticação do OWIN

  1. Em Gerenciador de soluções, clique com o botão direito do mouse em seu projeto, selecione Adicionare Adicionar novo item. No diálogo Pesquisar caixa de texto, digite "Owin". Nomeie a classe "Startup" e selecione Adicionar.

  2. No arquivo Startup.cs, adicione o código realçado mostrado abaixo para configurar a autenticação de cookie do OWIN.

    using Microsoft.AspNet.Identity;
    using Microsoft.Owin;
    using Microsoft.Owin.Security.Cookies;
    using Owin;
    
    [assembly: OwinStartup(typeof(WebFormsIdentity.Startup))]
    
    namespace WebFormsIdentity
    {
       public class Startup
       {
          public void Configuration(IAppBuilder app)
          {
             // For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=316888
             app.UseCookieAuthentication(new CookieAuthenticationOptions
             {
                AuthenticationType = DefaultAuthenticationTypes.ApplicationCookie,
                LoginPath = new PathString("/Login")
             });
          }
       }
    }
    

    Note

    Essa classe contém o atributo OwinStartup para especificar a classe de inicialização OWIN. Cada aplicativo OWIN tem uma classe de inicialização na qual você especifica componentes para o pipeline de aplicativo. Consulte detecção de classe de inicialização OWIN para obter mais informações sobre este modelo.

Adicionar formulários da Web para registro e entrada de usuários

  1. Abra o arquivo Register.aspx.cs e adicione o código a seguir que assina o usuário quando o registro é executado com sucesso.

    using Microsoft.AspNet.Identity;
    using Microsoft.AspNet.Identity.EntityFramework;
    using Microsoft.Owin.Security;
    using System;
    using System.Linq;
    using System.Web;
    
    namespace WebFormsIdentity
    {
       public partial class Register : System.Web.UI.Page
       {
          protected void CreateUser_Click(object sender, EventArgs e)
          {
             // Default UserStore constructor uses the default connection string named: DefaultConnection
             var userStore = new UserStore<IdentityUser>();
             var manager = new UserManager<IdentityUser>(userStore);
             var user = new IdentityUser() { UserName = UserName.Text };
    
             IdentityResult result = manager.Create(user, Password.Text);
    
             if (result.Succeeded)
             {
                var authenticationManager = HttpContext.Current.GetOwinContext().Authentication;
                var userIdentity = manager.CreateIdentity(user, DefaultAuthenticationTypes.ApplicationCookie);
                authenticationManager.SignIn(new AuthenticationProperties() { }, userIdentity);
                Response.Redirect("~/Login.aspx");
             }
             else
             {
                StatusMessage.Text = result.Errors.FirstOrDefault();
             }
          }
       }
    }
    

    Note

    • Como a autenticação de cookie ASP.NET Identity e OWIN é um sistema baseado em declarações, a estrutura requer que o desenvolvedor do aplicativo gere um ClaimsIdentity para o usuário. ClaimsIdentity tem informações sobre todas as declarações para o usuário, como a quais funções o usuário pertence. Você também pode adicionar mais declarações para o usuário neste estágio.
    • Você pode entrar no usuário usando o CustomTargetNameDictionary de OWIN e chamando SignIn e passando o ClaimsIdentity conforme mostrado acima. Esse código conectará o usuário e gerará um cookie também. Essa chamada é análoga a FormAuthentication. SetAuthCookie usado pelo módulo FormsAuthentication .
  2. Em Gerenciador de soluções, clique com o botão direito do mouse no projeto, selecione Adicionare, em seguida, formulário da Web. Nomeie o logondo Web Form.

  3. Substitua o conteúdo do arquivo login. aspx pelo código a seguir:

    <%@ Page Language="C#" AutoEventWireup="true" CodeBehind="Login.aspx.cs" Inherits="WebFormsIdentity.Login" %>
    
    <!DOCTYPE html>
    
    <html xmlns="http://www.w3.org/1999/xhtml">
    <head runat="server">
       <title></title>
    </head>
    <body style="font-family: Arial, Helvetica, sans-serif; font-size: small">
       <form id="form1" runat="server">
          <div>
             <h4 style="font-size: medium">Log In</h4>
             <hr />
             <asp:PlaceHolder runat="server" ID="LoginStatus" Visible="false">
                <p>
                   <asp:Literal runat="server" ID="StatusText" />
                </p>
             </asp:PlaceHolder>
             <asp:PlaceHolder runat="server" ID="LoginForm" Visible="false">
                <div style="margin-bottom: 10px">
                   <asp:Label runat="server" AssociatedControlID="UserName">User name</asp:Label>
                   <div>
                      <asp:TextBox runat="server" ID="UserName" />
                   </div>
                </div>
                <div style="margin-bottom: 10px">
                   <asp:Label runat="server" AssociatedControlID="Password">Password</asp:Label>
                   <div>
                      <asp:TextBox runat="server" ID="Password" TextMode="Password" />
                   </div>
                </div>
                <div style="margin-bottom: 10px">
                   <div>
                      <asp:Button runat="server" OnClick="SignIn" Text="Log in" />
                   </div>
                </div>
             </asp:PlaceHolder>
             <asp:PlaceHolder runat="server" ID="LogoutButton" Visible="false">
                <div>
                   <div>
                      <asp:Button runat="server" OnClick="SignOut" Text="Log out" />
                   </div>
                </div>
             </asp:PlaceHolder>
          </div>
       </form>
    </body>
    </html>
    
  4. Substitua o conteúdo do arquivo login.aspx.cs pelo seguinte:

    using Microsoft.AspNet.Identity;
    using Microsoft.AspNet.Identity.EntityFramework;
    using Microsoft.Owin.Security;
    using System;
    using System.Web;
    using System.Web.UI.WebControls;
    
    namespace WebFormsIdentity
    {
       public partial class Login : System.Web.UI.Page
       {
          protected void Page_Load(object sender, EventArgs e)
          {
             if (!IsPostBack)
             {
                if (User.Identity.IsAuthenticated)
                {
                   StatusText.Text = string.Format("Hello {0}!!", User.Identity.GetUserName());
                   LoginStatus.Visible = true;
                   LogoutButton.Visible = true;
                }
                else
                {
                   LoginForm.Visible = true;
                }
             }
          }
    
          protected void SignIn(object sender, EventArgs e)
          {
             var userStore = new UserStore<IdentityUser>();
             var userManager = new UserManager<IdentityUser>(userStore);
             var user = userManager.Find(UserName.Text, Password.Text);
    
             if (user != null)
             {
                var authenticationManager = HttpContext.Current.GetOwinContext().Authentication;
                var userIdentity = userManager.CreateIdentity(user, DefaultAuthenticationTypes.ApplicationCookie);
    
                authenticationManager.SignIn(new AuthenticationProperties() { IsPersistent = false }, userIdentity);
                Response.Redirect("~/Login.aspx");
             }
             else
             {
                StatusText.Text = "Invalid username or password.";
                LoginStatus.Visible = true;
             }
          }
    
          protected void SignOut(object sender, EventArgs e)
          {
             var authenticationManager = HttpContext.Current.GetOwinContext().Authentication;
             authenticationManager.SignOut();
             Response.Redirect("~/Login.aspx");
          }
       }
    }
    

    Note

    • O Page_Load agora verifica o status do usuário atual e executa uma ação com base em seu status de Context.User.Identity.IsAuthenticated. Exibir nome de usuário conectado : o Microsoft ASP.NET estrutura de identidade adicionou métodos de extensão em System. Security. principal. IIdentity que permite que você obtenha o UserName e UserId para o usuário conectado. Esses métodos de extensão são definidos no assembly Microsoft.AspNet.Identity.Core. Esses métodos de extensão são a substituição para HttpContext.User.Identity.Name .
    • Método de entrada: This método substitui o método CreateUser_Click anterior neste exemplo e agora entra no usuário depois de criar o usuário com êxito.
      O Microsoft OWIN Framework adicionou métodos de extensão em System.Web.HttpContext que permite obter uma referência a um IOwinContext. Esses métodos de extensão são definidos no assembly Microsoft.Owin.Host.SystemWeb. A classe OwinContext expõe uma propriedade IAuthenticationManager que representa a funcionalidade de middleware de autenticação disponível na solicitação atual. Você pode entrar no usuário usando o AuthenticationManager de OWIN e chamando SignIn e passando o ClaimsIdentity conforme mostrado acima. Como a autenticação de cookie ASP.NET Identity e OWIN é um sistema baseado em declarações, a estrutura requer que o aplicativo gere um ClaimsIdentity para o usuário. O ClaimsIdentity tem informações sobre todas as declarações para o usuário, como as funções às quais o usuário pertence. Você também pode adicionar mais declarações para o usuário neste estágio. esse código entrará no usuário e gerará um cookie também. Essa chamada é análoga a FormAuthentication. SetAuthCookie usado pelo módulo FormsAuthentication .
    • método de SignOut: Obtém uma referência ao AuthenticationManager de OWIN e chama SignOut. Isso é análogo ao método FormsAuthentication. SignOut usado pelo módulo FormsAuthentication .
  5. Pressione Ctrl + F5 para compilar e executar o aplicativo Web. Insira um novo nome de usuário e senha e, em seguida, selecione registrar.


    Observação: neste ponto, o novo usuário é criado e conectado.

  6. Selecione o botão fazer logoff . Você será redirecionado para o formulário de logon.

  7. Insira um nome de usuário ou senha inválido e selecione o botão fazer logon . O método UserManager.Find retornará NULL e a mensagem de erro: " nome de usuário ou senha inválido " será exibido.