\n\n\n"
},
{
"path": "samples/ReverseProxy.Auth.Sample/appsettings.Development.json",
"content": "{\n \"Logging\": {\n \"LogLevel\": {\n \"Default\": \"Debug\",\n \"Microsoft\": \"Debug\",\n \"Microsoft.Hosting.Lifetime\": \"Information\"\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.Auth.Sample/appsettings.json",
"content": "{\n \"Logging\": {\n \"LogLevel\": {\n \"Default\": \"Information\",\n \"Microsoft\": \"Information\",\n \"Microsoft.Hosting.Lifetime\": \"Information\"\n }\n },\n \"AllowedHosts\": \"*\",\n \"Kestrel\": {\n \"Endpoints\": {\n \"https\": {\n \"Url\": \"https://localhost:5001\"\n },\n \"http\": {\n \"Url\": \"http://localhost:5000\"\n }\n }\n },\n \"ReverseProxy\": {\n \"Clusters\": {\n \"cluster1\": {\n \"Destinations\": {\n \"cluster1/destination1\": {\n \"Address\": \"https://example.com/\"\n }\n }\n }\n },\n \"Routes\": {\n \"DefaultAuthRoute\": {\n \"ClusterId\": \"cluster1\",\n // This route uses the built-in default authorization policy which is to require authenticated users \n \"AuthorizationPolicy\": \"Default\",\n \"Match\": {\n \"Path\": \"/default\"\n }\n },\n \"ClaimsAuthRoute\": {\n \"ClusterId\": \"cluster1\",\n // This route requires the \"myPolicy\" authorization policy which is defined in Startup.cs\n \"AuthorizationPolicy\": \"myPolicy\",\n \"Match\": {\n \"Path\": \"/custom/{*any}\"\n }\n },\n \"AnonymousRoute\": {\n \"ClusterId\": \"cluster1\",\n // This route uses the explicit name Anonymous to not require authentication\n \"AuthorizationPolicy\": \"Anonymous\",\n \"Match\": {\n \"Path\": \"/open/{*any}\"\n }\n },\n \"Other\": {\n // As the following route does not define an authorization policy, it uses the fallback policy\n // which is set in Startup.cs to be null, and so not require authentication or claims.\n \"ClusterId\": \"cluster1\",\n \"Match\": {\n \"Path\": \"{**catchall}\"\n }\n }\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.Code.Sample/Program.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System.Collections.Generic;\nusing System;\nusing System.Threading.Tasks;\nusing Microsoft.AspNetCore.Builder;\nusing Microsoft.Extensions.DependencyInjection;\nusing Yarp.ReverseProxy.Configuration;\nusing Microsoft.AspNetCore.Http;\nusing Yarp.ReverseProxy.Model;\n\nconst string DEBUG_HEADER = \"Debug\";\nconst string DEBUG_METADATA_KEY = \"debug\";\nconst string DEBUG_VALUE = \"true\";\n\nvar builder = WebApplication.CreateBuilder(args);\n\nbuilder.Services.AddControllers();\nbuilder.Services.AddReverseProxy()\n .LoadFromMemory(GetRoutes(), GetClusters());\n\nvar app = builder.Build();\n\napp.Map(\"/update\", context =>\n{\n context.RequestServices.GetRequiredService().Update(GetRoutes(), GetClusters());\n return Task.CompletedTask;\n});\n// We can customize the proxy pipeline and add/remove/replace steps\napp.MapReverseProxy(proxyPipeline =>\n{\n // Use a custom proxy middleware, defined below\n proxyPipeline.Use(MyCustomProxyStep);\n // Don't forget to include these two middleware when you make a custom proxy pipeline (if you need them).\n proxyPipeline.UseSessionAffinity();\n proxyPipeline.UseLoadBalancing();\n});\n\napp.Run();\n\nRouteConfig[] GetRoutes()\n{\n return\n [\n new RouteConfig()\n {\n RouteId = \"route\" + Random.Shared.Next(), // Forces a new route id each time GetRoutes is called.\n ClusterId = \"cluster1\",\n Match = new RouteMatch\n {\n // Path or Hosts are required for each route. This catch-all pattern matches all request paths.\n Path = \"{**catch-all}\"\n }\n }\n ];\n}\n\nClusterConfig[] GetClusters()\n{\n var debugMetadata = new Dictionary\n {\n { DEBUG_METADATA_KEY, DEBUG_VALUE }\n };\n\n return\n [\n new ClusterConfig()\n {\n ClusterId = \"cluster1\",\n SessionAffinity = new SessionAffinityConfig { Enabled = true, Policy = \"Cookie\", AffinityKeyName = \".Yarp.ReverseProxy.Affinity\" },\n Destinations = new Dictionary(StringComparer.OrdinalIgnoreCase)\n {\n { \"destination1\", new DestinationConfig() { Address = \"https://example.com\" } },\n { \"debugdestination1\", new DestinationConfig() {\n Address = \"https://bing.com\",\n Metadata = debugMetadata }\n },\n }\n }\n ];\n}\n\n/// \n/// Custom proxy step that filters destinations based on a header in the inbound request\n/// Looks at each destination metadata, and filters in/out based on their debug flag and the inbound header\n/// \nTask MyCustomProxyStep(HttpContext context, Func next)\n{\n // Can read data from the request via the context\n var useDebugDestinations = context.Request.Headers.TryGetValue(DEBUG_HEADER, out var headerValues) && headerValues.Count == 1 && headerValues[0] == DEBUG_VALUE;\n\n // The context also stores a ReverseProxyFeature which holds proxy specific data such as the cluster, route and destinations\n var availableDestinationsFeature = context.Features.Get();\n var filteredDestinations = new List();\n\n // Filter destinations based on criteria\n foreach (var d in availableDestinationsFeature.AvailableDestinations)\n {\n //Todo: Replace with a lookup of metadata - but not currently exposed correctly here\n if (d.DestinationId.Contains(\"debug\") == useDebugDestinations) { filteredDestinations.Add(d); }\n }\n availableDestinationsFeature.AvailableDestinations = filteredDestinations;\n\n // Important - required to move to the next step in the proxy pipeline\n return next();\n}\n"
},
{
"path": "samples/ReverseProxy.Code.Sample/Properties/launchSettings.json",
"content": "{\n \"iisSettings\": {\n \"windowsAuthentication\": false,\n \"anonymousAuthentication\": true,\n \"iisExpress\": {\n \"applicationUrl\": \"https://localhost:44356/\",\n \"sslPort\": 44356\n }\n },\n \"profiles\": {\n \"ReverseProxy.Code.Sample\": {\n \"commandName\": \"Project\",\n \"launchBrowser\": false,\n \"environmentVariables\": {\n \"ASPNETCORE_ENVIRONMENT\": \"Development\"\n }\n },\n \"IIS Express\": {\n \"commandName\": \"IISExpress\",\n \"launchBrowser\": true,\n \"environmentVariables\": {\n \"ASPNETCORE_ENVIRONMENT\": \"Development\"\n }\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.Code.Sample/README.md",
"content": "# YARP Code Extensibility Sample\n\nThis sample shows two common customizations via code of the YARP reverse proxy:\n\n- ## Dynamic configuration from code\n\n YARP supports pulling configuration from a config file, but in many scenarios the configuration of the routes to use, and which destinations the requests should be sent to need to be programmatically fetched from another source. The extensibility of YARP makes it easy for you to fetch that data from where you need to, and then pass to the proxy as lists of objects.\n\n This sample shows the routes and destinations being created in code, and then passed to an in-memory provider. The role of the in-memory provider is to give change notifications to YARP for when the config has been changed and needs to be updated. YARP uses a snapshot model for its configuration, so that changes are applied as an atomic action, that will apply to subsequent requests after the change is applied. Existing requests that are already being processed will be completed using the configuration snapshot from the time that they were received.\n\n The ```IProxyConfig``` interface implemented in InMemoryConfigProvider includes a change token which is used to signal when a batch of changes to the configuration is complete, and the proxy should take a snapshot and update its internal configuration. Part of the snapshot processing is to create an optimized route table in ASP.NET, which can be a CPU intensive operation, for that reason we don't recommend signaling for updates more than once per 15 seconds. \n\n- ## Custom pipeline step\n\n YARP uses a pipeline model for the stages involved in processing each request:\n\n - Mapping the request path to a route and cluster of destinations\n - Pre-assigning servers based on existing session affinity headers in the request \n - Filtering the destination list for servers that are not healthy\n - Load balancing between the remaining servers based on load etc\n - Storing session affinity if applicable\n - Transforming headers if required\n - Proxying the request/response to/from the destination server\n\n You can insert additional custom stages into the pipeline, or replace built-in steps with your own implementations.\n \n This sample adds an additional stage that will filter the destinations from a cluster based on a \"debug\" metadata attribute being included in the config data based. If a custom header \"Debug:true\" is present in the request, then destinations with the debug metadata will be retained, and others will be filtered out, or vice-versa. \n\n## Key Files\n\nThe following files are key to implementing the features described above:\n\n- ### [Program.cs](Program.cs)\n Provides the initialization routines for ASP.NET and the reverse proxy. It:\n - sets up the proxy passing in the InMemoryConfigProvider instance. The sample routes and clusters definitions are created as part of this initialization. The config provider instance is used for the lifetime of the proxy.\n - sets up the request pipeline. As an additional step is added, the proxy pipeline is configured here.\n - ```MyCustomProxyStep``` is the implementation of the additional step. It finds the proxy functionality via features added to the HttpContext, and then filters the destinations based on the presence of a \"Debug\" header in the request.\n"
},
{
"path": "samples/ReverseProxy.Code.Sample/ReverseProxy.Code.Sample.csproj",
"content": "\n\n \n $(ReleaseTFMs)\n Exe\n Yarp.Sample\n latest\n \n\n \n \n \n\n \n \n \n\n\n"
},
{
"path": "samples/ReverseProxy.Code.Sample/appsettings.Development.json",
"content": "{\n \"Logging\": {\n \"LogLevel\": {\n \"Default\": \"Debug\",\n \"Microsoft\": \"Debug\",\n \"Microsoft.Hosting.Lifetime\": \"Information\"\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.Code.Sample/appsettings.json",
"content": "{\n \"Logging\": {\n \"LogLevel\": {\n \"Default\": \"Information\",\n \"Microsoft\": \"Warning\",\n \"Microsoft.Hosting.Lifetime\": \"Information\"\n }\n },\n \"AllowedHosts\": \"*\"\n}\n"
},
{
"path": "samples/ReverseProxy.Config.Sample/Program.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing Microsoft.AspNetCore.Builder;\nusing Microsoft.Extensions.DependencyInjection;\n\nvar builder = WebApplication.CreateBuilder(args);\n\nbuilder.Services.AddControllers();\nbuilder.Services.AddReverseProxy()\n .LoadFromConfig(builder.Configuration.GetSection(\"ReverseProxy\"));\n\nvar app = builder.Build();\n\napp.UseCors();\napp.MapReverseProxy();\n\napp.Run();\n"
},
{
"path": "samples/ReverseProxy.Config.Sample/Properties/launchSettings.json",
"content": "{\n \"iisSettings\": {\n \"windowsAuthentication\": false,\n \"anonymousAuthentication\": true,\n \"iisExpress\": {\n \"applicationUrl\": \"https://localhost:44356/\",\n \"sslPort\": 44356\n }\n },\n \"profiles\": {\n \"ReverseProxy.Config.Sample\": {\n \"commandName\": \"Project\",\n \"launchBrowser\": false,\n \"environmentVariables\": {\n \"ASPNETCORE_ENVIRONMENT\": \"Development\"\n }\n },\n \"IIS Express\": {\n \"commandName\": \"IISExpress\",\n \"launchBrowser\": true,\n \"environmentVariables\": {\n \"ASPNETCORE_ENVIRONMENT\": \"Development\"\n }\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.Config.Sample/README.md",
"content": "# Configuration Sample\n\nThis sample shows off the properties that can be supplied to YARP via configuration. In this case its using appsettings.json, but the same configuration properties could be supplied through code instead. See [ReverseProxy.Code.Sample](../ReverseProxy.Code.Sample) for an example\n\nThe [configuration file](appsettings.json) includes all the settings that are currently supported by YARP.\n\nThe configuration shows two routes and two clusters:\n- minimalRoute which will map to any URL\n - Routes to cluster \"minimalCluster\" which has one destination \"www.example.com\"\n- allRouteProps route\n - Which includes further restrictions:\n - Path must be /download/*\n - Host must be localhost, www.aaaaa.com or www.bbbbb.com\n - Http Method must be GET or POST\n - Must have a header \"MyCustomHeader\" with a value of \"value1\", \"value2\" or \"another value\"\n - A \"MyHeader\" header will be added with the value \"MyValue\"\n - Must have a query parameter \"MyQueryParameter\" with a value of \"value1\", \"value2\" or \"another value\"\n - This will route to cluster \"allClusterProps\" which has 2 destinations - https://dotnet.microsoft.com and https://10.20.30.40 \n - Requests will be [load balanced](https://learn.microsoft.com/aspnet/core/fundamentals/servers/yarp/load-balancing) between destinations using a \"PowerOfTwoChoices\" algorithm, which picks two destinations at random, then uses the least loaded of the two.\n - It includes [session affinity](https://learn.microsoft.com/aspnet/core/fundamentals/servers/yarp/session-affinity) using a cookie which will ensure subsequent requests from the same client go to the same host.\n - It is configured to have both active and passive [health checks](https://learn.microsoft.com/aspnet/core/fundamentals/servers/yarp/dests-health-checks) - note the second destination will timeout for active checks (unless you have a host with that IP on your network)\n - It includes [HttpClient configuration](https://learn.microsoft.com/aspnet/core/fundamentals/servers/yarp/http-client-config) setting outbound connection properties\n - HttpRequest properties defaulting to HTTP/2 with a 2min timeout\n\nThe other files in the sample are the same as the getting started instructions.\n\nTo make a request that would be successful against the second route, you will need a client request similar to:\n\n```bash\ncurl -v -k -X GET -H \"MyCustomHeader: value1\" https://localhost:5001/download?MyQueryParameter=value1\n```"
},
{
"path": "samples/ReverseProxy.Config.Sample/ReverseProxy.Config.Sample.csproj",
"content": "\n\n \n $(ReleaseTFMs)\n Exe\n Yarp.Sample\n latest\n \n\n \n \n \n\n \n \n \n\n\n"
},
{
"path": "samples/ReverseProxy.Config.Sample/appsettings.Development.json",
"content": "{\n \"Logging\": {\n \"LogLevel\": {\n \"Default\": \"Debug\",\n \"Microsoft\": \"Debug\",\n \"Microsoft.Hosting.Lifetime\": \"Information\"\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.Config.Sample/appsettings.json",
"content": "{\n // Base URLs the server listens on, must be configured independently of the routes below.\n // Can also be configured via Kestrel/Endpoints, see https://docs.microsoft.com/aspnet/core/fundamentals/servers/kestrel/endpoints\n \"Urls\": \"http://localhost:5000;https://localhost:5001\",\n\n //Sets the Logging level for ASP.NET\n \"Logging\": {\n \"LogLevel\": {\n \"Default\": \"Information\",\n // Uncomment to hide diagnostic messages from runtime and proxy\n // \"Microsoft\": \"Warning\",\n // \"Yarp\" : \"Warning\",\n \"Microsoft.Hosting.Lifetime\": \"Information\"\n }\n },\n \"AllowedHosts\": \"*\",\n\n // Configuration for YARP\n \"ReverseProxy\": {\n // Routes tell the proxy which requests to forward\n \"Routes\": {\n \"minimalRoute\": {\n // Matches anything and routes it to www.example.com\n \"ClusterId\": \"minimalCluster\",\n \"Match\": {\n \"Path\": \"{**catch-all}\"\n }\n },\n \"allRouteProps\": {\n // matches /download/* and routes to \"allClusterProps\"\n \"ClusterId\": \"allClusterProps\", // Name of one of the clusters\n \"Order\": 0, // Lower numbers have higher precedence, default is 0\n \"AuthorizationPolicy\": \"Anonymous\", // Name of the policy or \"Default\", \"Anonymous\"\n \"CorsPolicy\": \"disable\", // Name of the CorsPolicy to apply to this route or \"default\", \"disable\"\n \"Match\": { // Rules that have to be met for the route to match the request\n \"Path\": \"/download/{**remainder}\", // The path to match using ASP.NET syntax.\n \"Hosts\": [ \"localhost\", \"www.aaaaa.com\", \"www.bbbbb.com\" ], // The host names to match, unspecified is any\n \"Methods\": [ \"GET\", \"PUT\" ], // The HTTP methods that match, unspecified is all\n \"Headers\": [ // The headers to match, unspecified is any\n {\n \"Name\": \"MyCustomHeader\", // Name of the header\n \"Values\": [ \"value1\", \"value2\", \"another value\" ], // Matches are against any of these values\n \"Mode\": \"ExactHeader\", // or \"HeaderPrefix\", \"Exists\" , \"Contains\", \"NotContains\"\n \"IsCaseSensitive\": true\n }\n ],\n \"QueryParameters\": [ // The query parameters to match, unspecified is any\n {\n \"Name\": \"MyQueryParameter\", // Name of the query parameter\n \"Values\": [ \"value1\", \"value2\", \"another value\" ], // Matches are against any of these values\n \"Mode\": \"Exact\", // or \"Prefix\", \"Exists\" , \"Contains\", \"NotContains\"\n \"IsCaseSensitive\": true\n }\n ]\n },\n \"Metadata\": { // List of key value pairs that can be used by custom extensions\n \"MyName\": \"MyValue\"\n },\n \"Transforms\": [ // List of transforms. See ReverseProxy.Transforms.Sample for more details\n {\n \"RequestHeader\": \"MyHeader\",\n \"Set\": \"MyValue\"\n }\n ]\n }\n },\n // Clusters tell the proxy where and how to forward requests\n \"Clusters\": { // Cluster with the minimum information\n \"minimalCluster\": {\n \"Destinations\": { // Specifies which back end servers requests should be routed to.\n \"example.com\": { // name is used for logging and via extensibility\n \"Address\": \"http://www.example.com\" // Should specify Protocol, Address/IP & Port, but not path\n }\n }\n },\n \"allClusterProps\": { // Cluster with all properties\n \"Destinations\": { // Specifies which back end servers requests should be routed to.\n \"first_destination\": { // name is used for logging and via extensibility\n \"Address\": \"https://dotnet.microsoft.com\" // Should specify Protocol, Address/IP & Port, but not path\n },\n \"another_destination\": {\n \"Address\": \"https://10.20.30.40\",\n \"Health\": \"https://10.20.30.40:12345\", // override for active health checks\n \"Host\": \"contoso\",\n \"Metadata\": {\n \"SomeKey\": \"SomeValue\"\n }\n }\n },\n \"LoadBalancingPolicy\": \"PowerOfTwoChoices\", // Alternatively \"First\", \"Random\", \"RoundRobin\", \"LeastRequests\"\n \"SessionAffinity\": { // Ensures subsequent requests from a client go to the same destination server\n \"Enabled\": true, // Defaults to 'false'\n \"Policy\": \"HashCookie\", // Default, alternatively \"Cookie\" or \"CustomHeader\"\n \"FailurePolicy\": \"Redistribute\", // default, alternatively \"Return503Error\"\n \"AffinityKeyName\": \"MySessionCookieName\", // Required, no default\n \"Cookie\": { // Options for cookie based session affinity\n \"Path\": \"/\",\n \"SameSite\": \"None\",\n \"HttpOnly\": true,\n \"Expiration\": \"00:30:00\",\n \"Domain\": \"example.com\",\n \"MaxAge\": \"08:00:00\",\n \"SecurePolicy\": \"Always\",\n \"IsEssential\": true\n }\n },\n \"HealthCheck\": { // Ways to determine which destinations should be filtered out due to unhealthy state\n \"Active\": { // Makes API calls to validate the health of each destination\n \"Enabled\": true,\n \"Interval\": \"00:00:10\", // How often to query for health data\n \"Timeout\": \"00:00:10\", // Timeout for the health check request/response\n \"Policy\": \"ConsecutiveFailures\", // Or other custom policy that has been registered\n \"Path\": \"/favicon.ico\", // API endpoint to query for health state. Looks for 2XX response codes to indicate healthy state\n // Typically something like \"/api/health\" but used favicon to enable sample to run\n \"Query\": \"?healthCheck=true\" // Query string to append to the health check request\n },\n \"Passive\": { // Disables destinations based on HTTP response codes for proxy requests\n \"Enabled\": true, // Defaults to false\n \"Policy\": \"TransportFailureRate\", // Or other custom policy that has been registered\n \"ReactivationPeriod\": \"00:00:10\" // how long before the destination is re-enabled\n },\n \"AvailableDestinationsPolicy\": \"HealthyOrPanic\" // Policy for which destinations can be used when sending requests\n },\n \"HttpClient\": { // Configuration of HttpClient instance used to contact destinations\n \"SslProtocols\": [ \"Tls13\" ],\n \"DangerousAcceptAnyServerCertificate\": true, // Disables destination cert validation\n \"MaxConnectionsPerServer\": 1024, // Destination server can further limit this number\n \"EnableMultipleHttp2Connections\": true,\n \"RequestHeaderEncoding\": \"Latin1\", // How to interpret non ASCII characters in proxied request's header values\n \"ResponseHeaderEncoding\": \"Latin1\", // How to interpret non ASCII characters in proxied request's response header values\n \"WebProxy\": { // Optional proxy configuration for outgoing requests\n \"Address\": \"http://127.0.0.1\",\n \"BypassOnLocal\": true,\n \"UseDefaultCredentials\": false\n }\n },\n \"HttpRequest\": { // Options for sending request to destination\n \"ActivityTimeout\": \"00:02:00\", // Activity timeout for the request\n \"Version\": \"2\", // Http Version that should be tried first\n \"VersionPolicy\": \"RequestVersionOrLower\", // Policy for which other versions can be be used\n \"AllowResponseBuffering\": false\n },\n \"Metadata\": { // Custom Key/value pairs for extensibility\n \"TransportFailureRateHealthPolicy.RateLimit\": \"0.5\", // Used by Passive health policy\n \"MyKey\": \"MyValue\"\n }\n }\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.ConfigFilter.Sample/CustomConfigFilter.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System;\nusing System.Collections.Generic;\nusing System.Text.RegularExpressions;\nusing System.Threading;\nusing System.Threading.Tasks;\nusing Yarp.ReverseProxy.Configuration;\n\nnamespace Yarp.Sample\n{\n public class CustomConfigFilter : IProxyConfigFilter\n {\n // Matches {{env_var_name}}\n private readonly Regex _exp = new(\"\\\\{\\\\{(\\\\w+)\\\\}\\\\}\");\n\n // Configuration filter for clusters, will be passed each cluster in turn, which it should either return as-is or\n // clone and create a new version of with updated changes\n //\n // This sample looks at the destination addresses and any of the form {{key}} will be modified, looking up the key\n // as an environment variable. This is useful when hosted in Azure etc, as it enables a simple way to replace\n // destination addresses via the management console\n public ValueTask ConfigureClusterAsync(ClusterConfig origCluster, CancellationToken cancel)\n {\n // Each cluster has a dictionary of destinations, which is read-only, so we'll create a new one with our updates \n var newDests = new Dictionary(StringComparer.OrdinalIgnoreCase);\n\n foreach (var d in origCluster.Destinations)\n {\n var origAddress = d.Value.Address;\n if (_exp.IsMatch(origAddress))\n {\n // Get the name of the env variable from the destination and lookup value\n var lookup = _exp.Matches(origAddress)[0].Groups[1].Value;\n var newAddress = System.Environment.GetEnvironmentVariable(lookup);\n\n if (string.IsNullOrWhiteSpace(newAddress))\n {\n throw new System.ArgumentException($\"Configuration Filter Error: Substitution for '{lookup}' in cluster '{d.Key}' not found as an environment variable.\");\n }\n\n // using c# 9 \"with\" to clone and initialize a new record\n var modifiedDest = d.Value with { Address = newAddress };\n newDests.Add(d.Key, modifiedDest);\n }\n else\n {\n newDests.Add(d.Key, d.Value);\n }\n }\n return new ValueTask(origCluster with { Destinations = newDests });\n }\n\n public ValueTask ConfigureRouteAsync(RouteConfig route, ClusterConfig cluster, CancellationToken cancel)\n {\n // Example: do not let config based routes take priority over code based routes.\n // Lower numbers are higher priority. Code routes default to 0.\n if (route.Order.HasValue && route.Order.Value < 1)\n {\n return new ValueTask(route with { Order = 1 });\n }\n\n return new ValueTask(route);\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.ConfigFilter.Sample/Program.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing Microsoft.AspNetCore.Builder;\nusing Microsoft.Extensions.DependencyInjection;\nusing Yarp.Sample;\n\nvar builder = WebApplication.CreateBuilder(args);\n\nbuilder.Services.AddControllers();\nbuilder.Services.AddReverseProxy()\n .LoadFromConfig(builder.Configuration.GetSection(\"ReverseProxy\"))\n .AddConfigFilter();\n\nvar app = builder.Build();\n\napp.MapReverseProxy();\n\napp.Run();\n"
},
{
"path": "samples/ReverseProxy.ConfigFilter.Sample/Properties/launchSettings.json",
"content": "{\n \"iisSettings\": {\n \"windowsAuthentication\": false,\n \"anonymousAuthentication\": true,\n \"iisExpress\": {\n \"applicationUrl\": \"https://localhost:44356/\",\n \"sslPort\": 44356\n }\n },\n \"profiles\": {\n \"ReverseProxy.ConfigFilter.Sample\": {\n \"commandName\": \"Project\",\n \"environmentVariables\": {\n \"Key\": \"Value\",\n \"contoso\": \"https://contoso.com\",\n \"ASPNETCORE_ENVIRONMENT\": \"Development\"\n }\n },\n \"IIS Express\": {\n \"commandName\": \"IISExpress\",\n \"launchBrowser\": true,\n \"environmentVariables\": {\n \"ASPNETCORE_ENVIRONMENT\": \"Development\"\n }\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.ConfigFilter.Sample/README.md",
"content": "# Configuration Filter Sample\n\nThis sample shows an example of a configuration filter. A configuration filter enables a callback as part of the configuration load where custom code can modify the configuration values for the proxy as they are loaded. This is valuable when the configuration file provides most of what you need, but you want to be able to tweak some values, but don't want to have to write a custom config provider.\n\n## IProxyConfigFilter\n\nThe bulk of the code is the CustomConfigFilter class which implements the IProxyConfigFilter interface. The interface has two methods which act as callbacks when Clusters and Routes are loaded from config. The methods will be called for each Route and Cluster, and as both are defined as Records, they are immutable so the method should return the same object as-is or a replacement.\n\n## CustomConfigFilter Class\n\n### ConfigureClusterAsync\nThis looks at the value of each destination and sees whether it matches the pattern {{env_var_name}}, and if so it treats it as an indirection to an environment variable, and replaces the destination address with the value of the named variable (if it exists).\n\n**Note:** AppSettings.json includes a destination of {{contoso}} which will be matched. The Properties/launchSettings.json file includes a definition of the environment variable, which will be used by Visual Studio and other tools when debugging with \"F5\"."
},
{
"path": "samples/ReverseProxy.ConfigFilter.Sample/ReverseProxy.ConfigFilter.Sample.csproj",
"content": "\n\n \n $(ReleaseTFMs)\n Exe\n Yarp.Sample\n latest\n \n\n \n \n \n\n \n \n \n\n\n"
},
{
"path": "samples/ReverseProxy.ConfigFilter.Sample/appsettings.Development.json",
"content": "{\n \"Logging\": {\n \"LogLevel\": {\n \"Default\": \"Debug\",\n \"Microsoft\": \"Debug\",\n \"Microsoft.Hosting.Lifetime\": \"Information\"\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.ConfigFilter.Sample/appsettings.json",
"content": "{\n \"Logging\": {\n \"LogLevel\": {\n \"Default\": \"Information\",\n \"Microsoft\": \"Warning\",\n \"Microsoft.Hosting.Lifetime\": \"Information\"\n }\n },\n \"AllowedHosts\": \"*\",\n \"Kestrel\": {\n \"Endpoints\": {\n \"https\": {\n \"Url\": \"https://localhost:5001\"\n },\n \"http\": {\n \"Url\": \"http://localhost:5000\"\n }\n }\n },\n \"ReverseProxy\": {\n \"Routes\": {\n \"route1\": {\n \"ClusterId\": \"cluster1\",\n \"Match\": {\n \"Methods\": [ \"GET\", \"POST\" ],\n \"Hosts\": [ \"localhost\" ],\n \"Path\": \"/api/{**catch-all}\"\n }\n },\n \"route2\": {\n \"ClusterId\": \"cluster2\",\n \"Match\": {\n \"Path\": \"{**catch-all}\"\n }\n }\n },\n \"Clusters\": {\n \"cluster1\": {\n \"Destinations\": {\n \"cluster1/destination1\": {\n // Following value will be found by regex and looked up as an environment variable\n \"Address\": \"{{contoso}}\"\n },\n \"cluster1/destination2\": {\n \"Address\": \"https://bing.com/\"\n }\n }\n },\n \"cluster2\": {\n \"Destinations\": {\n \"cluster2/destination1\": {\n \"Address\": \"https://example.com/\"\n }\n }\n }\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.Direct.Sample/Program.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System;\nusing System.Diagnostics;\nusing System.Net;\nusing System.Net.Http;\nusing System.Threading.Tasks;\nusing System.Threading;\nusing Microsoft.AspNetCore.Builder;\nusing Microsoft.AspNetCore.Http;\nusing Microsoft.Extensions.DependencyInjection;\nusing Yarp.ReverseProxy.Forwarder;\nusing Yarp.ReverseProxy.Transforms;\n\nvar builder = WebApplication.CreateBuilder(args);\n\nbuilder.Services.AddHttpForwarder();\n\nvar app = builder.Build();\n\n// Configure our own HttpMessageInvoker for outbound calls for proxy operations\nvar httpClient = new HttpMessageInvoker(new SocketsHttpHandler\n{\n UseProxy = false,\n AllowAutoRedirect = false,\n AutomaticDecompression = DecompressionMethods.None,\n UseCookies = false,\n EnableMultipleHttp2Connections = true,\n ActivityHeadersPropagator = new ReverseProxyPropagator(DistributedContextPropagator.Current),\n ConnectTimeout = TimeSpan.FromSeconds(15),\n});\n\n// Setup our own request transform class\nvar transformer = new CustomTransformer(); // or HttpTransformer.Default;\nvar requestOptions = new ForwarderRequestConfig { ActivityTimeout = TimeSpan.FromSeconds(100) };\n\napp.UseRouting();\n\n// When using IHttpForwarder for direct forwarding you are responsible for routing, destination discovery, load balancing, affinity, etc..\n// For an alternate example that includes those features see BasicYarpSample.\napp.Map(\"/test/{**catch-all}\", async (HttpContext httpContext, IHttpForwarder forwarder) =>\n{\n var error = await forwarder.SendAsync(httpContext, \"https://example.com\", httpClient, requestOptions,\n static (context, proxyRequest) =>\n {\n // Customize the query string:\n var queryContext = new QueryTransformContext(context.Request);\n queryContext.Collection.Remove(\"param1\");\n queryContext.Collection[\"area\"] = \"xx2\";\n\n // Assign the custom uri. Be careful about extra slashes when concatenating here. RequestUtilities.MakeDestinationAddress is a safe default.\n proxyRequest.RequestUri = RequestUtilities.MakeDestinationAddress(\"https://example.com\", context.Request.Path, queryContext.QueryString);\n\n // Suppress the original request header, use the one from the destination Uri.\n proxyRequest.Headers.Host = null;\n\n return default;\n });\n\n // Check if the proxy operation was successful\n if (error != ForwarderError.None)\n {\n var errorFeature = httpContext.Features.Get();\n var exception = errorFeature.Exception;\n }\n});\n\napp.MapForwarder(\"/sample/{id}\", \"https://httpbin.org\", \"/anything/{id}\");\napp.MapForwarder(\"/sample/anything/{id}\", \"https://httpbin.org\", b => b.AddPathRemovePrefix(\"/sample\"));\n\n// When using extension methods for registering IHttpForwarder providing configuration, transforms, and HttpMessageInvoker is optional (defaults will be used).\napp.MapForwarder(\"/{**catch-all}\", \"https://example.com\", requestOptions, transformer, httpClient);\n\napp.Run();\n\n/// \n/// Custom request transformation\n/// \ninternal sealed class CustomTransformer : HttpTransformer\n{\n /// \n /// A callback that is invoked prior to sending the proxied request. All HttpRequestMessage\n /// fields are initialized except RequestUri, which will be initialized after the\n /// callback if no value is provided. The string parameter represents the destination\n /// URI prefix that should be used when constructing the RequestUri. The headers\n /// are copied by the base implementation, excluding some protocol headers like HTTP/2\n /// pseudo headers (\":authority\").\n /// \n /// The incoming request.\n /// The outgoing proxy request.\n /// The uri prefix for the selected destination server which can be used to create\n /// the RequestUri.\n public override async ValueTask TransformRequestAsync(HttpContext httpContext, HttpRequestMessage proxyRequest, string destinationPrefix, CancellationToken cancellationToken)\n {\n // Copy all request headers\n await base.TransformRequestAsync(httpContext, proxyRequest, destinationPrefix, cancellationToken);\n\n // Customize the query string:\n var queryContext = new QueryTransformContext(httpContext.Request);\n queryContext.Collection.Remove(\"param1\");\n queryContext.Collection[\"area\"] = \"xx2\";\n\n // Assign the custom uri. Be careful about extra slashes when concatenating here. RequestUtilities.MakeDestinationAddress is a safe default.\n proxyRequest.RequestUri = RequestUtilities.MakeDestinationAddress(\"https://example.com\", httpContext.Request.Path, queryContext.QueryString);\n\n // Suppress the original request header, use the one from the destination Uri.\n proxyRequest.Headers.Host = null;\n }\n}\n"
},
{
"path": "samples/ReverseProxy.Direct.Sample/Properties/launchSettings.json",
"content": "{\n \"iisSettings\": {\n \"windowsAuthentication\": false,\n \"anonymousAuthentication\": true,\n \"iisExpress\": {\n \"applicationUrl\": \"https://localhost:44356/\",\n \"sslPort\": 44356\n }\n },\n \"profiles\": {\n \"ReverseProxy.Direct.Sample\": {\n \"commandName\": \"Project\",\n \"launchBrowser\": false,\n \"environmentVariables\": {\n \"ASPNETCORE_ENVIRONMENT\": \"Development\"\n }\n },\n \"IIS Express\": {\n \"commandName\": \"IISExpress\",\n \"launchBrowser\": true,\n \"environmentVariables\": {\n \"ASPNETCORE_ENVIRONMENT\": \"Development\"\n }\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.Direct.Sample/README.md",
"content": "# YARP Direct Proxy Example\n\nSome customers who have an existing custom proxy for HTTP/1.1 are looking at YARP for a solution to handle more complex requests, such as HTTP/2, gRPC, WebSockets in future QUIC and HTTP/3. These applications have their own means of routing, load balancing, affinity, etc. and only need to forward a specific request to a specific destination. To make it easier to integrate YARP into these scenarios, the component that proxies requests is exposed via IHttpForwarder which can be called directly, and has few dependencies on the rest of YARP's infrastructure.\n\nThis example shows how to use IHttpForwarder to proxy a request to/from a specified destination.\n\nThe operation of the proxy can be thought of as:\n\n```text\n+-------------------+ +-------------------+ +-------------------+\n| Client | ──(a)──► | Proxy | ──(b)──► | Destination |\n| | ◄──(d)── | | ◄──(c)── | |\n+-------------------+ +-------------------+ +-------------------+\n```\n\n(a) and (b) show the *request* path, going from the client to the destination.\n(c) and (d) show the *response* path, going from the destination back to the client.\n\nNormal proxying comprises the following steps:\n\n| \\# | Step | Direction |\n| -- | ---- | --------- |\n| 1 | Disable ASP .NET Core limits for streaming requests | |\n| 2 | Create outgoing HttpRequestMessage | |\n| 3 | Setup copy of request body (background) | Client --► Proxy --► Destination |\n| 4 | Copy request headers | Client --► Proxy --► Destination |\n| 5 | Send the outgoing request using HttpMessageInvoker | Client --► Proxy --► Destination |\n| 6 | Copy response status line | Client ◄-- Proxy ◄-- Destination |\n| 7 | Copy response headers | Client ◄-- Proxy ◄-- Destination |\n| 8.1 | Check for a 101 upgrade response, this takes care of WebSockets as well as any other upgradeable protocol. | |\n| 8.1.1 | Upgrade client channel | Client ◄--- Proxy ◄--- Destination |\n| 8.1.2 | Copy duplex streams and return | Client ◄--► Proxy ◄--► Destination |\n| 8.2 | Copy (normal) response body | Client ◄-- Proxy ◄-- Destination |\n| 9 | Copy response trailer headers and finish response | Client ◄-- Proxy ◄-- Destination |\n| 10 | Wait for completion of step 2: copying request body | Client --► Proxy --► Destination |\n\nTo enable control over mapping request and response fields and headers between the client and destination (steps 4 and 7 above), the HttpForwarder.ProxyAsync method takes a HttpTransformer. Your implementation can modify the request url, method, protocol version, response status code, or decide which headers are copied, modify them, or insert additional headers as required.\n\n**Note:** When using the HttpForwarder class directly there are some [header transforms](https://learn.microsoft.com/aspnet/core/fundamentals/servers/yarp/transforms) included by default, such as adding ```X-Forwarded-For``` and removing the original Host header. This is the same set of transforms included by default in the YARP pipeline model (see BasicYarpSample).\n\n## Files\n\nThe key functionality for this sample is all included in [Program.cs](Program.cs).\n"
},
{
"path": "samples/ReverseProxy.Direct.Sample/ReverseProxy.Direct.Sample.csproj",
"content": "\n\n \n $(ReleaseTFMs)\n Exe\n Yarp.Sample\n latest\n \n\n \n \n \n\n \n \n \n\n\n"
},
{
"path": "samples/ReverseProxy.Direct.Sample/appsettings.Development.json",
"content": "{\n \"Logging\": {\n \"LogLevel\": {\n \"Default\": \"Debug\",\n \"Microsoft\": \"Debug\",\n \"Microsoft.Hosting.Lifetime\": \"Information\"\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.Direct.Sample/appsettings.json",
"content": "{\n \"Logging\": {\n \"LogLevel\": {\n \"Default\": \"Information\",\n \"Microsoft\": \"Warning\",\n \"Microsoft.Hosting.Lifetime\": \"Information\"\n }\n },\n \"AllowedHosts\": \"*\",\n \"Kestrel\": {\n \"Endpoints\": {\n \"https\": {\n \"Url\": \"https://localhost:5001\"\n },\n \"http\": {\n \"Url\": \"http://localhost:5000\"\n }\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.HttpSysDelegation.Sample/README.md",
"content": "# Http.sys Delegation Sample\nThis sample shows how to use YARP to delegate requests to other Http.sys request queues instead of or in addition to proxying requests. Using Http.sys delegation requires hosting YARP on [ASP.NET Core's Http.sys server](https://docs.microsoft.com/aspnet/core/fundamentals/servers/httpsys) and requests can only be delegated to other processes which use Http.sys for request processing (e.g. ASP.NET Core using Http.sys server or IIS).\n\n**Note:** delegation only works for ASP.NET Core 6+ running on new versions of Windows\n\n## Sample Projects\nThere are two projects as part of this sample. A sample Http.sys server where traffic will be delegated to and a YARP example which both proxies and delegates request depending on the route. Both projects use the minimal API style but this isn't a requirement.\n\n### ReverseProxy Delegation\n\nThere are four parts to enable YARP delegation support:\n- Use the ASP.NET Core Http.sys server\n```c#\nbuilder.WebHost.UseHttpSys();\n```\n- Add YARP services\n```c#\nbuilder.Services.AddReverseProxy()\n .LoadFromConfig(builder.Configuration.GetSection(\"ReverseProxy\"));\n```\n- Add YARP to the request pipeline. \n\nYou need to use the overload that allows you to define the middleware used in the YARP pipeline. \n```c#\napp.MapReverseProxy(proxyPipeline =>\n{\n // Add the three middleware YARP adds by default plus the Http.sys delegation middleware\n proxyPipeline.UseSessionAffinity(); // Has no affect on delegation destinations because the response doesn't go through YARP\n proxyPipeline.UseLoadBalancing();\n proxyPipeline.UsePassiveHealthChecks();\n proxyPipeline.UseHttpSysDelegation();\n});\n```\n- Add a ReverseProxy section to appsettings.json. \n\nConfiguration is almost identical to how YARP in typically configured. The only difference is, for destinations which should use delegation, they have metadata which indicates the Http.sys queue name to delegate the request to.\n```json\n\"Destinations\": {\n \"SampleHttpSysServer\": {\n \"Address\": \"http://localhost:5600/\",\n \"Metadata\": {\n \"HttpSysDelegationQueue\": \"SampleHttpSysServerQueue\"\n }\n }\n}\n```\n\n## Usage\nTo run the sample:\n1. Start the SampleHttpSysServer project `dotnet run --project SampleHttpSysServer\\SampleHttpSysServer.csproj`\n2. Start the ReverseProxy.HttpSysDelegation.Sample project `dotnet run --project ReverseProxy\\ReverseProxy.HttpSysDelegation.Sample.csproj`\n\nBy default, the SampleHttpSysServer will listen to http://localhost:5600 and the ReverseProxy will listen to http://localhost:5500. The ReverseProxy will delegate any requests under the path http://localhost:5500/delegate to the SampleHttpSysServer. Any other path will be proxied to https://httpbin.org/.\n"
},
{
"path": "samples/ReverseProxy.HttpSysDelegation.Sample/ReverseProxy/Program.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System.Diagnostics;\n\nvar builder = WebApplication.CreateBuilder(args);\n\nDebug.Assert(OperatingSystem.IsWindows());\nbuilder.WebHost.UseHttpSys();\nbuilder.Services.AddReverseProxy()\n .LoadFromConfig(builder.Configuration.GetSection(\"ReverseProxy\"));\n\nvar app = builder.Build();\n\napp.MapReverseProxy(proxyPipeline =>\n{\n proxyPipeline.UseSessionAffinity(); // Has no effect on delegation destinations because the response doesn't go through YARP\n proxyPipeline.UseLoadBalancing();\n proxyPipeline.UsePassiveHealthChecks();\n proxyPipeline.UseHttpSysDelegation();\n});\n\napp.Run();\n"
},
{
"path": "samples/ReverseProxy.HttpSysDelegation.Sample/ReverseProxy/Properties/launchSettings.json",
"content": "{\n \"profiles\": {\n \"ReverseProxy.HttpSysDelegation\": {\n \"commandName\": \"Project\",\n \"dotnetRunMessages\": true,\n \"launchBrowser\": true,\n \"applicationUrl\": \"http://localhost:5500\",\n \"environmentVariables\": {\n \"ASPNETCORE_ENVIRONMENT\": \"Development\"\n }\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.HttpSysDelegation.Sample/ReverseProxy/ReverseProxy.HttpSysDelegation.Sample.csproj",
"content": "\n\n \n $(ReleaseTFMs)\n enable\n enable\n \n\n \n \n \n\n\n"
},
{
"path": "samples/ReverseProxy.HttpSysDelegation.Sample/ReverseProxy/appsettings.Development.json",
"content": "{\n \"Logging\": {\n \"LogLevel\": {\n \"Default\": \"Information\",\n \"Microsoft.AspNetCore\": \"Warning\"\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.HttpSysDelegation.Sample/ReverseProxy/appsettings.json",
"content": "{\n \"Logging\": {\n \"LogLevel\": {\n \"Default\": \"Information\",\n \"Microsoft\": \"Warning\",\n \"Microsoft.Hosting.Lifetime\": \"Information\"\n }\n },\n \"AllowedHosts\": \"*\",\n \"ReverseProxy\": {\n \"Routes\": {\n \"delegateroute\": {\n \"ClusterId\": \"delegatecluster\",\n \"Match\": {\n \"Path\": \"/delegate/{**catch-all}\"\n }\n },\n \"proxyroute\": {\n \"ClusterId\": \"proxycluster\",\n \"Match\": {\n \"Path\": \"{**catch-all}\"\n }\n }\n },\n \"Clusters\": {\n \"delegatecluster\": {\n \"Destinations\": {\n \"SampleHttpSysServer\": {\n \"Address\": \"http://localhost:5600/\",\n \"Metadata\": {\n \"HttpSysDelegationQueue\": \"SampleHttpSysServerQueue\"\n }\n }\n }\n },\n \"proxycluster\": {\n \"Destinations\": {\n \"httpbin.org\": {\n \"Address\": \"https://httpbin.org/\"\n }\n }\n }\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.HttpSysDelegation.Sample/SampleHttpSysServer/Program.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System.Diagnostics;\nusing Microsoft.AspNetCore.Server.HttpSys;\n\nvar builder = WebApplication.CreateBuilder(args);\n\nDebug.Assert(OperatingSystem.IsWindows());\nbuilder.WebHost.UseHttpSys(options =>\n{\n options.RequestQueueName = \"SampleHttpSysServerQueue\";\n options.RequestQueueMode = RequestQueueMode.Create;\n});\n\nvar app = builder.Build();\n\napp.Run(async context =>\n{\n await context.Response.WriteAsync($\"Hello World! (PID: {Environment.ProcessId})\");\n});\napp.Run();\n"
},
{
"path": "samples/ReverseProxy.HttpSysDelegation.Sample/SampleHttpSysServer/Properties/launchSettings.json",
"content": "{\n \"profiles\": {\n \"SampleHttpSysServer\": {\n \"commandName\": \"Project\",\n \"dotnetRunMessages\": true,\n \"launchBrowser\": true,\n \"applicationUrl\": \"http://localhost:5600\",\n \"environmentVariables\": {\n \"ASPNETCORE_ENVIRONMENT\": \"Development\"\n }\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.HttpSysDelegation.Sample/SampleHttpSysServer/SampleHttpSysServer.csproj",
"content": "\n\n \n $(ReleaseTFMs)\n enable\n enable\n \n\n\n"
},
{
"path": "samples/ReverseProxy.HttpSysDelegation.Sample/SampleHttpSysServer/appsettings.Development.json",
"content": "{\n \"Logging\": {\n \"LogLevel\": {\n \"Default\": \"Information\",\n \"Microsoft.AspNetCore\": \"Warning\"\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.HttpSysDelegation.Sample/SampleHttpSysServer/appsettings.json",
"content": "{\n \"Logging\": {\n \"LogLevel\": {\n \"Default\": \"Information\",\n \"Microsoft.AspNetCore\": \"Warning\"\n }\n },\n \"AllowedHosts\": \"*\"\n}\n"
},
{
"path": "samples/ReverseProxy.LetsEncrypt.Sample/Program.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing Microsoft.AspNetCore.Builder;\nusing Microsoft.Extensions.DependencyInjection;\n\nvar builder = WebApplication.CreateBuilder(args);\n\nbuilder.Services.AddLettuceEncrypt();\n\nbuilder.Services.AddControllers();\n// Add the reverse proxy capability to the server\nbuilder.Services.AddReverseProxy()\n // Initialize the reverse proxy from the \"ReverseProxy\" section of configuration\n .LoadFromConfig(builder.Configuration.GetSection(\"ReverseProxy\"));\n\nvar app = builder.Build();\n\n// Register the reverse proxy routes\napp.MapReverseProxy();\n\napp.Run();\n"
},
{
"path": "samples/ReverseProxy.LetsEncrypt.Sample/Properties/launchSettings.json",
"content": "{\n \"$schema\": \"http://json.schemastore.org/launchsettings.json\",\n \"profiles\": {\n \"ReverseProxy.LetsEncrypt.Sample\": {\n \"commandName\": \"Project\",\n \"launchBrowser\": false,\n \"launchUrl\": \"\",\n \"environmentVariables\": {\n \"ASPNETCORE_ENVIRONMENT\": \"Development\"\n }\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.LetsEncrypt.Sample/README.md",
"content": "# Lets Encrypt Sample\n\n[Lets Encrypt](https://letsencrypt.org/) is a certificate authority (CA) that provides HTTPS (SSL/TLS) certificates for free. This sample shows how to add Lets Encrypt for TLS termination in YARP by integrating with [LettuceEncrypt](https://github.com/natemcmaster/LettuceEncrypt). It allows to set up TLS between the client and YARP with minimal configuration.\n\nThe sample includes the following parts:\n\n- **[Program.cs](Program.cs)**\n It calls `IServiceCollection.AddLettuceEncrypt` in the `ConfigureServices` method.\n\n- **[appsettings.json](appsettings.json)**\n Sets up the required options for LettuceEncrypt including:\n - \"DomainNames\" - at least one domain name is required\n - \"EmailAddress\" - email address must be specified to register with the certificate authority\n"
},
{
"path": "samples/ReverseProxy.LetsEncrypt.Sample/ReverseProxy.LetsEncrypt.Sample.csproj",
"content": "\n\n \n $(ReleaseTFMs)\n latest\n \n\n \n \n \n\n \n \n \n\n\n"
},
{
"path": "samples/ReverseProxy.LetsEncrypt.Sample/appsettings.json",
"content": "{\n \"Kestrel\": {\n \"Endpoints\": {\n \"Http\": {\n \"Url\": \"http://*:80\"\n },\n \"Https\": {\n \"Url\": \"https://*:443\"\n }\n }\n },\n \"Logging\": {\n \"LogLevel\": {\n \"Default\": \"Information\",\n \"Microsoft\": \"Information\",\n \"Microsoft.Hosting.Lifetime\": \"Information\"\n }\n },\n \"AllowedHosts\": \"*\",\n \"ReverseProxy\": {\n \"Routes\": {\n \"route1\": {\n \"ClusterId\": \"cluster1\",\n \"Match\": {\n \"Path\": \"{**catch-all}\"\n }\n }\n },\n \"Clusters\": {\n \"cluster1\": {\n \"Destinations\": {\n \"destination1\": {\n \"Address\": \"https://example.com/\"\n }\n }\n }\n }\n },\n \"LettuceEncrypt\": {\n // Set this to automatically accept the terms of service of your certificate authority.\n // If you don't set this in config, you will need to press \"y\" whenever the application starts\n \"AcceptTermsOfService\": true,\n\n // You must specify at least one domain name\n \"DomainNames\": [ \"example.com\" ],\n\n // You must specify an email address to register with the certificate authority\n \"EmailAddress\": \"it-admin@example.com\"\n }\n}\n"
},
{
"path": "samples/ReverseProxy.Metrics.Sample/ForwarderMetricsConsumer.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System;\nusing Yarp.Telemetry.Consumption;\n\nnamespace Yarp.Sample\n{\n public sealed class ForwarderMetricsConsumer : IMetricsConsumer\n {\n public void OnMetrics(ForwarderMetrics previous, ForwarderMetrics current)\n {\n var elapsed = current.Timestamp - previous.Timestamp;\n var newRequests = current.RequestsStarted - previous.RequestsStarted;\n Console.Title = $\"Forwarded {current.RequestsStarted} requests ({newRequests} in the last {(int)elapsed.TotalMilliseconds} ms)\";\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.Metrics.Sample/ForwarderTelemetryConsumer.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System;\nusing Yarp.ReverseProxy.Forwarder;\nusing Yarp.Telemetry.Consumption;\n\nnamespace Yarp.Sample\n{\n public sealed class ForwarderTelemetryConsumer : IForwarderTelemetryConsumer\n {\n public void OnForwarderStart(DateTime timestamp, string destinationPrefix)\n {\n var metrics = PerRequestMetrics.Current;\n metrics.ProxyStartOffset = metrics.CalcOffset(timestamp);\n }\n\n public void OnForwarderStop(DateTime timestamp, int statusCode)\n {\n var metrics = PerRequestMetrics.Current;\n metrics.ProxyStopOffset = metrics.CalcOffset(timestamp);\n }\n\n public void OnForwarderFailed(DateTime timestamp, ForwarderError error)\n {\n var metrics = PerRequestMetrics.Current;\n metrics.Error = error;\n }\n\n public void OnContentTransferred(DateTime timestamp, bool isRequest, long contentLength, long iops, TimeSpan readTime, TimeSpan writeTime, TimeSpan firstReadTime)\n {\n var metrics = PerRequestMetrics.Current;\n\n if (isRequest)\n {\n metrics.RequestBodyLength = contentLength;\n metrics.RequestContentIops = iops;\n }\n else\n {\n // We don't get a content stop from http as it is returning a stream that is up to the consumer to\n // read, but we know its ended here.\n metrics.HttpResponseContentStopOffset = metrics.CalcOffset(timestamp);\n metrics.ResponseBodyLength = contentLength;\n metrics.ResponseContentIops = iops;\n }\n }\n\n public void OnForwarderInvoke(DateTime timestamp, string clusterId, string routeId, string destinationId)\n {\n var metrics = PerRequestMetrics.Current;\n metrics.RouteInvokeOffset = metrics.CalcOffset(timestamp);\n metrics.RouteId = routeId;\n metrics.ClusterId = clusterId;\n metrics.DestinationId = destinationId;\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.Metrics.Sample/HttpClientTelemetryConsumer.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System;\nusing System.Net.Http;\nusing Yarp.Telemetry.Consumption;\n\nnamespace Yarp.Sample\n{\n public sealed class HttpClientTelemetryConsumer : IHttpTelemetryConsumer\n {\n public void OnRequestStart(DateTime timestamp, string scheme, string host, int port, string pathAndQuery, int versionMajor, int versionMinor, HttpVersionPolicy versionPolicy)\n {\n var metrics = PerRequestMetrics.Current;\n metrics.HttpRequestStartOffset = metrics.CalcOffset(timestamp);\n }\n\n public void OnRequestStop(DateTime timestamp)\n {\n var metrics = PerRequestMetrics.Current;\n metrics.HttpRequestStopOffset = metrics.CalcOffset(timestamp);\n }\n\n public void OnConnectionEstablished(DateTime timestamp, int versionMajor, int versionMinor)\n {\n var metrics = PerRequestMetrics.Current;\n metrics.HttpConnectionEstablishedOffset = metrics.CalcOffset(timestamp);\n }\n\n public void OnRequestLeftQueue(DateTime timestamp, TimeSpan timeOnQueue, int versionMajor, int versionMinor)\n {\n var metrics = PerRequestMetrics.Current;\n metrics.HttpRequestLeftQueueOffset = metrics.CalcOffset(timestamp);\n }\n\n public void OnRequestHeadersStart(DateTime timestamp)\n {\n var metrics = PerRequestMetrics.Current;\n metrics.HttpRequestHeadersStartOffset = metrics.CalcOffset(timestamp);\n }\n\n public void OnRequestHeadersStop(DateTime timestamp)\n {\n var metrics = PerRequestMetrics.Current;\n metrics.HttpRequestHeadersStopOffset = metrics.CalcOffset(timestamp);\n }\n\n public void OnRequestContentStart(DateTime timestamp)\n {\n var metrics = PerRequestMetrics.Current;\n metrics.HttpRequestContentStartOffset = metrics.CalcOffset(timestamp);\n }\n\n public void OnRequestContentStop(DateTime timestamp, long contentLength)\n {\n var metrics = PerRequestMetrics.Current;\n metrics.HttpRequestContentStopOffset = metrics.CalcOffset(timestamp);\n }\n\n public void OnResponseHeadersStart(DateTime timestamp)\n {\n var metrics = PerRequestMetrics.Current;\n metrics.HttpResponseHeadersStartOffset = metrics.CalcOffset(timestamp);\n }\n\n public void OnResponseHeadersStop(DateTime timestamp)\n {\n var metrics = PerRequestMetrics.Current;\n metrics.HttpResponseHeadersStopOffset = metrics.CalcOffset(timestamp);\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.Metrics.Sample/PerRequestMetrics.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System;\nusing System.Threading;\nusing Yarp.ReverseProxy.Forwarder;\nusing System.Text.Json;\n\nnamespace Yarp.Sample\n{\n public class PerRequestMetrics\n {\n private static readonly AsyncLocal _local = new AsyncLocal();\n private static readonly JsonSerializerOptions _jsonOptions = new JsonSerializerOptions { WriteIndented = true };\n\n // Ensure we are only fetched via the factory\n private PerRequestMetrics() { }\n\n /// \n /// Factory to instantiate or restore the metrics from AsyncLocal storage\n /// \n public static PerRequestMetrics Current => _local.Value ??= new PerRequestMetrics();\n\n // Time the request was started via the pipeline\n public DateTime StartTime { get; set; }\n\n // Offset Tics for each part of the proxy operation\n public float RouteInvokeOffset { get; set; }\n public float ProxyStartOffset { get; set; }\n public float HttpRequestStartOffset { get; set; }\n public float HttpConnectionEstablishedOffset { get; set; }\n public float HttpRequestLeftQueueOffset { get; set; }\n\n public float HttpRequestHeadersStartOffset { get; set; }\n public float HttpRequestHeadersStopOffset { get; set; }\n public float HttpRequestContentStartOffset { get; set; }\n public float HttpRequestContentStopOffset { get; set; }\n\n public float HttpResponseHeadersStartOffset { get; set; }\n public float HttpResponseHeadersStopOffset { get; set; }\n public float HttpResponseContentStopOffset { get; set; }\n\n public float HttpRequestStopOffset { get; set; }\n public float ProxyStopOffset { get; set; }\n\n // Info about the request\n public ForwarderError Error { get; set; }\n public long RequestBodyLength { get; set; }\n public long ResponseBodyLength { get; set; }\n public long RequestContentIops { get; set; }\n public long ResponseContentIops { get; set; }\n public string DestinationId { get; set; }\n public string ClusterId { get; set; }\n public string RouteId { get; set; }\n\n public string ToJson()\n {\n return JsonSerializer.Serialize(this, _jsonOptions);\n }\n\n public float CalcOffset(DateTime timestamp)\n {\n return (float)(timestamp - StartTime).TotalMilliseconds;\n }\n }\n}\n\n"
},
{
"path": "samples/ReverseProxy.Metrics.Sample/PerRequestYarpMetricCollectionMiddleware.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System;\nusing System.Threading.Tasks;\nusing Microsoft.AspNetCore.Builder;\nusing Microsoft.AspNetCore.Http;\nusing Microsoft.Extensions.Logging;\n\nnamespace Yarp.Sample\n{\n /// \n /// Middleware that collects YARP metrics and logs them at the end of each request\n /// \n public class PerRequestYarpMetricCollectionMiddleware\n {\n // Required for middleware\n private readonly RequestDelegate _next;\n // Supplied via DI\n private readonly ILogger _logger;\n\n public PerRequestYarpMetricCollectionMiddleware(RequestDelegate next, ILogger logger)\n {\n _logger = logger;\n _next = next;\n }\n\n /// \n /// Entrypoint for being called as part of the request pipeline\n /// \n public async Task InvokeAsync(HttpContext context)\n {\n var metrics = PerRequestMetrics.Current;\n metrics.StartTime = DateTime.UtcNow;\n\n // Call the next steps in the middleware, including the proxy\n await _next(context);\n\n // Called after the other middleware steps have completed\n // Write the info to the console via ILogger. In a production scenario you probably want\n // to write the results to your telemetry systems directly.\n _logger.LogInformation(\"PerRequestMetrics: \" + metrics.ToJson());\n }\n }\n\n /// \n /// Helper to aid with registration of the middleware\n /// \n public static class YarpMetricCollectionMiddlewareHelper\n {\n public static IApplicationBuilder UsePerRequestMetricCollection(\n this IApplicationBuilder builder)\n {\n return builder.UseMiddleware();\n }\n }\n}\n\n"
},
{
"path": "samples/ReverseProxy.Metrics.Sample/Program.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing Microsoft.AspNetCore.Builder;\nusing Microsoft.Extensions.DependencyInjection;\nusing Yarp.Sample;\n\nvar builder = WebApplication.CreateBuilder(args);\n\nvar services = builder.Services;\n\nservices.AddControllers();\n\nservices.AddReverseProxy()\n .LoadFromConfig(builder.Configuration.GetSection(\"ReverseProxy\"));\n\nservices.AddHttpContextAccessor();\n\n// Interface that collects general metrics about the proxy forwarder\nservices.AddMetricsConsumer();\n\n// Registration of a consumer to events for proxy forwarder telemetry\nservices.AddTelemetryConsumer();\n\n// Registration of a consumer to events for HttpClient telemetry\nservices.AddTelemetryConsumer();\n\nservices.AddTelemetryConsumer();\n\nvar app = builder.Build();\n\n// Custom middleware that collects and reports the proxy metrics\n// Placed at the beginning so that it is the first and last thing to run for each request\napp.UsePerRequestMetricCollection();\n\n// Middleware used to intercept the WebSocket connection and collect telemetry exposed to WebSocketsTelemetryConsumer\napp.UseWebSocketsTelemetry();\n\napp.MapReverseProxy();\n\napp.Run();\n"
},
{
"path": "samples/ReverseProxy.Metrics.Sample/Properties/launchSettings.json",
"content": "{\n \"iisSettings\": {\n \"windowsAuthentication\": false,\n \"anonymousAuthentication\": true,\n \"iisExpress\": {\n \"applicationUrl\": \"https://localhost:44356/\",\n \"sslPort\": 44356\n }\n },\n \"profiles\": {\n \"ReverseProxy.Metrics.Sample\": {\n \"commandName\": \"Project\",\n \"launchBrowser\": false,\n \"environmentVariables\": {\n \"ASPNETCORE_ENVIRONMENT\": \"Development\"\n }\n },\n \"IIS Express\": {\n \"commandName\": \"IISExpress\",\n \"launchBrowser\": true,\n \"environmentVariables\": {\n \"ASPNETCORE_ENVIRONMENT\": \"Development\"\n }\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.Metrics.Sample/README.md",
"content": "# ReverseProxy.Metrics.Sample\n\nThis sample demonstrates how to use the ReverseProxy.Telemetry.Consumption library to listen to telemetry data from YARP.\nIn this case it uses the events to create a per-request data structure with detailed timings for each operation that takes place as part of the proxy operation.\n\nInternally YARP uses EventSource to collect telemetry events and metrics from a number of subsystems that are used to process the requests.\nThe YARP telemetry library provides wrapper classes that collect these events metrics and make them available for Consumption.\nTo listen for the metrics you register classes with DI that implement an interface for each subsystem.\n\nThe subsystems are:\n- **Proxy** which represents the overall proxy operation, and success or failure. \n\n Events include:\n - When proxy requests are started and stopped\n - When request/response bodies are processed\n\n Metrics include:\n - Number of requests started\n - Number of request in flight\n - Number of requests that have failed\n\n- **Kestrel** which is the web server that handles incoming requests.\n\n Events include:\n - When requests are started/stopped or fail\n \n Metrics include:\n - Connection Rate - how many connections are opened a second\n - Total number of connections\n - Number of TLS handshakes\n - Incoming queue length\n\n- **Http** which is the HttpClient which makes outgoing requests to the destination servers. \n\n Events include:\n - When connections are created\n - When requests are started/stopped or fail\n - When headers/contents are sent/received\n - When requests are dequeued as connections become available\n\n Metrics include:\n - Number of outgoing requests started\n - Number of requests failed\n - Number of active requests\n - Number of outbound connections\n\n- **Sockets** which includes events around connection attempts & metrics about the amount of data sent and received\n\n- **NameResolution** which includes events around name resolution attempts & metrics about DNS lookups of destinations\n\n- **NetSecurity** which includes events around SslStream handshakes & metrics about the number and latency of handshakes per protocol\n\n## Key Files\n\nThe following files are key to implementing the features described above:\n\n### Program.cs\n\nPerforms registrtion of the proxy, the listener classes and a custom ASP.NET middleware step that starts per-request telemetry and reports the results when complete\n\n### ProxyTelemetryConsumer.cs\n\nListens to events from the proxy telemetry and records timings and info about the high level processing involved in proxying a request.\n\n### HttpTelemetryConsumer.cs\n\nListens to events from the HttpClient telemetry and records timings and info about the outbound request and response from the destination server.\n\n### PerRequestMetrics.cs\n\nClass to store the metrics on a per request basis. Instances are stored in AsyncLocal storage for the duration of the request. \n\n### PerRequestYarpMetricCollectionMiddleware.cs\n\nASP.NET Core middleware that is the first and last thing called as part of the ASP.NET handling of the request. It initializes the per-request metrics and logs the results at the end of the request.\n"
},
{
"path": "samples/ReverseProxy.Metrics.Sample/ReverseProxy.Metrics.Sample.csproj",
"content": "\n\n \n $(ReleaseTFMs)\n Exe\n Yarp.Sample\n latest\n \n\n \n \n \n\n \n \n \n\n\n"
},
{
"path": "samples/ReverseProxy.Metrics.Sample/WebSocketsTelemetryConsumer.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System;\nusing Microsoft.Extensions.Logging;\nusing Yarp.Telemetry.Consumption;\n\nnamespace Yarp.Sample\n{\n public sealed class WebSocketsTelemetryConsumer : IWebSocketsTelemetryConsumer\n {\n private readonly ILogger _logger;\n\n public WebSocketsTelemetryConsumer(ILogger logger)\n {\n ArgumentNullException.ThrowIfNull(logger);\n _logger = logger;\n }\n\n public void OnWebSocketClosed(DateTime timestamp, DateTime establishedTime, WebSocketCloseReason closeReason, long messagesRead, long messagesWritten)\n {\n _logger.LogInformation($\"WebSocket connection closed ({closeReason}) after reading {messagesRead} and writing {messagesWritten} messages over {(timestamp - establishedTime).TotalSeconds:N2} seconds.\");\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.Metrics.Sample/appsettings.Development.json",
"content": "{\n \"Logging\": {\n \"LogLevel\": {\n \"Default\": \"Debug\",\n \"Microsoft\": \"Debug\",\n \"Microsoft.Hosting.Lifetime\": \"Information\"\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.Metrics.Sample/appsettings.json",
"content": "{\n \"Logging\": {\n \"LogLevel\": {\n \"Default\": \"Information\",\n // \"Microsoft\": \"Warning\",\n \"Microsoft.Hosting.Lifetime\": \"Information\"\n }\n },\n \"AllowedHosts\": \"*\",\n \"Kestrel\": {\n \"Endpoints\": {\n \"http\": {\n \"Url\": \"http://localhost:5000\"\n },\n \"https\": {\n \"Url\": \"https://localhost:5001\"\n }\n }\n },\n \"ReverseProxy\": {\n \"Routes\": {\n \"route1\": {\n \"ClusterId\": \"cluster1\",\n \"Match\": {\n \"Path\": \"{**catch-all}\"\n }\n }\n },\n \"Clusters\": {\n \"cluster1\": {\n \"Destinations\": {\n \"cluster1/destination1\": {\n \"Address\": \"https://example.com/\"\n }\n }\n }\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.Transforms.Sample/MyTransformFactory.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System;\nusing System.Collections.Generic;\nusing System.Net.Http;\nusing Yarp.ReverseProxy.Transforms;\nusing Yarp.ReverseProxy.Transforms.Builder;\n\nnamespace Yarp.Sample\n{\n internal sealed class MyTransformFactory : ITransformFactory\n {\n public bool Validate(TransformRouteValidationContext context, IReadOnlyDictionary transformValues)\n {\n if (transformValues.TryGetValue(\"CustomTransform\", out var value))\n {\n if (string.IsNullOrEmpty(value))\n {\n context.Errors.Add(new ArgumentException(\"A non-empty CustomTransform value is required\"));\n }\n\n return true; // Matched\n }\n return false;\n }\n\n public bool Build(TransformBuilderContext context, IReadOnlyDictionary transformValues)\n {\n if (transformValues.TryGetValue(\"CustomTransform\", out var value))\n {\n if (string.IsNullOrEmpty(value))\n {\n throw new ArgumentException(\"A non-empty CustomTransform value is required\");\n }\n\n context.AddRequestTransform(transformContext =>\n {\n transformContext.ProxyRequest.Options.Set(new HttpRequestOptionsKey(\"CustomTransform\"), value);\n return default;\n });\n\n return true;\n }\n\n return false;\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.Transforms.Sample/MyTransformProvider.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System;\nusing System.Net.Http;\nusing Yarp.ReverseProxy.Transforms;\nusing Yarp.ReverseProxy.Transforms.Builder;\n\nnamespace Yarp.Sample\n{\n internal sealed class MyTransformProvider : ITransformProvider\n {\n public void ValidateRoute(TransformRouteValidationContext context)\n {\n // Check all routes for a custom property and validate the associated transform data.\n if (context.Route.Metadata?.TryGetValue(\"CustomMetadata\", out var value) ?? false)\n {\n if (string.IsNullOrEmpty(value))\n {\n context.Errors.Add(new ArgumentException(\"A non-empty CustomMetadata value is required\"));\n }\n }\n }\n\n public void ValidateCluster(TransformClusterValidationContext context)\n {\n // Check all clusters for a custom property and validate the associated transform data.\n if (context.Cluster.Metadata?.TryGetValue(\"CustomMetadata\", out var value) ?? false)\n {\n if (string.IsNullOrEmpty(value))\n {\n context.Errors.Add(new ArgumentException(\"A non-empty CustomMetadata value is required\"));\n }\n }\n }\n\n public void Apply(TransformBuilderContext transformBuildContext)\n {\n // Check all routes for a custom property and add the associated transform.\n if ((transformBuildContext.Route.Metadata?.TryGetValue(\"CustomMetadata\", out var value) ?? false)\n || (transformBuildContext.Cluster?.Metadata?.TryGetValue(\"CustomMetadata\", out value) ?? false))\n {\n if (string.IsNullOrEmpty(value))\n {\n throw new ArgumentException(\"A non-empty CustomMetadata value is required\");\n }\n\n transformBuildContext.AddRequestTransform(transformContext =>\n {\n transformContext.ProxyRequest.Options.Set(new HttpRequestOptionsKey(\"CustomMetadata\"), value);\n return default;\n });\n }\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.Transforms.Sample/Program.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System.Net.Http.Headers;\nusing Microsoft.AspNetCore.Authentication;\nusing Microsoft.AspNetCore.Builder;\nusing Microsoft.Extensions.DependencyInjection;\nusing Yarp.ReverseProxy.Transforms;\nusing Yarp.Sample;\n\nvar builder = WebApplication.CreateBuilder(args);\n\nbuilder.Services.AddControllers();\nbuilder.Services.AddReverseProxy()\n .LoadFromConfig(builder.Configuration.GetSection(\"ReverseProxy\"))\n .AddTransforms() // Adds custom transforms via code.\n .AddTransformFactory() // Adds custom transforms via config.\n .AddTransforms(transformBuilderContext => // Add transforms inline\n {\n // For each route+cluster pair decide if we want to add transforms, and if so, which?\n // This logic is re-run each time a route is rebuilt.\n\n transformBuilderContext.AddPathPrefix(\"/prefix\");\n\n // Only do this for routes that require auth.\n if (string.Equals(\"token\", transformBuilderContext.Route.AuthorizationPolicy))\n {\n transformBuilderContext.AddRequestTransform(async transformContext =>\n {\n // AuthN and AuthZ will have already been completed after request routing.\n var ticket = await transformContext.HttpContext.AuthenticateAsync(\"token\");\n var tokenService = transformContext.HttpContext.RequestServices.GetRequiredService();\n var token = await tokenService.GetAuthTokenAsync(ticket.Principal);\n transformContext.ProxyRequest.Headers.Authorization = new AuthenticationHeaderValue(\"Bearer\", token);\n });\n }\n });\n\nvar app = builder.Build();\n\napp.UseAuthentication();\napp.UseAuthorization();\n\n// Register the reverse proxy routes\napp.MapReverseProxy();\n\napp.Run();\n"
},
{
"path": "samples/ReverseProxy.Transforms.Sample/Properties/launchSettings.json",
"content": "{\n \"iisSettings\": {\n \"windowsAuthentication\": false,\n \"anonymousAuthentication\": true,\n \"iisExpress\": {\n \"applicationUrl\": \"https://localhost:44356/\",\n \"sslPort\": 44356\n }\n },\n \"profiles\": {\n \"ReverseProxy.Transforms.Sample\": {\n \"commandName\": \"Project\",\n \"launchBrowser\": false,\n \"environmentVariables\": {\n \"ASPNETCORE_ENVIRONMENT\": \"Development\"\n }\n },\n \"IIS Express\": {\n \"commandName\": \"IISExpress\",\n \"launchBrowser\": true,\n \"environmentVariables\": {\n \"ASPNETCORE_ENVIRONMENT\": \"Development\"\n }\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.Transforms.Sample/ReverseProxy.Transforms.Sample.csproj",
"content": "\n\n \n $(ReleaseTFMs)\n Exe\n Yarp.Sample\n latest\n \n\n \n \n \n\n \n \n \n\n\n"
},
{
"path": "samples/ReverseProxy.Transforms.Sample/TokenService.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System.Security.Claims;\nusing System.Threading.Tasks;\n\nnamespace Yarp.Sample\n{\n internal sealed class TokenService\n {\n internal Task GetAuthTokenAsync(ClaimsPrincipal user)\n {\n return Task.FromResult(user.Identity.Name);\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.Transforms.Sample/appsettings.Development.json",
"content": "{\n \"Logging\": {\n \"LogLevel\": {\n \"Default\": \"Debug\",\n \"Microsoft\": \"Debug\",\n \"Microsoft.Hosting.Lifetime\": \"Information\"\n }\n }\n}\n"
},
{
"path": "samples/ReverseProxy.Transforms.Sample/appsettings.json",
"content": "{\n \"Logging\": {\n \"LogLevel\": {\n \"Default\": \"Information\",\n \"Microsoft\": \"Warning\",\n \"Microsoft.Hosting.Lifetime\": \"Information\"\n }\n },\n \"AllowedHosts\": \"*\",\n \"Kestrel\": {\n \"Endpoints\": {\n \"https\": {\n \"Url\": \"https://localhost:5001\"\n },\n \"http\": {\n \"Url\": \"http://localhost:5000\"\n }\n }\n },\n \"ReverseProxy\": {\n \"Routes\": {\n \"route1\": {\n \"ClusterId\": \"cluster1\",\n \"Match\": {\n \"Path\": \"{**catch-all}\"\n },\n \"Transforms\": [\n { \"PathPrefix\": \"/prefix\" },\n { \"RequestHeadersCopy\": true },\n { \"RequestHeaderOriginalHost\": false },\n {\n \"RequestHeader\": \"foo0\",\n \"Append\": \"bar\"\n },\n {\n \"RequestHeader\": \"foo1\",\n \"Set\": \"bar, baz\"\n },\n {\n \"RequestHeader\": \"clearMe\",\n \"Set\": \"\"\n },\n {\n \"ResponseHeader\": \"foo\",\n \"Append\": \"bar\",\n \"When\": \"Always\"\n },\n {\n \"ResponseTrailer\": \"foo\",\n \"Append\": \"trailer\",\n \"When\": \"Always\"\n },\n {\n \"CustomTransform\": \"custom value\"\n }\n ]\n }\n },\n \"Clusters\": {\n \"cluster1\": {\n \"Metadata\": {\n \"CustomMetadata\": \"custom value\"\n },\n \"Destinations\": {\n \"cluster1/destination1\": {\n \"Address\": \"https://example.com\"\n }\n }\n }\n }\n }\n}\n"
},
{
"path": "samples/SampleServer/Controllers/HealthController.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing Microsoft.AspNetCore.Mvc;\n\nnamespace SampleServer.Controllers\n{\n /// \n /// Controller for active health check probes.\n /// \n [ApiController]\n public class HealthController : ControllerBase\n {\n private static volatile int _count;\n /// \n /// Returns 200 if server is healthy.\n /// \n [HttpGet]\n [Route(\"/api/health\")]\n public IActionResult CheckHealth()\n {\n _count++;\n // Simulate temporary health degradation.\n return _count % 10 < 4 ? Ok() : StatusCode(500);\n }\n }\n}\n"
},
{
"path": "samples/SampleServer/Controllers/HttpController.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System;\nusing System.Collections.Generic;\nusing System.IO;\nusing System.Linq;\nusing System.Threading.Tasks;\nusing Microsoft.AspNetCore.Mvc;\n\nnamespace SampleServer.Controllers\n{\n /// \n /// Sample controller.\n /// \n [ApiController]\n public class HttpController : ControllerBase\n {\n /// \n /// Returns a 200 response.\n /// \n [HttpGet]\n [Route(\"/api/noop\")]\n public void NoOp()\n {\n }\n\n /// \n /// Returns a 200 response dumping all info from the incoming request.\n /// \n [HttpGet, HttpPost]\n [Route(\"/api/dump\")]\n [Route(\"/{**catchall}\", Order = int.MaxValue)] // Make this the default route if nothing matches\n public async Task Dump()\n {\n var result = new {\n Request.Protocol,\n Request.Method,\n Request.Scheme,\n Host = Request.Host.Value,\n PathBase = Request.PathBase.Value,\n Path = Request.Path.Value,\n Query = Request.QueryString.Value,\n Headers = Request.Headers.ToDictionary(kvp => kvp.Key, kvp => kvp.Value.ToArray()),\n Time = DateTimeOffset.UtcNow,\n Body = await new StreamReader(Request.Body).ReadToEndAsync(),\n };\n\n return Ok(result);\n }\n\n /// \n /// Returns a 200 response dumping all info from the incoming request.\n /// \n [HttpGet]\n [Route(\"/api/statuscode\")]\n public void Status(int statusCode)\n {\n Response.StatusCode = statusCode;\n }\n\n /// \n /// Returns a 200 response dumping all info from the incoming request.\n /// \n [HttpGet]\n [Route(\"/api/headers\")]\n public void Headers([FromBody] Dictionary headers)\n {\n foreach (var (key, value) in headers)\n {\n Response.Headers[key] = value;\n }\n }\n }\n}\n"
},
{
"path": "samples/SampleServer/Controllers/WebSocketsController.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System;\nusing System.Net.WebSockets;\nusing System.Threading;\nusing System.Threading.Tasks;\nusing Microsoft.AspNetCore.Http;\nusing Microsoft.AspNetCore.Mvc;\nusing Microsoft.Extensions.Logging;\n\nnamespace SampleServer.Controllers\n{\n /// \n /// Sample controller.\n /// \n [ApiController]\n public class WebSocketsController : ControllerBase\n {\n private readonly ILogger _logger;\n\n /// \n /// Initializes a new instance of the class.\n /// \n public WebSocketsController(ILogger logger)\n {\n _logger = logger;\n }\n\n /// \n /// Returns a 200 response.\n /// \n [HttpGet]\n [Route(\"/api/websockets\")]\n public async Task WebSockets()\n {\n if (!HttpContext.WebSockets.IsWebSocketRequest)\n {\n HttpContext.Response.ContentType = \"text/html\";\n await HttpContext.Response.SendFileAsync(\"./wwwroot/index.html\");\n return;\n }\n\n using (var webSocket = await HttpContext.WebSockets.AcceptWebSocketAsync())\n {\n _logger.LogInformation(\"WebSockets established.\");\n await RunPingPongAsync(webSocket, HttpContext.RequestAborted);\n }\n\n _logger.LogInformation(\"WebSockets finished.\");\n }\n\n private static async Task RunPingPongAsync(WebSocket webSocket, CancellationToken cancellation)\n {\n var buffer = new byte[1024];\n while (true)\n {\n var message = await webSocket.ReceiveAsync(buffer, cancellation);\n if (message.MessageType == WebSocketMessageType.Close)\n {\n await webSocket.CloseOutputAsync(WebSocketCloseStatus.NormalClosure, \"Bye\", cancellation);\n return;\n }\n\n await webSocket.SendAsync(new ArraySegment(buffer, 0, message.Count),\n message.MessageType,\n message.EndOfMessage,\n cancellation);\n }\n }\n }\n}\n"
},
{
"path": "samples/SampleServer/Program.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing Microsoft.AspNetCore.Builder;\nusing Microsoft.Extensions.DependencyInjection;\n\nvar builder = WebApplication.CreateBuilder(args);\n\nbuilder.Services.AddControllers()\n .AddJsonOptions(options => options.JsonSerializerOptions.WriteIndented = true);\n\nvar app = builder.Build();\n\napp.UseWebSockets();\napp.MapControllers();\n\napp.Run();\n"
},
{
"path": "samples/SampleServer/Properties/launchSettings.json",
"content": "{\n \"profiles\": {\n \"SampleServer\": {\n \"commandName\": \"Project\",\n \"launchBrowser\": false,\n \"environmentVariables\": {\n \"ASPNETCORE_ENVIRONMENT\": \"Development\"\n }\n }\n }\n}\n"
},
{
"path": "samples/SampleServer/README.md",
"content": "# Sample Server\n\nThis is a simple web server implementation that can be used to test YARP proxy, by using it as the destination.\n\nFunctionality in this sample server includes:\n\n## Echoing of Request Headers\n\nProvided that the request URI path doesn't match other endpoints described below, then the request headers will be reported back as text in the response body. This enables you to quickly see what headers were sent, for example to analyze header transforms made by the reverse proxy.\n\n## Healthcheck status endpoint\n\n[HealthController](Controllers/HealthController.cs) implements an API endpoint for /api/health that will randomly return bad health status.\n\n## WebSockets endpoint\n\n[WebSocketsController](Controllers/WebSocketsController.cs) implements an endpoint for testing web sockets at /api/websockets.\n\n## Usage\n\nTo run the sample server use: \n- ```dotnet run``` from the sample folder\n- ```dotnet run SampleServer/SampleServer.csproj``` passing in the path to the .csproj file\n- Build an executable using ```dotnet build SampleServer.csproj``` and then run the executable directly\n\nThe server will listen to http://localhost:5000 and https://localhost:5001 by default. The ports and interface can be changed using the urls option on the cmd line. For example ```dotnet run SampleServer/SampleServer.csproj --urls \"https://localhost:10000;http://localhost:10010\"```\n"
},
{
"path": "samples/SampleServer/SampleServer.csproj",
"content": "\n\n \n $(ReleaseTFMs)\n Exe\n SampleServer\n \n\n \n \n \n\n\n"
},
{
"path": "samples/SampleServer/appsettings.Development.json",
"content": "{\n \"Logging\": {\n \"LogLevel\": {\n \"Default\": \"Information\",\n \"Microsoft\": \"Information\",\n \"Microsoft.Hosting.Lifetime\": \"Information\"\n }\n }\n}\n"
},
{
"path": "samples/SampleServer/appsettings.json",
"content": "{\n \"Logging\": {\n \"LogLevel\": {\n \"Default\": \"Information\",\n \"Microsoft\": \"Warning\",\n \"Microsoft.Hosting.Lifetime\": \"Information\"\n }\n },\n \"AllowedHosts\": \"*\"\n}"
},
{
"path": "samples/SampleServer/wwwroot/index.html",
"content": "\n\n\n \n \n \n\n\n
WebSocket Test Page
\n
Ready to connect...
\n
\n \n \n \n
\n
\n \n \n \n \n
\n\n
Note: When connected to the default server (i.e. the server in the address bar ;)), the message \"ServerClose\" will cause the server to close the connection. Similarly, the message \"ServerAbort\" will cause the server to forcibly terminate the connection without a closing handshake
\n\n
Communication Log
\n
\n \n
\n
From
\n
To
\n
Data
\n
\n \n \n \n
\n\n \n\n\n"
},
{
"path": "src/Application/Extensions.cs",
"content": "using System.Net;\nusing System.Security.Cryptography;\nusing System.Security.Cryptography.X509Certificates;\nusing HealthChecks.ApplicationStatus.DependencyInjection;\nusing Microsoft.AspNetCore.Builder;\nusing Microsoft.AspNetCore.Diagnostics.HealthChecks;\nusing Microsoft.Extensions.DependencyInjection;\nusing Microsoft.Extensions.Logging;\nusing OpenTelemetry;\nusing OpenTelemetry.Exporter;\nusing OpenTelemetry.Logs;\nusing OpenTelemetry.Metrics;\nusing OpenTelemetry.Trace;\nusing static System.Net.WebRequestMethods;\n\nnamespace Microsoft.Extensions.Hosting;\n\n// Adds common .NET Aspire services: service discovery, resilience, health checks, and OpenTelemetry.\n// This project should be referenced by each service project in your solution.\n// To learn more about using this project, see https://aka.ms/dotnet/aspire/service-defaults\npublic static class Extensions\n{\n public static TBuilder AddServiceDefaults(this TBuilder builder) where TBuilder : IHostApplicationBuilder\n {\n builder.ConfigureOpenTelemetry();\n\n builder.AddDefaultHealthChecks();\n\n builder.Services.AddServiceDiscovery();\n\n return builder;\n }\n\n public static TBuilder ConfigureOpenTelemetry(this TBuilder builder) where TBuilder : IHostApplicationBuilder\n {\n var useOtlpExporter = !string.IsNullOrWhiteSpace(builder.Configuration[\"OTEL_EXPORTER_OTLP_ENDPOINT\"]);\n\n if (useOtlpExporter)\n {\n builder.Logging.AddOpenTelemetry(logging =>\n {\n logging.IncludeFormattedMessage = true;\n logging.IncludeScopes = true;\n });\n\n var telemetryBuilder = builder.Services.AddOpenTelemetry();\n\n telemetryBuilder\n .WithLogging(logging => logging.AddOtlpExporter())\n .WithMetrics(metrics =>\n {\n metrics.AddAspNetCoreInstrumentation()\n .AddHttpClientInstrumentation()\n .AddRuntimeInstrumentation()\n .SetExemplarFilter(ExemplarFilterType.TraceBased)\n .AddOtlpExporter();\n })\n .WithTracing(tracing =>\n {\n tracing.AddAspNetCoreInstrumentation()\n .AddHttpClientInstrumentation()\n .AddOtlpExporter();\n });\n\n if (string.Equals(Environment.GetEnvironmentVariable(\"YARP_UNSAFE_OLTP_CERT_ACCEPT_ANY_SERVER_CERTIFICATE\"), \"true\", StringComparison.InvariantCultureIgnoreCase))\n {\n // We cannot use UseOtlpExporter() since it doesn't support configuration via OtlpExporterOptions\n // https://github.com/open-telemetry/opentelemetry-dotnet/issues/5802\n builder.Services.Configure(ConfigureOtlpExporterOptions);\n }\n }\n\n static void ConfigureOtlpExporterOptions(OtlpExporterOptions options)\n {\n options.HttpClientFactory = () =>\n {\n var handler = new HttpClientHandler();\n handler.ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousAcceptAnyServerCertificateValidator;\n var httpClient = new HttpClient(handler);\n return httpClient;\n };\n }\n\n return builder;\n }\n\n public static TBuilder AddDefaultHealthChecks(this TBuilder builder) where TBuilder : IHostApplicationBuilder\n {\n builder.Services.AddHealthChecks()\n // Add a default liveness check on application status.\n .AddApplicationStatus(tags: [\"live\"]);\n\n return builder;\n }\n}\n"
},
{
"path": "src/Application/Program.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing Microsoft.AspNetCore.Builder;\nusing Microsoft.AspNetCore.Http;\nusing Microsoft.Extensions.Configuration;\nusing Microsoft.Extensions.DependencyInjection;\nusing Microsoft.Extensions.Hosting;\n\nvar builder = WebApplication.CreateBuilder();\n\n// Load configuration from file if passed\nif (args.Length == 1)\n{\n var configFile = args[0];\n var fileInfo = new FileInfo(configFile);\n if (!fileInfo.Exists)\n {\n Console.Error.WriteLine($\"Could not find '{configFile}'.\");\n return 2;\n }\n builder.Configuration.AddJsonFile(fileInfo.FullName, optional: false, reloadOnChange: true);\n builder.Configuration.AddEnvironmentVariables();\n}\n\n// Configure YARP\nbuilder.AddServiceDefaults();\nbuilder.Services.AddServiceDiscovery();\nbuilder.Services.AddReverseProxy()\n .LoadFromConfig(builder.Configuration.GetSection(\"ReverseProxy\"))\n .AddServiceDiscoveryDestinationResolver();\n\nvar app = builder.Build();\nvar isEnabledStaticFiles = Environment.GetEnvironmentVariable(\"YARP_ENABLE_STATIC_FILES\");\nif (string.Equals(isEnabledStaticFiles, \"true\", StringComparison.OrdinalIgnoreCase))\n{\n app.UseFileServer();\n}\napp.UseRouting();\napp.MapReverseProxy();\n\nawait app.RunAsync();\n\nreturn 0;\n"
},
{
"path": "src/Application/Yarp.Application.csproj",
"content": "\n\n \n Exe\n win-x64;win-arm64;linux-x64;linux-arm64;\n net9.0\n enable\n enable\n yarp\n false\n false\n \n\n \n \n\n \n \n \n \n\n \n \n \n \n \n \n \n\n\n"
},
{
"path": "src/Common/Package.targets",
"content": "\n \n \n \n\n"
},
{
"path": "src/Directory.Build.props",
"content": "\n\n \n \n\n \n \n $(MSBuildProjectDirectory)\\ConfigurationSchema.json\n true\n \n\n \n \n \n\n \n $(TargetsForTfmSpecificContentInPackage);AddPackageTargetsInPackage\n \n\n \n \n \n \n \n\n \n true\n true\n true\n icon.png\n \n\n \n \n \n\n"
},
{
"path": "src/Kubernetes.Controller/Caching/Endpoints.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing k8s.Models;\nusing System;\nusing System.Collections.Generic;\n\nnamespace Yarp.Kubernetes.Controller.Caching;\n\n/// \n/// Holds data needed from a resource.\n/// \npublic struct Endpoints\n{\n public Endpoints(V1Endpoints endpoints)\n {\n ArgumentNullException.ThrowIfNull(endpoints);\n\n Name = endpoints.Name();\n Subsets = endpoints.Subsets;\n }\n\n public string Name { get; set; }\n public IList Subsets { get; }\n}\n"
},
{
"path": "src/Kubernetes.Controller/Caching/ICache.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing k8s;\nusing k8s.Models;\nusing System.Collections.Generic;\nusing System.Collections.Immutable;\nusing Yarp.Kubernetes.Controller.Services;\n\nnamespace Yarp.Kubernetes.Controller.Caching;\n\n/// \n/// ICache service interface holds onto the least amount of data necessary\n/// for to process work.\n/// \npublic interface ICache\n{\n void Update(WatchEventType eventType, V1IngressClass ingressClass);\n bool Update(WatchEventType eventType, V1Ingress ingress);\n ImmutableList Update(WatchEventType eventType, V1Service service);\n ImmutableList Update(WatchEventType eventType, V1Endpoints endpoints);\n void Update(WatchEventType eventType, V1Secret secret);\n bool TryGetReconcileData(NamespacedName key, out ReconcileData data);\n void GetKeys(List keys);\n IEnumerable GetIngresses();\n}\n"
},
{
"path": "src/Kubernetes.Controller/Caching/IngressCache.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing k8s;\nusing k8s.Models;\nusing Microsoft.Extensions.Logging;\nusing Microsoft.Extensions.Options;\nusing System;\nusing System.Collections.Generic;\nusing System.Collections.Immutable;\nusing System.Linq;\nusing Yarp.Kubernetes.Controller.Certificates;\nusing Yarp.Kubernetes.Controller.Services;\n\nnamespace Yarp.Kubernetes.Controller.Caching;\n\n/// \n/// ICache service interface holds onto the least amount of data necessary\n/// for to process work.\n/// \npublic class IngressCache : ICache\n{\n private readonly object _sync = new object();\n private readonly Dictionary _ingressClassData = new Dictionary();\n private readonly Dictionary _namespaceCaches = new Dictionary();\n private readonly YarpOptions _options;\n private readonly IServerCertificateSelector _certificateSelector;\n private readonly ICertificateHelper _certificateHelper;\n private readonly ILogger _logger;\n\n private bool _isDefaultController;\n\n public IngressCache(IOptions options, IServerCertificateSelector certificateSelector, ICertificateHelper certificateHelper, ILogger logger)\n {\n ArgumentNullException.ThrowIfNull(options?.Value);\n ArgumentNullException.ThrowIfNull(certificateSelector);\n ArgumentNullException.ThrowIfNull(certificateHelper);\n ArgumentNullException.ThrowIfNull(logger);\n\n _options = options.Value;\n _certificateSelector = certificateSelector;\n _certificateHelper = certificateHelper;\n _logger = logger;\n }\n\n public void Update(WatchEventType eventType, V1IngressClass ingressClass)\n {\n ArgumentNullException.ThrowIfNull(ingressClass);\n\n if (!string.Equals(_options.ControllerClass, ingressClass.Spec.Controller, StringComparison.OrdinalIgnoreCase))\n {\n _logger.LogInformation(\n \"Ignoring {IngressClassNamespace}/{IngressClassName} as the spec.controller is not the same as this ingress\",\n ingressClass.Metadata.NamespaceProperty,\n ingressClass.Metadata.Name);\n return;\n }\n\n var ingressClassName = ingressClass.Name();\n lock (_sync)\n {\n if (eventType == WatchEventType.Added || eventType == WatchEventType.Modified)\n {\n _ingressClassData[ingressClassName] = new IngressClassData(ingressClass);\n }\n else if (eventType == WatchEventType.Deleted)\n {\n _ingressClassData.Remove(ingressClassName);\n }\n\n _isDefaultController = _ingressClassData.Values.Any(ic => ic.IsDefault);\n }\n }\n\n public bool Update(WatchEventType eventType, V1Ingress ingress)\n {\n ArgumentNullException.ThrowIfNull(ingress);\n\n Namespace(ingress.Namespace()).Update(eventType, ingress);\n return true;\n }\n\n public ImmutableList Update(WatchEventType eventType, V1Service service)\n {\n ArgumentNullException.ThrowIfNull(service);\n\n return Namespace(service.Namespace()).Update(eventType, service);\n }\n\n public ImmutableList Update(WatchEventType eventType, V1Endpoints endpoints)\n {\n return Namespace(endpoints.Namespace()).Update(eventType, endpoints);\n }\n\n public void Update(WatchEventType eventType, V1Secret secret)\n {\n var namespacedName = NamespacedName.From(secret);\n _logger.LogDebug(\"Found secret '{NamespacedName}'. Checking against default {CertificateSecretName}\", namespacedName, _options.DefaultSslCertificate);\n\n if (!string.Equals(namespacedName.ToString(), _options.DefaultSslCertificate, StringComparison.OrdinalIgnoreCase))\n {\n return;\n }\n\n _logger.LogInformation(\"Found secret `{NamespacedName}` to use as default certificate for HTTPS traffic\", namespacedName);\n\n var certificate = _certificateHelper.ConvertCertificate(namespacedName, secret);\n if (certificate is null)\n {\n return;\n }\n\n if (eventType == WatchEventType.Added || eventType == WatchEventType.Modified)\n {\n _certificateSelector.AddCertificate(namespacedName, certificate);\n }\n else if (eventType == WatchEventType.Deleted)\n {\n _certificateSelector.RemoveCertificate(namespacedName);\n }\n }\n\n public bool TryGetReconcileData(NamespacedName key, out ReconcileData data)\n {\n return Namespace(key.Namespace).TryLookup(key, out data);\n }\n\n public void GetKeys(List keys)\n {\n lock (_sync)\n {\n foreach (var (ns, cache) in _namespaceCaches)\n {\n cache.GetKeys(ns, keys);\n }\n }\n }\n\n public IEnumerable GetIngresses()\n {\n var ingresses = new List();\n\n lock (_sync)\n {\n foreach (var ns in _namespaceCaches)\n {\n ingresses.AddRange(ns.Value.GetIngresses().Where(IsYarpIngress));\n }\n }\n\n return ingresses;\n }\n\n private bool IsYarpIngress(IngressData ingress)\n {\n if (ingress.Spec.IngressClassName is null)\n {\n return _isDefaultController;\n }\n\n lock (_sync)\n {\n return _ingressClassData.ContainsKey(ingress.Spec.IngressClassName);\n }\n }\n\n private NamespaceCache Namespace(string key)\n {\n lock (_sync)\n {\n if (!_namespaceCaches.TryGetValue(key, out var value))\n {\n value = new NamespaceCache();\n _namespaceCaches.Add(key, value);\n }\n return value;\n }\n }\n}\n"
},
{
"path": "src/Kubernetes.Controller/Caching/IngressClassData.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System;\nusing k8s.Models;\n\nnamespace Yarp.Kubernetes.Controller.Caching;\n\n/// \n/// Holds data needed from a resource.\n/// \npublic struct IngressClassData\n{\n public IngressClassData(V1IngressClass ingressClass)\n {\n ArgumentNullException.ThrowIfNull(ingressClass);\n\n IngressClass = ingressClass;\n IsDefault = GetDefaultAnnotation(ingressClass);\n }\n\n public V1IngressClass IngressClass { get; }\n\n public bool IsDefault { get; }\n\n private static bool GetDefaultAnnotation(V1IngressClass ingressClass)\n {\n var annotation = ingressClass.GetAnnotation(\"ingressclass.kubernetes.io/is-default-class\");\n return string.Equals(\"true\", annotation, StringComparison.OrdinalIgnoreCase);\n }\n}\n"
},
{
"path": "src/Kubernetes.Controller/Caching/IngressData.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing k8s.Models;\nusing System;\n\nnamespace Yarp.Kubernetes.Controller.Caching;\n\n/// \n/// Holds data needed from a resource.\n/// \npublic struct IngressData\n{\n public IngressData(V1Ingress ingress)\n {\n ArgumentNullException.ThrowIfNull(ingress);\n\n Spec = ingress.Spec;\n Metadata = ingress.Metadata;\n }\n\n public V1IngressSpec Spec { get; set; }\n public V1ObjectMeta Metadata { get; set; }\n}\n"
},
{
"path": "src/Kubernetes.Controller/Caching/NamespaceCache.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing k8s;\nusing k8s.Models;\nusing System;\nusing System.Collections.Generic;\nusing System.Collections.Immutable;\nusing System.Linq;\nusing Yarp.Kubernetes.Controller.Services;\n\nnamespace Yarp.Kubernetes.Controller.Caching;\n\n/// \n/// Per-namespace cache data. Implicitly scopes name-based lookups to same namespace. Also\n/// intended to make updates faster because cross-reference dictionaries are not cluster-wide.\n/// \npublic class NamespaceCache\n{\n private readonly object _sync = new object();\n private readonly Dictionary> _ingressToServiceNames = new Dictionary>();\n private readonly Dictionary> _serviceToIngressNames = new Dictionary>();\n private readonly Dictionary _ingressData = new Dictionary();\n private readonly Dictionary _serviceData = new Dictionary();\n private readonly Dictionary _endpointsData = new Dictionary();\n\n public void Update(WatchEventType eventType, V1Ingress ingress)\n {\n ArgumentNullException.ThrowIfNull(ingress);\n\n var serviceNames = ImmutableList.Empty;\n\n if (eventType == WatchEventType.Added || eventType == WatchEventType.Modified)\n {\n // If the ingress exists, list out the related services\n var spec = ingress.Spec;\n var defaultBackend = spec?.DefaultBackend;\n var defaultService = defaultBackend?.Service;\n if (!string.IsNullOrEmpty(defaultService?.Name))\n {\n serviceNames = serviceNames.Add(defaultService.Name);\n }\n\n foreach (var rule in spec.Rules ?? Enumerable.Empty())\n {\n var http = rule.Http;\n foreach (var path in http.Paths ?? Enumerable.Empty())\n {\n var backend = path.Backend;\n var service = backend.Service;\n\n if (!serviceNames.Contains(service.Name))\n {\n serviceNames = serviceNames.Add(service.Name);\n }\n }\n }\n }\n\n var ingressName = ingress.Name();\n lock (_sync)\n {\n var serviceNamesPrevious = ImmutableList.Empty;\n if (eventType == WatchEventType.Added || eventType == WatchEventType.Modified)\n {\n // If the ingress exists then remember details\n\n _ingressData[ingressName] = new IngressData(ingress);\n\n if (_ingressToServiceNames.TryGetValue(ingressName, out serviceNamesPrevious))\n {\n _ingressToServiceNames[ingressName] = serviceNames;\n }\n else\n {\n serviceNamesPrevious = ImmutableList.Empty;\n _ingressToServiceNames.Add(ingressName, serviceNames);\n }\n }\n else if (eventType == WatchEventType.Deleted)\n {\n // otherwise clear out details\n\n _ingressData.Remove(ingressName);\n\n if (_ingressToServiceNames.TryGetValue(ingressName, out serviceNamesPrevious))\n {\n _ingressToServiceNames.Remove(ingressName);\n }\n }\n\n // update cross-reference for new ingress-to-services linkage not previously known\n foreach (var serviceName in serviceNames)\n {\n if (!serviceNamesPrevious.Contains(serviceName))\n {\n if (_serviceToIngressNames.TryGetValue(serviceName, out var ingressNamesPrevious))\n {\n _serviceToIngressNames[serviceName] = _serviceToIngressNames[serviceName].Add(ingressName);\n }\n else\n {\n _serviceToIngressNames.Add(serviceName, ImmutableList.Empty.Add(ingressName));\n }\n }\n }\n\n // remove cross-reference for previous ingress-to-services linkage no longer present\n foreach (var serviceName in serviceNamesPrevious)\n {\n if (!serviceNames.Contains(serviceName))\n {\n _serviceToIngressNames[serviceName] = _serviceToIngressNames[serviceName].Remove(ingressName);\n }\n }\n }\n }\n\n public ImmutableList Update(WatchEventType eventType, V1Service service)\n {\n ArgumentNullException.ThrowIfNull(service);\n\n var serviceName = service.Name();\n lock (_sync)\n {\n if (eventType == WatchEventType.Added || eventType == WatchEventType.Modified)\n {\n _serviceData[serviceName] = new ServiceData(service);\n }\n else if (eventType == WatchEventType.Deleted)\n {\n _serviceData.Remove(serviceName);\n }\n\n if (_serviceToIngressNames.TryGetValue(serviceName, out var ingressNames))\n {\n return ingressNames;\n }\n else\n {\n return ImmutableList.Empty;\n }\n }\n }\n\n public void GetKeys(string ns, List keys)\n {\n ArgumentNullException.ThrowIfNull(keys);\n\n lock (_sync)\n {\n foreach (var name in _ingressData.Keys)\n {\n keys.Add(new NamespacedName(ns, name));\n }\n }\n }\n\n public ImmutableList Update(WatchEventType eventType, V1Endpoints endpoints)\n {\n ArgumentNullException.ThrowIfNull(endpoints);\n\n var serviceName = endpoints.Name();\n lock (_sync)\n {\n if (eventType == WatchEventType.Added || eventType == WatchEventType.Modified)\n {\n _endpointsData[serviceName] = new Endpoints(endpoints);\n }\n else if (eventType == WatchEventType.Deleted)\n {\n _endpointsData.Remove(serviceName);\n }\n\n if (_serviceToIngressNames.TryGetValue(serviceName, out var ingressNames))\n {\n return ingressNames;\n }\n else\n {\n return ImmutableList.Empty;\n }\n }\n }\n\n public IEnumerable GetIngresses()\n {\n return _ingressData.Values;\n }\n\n public bool IngressExists(V1Ingress ingress)\n {\n return _ingressData.ContainsKey(ingress.Name());\n }\n\n public bool TryLookup(NamespacedName key, out ReconcileData data)\n {\n var endpointsList = new List();\n var servicesList = new List();\n\n lock (_sync)\n {\n if (!_ingressData.TryGetValue(key.Name, out var ingress))\n {\n data = default;\n return false;\n }\n\n if (_ingressToServiceNames.TryGetValue(key.Name, out var serviceNames))\n {\n foreach (var serviceName in serviceNames)\n {\n if (_serviceData.TryGetValue(serviceName, out var serviceData))\n {\n servicesList.Add(serviceData);\n }\n\n if (_endpointsData.TryGetValue(serviceName, out var endpoints))\n {\n endpointsList.Add(endpoints);\n }\n }\n }\n\n if (_serviceData.Count == 0)\n {\n data = default;\n return false;\n }\n\n data = new ReconcileData(ingress, servicesList, endpointsList);\n return true;\n }\n }\n}\n"
},
{
"path": "src/Kubernetes.Controller/Caching/ServiceData.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing k8s.Models;\nusing System;\n\nnamespace Yarp.Kubernetes.Controller.Caching;\n\n/// \n/// Holds data needed from a resource.\n/// \npublic struct ServiceData\n{\n public ServiceData(V1Service service)\n {\n ArgumentNullException.ThrowIfNull(service);\n\n Spec = service.Spec;\n Metadata = service.Metadata;\n }\n\n public V1ServiceSpec Spec { get; set; }\n public V1ObjectMeta Metadata { get; set; }\n}\n"
},
{
"path": "src/Kubernetes.Controller/Certificates/CertificateHelper.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System;\nusing System.Runtime.InteropServices;\nusing System.Security.Cryptography.X509Certificates;\nusing System.Text;\nusing k8s.Models;\nusing Microsoft.Extensions.Logging;\n\nnamespace Yarp.Kubernetes.Controller.Certificates;\n\npublic class CertificateHelper : ICertificateHelper\n{\n private const string TlsCertKey = \"tls.crt\";\n private const string TlsPrivateKeyKey = \"tls.key\";\n\n private readonly ILogger _logger;\n\n public CertificateHelper(ILogger logger)\n {\n ArgumentNullException.ThrowIfNull(logger);\n _logger = logger;\n }\n\n public X509Certificate2 ConvertCertificate(NamespacedName namespacedName, V1Secret secret)\n {\n try\n {\n var cert = secret?.Data[TlsCertKey];\n var privateKey = secret?.Data[TlsPrivateKeyKey];\n\n if (cert == null || cert.Length == 0 || privateKey == null || privateKey.Length == 0)\n {\n _logger.LogWarning(\"TLS secret '{NamespacedName}' contains invalid data.\", namespacedName);\n return null;\n }\n\n var certString = EnsurePemFormat(cert, \"CERTIFICATE\");\n var privateString = EnsurePemFormat(privateKey, \"PRIVATE KEY\");\n\n if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))\n {\n // Cert needs converting. Read https://github.com/dotnet/runtime/issues/23749#issuecomment-388231655\n using var convertedCertificate = X509Certificate2.CreateFromPem(certString, privateString);\n return new X509Certificate2(convertedCertificate.Export(X509ContentType.Pkcs12));\n }\n\n return X509Certificate2.CreateFromPem(certString, privateString);\n }\n catch (Exception ex)\n {\n _logger.LogWarning(ex, \"Failed to convert secret '{NamespacedName}'\", namespacedName);\n }\n\n return null;\n }\n\n /// \n /// Kubernetes Secrets should be stored in base-64 encoded DER format (see https://kubernetes.io/docs/concepts/configuration/secret/#tls-secrets)\n /// but need can be imported into a object via PEM. Before this type of secret existed, an Opaque secret would be\n /// used containing the full PEM format, so it's possible that the incorrect format would be used.\n /// Doing it this way means we are more tolerant in handling certs in the wrong format.\n /// \n /// The raw data.\n /// The type for the PEM header.\n /// The certificate data in PEM format.\n private static string EnsurePemFormat(byte[] data, string pemType)\n {\n var der = Encoding.ASCII.GetString(data);\n if (!der.StartsWith(\"---\", StringComparison.Ordinal))\n {\n // Convert from encoded DER to PEM\n return $\"-----BEGIN {pemType}-----\\n{der}\\n-----END {pemType}-----\";\n }\n\n return der;\n }\n}\n"
},
{
"path": "src/Kubernetes.Controller/Certificates/ICertificateHelper.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System.Security.Cryptography.X509Certificates;\nusing k8s.Models;\n\nnamespace Yarp.Kubernetes.Controller.Certificates;\n\npublic interface ICertificateHelper\n{\n X509Certificate2 ConvertCertificate(NamespacedName namespacedName, V1Secret secret);\n}\n"
},
{
"path": "src/Kubernetes.Controller/Certificates/IServerCertificateSelector.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System.Security.Cryptography.X509Certificates;\nusing Microsoft.AspNetCore.Connections;\n\nnamespace Yarp.Kubernetes.Controller.Certificates;\n\n/// \n/// A mechanism for obtaining server certificates dynamically based on the SNI domain name.\n/// \npublic interface IServerCertificateSelector\n{\n /// \n /// Retrieve a certificate using the provided domain name.\n /// \n /// The connection context.\n /// The domain name.\n /// Either returns the specific certificate for the domain name, a wildcard certificates, or no certificate.\n X509Certificate2 GetCertificate(ConnectionContext connectionContext, string domainName);\n\n /// \n /// Adds a certificate to the selector.\n /// \n /// An identifier for the certificate that can be used to remove it.\n /// The server certificate.\n void AddCertificate(NamespacedName certificateName, X509Certificate2 certificate);\n\n /// \n /// Removes a certificate from the selector.\n /// \n /// An identifier for the certificate that can be used to remove it.\n void RemoveCertificate(NamespacedName certificateName);\n}\n"
},
{
"path": "src/Kubernetes.Controller/Certificates/ServerCertificateSelector.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System.Security.Cryptography.X509Certificates;\nusing Microsoft.AspNetCore.Connections;\n\nnamespace Yarp.Kubernetes.Controller.Certificates;\n\ninternal class ServerCertificateSelector : IServerCertificateSelector\n{\n private X509Certificate2 _defaultCertificate;\n\n public void AddCertificate(NamespacedName certificateName, X509Certificate2 certificate)\n {\n _defaultCertificate = certificate;\n }\n\n public X509Certificate2 GetCertificate(ConnectionContext connectionContext, string domainName)\n {\n return _defaultCertificate;\n }\n\n public void RemoveCertificate(NamespacedName certificateName)\n {\n _defaultCertificate = null;\n }\n}\n"
},
{
"path": "src/Kubernetes.Controller/Client/GroupApiVersionKind.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing k8s.Models;\nusing System;\nusing System.Reflection;\n\nnamespace Yarp.Kubernetes.Controller.Client;\n\npublic struct GroupApiVersionKind : IEquatable\n{\n public GroupApiVersionKind(string group, string apiVersion, string kind)\n {\n ApiVersion = apiVersion;\n GroupApiVersion = string.IsNullOrEmpty(group) ? apiVersion : $\"{group}/{apiVersion}\";\n Kind = kind;\n }\n\n public string ApiVersion { get; }\n\n public string GroupApiVersion { get; }\n\n public string Kind { get; }\n\n public static GroupApiVersionKind From() => From(typeof(TResource));\n\n public static GroupApiVersionKind From(Type resourceType)\n {\n var entity = resourceType.GetTypeInfo().GetCustomAttribute();\n\n return new GroupApiVersionKind(\n group: entity.Group,\n apiVersion: entity.ApiVersion,\n kind: entity.Kind);\n }\n\n public override bool Equals(object obj)\n {\n return obj is GroupApiVersionKind kind && Equals(kind);\n }\n\n public bool Equals(GroupApiVersionKind other)\n {\n return GroupApiVersion == other.GroupApiVersion\n && Kind == other.Kind;\n }\n\n public override int GetHashCode()\n {\n return HashCode.Combine(GroupApiVersion, Kind);\n }\n\n public override string ToString()\n {\n return $\"{Kind}.{GroupApiVersion}\";\n }\n\n public static bool operator ==(GroupApiVersionKind left, GroupApiVersionKind right)\n {\n return left.Equals(right);\n }\n\n public static bool operator !=(GroupApiVersionKind left, GroupApiVersionKind right)\n {\n return !(left == right);\n }\n}\n"
},
{
"path": "src/Kubernetes.Controller/Client/IIngressResourceStatusUpdater.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System.Threading;\nusing System.Threading.Tasks;\n\nnamespace Yarp.Kubernetes.Controller.Client;\n\npublic interface IIngressResourceStatusUpdater\n{\n /// \n /// Updates the status of cached ingresses.\n /// \n Task UpdateStatusAsync(CancellationToken cancellationToken);\n}\n"
},
{
"path": "src/Kubernetes.Controller/Client/IResourceInformer.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing k8s;\nusing k8s.Models;\nusing Microsoft.Extensions.Hosting;\nusing System;\nusing System.Threading;\nusing System.Threading.Tasks;\n\nnamespace Yarp.Kubernetes.Controller.Client;\n\n/// \n/// Callback for resource event notifications.\n/// \n/// The type of being monitored.\n/// The type of change event which was received.\n/// The instance of the resource which was received.\npublic delegate void ResourceInformerCallback(WatchEventType eventType, TResource resource) where TResource : class, IKubernetesObject;\n\n/// \n/// Interface IResourceInformer is a service which generates\n/// notifications for a specific type\n/// of Kubernetes object. The callback eventType informs if the notification\n/// is because it is new, modified, or has been deleted.\n/// Implements the .\n/// \n/// The type of the t resource.\n/// \n/// \npublic interface IResourceInformer : IHostedService, IResourceInformer\n where TResource : class, IKubernetesObject, new()\n{\n /// \n /// Registers a callback for change notification. To ensure no events are missed the registration\n /// may be created in the constructor of a dependant . The returned\n /// registration should be disposed when the receiver is ending its work.\n /// \n /// The delegate that is invoked with each resource notification.\n /// A registration that should be disposed to end the notifications.\n IResourceInformerRegistration Register(ResourceInformerCallback callback);\n}\n\npublic interface IResourceInformer\n{\n /// \n /// Instructs the resource informer to being watching resources. Allows the startup of informers to be synchronised.\n /// \n void StartWatching();\n\n /// \n /// Returns a task that can be awaited to know when the initial listing of resources is complete.\n /// Once an await on this method is completed it is safe to assume that all the knowledge of this resource\n /// type has been made available. Any new changes will be a result of receiving new updates.\n /// \n /// The cancellation token that can be used by other objects or threads to receive notice of cancellation.\n /// Task.\n Task ReadyAsync(CancellationToken cancellationToken);\n\n /// \n /// Registers a callback for change notification. To ensure no events are missed the registration\n /// may be created in the constructor of a dependant . The returned\n /// registration should be disposed when the receiver is ending its work.\n /// \n /// The delegate that is invoked with each resource notification.\n /// A registration that should be disposed to end the notifications.\n IResourceInformerRegistration Register(ResourceInformerCallback> callback);\n}\n"
},
{
"path": "src/Kubernetes.Controller/Client/IResourceInformerRegistration.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System;\nusing System.Threading;\nusing System.Threading.Tasks;\n\nnamespace Yarp.Kubernetes.Controller.Client;\n\n/// \n/// Returned by to control the lifetime of an event\n/// notification connection. Call when the lifetime of the notification receiver is ending.\n/// \npublic interface IResourceInformerRegistration : IDisposable\n{\n /// \n /// Returns a task that can be awaited to know when the initial listing of resources is complete.\n /// Once an await on this method is completed it is safe to assume that all the knowledge of this resource\n /// type has been made available. Any new changes will be a result of receiving new updates.\n /// \n /// The cancellation token that can be used by other objects or threads to receive notice of cancellation.\n /// Task.\n Task ReadyAsync(CancellationToken cancellationToken);\n}\n"
},
{
"path": "src/Kubernetes.Controller/Client/KubernetesClientOptions.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing k8s;\n\nnamespace Yarp.Kubernetes.Controller.Client;\n\n/// \n/// Class KubernetesClientOptions.\n/// \npublic class KubernetesClientOptions\n{\n /// \n /// Gets or sets the configuration.\n /// \n /// The configuration.\n public KubernetesClientConfiguration Configuration { get; set; }\n}\n"
},
{
"path": "src/Kubernetes.Controller/Client/ResourceInformer.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing k8s;\nusing k8s.Autorest;\nusing k8s.Models;\nusing Microsoft.Extensions.Hosting;\nusing Microsoft.Extensions.Logging;\nusing System;\nusing System.Collections.Generic;\nusing System.Collections.Immutable;\nusing System.IO;\nusing System.Net.Sockets;\nusing System.Threading;\nusing System.Threading.Tasks;\nusing Yarp.Kubernetes.Controller.Hosting;\nusing Yarp.Kubernetes.Controller.Rate;\n\nnamespace Yarp.Kubernetes.Controller.Client;\n\n/// \n/// Class ResourceInformer.\n/// Implements the .\n/// Implements the .\n/// \n/// The type of the t resource.\n/// The type of the t resource used in lists.\n/// \n/// \npublic abstract class ResourceInformer : BackgroundHostedService, IResourceInformer\n where TResource : class, IKubernetesObject, new()\n where TListResource : class, IKubernetesObject, IItems, new()\n{\n private readonly object _sync = new object();\n private readonly GroupApiVersionKind _names;\n private readonly SemaphoreSlim _ready = new SemaphoreSlim(0);\n private readonly SemaphoreSlim _start = new SemaphoreSlim(0);\n private readonly ResourceSelector _selector;\n private ImmutableList _registrations = ImmutableList.Empty;\n private Dictionary> _cache = [];\n private string _lastResourceVersion;\n\n /// \n /// Initializes a new instance of the class.\n /// \n /// The client.\n /// A resource selector for (optionally) filtering the list of resources.\n /// The host application lifetime.\n /// The logger.\n public ResourceInformer(\n IKubernetes client,\n ResourceSelector selector,\n IHostApplicationLifetime hostApplicationLifetime,\n ILogger logger)\n : base(hostApplicationLifetime, logger)\n {\n ArgumentNullException.ThrowIfNull(client);\n ArgumentNullException.ThrowIfNull(selector);\n\n Client = client;\n _selector = selector;\n _names = GroupApiVersionKind.From();\n }\n\n private enum EventType\n {\n SynchronizeStarted = 101,\n SynchronizeComplete = 102,\n WatchingResource = 103,\n ReceivedError = 104,\n WatchingComplete = 105,\n InformerWatchEvent = 106,\n DisposingToReconnect = 107,\n IgnoringError = 108,\n }\n\n protected IKubernetes Client { get; init; }\n\n /// \n protected override void Dispose(bool disposing)\n {\n if (disposing)\n {\n try\n {\n _start.Dispose();\n _ready.Dispose();\n }\n catch (ObjectDisposedException)\n {\n // ignore redundant exception to allow shutdown sequence to progress uninterrupted\n }\n }\n base.Dispose(disposing);\n }\n\n public void StartWatching()\n {\n _start.Release();\n }\n\n public virtual IResourceInformerRegistration Register(ResourceInformerCallback callback)\n {\n return new Registration(this, callback);\n }\n\n public IResourceInformerRegistration Register(ResourceInformerCallback> callback)\n {\n return new Registration(this, (eventType, resource) => callback(eventType, resource));\n }\n\n /// \n public virtual async Task ReadyAsync(CancellationToken cancellationToken)\n {\n await _ready.WaitAsync(cancellationToken).ConfigureAwait(false);\n\n // Release is called after each WaitAsync because\n // the semaphore is being used as a manual reset event\n _ready.Release();\n }\n\n /// \n /// RunAsync starts processing when StartAsync is called, and is terminated when\n /// StopAsync is called.\n /// \n /// The cancellation token that can be used by other objects or threads to receive notice of cancellation.\n /// A representing the result of the asynchronous operation.\n public override async Task RunAsync(CancellationToken cancellationToken)\n {\n try\n {\n await _start.WaitAsync(cancellationToken).ConfigureAwait(false);\n\n var limiter = new Limiter(new Limit(0.2), 3);\n var shouldSync = true;\n var firstSync = true;\n while (true)\n {\n cancellationToken.ThrowIfCancellationRequested();\n\n try\n {\n if (shouldSync)\n {\n await ListAsync(cancellationToken).ConfigureAwait(true);\n shouldSync = false;\n }\n\n if (firstSync)\n {\n _ready.Release();\n firstSync = false;\n }\n\n await WatchAsync(cancellationToken).ConfigureAwait(true);\n }\n catch (IOException ex) when (ex.InnerException is SocketException)\n {\n Logger.LogDebug(\n EventId(EventType.ReceivedError),\n \"Received error watching {ResourceType}: {ErrorMessage}\",\n typeof(TResource).Name,\n ex.Message);\n }\n catch (KubernetesException ex)\n {\n Logger.LogDebug(\n EventId(EventType.ReceivedError),\n \"Received error watching {ResourceType}: {ErrorMessage}\",\n typeof(TResource).Name,\n ex.Message);\n\n // deal with this non-recoverable condition \"too old resource version\"\n // with a re-sync to listing everything again ensuring no subscribers miss updates\n if (ex is KubernetesException kubernetesError)\n {\n if (string.Equals(kubernetesError.Status.Reason, \"Expired\", StringComparison.Ordinal))\n {\n shouldSync = true;\n }\n }\n }\n\n // rate limiting the reconnect loop\n await limiter.WaitAsync(cancellationToken).ConfigureAwait(true);\n }\n }\n catch (Exception error)\n {\n Logger.LogInformation(\n EventId(EventType.WatchingComplete),\n error,\n \"No longer watching {ResourceType} resources from API server.\",\n typeof(TResource).Name);\n throw;\n }\n }\n\n protected abstract Task> RetrieveResourceListAsync(string resourceVersion = null, ResourceSelector resourceSelector = null, CancellationToken cancellationToken = default);\n protected abstract Watcher WatchResourceListAsync(string resourceVersion = null, ResourceSelector resourceSelector = null, Action onEvent = null, Action onError = null, Action onClosed = null);\n\n private static EventId EventId(EventType eventType) => new EventId((int)eventType, eventType.ToString());\n\n private async Task ListAsync(CancellationToken cancellationToken)\n {\n var previousCache = _cache;\n _cache = new Dictionary>();\n\n if (_selector.FieldSelector is not null)\n {\n Logger.LogInformation(\n EventId(EventType.SynchronizeStarted),\n \"Started synchronizing {ResourceType} resources from API server with field selector '{FieldSelector}'.\",\n typeof(TResource).Name,\n _selector.FieldSelector);\n }\n else\n {\n Logger.LogInformation(\n EventId(EventType.SynchronizeStarted),\n \"Started synchronizing {ResourceType} resources from API server.\",\n typeof(TResource).Name);\n }\n\n string continueParameter = null;\n do\n {\n cancellationToken.ThrowIfCancellationRequested();\n\n // request next page of items\n using var listWithHttpMessage = await RetrieveResourceListAsync(resourceVersion: _lastResourceVersion, resourceSelector: _selector, cancellationToken: cancellationToken);\n\n var list = listWithHttpMessage.Body;\n foreach (var item in list.Items)\n {\n // These properties are not already set on items while listing\n // assigned here for consistency\n item.ApiVersion = _names.GroupApiVersion;\n item.Kind = _names.Kind;\n\n var key = NamespacedName.From(item);\n _cache[key] = item?.Metadata?.OwnerReferences;\n\n var watchEventType = WatchEventType.Added;\n if (previousCache.Remove(key))\n {\n // an already-known key is provided as a modification for re-sync purposes\n watchEventType = WatchEventType.Modified;\n }\n\n InvokeRegistrationCallbacks(watchEventType, item);\n }\n\n foreach (var (key, value) in previousCache)\n {\n // for anything which was previously known but not part of list\n // send a deleted notification to clear any observer caches\n var item = new TResource\n {\n ApiVersion = _names.GroupApiVersion,\n Kind = _names.Kind,\n Metadata = new V1ObjectMeta\n {\n Name = key.Name,\n NamespaceProperty = key.Namespace,\n OwnerReferences = value\n }\n };\n\n InvokeRegistrationCallbacks(WatchEventType.Deleted, item);\n }\n\n // keep track of values needed for next page and to start watching\n _lastResourceVersion = list.ResourceVersion();\n continueParameter = list.Continue();\n }\n while (!string.IsNullOrEmpty(continueParameter));\n\n Logger.LogInformation(\n EventId(EventType.SynchronizeComplete),\n \"Completed synchronizing {ResourceType} resources from API server.\",\n typeof(TResource).Name);\n }\n\n private async Task WatchAsync(CancellationToken cancellationToken)\n {\n Logger.LogInformation(\n EventId(EventType.WatchingResource),\n \"Watching {ResourceType} starting from resource version {ResourceVersion}.\",\n typeof(TResource).Name,\n _lastResourceVersion);\n\n // completion source helps turn OnClose callback into something awaitable\n var watcherCompletionSource = new TaskCompletionSource();\n\n // begin watching where list left off\n var watcher = WatchResourceListAsync(resourceVersion: _lastResourceVersion, resourceSelector: _selector,\n (watchEventType, item) =>\n {\n if (!watcherCompletionSource.Task.IsCompleted)\n {\n OnEvent(watchEventType, item);\n }\n },\n error =>\n {\n if (error is KubernetesException kubernetesError)\n {\n // deal with this non-recoverable condition \"too old resource version\"\n if (string.Equals(kubernetesError.Status.Reason, \"Expired\", StringComparison.Ordinal))\n {\n // cause this error to surface\n watcherCompletionSource.TrySetException(error);\n throw error;\n }\n }\n\n Logger.LogDebug(\n EventId(EventType.IgnoringError),\n \"Ignoring error {ErrorType}: {ErrorMessage}\",\n error.GetType().Name,\n error.Message);\n },\n () =>\n {\n watcherCompletionSource.TrySetResult(0);\n }\n );\n\n var lastEventUtc = DateTime.UtcNow;\n\n // reconnect if no events have arrived after a certain time\n using var checkLastEventUtcTimer = new Timer(\n _ =>\n {\n var lastEvent = DateTime.UtcNow - lastEventUtc;\n if (lastEvent > TimeSpan.FromMinutes(9.5))\n {\n lastEventUtc = DateTime.MaxValue;\n Logger.LogDebug(\n EventId(EventType.DisposingToReconnect),\n \"Disposing watcher for {ResourceType} to cause reconnect.\",\n typeof(TResource).Name);\n\n watcherCompletionSource.TrySetCanceled();\n watcher.Dispose();\n\n }\n },\n state: null,\n dueTime: TimeSpan.FromSeconds(45),\n period: TimeSpan.FromSeconds(45));\n\n using var registration = cancellationToken.Register(watcher.Dispose);\n try\n {\n await watcherCompletionSource.Task;\n }\n catch (TaskCanceledException)\n {\n }\n }\n\n private void OnEvent(WatchEventType watchEventType, TResource item)\n {\n if (watchEventType != WatchEventType.Modified || item.Kind != \"ConfigMap\")\n {\n Logger.LogDebug(\n EventId(EventType.InformerWatchEvent),\n \"Informer {ResourceType} received {WatchEventType} notification for {ItemKind}/{ItemName}.{ItemNamespace} at resource version {ResourceVersion}\",\n typeof(TResource).Name,\n watchEventType,\n item.Kind,\n item.Name(),\n item.Namespace(),\n item.ResourceVersion());\n }\n\n if (watchEventType == WatchEventType.Added ||\n watchEventType == WatchEventType.Modified)\n {\n // BUGBUG: log warning if cache was not in expected state\n _cache[NamespacedName.From(item)] = item.Metadata?.OwnerReferences;\n }\n\n if (watchEventType == WatchEventType.Deleted)\n {\n _cache.Remove(NamespacedName.From(item));\n }\n\n if (watchEventType == WatchEventType.Added ||\n watchEventType == WatchEventType.Modified ||\n watchEventType == WatchEventType.Deleted ||\n watchEventType == WatchEventType.Bookmark)\n {\n _lastResourceVersion = item.ResourceVersion();\n }\n\n if (watchEventType == WatchEventType.Added ||\n watchEventType == WatchEventType.Modified ||\n watchEventType == WatchEventType.Deleted)\n {\n InvokeRegistrationCallbacks(watchEventType, item);\n }\n }\n\n private void InvokeRegistrationCallbacks(WatchEventType eventType, TResource resource)\n {\n\n List innerExceptions = default;\n foreach (var registration in _registrations)\n {\n try\n {\n registration.Callback.Invoke(eventType, resource);\n }\n catch (Exception innerException)\n {\n innerExceptions ??= new List();\n innerExceptions.Add(innerException);\n }\n }\n\n if (innerExceptions is not null)\n {\n throw new AggregateException(\"One or more exceptions thrown by ResourceInformerCallback.\", innerExceptions);\n }\n }\n\n internal class Registration : IResourceInformerRegistration\n {\n private bool _disposedValue;\n\n public Registration(ResourceInformer resourceInformer, ResourceInformerCallback callback)\n {\n ResourceInformer = resourceInformer;\n Callback = callback;\n lock (resourceInformer._sync)\n {\n resourceInformer._registrations = resourceInformer._registrations.Add(this);\n }\n }\n\n ~Registration()\n {\n // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method\n Dispose(disposing: false);\n }\n\n public ResourceInformer ResourceInformer { get; }\n public ResourceInformerCallback Callback { get; }\n\n public Task ReadyAsync(CancellationToken cancellationToken) => ResourceInformer.ReadyAsync(cancellationToken);\n\n protected virtual void Dispose(bool disposing)\n {\n if (!_disposedValue)\n {\n lock (ResourceInformer._sync)\n {\n ResourceInformer._registrations = ResourceInformer._registrations.Remove(this);\n }\n _disposedValue = true;\n }\n }\n\n public void Dispose()\n {\n // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method\n Dispose(disposing: true);\n GC.SuppressFinalize(this);\n }\n }\n}\n"
},
{
"path": "src/Kubernetes.Controller/Client/ResourceSelector.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing k8s;\nusing k8s.Models;\n\nnamespace Yarp.Kubernetes.Controller.Client;\n\n/// \n/// Provides a mechanism for to constrain search based on fields in the resource.\n/// \npublic class ResourceSelector\n where TResource : class, IKubernetesObject, new()\n{\n public ResourceSelector(string fieldSelector)\n {\n FieldSelector = fieldSelector;\n }\n\n public string FieldSelector { get; }\n}\n"
},
{
"path": "src/Kubernetes.Controller/Client/V1EndpointsResourceInformer.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System;\nusing k8s;\nusing k8s.Autorest;\nusing k8s.Models;\nusing Microsoft.Extensions.Hosting;\nusing Microsoft.Extensions.Logging;\nusing System.Threading;\nusing System.Threading.Tasks;\n\nnamespace Yarp.Kubernetes.Controller.Client;\n\ninternal class V1EndpointsResourceInformer : ResourceInformer\n{\n public V1EndpointsResourceInformer(\n IKubernetes client,\n ResourceSelector selector,\n IHostApplicationLifetime hostApplicationLifetime,\n ILogger logger)\n : base(client, selector, hostApplicationLifetime, logger)\n {\n }\n\n protected override Task> RetrieveResourceListAsync(string resourceVersion = null, ResourceSelector resourceSelector = null, CancellationToken cancellationToken = default)\n {\n return Client.CoreV1.ListEndpointsForAllNamespacesWithHttpMessagesAsync(resourceVersion: resourceVersion, fieldSelector: resourceSelector?.FieldSelector, cancellationToken: cancellationToken);\n }\n\n protected override Watcher WatchResourceListAsync(string resourceVersion = null, ResourceSelector resourceSelector = null, Action onEvent = null, Action onError = null, Action onClosed = null)\n {\n return Client.CoreV1.WatchListEndpointsForAllNamespaces(resourceVersion: resourceVersion, fieldSelector: resourceSelector?.FieldSelector, onEvent: onEvent, onError: onError, onClosed: onClosed);\n }\n}\n"
},
{
"path": "src/Kubernetes.Controller/Client/V1IngressClassResourceInformer.cs",
"content": "// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n\nusing System;\nusing k8s;\nusing k8s.Autorest;\nusing k8s.Models;\nusing Microsoft.Extensions.Hosting;\nusing Microsoft.Extensions.Logging;\nusing System.Threading;\nusing System.Threading.Tasks;\n\nnamespace Yarp.Kubernetes.Controller.Client;\n\ninternal class V1IngressClassResourceInformer : ResourceInformer\n{\n public V1IngressClassResourceInformer(\n IKubernetes client,\n ResourceSelector selector,\n IHostApplicationLifetime hostApplicationLifetime,\n ILogger logger)\n : base(client, selector, hostApplicationLifetime, logger)\n {\n }\n\n protected override Task> RetrieveResourceListAsync(string resourceVersion = null, ResourceSelector resourceSelector = null, CancellationToken cancellationToken = default)\n {\n return Client.NetworkingV1.ListIngressClassWithHttpMessagesAsync(resourceVersion: resourceVersion, fieldSelector: resourceSelector?.FieldSelector, cancellationToken: cancellationToken);\n }\n\n protected override Watcher