A toolkit to create HTTP proxies hosted in ASP.NET Core as middleware. This allows focused code-first proxies that can be embedded in existing ASP.NET Core applications or deployed as a standalone server. Deployable anywhere ASP.NET Core is deployable such as Windows, Linux, Containers and Serverless (with caveats).
Having built proxies many times before, I felt it is time make a package. Forked
from ASP.NET labs, it has been heavily modified with a different
API, to facilitate a wider variety of proxying scenarios (i.e. routing based on
a JWT claim) and interception of the proxy requests / responses for
customization of headers and (optionally) request / response bodies. It also
uses HttpClientFactory
internally that will mitigate against dns caching
issues making it suitable for microservice / container environments.
- 1. Quick Start
- 2. Customising the upstream request
- 3. Customising the upstream response
- 4. X-Forwarded Headers
- 5. Making upstream servers reverse proxy friendly
- 6. Configuring ProxyOptions
- 7. Error handling
- 8. Testing
- 9. Load Balancing
- 10. Recipes
- 11. Performance considerations
- 12. Note about serverless
- 13. Comparison with Ocelot
- 14. How to build
- 15. Contributing / Feedback / Questions
ProxyKit is a NetStandard2.0
package. Install into your ASP.NET Core project:
dotnet add package ProxyKit
In your Startup
, add the proxy service:
public void ConfigureServices(IServiceCollection services)
{
...
services.AddProxy();
...
}
Forward requests to localhost:5001
:
public void Configure(IApplicationBuilder app)
{
app.RunProxy(context => context
.ForwardTo("http://upstream-server:5001")
.Send());
}
What is happening here?
context.ForwardTo(upstreamHost)
is an extension method over theHttpContext
that creates and initializes anHttpRequestMessage
with the original request headers copied over and returns aForwardContext
.Send
Sends the forward request to the upstream server and returns anHttpResponseMessage
.- The proxy middleware then takes the response and applies it to
HttpContext.Response
.
Note: RunProxy
is terminal - anything added to the pipeline after RunProxy
will never be executed.
One can modify the upstream request headers prior to sending them to suit customisation needs. ProxyKit doesn't add, remove nor modify any headers by default; one must opt in any behaviours explicitly.
In this example we will add a X-Correlation-Id
header if it does not exist:
public const string XCorrelationId = "X-Correlation-ID";
public void Configure(IApplicationBuilder app)
{
app.RunProxy(context =>
{
var forwardContext = context.ForwardTo("http://localhost:5001");
if (!forwardContext.UpstreamRequest.Headers.Contains(XCorrelationId))
{
forwardContext.UpstreamRequest.Headers.Add(XCorrelationId, Guid.NewGuid().ToString());
}
return forwardContext.Send();
});
}
This can be encapsulated as an extension method:
public static class CorrelationIdExtensions
{
public static ForwardContext ApplyCorrelationId(this ForwardContext forwardContext)
{
if (forwardContext.UpstreamRequest.Headers.Contains("X-Correlation-ID"))
{
forwardContext.UpstreamRequest.Headers.Add("X-Correlation-ID", Guid.NewGuid().ToString());
}
return forwardContext;
}
}
... making the proxy code a little nicer to read:
public void Configure(IApplicationBuilder app)
{
app.RunProxy(context => context
.ForwardTo("http://localhost:5001")
.ApplyCorrelationId()
.Send());
}
Response from an upstream server can be modified before it is sent to the client. In this example we are removing a header:
public void Configure(IApplicationBuilder app)
{
app.RunProxy(async context =>
{
var response = await context
.ForwardTo("http://localhost:5001")
.Send();
response.Headers.Remove("MachineID");
return response;
});
}
X-Forward-*
headers from the incoming request to the upstream
request by default. To copy these headers requries opting in. See 4.3. Copying
X-Forwarded-Headers below.
Many applications will need to know what their "outside" host / url is in order
to generate correct values. This is achieved using X-Forwarded-*
and
Forwarded
headers. ProxyKit supports applying X-Forward-*
headers out of the
box (applying Forwarded
headers support is on backlog). At time of writing,
Forwarded
is not supported
in ASP.NET Core.
To add X-Forwarded-Headers
to the request to the upstream server:
public void Configure(IApplicationBuilder app)
{
app.RunProxy(context => context
.ForwardTo("http://upstream-server:5001")
.AddXForwardedHeaders()
.Send());
}
This will add X-Forwarded-For
, X-Forwarded-Host
and X-Forwarded-Proto
headers to the upstream request using values from HttpContext
. If the proxy
middleware is hosted on a path and a PathBase
exists on the request, then an
X-Forwarded-PathBase
is also added.
Chaining proxies is a common pattern in more complex setups. In this case, if
the proxy is an "internal" proxy, you will want to copy the "X-Forwarded-*"
headers from previous proxy. To do so, use CopyXForwardedHeaders()
:
public void Configure(IApplicationBuilder app)
{
app.RunProxy(context => context
.ForwardTo("http://upstream-server:5001")
.CopyXForwardedHeaders()
.Send());
}
You may optionally also add the "internal" proxy details to the X-Forwarded-*
header values by combinging CopyXForwardedHeaders()
and
AddXForwardedHeaders()
(note the order is important):
public void Configure(IApplicationBuilder app)
{
app.RunProxy(context => context
.ForwardTo("http://upstream-server:5001")
.CopyXForwardedHeaders()
.AddXForwardedHeaders()
.Send());
}
Applications that are deployed behind a reverse proxy typically need to be
somewhat aware of that so they can generate correct URLs and paths when
responding to a browser. That is, they look at X-Forward-*
\ Forwarded
headers and use their values .
In ASP.NET Core, this means using the Forwarded Headers middleware in your application. Please refer to the documentation for correct usage (and note the security advisory!).
Note: the Forwarded Headers middleware does not support
X-Forwarded-PathBase
. This means if you proxy http://example.com/foo/
to
http://upstream-host/
the /foo/
part is lost and absolute URLs cannot be
generated unless you configure your applications PathBase directly.
Related issues and discussions:
To support PathBase dynamically in your application with X-Forwarded-PathBase
,
examine the header early in your pipeline and set the PathBase
accordingly:
var options = new ForwardedHeadersOptions
{
...
};
app.UseForwardedHeaders(options);
app.Use((context, next) =>
{
if (context.Request.Headers.TryGetValue("X-Forwarded-PathBase", out var pathBases))
{
context.Request.PathBase = pathBases.First();
}
return next();
});
Alternatively you can use ProxyKit's UseXForwardedHeaders
extension that
perform the same as the above (including calling UseForwardedHeaders
):
var options = new ForwardedHeadersOptions
{
...
};
app.UseXForwardedHeaders(options);
When adding the Proxy to the service collection there are a couple of options available to configure the proxy behavior:
services.AddProxy(options => /* configure options here */);
There are two options :
-
options.ConfigureHttpClient
: anAction<HttpClient>
to configure the HTTP Client on each request e.g. configuring a timeout:services.AddProxy(options => options.ConfigureHttpClient = (serviceProvider, client) => client.Timeout = TimeSpan.FromSeconds(5));
-
Configure the primary
HttpMessageHandler
factory. This is typically used in testing to inject a test handler (see Testing below). This is a factory method as, internally,HttpClientFactory
recreates the HttpHandler pipeline disposing previously created handlers.services.AddProxy(options => options.GetMessageHandler = () => _httpMessageHandler);
When HttpClient
throws the following logic applies:
- When upstream server is not reachable then
ServiceUnavailable
is returned. - When upstream server is slow and client timeouts then
GatewayTimeout
is returned.
Not all exception scenarios and variations are caught which may result in a
InternalServerError
being returned to your clients. Please create an issue if
a scenario is missing.
As ProxyKit is standard ASP.NET Core middleware, it can be tested using the
standard in-memory TestServer
mechanism.
Often you will want to test ProxyKit with your application and perhaps test the behaviour of your application when load balanced with two or more instances as indicated below.
+----------+
|"Outside" |
|HttpClient|
+-----+----+
|
|
|
+-----------+---------+
+-------------------->RoutingMessageHandler|
| +-----------+---------+
| |
| |
| +--------------------+-------------------------+
| | | |
+---+-----------v----+ +--------v---------+ +---------v--------+
|Proxy TestServer | |Host1 TestServer | |Host2 TestServer |
|with Routing Handler| |HttpMessageHandler| |HttpMessageHandler|
+--------------------+ +------------------+ +------------------+
RoutingMessageHandler
is an HttpMessageHandler
that will route requests to
to specific host based on on the origin it is configured with. For ProyKit
to forward requests (in memory) to the upstream hosts, it needs to be configured
to use the RoutingMessageHandler
as it's primary HttpMessageHandler
.
Full example can been viewed here.
Load balancing is mechanism to decide which upstream server to forward the request to. Out of the box, ProxyKit currently supports one type of load balancing - Weighted Round Robin. Other types are planned.
Round Robin simply distributes requests as they arrive to the next host in a distribution list. With optional weighting, more requests are send to host with greater weights.
public void Configure(IApplicationBuilder app)
{
var roundRobin = new RoundRobin
{
new UpstreamHost("http://localhost:5001", weight: 1),
new UpstreamHost("http://localhost:5002", weight: 2)
};
app.RunProxy(
async context =>
{
var host = roundRobin.Next();
return await context
.ForwardTo(host)
.Send();
});
}
Recipes are code samples that help you create proxy solutions for your needs. If you have any ideas for a recipie, or can spot any improvements to the ones below, please send a pull request! Recipes that stand test of time may be promoted to an out-of-the-box feature in a future version of ProxyKit.
- Simple Forwarding - Forward request to a single upstream host.
- Proxy Pathing - Hosting multiple proxys on seperate paths.
- Tenant Routing - Routing to a specific
upstream host based on a
TenantId
claim for an authenticated user. - Authentication offloading - Using IdentityServer to handle authentication before forwarding to upstream host.
- Round Roblin Load Balancing - Weighed Round Robin load balancing to two upstream hosts.
- In-memory Testing - Testing behaviour or your ASP.NET Core application by running two instances behind round robin proxy. Really useful if your application has eventually consistent aspects.
- Customise Upstream Requests - Customise the upstream request by adding a header.
- Customise Upstream Responses - Customise the upstream response by removing a header.
- Consul Service Discovery - Service discovery for an upstream host using Consul.
- Copy X-Forward Headers - Copies
X-Forwarded-For
,X-Forwarded-Host
,X-Forwarded-Proto
andX-Forwarded-PathBase
headers from the incoming request.
According to TechEmpower's Web Framework Benchmarks, ASP.NET Core is up there with the fastest for plain text. As ProxyKit simply captures headers and async copies request and response body streams, it will fast enough for most scenarios.
Stress testing shows that ProxyKit is approximately 8% slower than nginx for simple forwarding on linux. If absolute raw throughput is a concern for you then consider nginx or alternatives. For me being able to create flexible proxies using C# is a reasonable tradeoff for the (small) performance cost. Note that depending on what your proxy does may impact performance so you should measure yourself.
On windows, ProxyKit is ~3x faster than nginx. However, nginx has clearly documented that it has known performance issues on windows. Since one wouldn't be running production nginx on windows this comparison is academic.
Memory wise, ProxyKit maintained a steady ~20MB of RAM after processing millions of requests for simple forwarding. Again, it depends on what your proxy does so you should analyse and measure yourself.
Whilst is it is possible to run full ASP.NET Core web application in AWS Lambda and Azure Functions it should be noted that Serverless systems are message based and not stream based. Incoming and outgoing HTTP request messages will be buffered and potentially encoded as Base64 if binary (so larger). This means ProxyKit should only be used for API (json) proxying in production on Serverless. (Though proxing other payloads is fine for dev / exploration / quick'n'dirty purposes.)
Ocelot is an API Gateway that also runs on ASP.NET Core. A key difference between API Gateways and general Reverse Proxies is that the former tend to be message based whereas a reverse proxy is stream based. That is, an API gateway will typically buffer the every request and response message to be able to perform transformations. This is fine for an API gateway but not suitable for a general reverse proxy performance wise nor for responses that are chunked-encoded. See Not Supported Ocelot docs.
Combining ProxyKit with Ocelot would give some nice options for a variety of scenarios.
Requirements: .NET Core SDK 2.2.100 or later.
On Windows:
.\build.cmd
On Linux:
./build.sh
Any ideas for features, bugs or questions, please create an issue. Pull requests gratefully accepted but please create an issue for discussion first.
I can be reached on twitter at @randompunter
distribute by ChangHoon Baek from the Noun Project.