Jiasaw 1.0.1

Jiasaw文档

导入包

PM>Install-Package Jiasaw -Version 1.0.0
或者Nuget管理界面搜索 Jiasaw

身份验证模块-Authentication

使用方法

• 增加拦截器

   public static class WebApiConfig
   {
      public static void Register(HttpConfiguration config)
      {
        //增加拦截器
        config.Filters.Add(new AuthenticationFilter());            
      }
   }

• Global.asax 设置身份验证拦截器全局参数

 public class WebApiApplication : System.Web.HttpApplication
 {
        protected void Application_Start()
        {
            //设置没有注解的Action是否需要验证授权
            //默认为true
            AuthenticationConfig.SetAuthenticateNoAttribute(false);
            //设置ticket是否在验证授权之后,每次请求都更新ticket过期时间
            //默认为false
            AuthenticationConfig.SetRefreshTicket(true);
            //设置ticket过期时间,单位为秒
            //默认为1小时过期
            AuthenticationConfig.SetTicketExpire(1000);
        }
 }

• 需要授权的Action上增加注解

 [HttpGet]
 [Authentication(Authenticate =false)]
 public string Login()
 {
     object user = new object();
     List<string> roles = new List<string>() { "role1", "role2" };
     AuthenticationConfig.RegisterUserAndRole(user, roles);
     return "success";
 }
 

Authorization 值代表是否需要授权验证

AuthenticationConfig.RegisterUserAndRole(user, roles); 方法是存储当前用户信息，包括自定义的user，user对应的roles,roles值在验权值有用

• 身份验证通过

ticket:ticket的值

身份验证通过时，接口返回头中有ticket，以及ticket对应的值

前端在请求需要身份验证的接口请求头中加上tikect以及对应的值

• 身份验证失败

public class ExceptionFilter : IExceptionFilter
{
    public bool AllowMultiple =>true;

    public Task ExecuteExceptionFilterAsync(HttpActionExecutedContext actionExecutedContext, CancellationToken cancellationToken)
    {
        if (actionExecutedContext.Exception is AuthenticationException)
        {
        	//log 
        }
    	return null;
    }
}

项目中定义全局异常捕获，身份验证失败时，会抛出AuthenticationException，后续操作自行处理

权限验证模块-Authorization

使用方法

• 增加拦截器

   public static class WebApiConfig
   {
      public static void Register(HttpConfiguration config)
      {
        //增加拦截器
        config.Filters.Add(new AuthorizationFilter());            
      }
   }

• Global.asax 设置身份验证拦截器全局参数

 public class WebApiApplication : System.Web.HttpApplication
 {
     protected void Application_Start()
     {
        //设置没有注解是否要验权
        //默认为true
     	AuthorizationConfig.SetAuthorizationNoAttribute(false);
     }
 }

• 需要授权的Action上增加注解

 [HttpGet]
 [Authorization(Authorization =true,Logical =Logical.OR,Roles ="1,2,3,4")]
 public string Test()
 {     
     return "success";
 }
 

Authorization 值代表示否需要验证权限

Logical =Logical.OR|Logical.AND 表示 user roles 和 Authorization 的Roles验证逻辑

Logical.OR ：user roles只要有Authorization 的Roles其中一个

Logical.AND：user roles必须有Authorization 的Roles所有值

Roles：角色配置，多个角色以 , 分隔

• 身份验证失败

public class ExceptionFilter : IExceptionFilter
{
    public bool AllowMultiple =>true;

    public Task ExecuteExceptionFilterAsync(HttpActionExecutedContext actionExecutedContext, CancellationToken cancellationToken)
    {
        if (actionExecutedContext.Exception is AuthorizationException)
        {
        	//log 
        }
    	return null;
    }
}

项目中定义全局异常捕获，身份验证失败时，会抛出AuthorizationException，后续操作自行处理