提高进程请看,Claim等连锁知识

在微软Tech Summit 2017 大会上和豪门大快朵颐了一门学科《.NET Core
在腾讯财付通的商号级应用开发实践》,在那之中重点是依照ASP.NET
Core构建可扩张的高品质公司级API网关,以开源的API网关Ocelot为底蕴结合本身的作业特色,当天科目唯有40分钟,有诸多剧情都并未开始展览,接下去就用一篇小小说来聊下Ocelot
的落实原理,大家在采用的经过中也能够共同来进献。 总体来说那是2个ASP.NET
Core
高级编制程序的始末,此前在万众号里已经发过不少各位朋友写的文章,后日都会在那篇文章中引用,让你越来越深远学习。

连带知识点

不再对IdentityServer4做连锁介绍,今日头条上曾经有人出了连带的多级小说,不精通的能够看一下:

蟋蟀大神的:菜肴学习编制程序-IdentityServer4

晓晨Master:IdentityServer4

以及Identity,Claim等连锁知识:

Savorboard:ASP.NET Core 之 Identity
入门(一)
ASP.NET
Core 之 Identity
入门(二)

图片 1

创建IndentityServer4 服务

开创一个名为QuickstartIdentityServer的ASP.NET Core Web 空项目(asp.net
core 2.0),端口四千

图片 2

图片 3

NuGet包:

图片 4

修改Startup.cs 设置使用IdentityServer:

public class Startup
    {
        public void ConfigureServices(IServiceCollection services)
        {
            // configure identity server with in-memory stores, keys, clients and scopes
            services.AddIdentityServer()
                .AddDeveloperSigningCredential()
                .AddInMemoryIdentityResources(Config.GetIdentityResourceResources())
                .AddInMemoryApiResources(Config.GetApiResources())
                .AddInMemoryClients(Config.GetClients())
                .AddResourceOwnerValidator<ResourceOwnerPasswordValidator>()
                .AddProfileService<ProfileService>();
        }

        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            app.UseIdentityServer();
        }
    }

添加Config.cs配置IdentityResource,ApiResource以及Client:

 public class Config
    {
        public static IEnumerable<IdentityResource> GetIdentityResourceResources()
        {
            return new List<IdentityResource>
            {
                new IdentityResources.OpenId(), //必须要添加,否则报无效的scope错误
                new IdentityResources.Profile()
            };
        }
        // scopes define the API resources in your system
        public static IEnumerable<ApiResource> GetApiResources()
        {
            return new List<ApiResource>
            {
                new ApiResource("api1", "My API")
            };
        }

        // clients want to access resources (aka scopes)
        public static IEnumerable<Client> GetClients()
        {
            // client credentials client
            return new List<Client>
            {
                new Client
                {
                    ClientId = "client1",
                    AllowedGrantTypes = GrantTypes.ClientCredentials,

                    ClientSecrets = 
                    {
                        new Secret("secret".Sha256())
                    },
                    AllowedScopes = { "api1",IdentityServerConstants.StandardScopes.OpenId, //必须要添加,否则报forbidden错误
                  IdentityServerConstants.StandardScopes.Profile},

                },

                // resource owner password grant client
                new Client
                {
                    ClientId = "client2",
                    AllowedGrantTypes = GrantTypes.ResourceOwnerPassword,

                    ClientSecrets = 
                    {
                        new Secret("secret".Sha256())
                    },
                    AllowedScopes = { "api1",IdentityServerConstants.StandardScopes.OpenId, //必须要添加,否则报forbidden错误
                  IdentityServerConstants.StandardScopes.Profile }
                }
            };
        }
    }

因为要使用登录的时候要利用数据中保留的用户举办验证,要实IResourceOwnerPasswordValidator接口:

public class ResourceOwnerPasswordValidator : IResourceOwnerPasswordValidator
    {
        public ResourceOwnerPasswordValidator()
        {

        }

        public async Task ValidateAsync(ResourceOwnerPasswordValidationContext context)
        {
            //根据context.UserName和context.Password与数据库的数据做校验,判断是否合法
            if (context.UserName=="wjk"&&context.Password=="123")
            {
                context.Result = new GrantValidationResult(
                 subject: context.UserName,
                 authenticationMethod: "custom",
                 claims: GetUserClaims());
            }
            else
            {

                 //验证失败
                 context.Result = new GrantValidationResult(TokenRequestErrors.InvalidGrant, "invalid custom credential");
            }
        }
        //可以根据需要设置相应的Claim
        private Claim[] GetUserClaims()
        {
            return new Claim[]
            {
            new Claim("UserId", 1.ToString()),
            new Claim(JwtClaimTypes.Name,"wjk"),
            new Claim(JwtClaimTypes.GivenName, "jaycewu"),
            new Claim(JwtClaimTypes.FamilyName, "yyy"),
            new Claim(JwtClaimTypes.Email, "977865769@qq.com"),
            new Claim(JwtClaimTypes.Role,"admin")
            };
        }
    }

IdentityServer提供了接口访问用户音讯,不过暗中同意重临的数量只有sub,就是地方安装的subject:
context.UserName,要再次来到越多的音讯,需求贯彻IProfile瑟维斯接口:

public class ProfileService : IProfileService
    {
        public async Task GetProfileDataAsync(ProfileDataRequestContext context)
        {
            try
            {
                //depending on the scope accessing the user data.
                var claims = context.Subject.Claims.ToList();

                //set issued claims to return
                context.IssuedClaims = claims.ToList();
            }
            catch (Exception ex)
            {
                //log your error
            }
        }

        public async Task IsActiveAsync(IsActiveContext context)
        {
            context.IsActive = true;
        }

context.Subject.Claims正是事先完毕IResourceOwnerPasswordValidator接口时claims:
GetUserClaims()给到的数据。
另外,经过调节和测试发现,呈现执行ResourceOwnerPasswordValidator
里的ValidateAsync,然后实施ProfileService里的IsActiveAsync,GetProfileDataAsync。

运行项目,使用postman进行呼吁就足以获得到token:

图片 5

再用token获取相应的用户新闻:

图片 6

token认证服务一般是与web程序分其余,上边创制的QuickstartIdentityServer项目就也就是服务端,大家需求写作业逻辑的web程序就一定于客户端。当用户请求web程序的时候,web程序拿着用户已经报到取得的token去IdentityServer服务端校验。

 

创建web应用

制造一个名为API的ASP.NET Core Web 空项目(asp.net core 2.0),端口5001。

NuGet包:

图片 7

修改Startup.cs 设置使用IdentityServer进行校验:

public class Startup
    {
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvcCore(option=>
            {
                option.Filters.Add(new TestAuthorizationFilter());
            }).AddAuthorization()
                .AddJsonFormatters();

            services.AddAuthentication("Bearer")
                .AddIdentityServerAuthentication(options =>
                {
                    options.Authority = "http://localhost:5000";
                    options.RequireHttpsMetadata = false;

                    options.ApiName = "api1";
                });
        }

        public void Configure(IApplicationBuilder app)
        {
            app.UseAuthentication();

            app.UseMvc();
        }
    }

创建IdentityController:

[Route("[controller]")]
    public class IdentityController : ControllerBase
    {
        [HttpGet]
        [Authorize]
        public IActionResult Get()
        {
            return new JsonResult("Hello Word");
        }

    }

独家运转QuickstartIdentityServer,API项目。用生成的token访问API:

图片 8

通过上述顺序,已经能够做多个光景端分离的记名功用。

事实上,web应用程序中大家日常须求获得当前用户的相关音讯实行操作,比如记录用户的有的操作日志等。以前说过IdentityServer提供了接口/connect/userinfo来获取用户的有关新闻。从前自身的想法也是web程序中拿着token去乞请那些接口来获取用户新闻,并且第四回拿走后做相应的缓冲。但是觉得微微古怪,IdentityServer不容许没有想到那点,平常的做法应该是校验通过会将用户的音信重返的web程序中。难题又来了,即便IdentityServer真的是那般做的,web程序该怎么获取到吗,查了合法文档也远非找到。然后就拿着”Claim”关键字查了一通(从前没领悟过ASP.NET
Identity),最后通过HttpContext.User.Claims取到了设置的用户音信:

修改IdentityController :

[Route("[controller]")]
    public class IdentityController : ControllerBase
    {
        [HttpGet]
        [Authorize]
        public IActionResult Get()
        {
            return new JsonResult(from c in HttpContext.User.Claims select new { c.Type, c.Value });
        }

    }

图片 9

自家在github上的地址https://github.com/geffzhang
欢迎互粉,Ocelot在github的地址 https://github.com/TomPallister/Ocelot
, 卓殊给力的是在课程当天完结了.NET Core
2.0的晋级,升级进程请看https://github.com/TomPallister/Ocelot/issues/114
。后天自己花了半小时就把作者的此外三个POC项目Nanofabric  
https://github.com/geffzhang/NanoFabric 升级到了.NET Core 2.0,
那么些POC项目也是自家的享用的门类的原型,能够如此说.NET Core 2.0
4月份正式通知,经过四个月时间的升高,社区生态已经都早就做好了准备,开发新项目得以选用.NET
Core 2,Ocelot 是1个集成社区中许多优良开源项目标代表。

权力控制

IdentityServer4
也提供了权力管理的法力,大概看了一眼,没有达到自个儿想要(没耐心去斟酌)。
我索要的是对准区别的模块,功用定义权限码(字符串),各种权限码对应相应的功力权限。当用户展开呼吁的时候,判断用户是不是享有相应功效的权杖(是还是不是予以了对应的权杖字符串编码),来达到权限决定。

IdentityServer的校验是通过Authorize天性来判定相应的Controller或Action是还是不是须要校验。那里也透过自定义本性来促成权力的校验,并且是在本来的Authorize性子上举办扩充。可行的方案继承AuthorizeAttribute,重写。但是在.net
core中升迁没有OnAuthorization方法可开展重写。最后参考的ABP的做法,过滤器和特性共同使用。

新建TestAuthorizationFilter.cs

public class TestAuthorizationFilter : IAuthorizationFilter
    {
        public void OnAuthorization(AuthorizationFilterContext context)
        {
            if (context.Filters.Any(item => item is IAllowAnonymousFilter))
            {
                return;
            }

            if (!(context.ActionDescriptor is ControllerActionDescriptor))
            {
                return;
            }
            var attributeList = new List<object>();
            attributeList.AddRange((context.ActionDescriptor as ControllerActionDescriptor).MethodInfo.GetCustomAttributes(true));
            attributeList.AddRange((context.ActionDescriptor as ControllerActionDescriptor).MethodInfo.DeclaringType.GetCustomAttributes(true));
            var authorizeAttributes = attributeList.OfType<TestAuthorizeAttribute>().ToList();
            var claims = context.HttpContext.User.Claims;
            // 从claims取出用户相关信息,到数据库中取得用户具备的权限码,与当前Controller或Action标识的权限码做比较
            var userPermissions = "User_Edit";
            if (!authorizeAttributes.Any(s => s.Permission.Equals(userPermissions)))
            {
                context.Result = new JsonResult("没有权限");
            }
            return;

        }
    }

新建TestAuthorizeAttribute

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true)]
    public class TestAuthorizeAttribute: AuthorizeAttribute
    {

        public string Permission { get; set; }

        public TestAuthorizeAttribute(string permission)
        {
            Permission = permission;
        }

    }

将IdentityController
[Authorize]改为[TestAuthorize(“User_Edit”)],再运行API项目。

透过修改权限码,验证是不是起效果

图片 10

除开利用过滤器和特点结合使用,貌似还有其他艺术,有空再研讨。

本文中的源码

图片 11

图片 12

事务的飞快发展,爆发的十二分多的对外的服务接口,分散在共青团和少先队的逐条位置需求展开联合的治本,而且大家的环境是linux和windows的参差不齐环境,大家的目的是联合在合营社的Linux环境,.NET
Core对于.NET 技术团队来说是三个丰盛棒的技艺,而且.NET
Core自个儿的架构万分好,品质就更好了。

图片 13

图片 14

此处列出了Ocelot近日支撑的特点:

  • Routing
    • 用户能够钦命上游请求之间的照射,并将其转会到下游服务上的例外U中华VL。
  • Service Discovery
    • Ocelot能够查看你的劳动意识,并找到它应该转载下游请求的服务。它能够在这一个服务时期展开负载平衡。.
  • Authentication using IdentityServer

    • 您能够将端点标记为已评释,并使用IdentityServer承载标记对您的用户展开身份验证.
  • Authorisation using Claims
    • 比方接纳 bearer tokens, 可以行使 claims 标记特定
      endpoints是授权的
  • Claims Transformation
    • Ocelot提供了一种语法来转换给下游请求,并将宣示数据增加到标题,UPAJEROL参数,别的评释等等
  • Quality of service
    • Retries, circuit breaker, timeouts etc.
  • Request / Correlation Ids
  • Caching
  • Logging
  • Custom Middleware

更详实的始末参看文书档案 https://github.com/TomPallister/Ocelot/wiki 

地点介绍了Ocelot的成效特色,接下去大家进入介绍Ocelot
的落实原理分析,主旨是是ASP.NET Core Middleware 以及 ASP.NET Core
DependencyInjection:

图片 15

ASP.NET Core 守旧的ASP.NET
在架设上有非常的大的校订,尤其的模块化,下图形象的印证了她们之间分歧,Application
和 Middleware 是一律的,比如ASP.NET Core
MVC也是一个Middleware,通过Middleware那样的构造大家万分不难的扩充大家的应用程序。

图片 16

Ocelot正是利用Middleware来形成网关的拥有成效,每一个小功能就是三个Middleware,具体能够看代码
https://github.com/TomPallister/Ocelot/blob/develop/src/Ocelot/Middleware/OcelotMiddlewareExtensions.cs
,Ocelot 是哪些把各类Middleware串起来共同实现三个API网关的效益。 asp.net
core 13分抢眼的宏图,把Middleware抽象成了三个委托RequestDelegate,
ASP.NET Core 的种种 Request 都会透过每种所注册的 Middleware,Response
也是种种回传,以先进后出的艺术处理每3个封包:

图片 17

具体内容参考: ASP.NET Core HTTP
管道中的那么些事情

如何一分钟从头塑造二个 ASP.NET Core
中间件

大家在Middleware的编程进度中需求关爱HttpContext 以及管道的注册者和营造者
ApplicationBuilder。

 图片 18

ASP.NET Core 使用了大气的 DI (Dependency Injection)
设计,同样大家在Ocelot的安插中也利用了汪洋的DI设计,具体参看源码https://github.com/TomPallister/Ocelot/blob/develop/src/Ocelot/DependencyInjection/ServiceCollectionExtensions.cs 

登记 瑟维斯 有分三种方法:

  • Transient  每回注入时,都再次 new 一个新的实业。
  • Scoped    每一个 Request 都重新 new 1个新的实体。
  • Singleton 程序运营后会 new 3个实体。也正是运维期间只会有三个实体。

上边那张图来自https://blog.johnwu.cc/article/asp-net-core-dependency-injection.html
,形象的演示了指标生命周期。

图片 19

  • A 为 Singleton
  • B 为 Scoped
  • C 为 Transient

上边介绍完了Ocelot开发的基本原理,近来Ocelot 由17 个Middleware
来成功,在各样Middleware的内部贯彻上还有涉及到许多工作的知识,本篇文章先不做展开,后续写现实的篇章详细分析。接下来大家的话说什么样自定义扩大,在大家的类别中首要性在几个方面实行了扩充:

一 、自定义扩张API 接口验证

图片 20

Ocelot 暗中认可帮忙基于IdentityServer4的表达,必要自定义表明,可以参考
https://github.com/TomPallister/Ocelot/pull/110,添加自定义的认证,不过.net
core 2.0 认证部分基本上海重机厂写了。

贰 、自定义扩大下游通讯协议

图片 21

Ocelot
私下认可扶助Http的报纸发表,在我们的莫过于项目中有诸多老的劳动是PRADOPC调用,使用的是私有的Relay通信框架,在API网关上需求做协议转换,自动将Http的伏乞改换来Relay的tcp通信。

三 、自定义管控台

图片 22

ocelot 有管理API,能够依据管理API 做自定义的军管控制台,github 有个
https://github.com/dbarkwell/Ocelot.ConfigEditor,这几个类型落到实处了asp.net
core mvc 的在线编辑路由。

相关文章