Authentication and Authorize in Web API 2

Trong bài viết này, chúng ta sẽ cài đặt và sử dụng Identity cho dự án Web API. Bên cạnh đó, chúng ta sẽ sử dụng Entity Framework Migrations để quản lý phiên bản và thiết lập dữ liệu ban đầu cho database

Thiết lập cấu hình ASP.NET Identity 2.1 với ASP.NET Web API 2.2

Trong bài viết này, chúng ta sẽ sử dụng Visual Studio 2017 và .NET Framework 4.5.
Tạo 1 dự án tên là AspNetIdentity

 

Cài đặt Nuget Packages

Chúng ta sẽ cài đặt Nuget packages để thiết lập Owin server và cấu hình ASPNET Web API để lưu trữ Owin Server.

Install-Package Microsoft.AspNet.Identity.Owin
Install-Package Microsoft.AspNet.Identity.EntityFramework
Install-Package Microsoft.Owin.Host.SystemWeb
Install-Package Microsoft.AspNet.WebApi.Owin
Install-Package Microsoft.Owin.Security.OAuth
Install-Package Microsoft.Owin.Cors

Giải thích

• Microsoft.AspNet.Identity.OWIN: được sử dụng khi bạn thêm hàm login vào hệ thống và gọi OWIN Cookie Authentication middleware để tạo cookie.
• Microsoft.AspNet.Identity.EntityFramework: dùng để ánh xạ dữ liệu và schema ASP.NET vào SQL Server.
• Microsoft.Owin.Host.SystemWeb: cho phép server Owin chạy API trên IIS sử dụng ASP.NET request pipeline.
• Microsoft.AspNet.WebApi.Owin: cho phép bạn lưu trữ ASP.Net Web API trong OWIN Server và cung cấp quyền truy cập các tính năng của OWIN.
• Microsoft.Owin.Security.Oauth: là 1 Middleware, cho phép ứng dụng hỗ trợ đăng nhập bằng Oauth 2.0.
• Microsoft.Owin.Cors: chứa những components cho phép thực hiện Cross-Origin Resource Sharing (CORS) trong OWIN middleware (truy cập các resource bên ngoài).

Bạn có thể tham khảo thêm bài viết: Introduction to ASP.NET Identity

Thêm class ApplicationUser và ApplicatonDbContext

Bạn tạo class ApplicationUser. Class này đại diện cho 1 user muốn đăng ký vào hệ thống.
Chúng ta sẽ mở rộng class mặc định, thêm các thuộc tính: FirstName, LastName. Những thuộc tính này sẽ được chuyển thành cột trong bảng AspNetUsers

using System;
using System.ComponentModel.DataAnnotations;
using Microsoft.AspNet.Identity.EntityFramework;

namespace AspNetIdentity.Infrastructure
{
    public class ApplicationUser : IdentityUser
    {
        [Required]
        [MaxLength(100)]
        public string FirstName { get; set; }

        [Required]
        [MaxLength(100)]
        public string LastName { get; set; }

        [Required]
        public byte Level { get; set; }

        [Required]
        public DateTime JoinDate { get; set; }

    }
}

Bạn thêm class ApplicationDbContext. Class này sẽ chịu trách nhiệm giao tiếp với Database.

    public class ApplicationDbContext : IdentityDbContext<applicationuser>
    {
        public ApplicationDbContext()
            : base("DemoContext", throwIfV1Schema: false)
        {
            Configuration.ProxyCreationEnabled = false;
            Configuration.LazyLoadingEnabled = false;
        }

        public static ApplicationDbContext Create()
        {
            return new ApplicationDbContext();
        }
}

Thay vì kế thừa từ DbContext, bạn sẽ kế thừa từ IdentityDbContext.
Đây là 1 phiên bản đặc biệt của DbContext,cung cấp tất cả các mapping và DbSet để quản lý Identity trong Sql Server.
Hàm Static Create được gọi trong class OWIN Startup. Sau đó, bạn phải thêm connection string vào web.config

<connectionStrings>
    <add name="DemoContext" connectionString="Server=.;Database=AspNetIdentity;User ID=sa;Password=123456;MultipleActiveResultSets=True;Trusted_Connection=False;Connection Timeout=10800000;" providerName="System.Data.SqlClient" />
  </connectionStrings>

Thiết lập Migration

Trong nuget package console, bạn gõ:

enable-migrations
add-migration InitialCreate

Để cho phép sử dụng Migration và tạo phiên bản đầu tiên: InitialCreate.
Để cập nhật Database, bạn dùng câu lệnh:

Update-database

Class OWIN Startup

public class Startup
    {

        public void Configuration(IAppBuilder app)
        {
            HttpConfiguration httpConfig = new HttpConfiguration();

            ConfigureOAuthTokenGeneration(app);

            ConfigureWebApi(httpConfig);

            app.UseCors(Microsoft.Owin.Cors.CorsOptions.AllowAll);

            app.UseWebApi(httpConfig);

        }

        private void ConfigureOAuthTokenGeneration(IAppBuilder app)
        {
            // Configure the db context and user manager to use a single instance per request
            app.CreatePerOwinContext(LegacyDatabaseContext.Create);
            app.CreatePerOwinContext<ApplicationUserManager>(ApplicationUserManager.Create);

            // Plugin the OAuth bearer JSON Web Token tokens generation and Consumption will be here

        }

        private void ConfigureWebApi(HttpConfiguration config)
        {
            config.MapHttpAttributeRoutes();

            var jsonFormatter = config.Formatters.OfType<JsonMediaTypeFormatter>().First();
            jsonFormatter.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();
        }
    }

Class Owin Startup sẽ được kích hoạt 1 lần khi server khởi động. Tham số “IAppBuilder” sẽ được cung cấp cho hàm “Configuration” trong lúc host đang chạy.

Định nghĩa controllers và hàm Web API

Bây giờ, chúng ta sẽ định nghĩa AccountController. Đây là class chịu trách nhiệm quản lý user trong hệ thống Identity.

    [RoutePrefix("api/accounts")]
    public class AccountsController : BaseApiController
    {

        [Route("users")]
        public IHttpActionResult GetUsers()
        {
            var result = AppUserManager.Users.ToList().Select(u => this.TheModelFactory.Create(u));
            return Ok(result);
        }

        [Route("user/{id:guid}", Name = "GetUserById")]
        public async Task<IHttpActionResult> GetUser(string Id)
        {
            var user = await this.AppUserManager.FindByIdAsync(Id);

            if (user != null)
            {
                var createdUserResult = TheModelFactory.Create(user);
                return Ok(createdUserResult);
            }

            return NotFound();

        }

        [Route("user/{username}")]
        public async Task<IHttpActionResult> GetUserByName(string username)
        {
            var user = await this.AppUserManager.FindByNameAsync(username);

            if (user != null)
            {
                var getUserResult = TheModelFactory.Create(user);
                return Ok(getUserResult);
            }

            return NotFound();

        }

        [Route("create")]
        public async Task<IHttpActionResult> CreateUser(CreateUserBindingModel createUserModel)
        {
            if (!ModelState.IsValid)
            {
                return BadRequest(ModelState);
            }

            var user = new ApplicationUser()
            {
                UserName = createUserModel.Username,
                Email = createUserModel.Email,
                FirstName = createUserModel.FirstName,
                LastName = createUserModel.LastName,
                Level = 3,
                JoinDate = DateTime.Now.Date,
            };

            var addUserResult = await this.AppUserManager.CreateAsync(user, createUserModel.Password);

            if (!addUserResult.Succeeded)
            {
                return GetErrorResult(addUserResult);
            }

            var locationHeader = new Uri(Url.Link("GetUserById", new { id = user.Id }));

            return Created(locationHeader, TheModelFactory.Create(user));
        }
    }

“AccountsController” kế thừa từ base controller “BaseApiController”.
“BaseApiController” sẽ chứa: “AppUserManager”, “TheModelFactory”, and “GetErrorResult”.

    public class BaseApiController : ApiController
    {

        private ModelFactory _modelFactory;
        private readonly ApplicationUserManager _appUserManager = null;

        protected ApplicationUserManager AppUserManager => _appUserManager ?? Request.GetOwinContext().GetUserManager<ApplicationUserManager>();


        protected ModelFactory TheModelFactory => _modelFactory ?? (_modelFactory = new ModelFactory(Request, AppUserManager));

        protected IHttpActionResult GetErrorResult(IdentityResult result)
        {
            if (result == null)
            {
                return InternalServerError();
            }

            if (result.Succeeded) return null;
            if (result.Errors != null)
            {
                foreach (string error in result.Errors)
                {
                    ModelState.AddModelError("", error);
                }
            }

            if (ModelState.IsValid)
            {
                // No ModelState errors are available to send, so just return an empty BadRequest.
                return BadRequest();
            }

            return BadRequest(ModelState);
        }
    }

• Chúng ta có đối tượng “AppUserManager” dùng để trả về đối tượng “ApplicationUserManager”.
• “TheModelFactory” trả về kết quả kiểu “ModelFactory”, bao gồm các thuộc tính Id, UserName, Email…
•  “GetErrorResult”: định dạng lỗi trả về phía client

Lưu ý:
Header của mỗi Request:

Header: Content-Type: application/json; charset=utf-8

Ví dụ:
Trường hợp thành công
Request body:

{
  "Email": "anbinhtrong@gmail.com",
  "Username": "anbinhtrong",
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "RoleName": "sample string 5",
  "Password": "Abc123123",
  "ConfirmPassword": "Abc123123"
}

Kết quả trả về:

{
  "url": "http://localhost:23824/api/accounts/user/ad4454ec-a255-4171-bd26-2d8045e6265f",
  "id": "ad4454ec-a255-4171-bd26-2d8045e6265f",
  "userName": "anbinhtrong",
  "fullName": "sample string 3 sample string 4",
  "email": "anbinhtrong@gmail.com",
  "emailConfirmed": false,
  "level": 3,
  "joinDate": "2017-05-29T00:00:00+07:00",
  "roles": [],
  "claims": []
}

 Trường hợp lỗi:

Tham khảo

Bài viết được tham khảo từ http://johnatten.com/2013/10/27/configuring-db-connection-and-code-first-migration-for-identity-accounts-in-asp-net-mvc-5-and-visual-studio-2013/
Và http://bitoftech.net/2015/01/21/asp-net-identity-2-with-asp-net-web-api-2-accounts-management/