.NET Core API网关Ocelot(九)【Authentication，Authorisation】

最新推荐文章于 2024-04-19 00:30:00 发布

转载最新推荐文章于 2024-04-19 00:30:00 发布 · 679 阅读

1 ·

CC 4.0 BY-SA版权

原文链接：https://blog.youkuaiyun.com/WuLex

NET Core API网关Ocelot 专栏收录该内容

22 篇文章

订阅专栏

本文阐述了如何在Ocelot中配置路由和认证服务，包括JWT令牌、IdentityServer及Okta的集成方法，实现基于声明的授权。

为了验证Routes并随后使用Ocelot的任何基于声明的功能，如授权或使用令牌中的值修改请求。用户必须像往常一样在他们的Startup.cs中注册认证服务，但他们给每个注册提供了一个方案（认证提供商密钥），例如

public void ConfigureServices(IServiceCollection services)
{
    var authenticationProviderKey = "TestKey";

    services.AddAuthentication()
        .AddJwtBearer(authenticationProviderKey, x =>
        {
        });
}

在此示例中，TestKey是此提供程序已注册的方案。然后，我们将其映射到配置中的Route，例如

"Routes": [{
        "DownstreamHostAndPorts": [
            {
                "Host": "localhost",
                "Port": 51876,
            }
        ],
        "DownstreamPathTemplate": "/",
        "UpstreamPathTemplate": "/",
        "UpstreamHttpMethod": ["Post"],
        "RouteIsCaseSensitive": false,
        "DownstreamScheme": "http",
        "AuthenticationOptions": {
            "AuthenticationProviderKey": "TestKey",
            "AllowedScopes": []
        }
    }]

当Ocelot运行时，它会查看此Routes的AuthenticationOptions.AuthenticationProviderKey并检查是否存在给定密钥注册的身份验证提供程序。如果没有，那么Ocelot不会启动，如果有的话Route将在执行时使用该提供者。

如果Route配置了认证，Ocelot在执行认证中间件时将调用与其相关的任何验证方案。如果请求认证失败，Ocelot返回http状态码401。

JWT令牌

如果您想使用JWT令牌进行身份验证，例如Auth0等提供商，您可以使用正常的方式注册你的身份验证中间件。

public void ConfigureServices(IServiceCollection services)
{
    var authenticationProviderKey = "TestKey";

    services.AddAuthentication()
        .AddJwtBearer(authenticationProviderKey, x =>
        {
            x.Authority = "test";
            x.Audience = "test";
        });

    services.AddOcelot();
}

然后将身份验证提供程序密钥映射到配置中的Route，例如

"Routes": [{
        "DownstreamHostAndPorts": [
            {
                "Host": "localhost",
                "Port": 51876,
            }
        ],
        "DownstreamPathTemplate": "/",
        "UpstreamPathTemplate": "/",
        "UpstreamHttpMethod": ["Post"],
        "RouteIsCaseSensitive": false,
        "DownstreamScheme": "http",
        "AuthenticationOptions": {
            "AuthenticationProviderKey": "TestKey",
            "AllowedScopes": []
        }
    }]

Identity Server 承载令牌

为了使用IdentityServer承载令牌，请按照惯例在ConfigureServices 中使用方案（密钥）注册您的IdentityServer服务。如果您不明白如何操作，请访问IdentityServer文档。

public void ConfigureServices(IServiceCollection services)
{
    var authenticationProviderKey = "TestKey";
    Action<IdentityServerAuthenticationOptions> options = o =>
        {
            o.Authority = "https://whereyouridentityserverlives.com";
            o.ApiName = "api";
            o.SupportedTokens = SupportedTokens.Both;
            o.ApiSecret = "secret";
        };

    services.AddAuthentication()
        .AddIdentityServerAuthentication(authenticationProviderKey, options);

    services.AddOcelot();
}

然后将身份验证提供程序密钥映射到配置中的Route，例如

"Routes": [{
        "DownstreamHostAndPorts": [
            {
                "Host": "localhost",
                "Port": 51876,
            }
        ],
        "DownstreamPathTemplate": "/",
        "UpstreamPathTemplate": "/",
        "UpstreamHttpMethod": ["Post"],
        "RouteIsCaseSensitive": false,
        "DownstreamScheme": "http",
        "AuthenticationOptions": {
            "AuthenticationProviderKey": "TestKey",
            "AllowedScopes": []
        }
    }]

Okta

Add the following to your startup Configure method:
将以下内容添加到您的启动Configure方法中：

app
    .UseAuthentication()
    .UseOcelot()
    .Wait();

至少将以下内容添加到启动的ConfigureServices方法中：

 services
     .AddAuthentication()
     .AddJwtBearer(oktaProviderKey, options =>
     {
         options.Audience = configuration["Authentication:Okta:Audience"]; // Okta Authorization server Audience
         options.Authority = configuration["Authentication:Okta:Server"]; // Okta Authorization Issuer URI URL e.g. https://{subdomain}.okta.com/oauth2/{authidentifier}
     });
services.AddOcelot(configuration);

注意：为了使Ocelot可以正确地查看Okta的范围声明，您必须添加以下内容以将默认的Okta“scp”声明映射到“scope”

// Map Okta scp to scope claims instead of http://schemas.microsoft.com/identity/claims/scope to allow ocelot to read/verify them
JwtSecurityTokenHandler.DefaultInboundClaimTypeMap.Remove("scp");
JwtSecurityTokenHandler.DefaultInboundClaimTypeMap.Add("scp", "scope");

发行446，其中包含一些可能有助于Okta集成的代码和示例。

允许的范围

如果将范围添加到AllowedScopes，Ocelot将获得类型范围的所有用户声明（从令牌中），并确保用户具有列表中的所有范围。

这是一种基于范围限制对Route访问的方式。

Ocelot支持基于声明的授权，该授权在身份验证后运行。这意味着，如果您有要授权的路由，则可以在路由配置中添加以下内容。

"RouteClaimsRequirement": {
    "UserType": "registered"
}

在此示例中，当调用授权中间件时，Ocelot将检查用户是否具有声明类型UserType以及该声明的值是否已注册。如果不是，则将不授权用户，并且响应将被禁止403。