ASP.NET Core 反向代理部署知多少

引言

最近在折腾统一认证中心,看到开源项目IdentityServer4.Admin集成了IdentityServer4和管理面板,就直接拿过来用了。在尝试Nginx部署时遇到了诸如虚拟目录映射,请求头超长、基础路径映射有误等问题,简单记录,以供后人参考。

Nginx 配置路由转发

首先来看下IdentityServer4.Admin的项目结构:

IdentityServer4.Admin /
├── Id4.Admin.Api                  # 用于提供访问Id4资源的WebApi项目
├── Id4.Admin                      # 用于提供管理Id4资源的Web管理面板
├── Id4.STS.Identity               # 用于提供 STS 服务的Web项目

作为三个独立的项目,分开部署很简单,但为了统一入口管理,我倾向于将Id4.AdminId4.STS.Identity 部署在一个域名之下,Id4.Admin.API项目部署到网关中去。也就是通过http://auth.xxx.com访问Id4.STS.Identity,通过http://auth.xxx.com/admin访问Id4.Admin

这也就是遇到的第一个问题如何借助Nginx实现单域名多站点部署!

Kestrel作为一个边缘web服务器部署时,其将独占一个IP和端口。在没有反向代理服务器的情况下,用作边缘服务器的Kestrel不支持在多个进程之间共享相同的IP和端口。当将Kestrel配置为在端口上侦听时,Kestrel将处理该端口的所有网络通信,并且忽略请求头中指定的Host请求头,也就意味着Kestrel 不会负责请求转发。

因此为了进行端口共享,我们需借助反向代理将唯一的IP和端口上将请求转发给Kestrel。也就是下面这张图。

根据Nginx 官方配置文档,通过配置Location就可以实现指定路径路由转发。

server {
    listen 80;
    listen [::]:80;
    server_name mysite;

    location / {
        proxy_pass http://id4.sts.identity:80;
        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }

    location /admin/ {
        proxy_pass http://id4.admin:80/;
        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

我们 比较下两个proxy_pass的配置:

  1. location / { proxy_pass http://id4.sts.identity:80; }
  2. location /admin/ { proxy_pass http://id4.admin:80/; }

主要的不同点是 location /admin/ 节点下proxy_pass http://id4.admin:80/结尾包含一个左斜杠 /。(如果没有这个左斜杠,所有的请求都会被路由到根节点。)比如有个请求http://auth.xxx.com/admin/dashboard,那么nginx根据以上配置会将请求路由到http://id4.admin:80/dashboard。也就是最后一个左斜杠会将替换掉 location 指定的路由规则,也就是这里的/admin

但这样就OK了吗?Absolutely no!执行nginx -s reload 你将会得到一个大大的404

启用 UsePathBase 中间件

这时就要用到UsePathBase中间件了,其作用就是设置站点请求基础路径。在Web项目中添加UsePathBase 中间件很简单,首先在appsettings.json中添加一个配置项PATHBASE,然后Startup的Config中启用就好。

appsettings.json
{
    "PATHBASE":"/admin"
}
-----

public class Startup
{
    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;
    }
    private IConfiguration Configuration { get; }
    // ...
    public void Configure(...)
    {
        // ...
        app.UsePathBase(Configuration.GetValue<string>("PATHBASE"));

启用 UseForwardedHeaders 中间件

使用反向代理还有一个问题要注意,那就是反向代理会模糊一些请求信息:

  1. 通过HTTP代理HTTPS请求时,原始传输协议(HTTPS)丢失,必须在请求头中转发。
  2. 由于应用程序是从代理服务器收到请求的,而不是真正的请求来源,因此原始客户端IP地址也必须在请求头中转发。

这也就是为什么上面的Nginx 配置,会默认包含以下两项配置的原因。

proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;

Nginx已经默认配置转发了以上信息,那么自然要显式告知ASP.NET Core Web 应用要从请求头中取回真实的请求信息。配置很简单,需要安`Microsoft.AspNetCore.HttpOverrides NuGet包,然后在Startup的Config中启用中间件。

public class Startup
{
    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;
    }
    private IConfiguration Configuration { get; }
    // ...
    public void Configure(...)
    {
        // ...
        app.UseForwardedHeaders(new ForwardedHeadersOptions{
          ForwardedHeaders = ForwardedHeaders.XForwardedFor | ForwardedHeaders.XForwardedProto });

        app.UsePathBase(Configuration.GetValue<string>("PATHBASE"));

有一点必须注意,依赖于传输协议的任何组件,例如身份验证,链接生成,重定向和地理位置,都必须在请求头转发中间件之后启用。通常,除了诊断和错误处理中间件外,请求头转发中间件应先于其他中间件运行。

配置完成后,重新部署,对于一般的项目,应该可以正常运行了。但也可能遭遇:

解除 Nginx 请求头转发大小限制

针对这种错误当然要查Nginx错误日志了,如果Nginx服务器部署在Linux服务器,那么默认日志文件在/var/log/nginx/error.log,日志如下:17677925 upstream sent too big header while reading response header from upstream。简单翻译就是请求头数据过大。那我们就来看看转发的请求头到底会有多大,从下图来看请求头中携带的Cookie最大的有3K多。

nginx添加下面的配置即可:

proxy_buffer_size          128k;
proxy_buffers              4 256k;
proxy_busy_buffers_size    256k;

重新加载Nginx 配置,访问成功。

Is All Set? No!

修复基础路径错误

当我尝试点击Admin管理面板的链接时,得到无情的404,因为链接地址为:http://auth.xxx.com/configruaion/clients,正确的链接地址应该是http://auth.xxx.com/admin/configruaion/clients。也就是Razor TagHelper 渲染的<a asp-controller="Configruaion" asp-action="Clients">Manage Client</a>,并没有帮按照UsePathBase指定的路径生成a标签链接。咱们只能看看源码一探究竟了Microsoft.AspNetCore.Mvc.TagHelpers/AnchorTagHelper.cs,最终在拼接Herf属性时使用的是var pathBase = ActionContext.HttpContext.Request.PathBase;来拼接基础路径。也就是说说TagHelper根据Http请求上下文中获取基础路径。因此如果采用location /admin/ { proxy_pass http://id4.admin:80/;这种路由映射,最终会丢失原始路由的基础路径,也就是/admin/ 路由部分。所以,我们还是乖乖把基础路径补充上,也就是proxy_pass http://id4.admin:80/admin/;
至此完成反向代理的单域名多站点部署。

最后

一波三折,但最终不负期望。最后完整Nginx配置放出,以供参考:

server {
    listen 80;
    listen [::]:80;
    server_name mysite;

    location / {
        proxy_pass http://id4.sts.identity:80;
        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }

    location /admin/ {
        proxy_pass http://id4.admin:80/admin/;
        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_buffer_size          128k;
        proxy_buffers              4 256k;
        proxy_busy_buffers_size    256k;
    }
}


参考资料:

  1. Configure ASP.NET Core to work with proxy servers and load balancers
  2. GitHub Issue: Deploy to subdirectory #15464
  3. ASP.Net Core 3 App Running under a Subdirectory on Nginx

原文地址:https://www.cnblogs.com/sheng-jie/p/Deploy-ASP-NET-CORE-WITH-REVERSE-PROXY.html

时间: 2024-08-10 06:07:09

ASP.NET Core 反向代理部署知多少的相关文章

ASP.NET Core使用TopShelf部署Windows服务

asp.net core很大的方便了跨平台的开发者,linux的开发者可以使用apache和nginx来做反向代理,windows上可以用IIS进行反向代理. 反向代理可以提供很多特性,固然很好.但是还有复杂性,我们也可以使用windows service来直接启动kestrel. asp.net core官方网站提供了一种基于windows服务部署的方法:在 Windows 服务中托管 ASP.NET Core 这种方式需要修改代码,然后部署的时候,使用命令行创建.安装服务,然后再启动. 感觉

asp.net core 2.1 部署 centos7

asp.net core 2.1 部署 centos7 Kestrel 非常适合从 ASP.NET Core 提供动态内容. 但是,Web 服务功能不像服务器(如 IIS.Apache 或 Nginx)那样功能丰富. 反向代理服务器可以从 HTTP 服务器卸载服务静态内容.缓存请求.压缩请求和 SSL 终端等工作. 反向代理服务器可能驻留在专用计算机上,也可能与 HTTP 服务器一起部署. 鉴于此指南的目的,使用 Nginx 的单个实例. 它与 HTTP 服务器一起运行在同一服务器上. 参考文档

ASP.NET Core 1.0 部署 HTTPS

ASP.NET Core 1.0 部署 HTTPS ASP.NET Core 1.0 部署 HTTPS (.NET Framework 4.5.1) 提示 更新时间:2016年01月23日. 在目前介绍 ASP.NET Core 1.0 的中英文文章中,我没有找到关于部署HTTPS的, 究其原因,除了暂时无法跨平台外,就算是很少人有这个需求,但我还是决定写一下. 警告 目前( 1.0.0-rc1-update1 )仅支持完整版的dnx451,dnxcore5需要rc2的支持.目前只能运行在Win

ASP.NET Core 1.0 部署 HTTPS (.NET Core 1.0)

这两个月要做一个项目,正逢ASP.Net Core 1.0版本的正式发布.由于现代互联网的安全要求,HTTPS加密通讯已成主流,所以就有了这个方案. 本方案启发于一个旧版的解决方案: ASP.NET Core 1.0 部署 HTTPS (.NET Framework 4.5.1) http://www.cnblogs.com/qin-nz/p/aspnetcore-using-https-on-dnx451.html?utm_source=tuicool&utm_medium=referral

ASP.NET Core 1.0 部署 HTTPS (.NET Framework 4.5.1)

ASP.NET Core 1.0 部署 HTTPS (.NET Framework 4.5.1)? 警告 您当前查看的页面是未经授权的转载! 如果当前版本排版错误,请前往查看最新版本:http://www.cnblogs.com/qin-nz/p/aspnetcore-using-https-on-dnx451.html 提示 更新时间:2016年01月23日. 在目前介绍 ASP.NET Core 1.0 的中英文文章中,我没有找到关于部署HTTPS的, 究其原因,除了暂时无法跨平台外,就算是

ASP.NET Core开发Docker部署

ASP.NET Core开发Docker部署,.NET Core支持Docker 部署运行.我们将ASP.NET Core 部署在Docker 上运行. 大家可能都见识过Docker ,今天我们就详细了解一下Docker的用途,以及真实的应用场景. Docker源于PaaS,PaaS的应用场景即是Docker的应用场景. Platform as a Service: 平台即服务, 是面向软件开发者的服务, 云计算平台提供硬件, OS, 编程语言, 开发库, 部署工具, 帮助软件开发者更快的开发软

ASP.NET Core开发-Docker部署运行

ASP.NET Core开发Docker部署,.NET Core支持Docker 部署运行.我们将ASP.NET Core 部署在Docker 上运行. 大家可能都见识过Docker ,今天我们就详细了解一下Docker的用途,以及真实的应用场景. Docker源于PaaS,PaaS的应用场景即是Docker的应用场景. Platform as a Service: 平台即服务, 是面向软件开发者的服务, 云计算平台提供硬件, OS, 编程语言, 开发库, 部署工具, 帮助软件开发者更快的开发软

asp.net core的基本部署

随着.net core正式版的推出,我也准备开始使用这种微软有史以来第一次跨平台的技术(本人从来不学也不看beta版的技术),使用VS2017新建一个.net core的web应用程序 这里随便选什么都可以,其实创建出来的都一样,在core中,MVC和WebApi的管道已经统一,所以在类库中已经不会再出现API字眼(虽然实际上,现在MVC早已没人用了)的类了, 建完以后,大概长这样 忽略host.json,那个是我自己加的,打开program,可以发现,web应用程序本质上就是一个控制台程序,

Asp.Net Core 发布和部署(Linux + Jexus )

前言 在上篇文章中,主要介绍了 Dotnet Core Run 命令,这篇文章主要是讲解如何在 asp.net core 中对我们的已经完成的程序进行发布和部署. 有关如何使用 Nginx 进行部署,请参见本人的另一篇文章:http://www.cnblogs.com/savorboard/p/dotnet-core-publish-nginx.html 目录 安装 Liunx DotNet 环境 新建一个 Web 项目,并发布 使用 Jexus 进行反向代理 安装 Linux DotNet 环