| | | 1 | | using System.Net; |
| | | 2 | | using System.Text.RegularExpressions; |
| | | 3 | | using Kestrun.Hosting.Options; |
| | | 4 | | using Kestrun.Languages; |
| | | 5 | | using Kestrun.Models; |
| | | 6 | | using Kestrun.OpenApi; |
| | | 7 | | using Kestrun.Runtime; |
| | | 8 | | using Kestrun.Scripting; |
| | | 9 | | using Kestrun.TBuilder; |
| | | 10 | | using Kestrun.Utilities; |
| | | 11 | | using Microsoft.AspNetCore.Antiforgery; |
| | | 12 | | using Microsoft.AspNetCore.Authorization; |
| | | 13 | | using Microsoft.Extensions.Options; |
| | | 14 | | using Microsoft.OpenApi; |
| | | 15 | | using Serilog.Events; |
| | | 16 | | |
| | | 17 | | namespace Kestrun.Hosting; |
| | | 18 | | |
| | | 19 | | /// <summary> |
| | | 20 | | /// Provides extension methods for mapping routes and handlers to the KestrunHost. |
| | | 21 | | /// </summary> |
| | | 22 | | public static partial class KestrunHostMapExtensions |
| | | 23 | | { |
| | | 24 | | /// <summary> |
| | | 25 | | /// Public utility facade for endpoint specification parsing. This provides a stable API surface |
| | | 26 | | /// over the internal helper logic used by host route constraint processing. |
| | | 27 | | /// </summary> |
| | | 28 | | public static class EndpointSpecParser |
| | | 29 | | { |
| | | 30 | | /// <summary> |
| | | 31 | | /// Parses an endpoint specification into host, port and optional HTTPS flag. |
| | | 32 | | /// </summary> |
| | | 33 | | /// <param name="spec">Specification string. See <see cref="TryParseEndpointSpec"/> for accepted formats.</param |
| | | 34 | | /// <param name="host">Resolved host when successful, otherwise empty string.</param> |
| | | 35 | | /// <param name="port">Resolved port when successful, otherwise 0.</param> |
| | | 36 | | /// <param name="https">True for https, false for http, null when unspecified (host:port form).</param> |
| | | 37 | | /// <returns><c>true</c> if parsing succeeds; otherwise <c>false</c>.</returns> |
| | | 38 | | public static bool TryParse(string spec, out string host, out int port, out bool? https) |
| | 16 | 39 | | => TryParseEndpointSpec(spec, out host, out port, out https); |
| | | 40 | | } |
| | | 41 | | /// <summary> |
| | | 42 | | /// Represents a delegate that handles a Kestrun request with the provided context. |
| | | 43 | | /// </summary> |
| | | 44 | | /// <param name="Context">The context for the Kestrun request.</param> |
| | | 45 | | /// <returns>A task representing the asynchronous operation.</returns> |
| | | 46 | | public delegate Task KestrunHandler(KestrunContext Context); |
| | | 47 | | |
| | | 48 | | /// <summary> |
| | | 49 | | /// Adds a native route to the KestrunHost for the specified pattern and HTTP verb. |
| | | 50 | | /// </summary> |
| | | 51 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 52 | | /// <param name="pattern">The route pattern.</param> |
| | | 53 | | /// <param name="httpVerb">The HTTP verb for the route.</param> |
| | | 54 | | /// <param name="handler">The handler to execute for the route.</param> |
| | | 55 | | /// <param name="requireSchemes">Optional array of authorization schemes required for the route.</param> |
| | | 56 | | /// <param name="map">The endpoint convention builder for further configuration.</param> |
| | | 57 | | /// <returns>The KestrunHost instance for chaining.</returns> |
| | | 58 | | public static KestrunHost AddMapRoute(this KestrunHost host, string pattern, HttpVerb httpVerb, KestrunHandler handl |
| | 3 | 59 | | host.AddMapRoute(pattern: pattern, httpVerbs: [httpVerb], handler: handler, out map, requireSchemes: requireSchemes) |
| | | 60 | | |
| | | 61 | | /// <summary> |
| | | 62 | | /// Adds a native route to the KestrunHost for the specified pattern and HTTP verbs. |
| | | 63 | | /// </summary> |
| | | 64 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 65 | | /// <param name="pattern">The route pattern.</param> |
| | | 66 | | /// <param name="httpVerbs">The HTTP verbs for the route.</param> |
| | | 67 | | /// <param name="handler">The handler to execute for the route.</param> |
| | | 68 | | /// <param name="requireSchemes">Optional array of authorization schemes required for the route.</param> |
| | | 69 | | /// <param name="map">The endpoint convention builder for further configuration.</param> |
| | | 70 | | /// <returns>The KestrunHost instance for chaining.</returns> |
| | | 71 | | public static KestrunHost AddMapRoute(this KestrunHost host, string pattern, IEnumerable<HttpVerb> httpVerbs, Kestru |
| | | 72 | | out IEndpointConventionBuilder? map, List<string>? requireSchemes = null) |
| | | 73 | | { |
| | 3 | 74 | | return host.AddMapRoute(new MapRouteOptions |
| | 3 | 75 | | { |
| | 3 | 76 | | Pattern = pattern, |
| | 3 | 77 | | HttpVerbs = [.. httpVerbs], |
| | 3 | 78 | | ScriptCode = new LanguageOptions |
| | 3 | 79 | | { |
| | 3 | 80 | | Language = ScriptLanguage.Native, |
| | 3 | 81 | | }, |
| | 3 | 82 | | RequireSchemes = requireSchemes ?? [] // No authorization by default |
| | 3 | 83 | | }, handler, out map); |
| | | 84 | | } |
| | | 85 | | |
| | | 86 | | /// <summary> |
| | | 87 | | /// Adds a native route to the KestrunHost using the specified MapRouteOptions and handler. |
| | | 88 | | /// </summary> |
| | | 89 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 90 | | /// <param name="options">The MapRouteOptions containing route configuration.</param> |
| | | 91 | | /// <param name="handler">The handler to execute for the route.</param> |
| | | 92 | | /// <param name="map">The endpoint convention builder for further configuration.</param> |
| | | 93 | | /// <returns>The KestrunHost instance for chaining.</returns> |
| | | 94 | | public static KestrunHost AddMapRoute(this KestrunHost host, MapRouteOptions options, KestrunHandler handler, out IE |
| | | 95 | | { |
| | 15 | 96 | | if (host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 97 | | { |
| | 1 | 98 | | host.Logger.Debug("AddMapRoute called with options={Options}", options); |
| | | 99 | | } |
| | | 100 | | // Ensure the WebApplication is initialized |
| | 15 | 101 | | if (host.App is null) |
| | | 102 | | { |
| | 0 | 103 | | throw new InvalidOperationException("WebApplication is not initialized. Call EnableConfiguration first."); |
| | | 104 | | } |
| | | 105 | | |
| | | 106 | | // Validate options |
| | 14 | 107 | | if (string.IsNullOrWhiteSpace(options.Pattern)) |
| | | 108 | | { |
| | 0 | 109 | | throw new ArgumentException("Pattern cannot be null or empty.", nameof(options.Pattern)); |
| | | 110 | | } |
| | | 111 | | |
| | 14 | 112 | | if (options.HttpVerbs.Count == 0) |
| | | 113 | | { |
| | 1 | 114 | | options.HttpVerbs = [HttpVerb.Get]; |
| | | 115 | | } |
| | | 116 | | |
| | 14 | 117 | | options.ScriptCode.Language = ScriptLanguage.Native; |
| | | 118 | | |
| | 28 | 119 | | string[] methods = [.. options.HttpVerbs.Select(v => v.ToMethodString())]; |
| | 14 | 120 | | map = host.App.MapMethods(options.Pattern, methods, async context => |
| | 14 | 121 | | { |
| | 14 | 122 | | // 🔒 CSRF validation only for the current request when that verb is unsafe (unless disabled) |
| | 5 | 123 | | if (ShouldValidateCsrf(options, context)) |
| | 14 | 124 | | { |
| | 1 | 125 | | if (!await TryValidateAntiforgeryAsync(context)) |
| | 14 | 126 | | { |
| | 0 | 127 | | return; // already responded 400 |
| | 14 | 128 | | } |
| | 14 | 129 | | } |
| | 5 | 130 | | var kestrunContext = new KestrunContext(host, context); |
| | 5 | 131 | | await handler(kestrunContext); |
| | 5 | 132 | | await kestrunContext.Response.ApplyTo(context.Response); |
| | 19 | 133 | | }); |
| | | 134 | | |
| | 14 | 135 | | host.AddMapOptions(map, options); |
| | 14 | 136 | | var registeredPattern = NormalizeCatchAllPattern(options.Pattern); |
| | 56 | 137 | | foreach (var method in options.HttpVerbs) |
| | | 138 | | { |
| | 14 | 139 | | host._registeredRoutes[(registeredPattern, method)] = options; |
| | | 140 | | } |
| | | 141 | | |
| | 14 | 142 | | host.Logger.Information("Added native route: {Pattern} with methods: {Methods}", options.Pattern, string.Join(", |
| | | 143 | | // Add to the feature queue for later processing |
| | 14 | 144 | | host.FeatureQueue.Add(host => host.AddMapRoute(options)); |
| | 14 | 145 | | return host; |
| | | 146 | | } |
| | | 147 | | |
| | | 148 | | /// <summary> |
| | | 149 | | /// Adds a route to the KestrunHost that serves OpenAPI documents based on the provided options. |
| | | 150 | | /// </summary> |
| | | 151 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 152 | | /// <param name="options">The OpenApiMapRouteOptions instance.</param> |
| | | 153 | | /// <returns>The KestrunHost instance for chaining.</returns> |
| | | 154 | | public static KestrunHost AddOpenApiMapRoute(this KestrunHost host, OpenApiMapRouteOptions options) |
| | | 155 | | { |
| | 1 | 156 | | ArgumentNullException.ThrowIfNull(options); |
| | 1 | 157 | | ArgumentNullException.ThrowIfNull(host); |
| | | 158 | | |
| | | 159 | | // Validate options |
| | 1 | 160 | | return host.AddMapRoute(options.MapOptions, async context => |
| | 1 | 161 | | { |
| | 1 | 162 | | // Extract parameters |
| | 3 | 163 | | var refresh = false; |
| | 3 | 164 | | var docId = options.DocId; |
| | 1 | 165 | | OpenApiSpecVersion specVersion; |
| | 1 | 166 | | // Try to get version and format from route values |
| | 3 | 167 | | var version = context.Request.RouteValues[options.VersionVarName]?.ToString() ?? options.DefaultVersion; |
| | 3 | 168 | | var format = context.Request.RouteValues[options.FormatVarName]?.ToString() ?? options.DefaultFormat; |
| | 3 | 169 | | if (context.Request.Query.TryGetValue(options.RefreshVarName, out var value)) |
| | 1 | 170 | | { |
| | 0 | 171 | | _ = bool.TryParse(value, out refresh); |
| | 1 | 172 | | } |
| | 1 | 173 | | // Try to get version and format from route values |
| | 1 | 174 | | try |
| | 1 | 175 | | { |
| | 3 | 176 | | specVersion = OpenApiSpecVersionExtensions.ParseOpenApiSpecVersion(version); |
| | 3 | 177 | | if (format is not "json" and not "yaml") |
| | 1 | 178 | | { |
| | 1 | 179 | | throw new InvalidOperationException($"Unsupported OpenAPI format requested: {format}"); |
| | 1 | 180 | | } |
| | 2 | 181 | | } |
| | 1 | 182 | | catch |
| | 1 | 183 | | { |
| | 1 | 184 | | host.Logger.Warning("Invalid OpenAPI version or format requested: {Version}, {Format}", version, format) |
| | 1 | 185 | | context.Response.StatusCode = 404; // Not Found |
| | 1 | 186 | | return; |
| | 1 | 187 | | } |
| | 1 | 188 | | // Refresh the document if requested |
| | 2 | 189 | | if (refresh) |
| | 1 | 190 | | { |
| | 0 | 191 | | host.Logger.Information("Refreshing OpenAPI document cache as requested."); |
| | 0 | 192 | | var doc = host.OpenApiDocumentDescriptor[docId]; |
| | 0 | 193 | | doc.GenerateDoc(); |
| | 1 | 194 | | } |
| | 1 | 195 | | // Serve the document in the requested format |
| | 2 | 196 | | if (format == "json") |
| | 1 | 197 | | { |
| | 1 | 198 | | var json = host.OpenApiDocumentDescriptor[docId].ToJson(specVersion); |
| | 1 | 199 | | await context.Response.WriteTextResponseAsync(json, 200, "application/json"); |
| | 1 | 200 | | } |
| | 1 | 201 | | else |
| | 1 | 202 | | { |
| | 1 | 203 | | var yml = host.OpenApiDocumentDescriptor[docId].ToYaml(specVersion); |
| | 1 | 204 | | await context.Response.WriteTextResponseAsync(yml, 200, "application/yaml"); |
| | 1 | 205 | | } |
| | 4 | 206 | | }, out _); |
| | | 207 | | } |
| | | 208 | | |
| | | 209 | | /// <summary> |
| | | 210 | | /// Adds a route to the KestrunHost that executes a script block for the specified HTTP verb and pattern. |
| | | 211 | | /// </summary> |
| | | 212 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 213 | | /// <param name="pattern">The route pattern.</param> |
| | | 214 | | /// <param name="httpVerbs">The HTTP verb for the route.</param> |
| | | 215 | | /// <param name="scriptBlock">The script block to execute.</param> |
| | | 216 | | /// <param name="language">The scripting language to use (default is PowerShell).</param> |
| | | 217 | | /// <param name="requireSchemes">Optional array of authorization schemes required for the route.</param> |
| | | 218 | | /// <param name="arguments">Optional dictionary of arguments to pass to the script.</param> |
| | | 219 | | /// <returns>The KestrunHost instance for chaining.</returns> |
| | | 220 | | public static KestrunHost AddMapRoute(this KestrunHost host, string pattern, HttpVerb httpVerbs, string scriptBlock, |
| | | 221 | | List<string>? requireSchemes = null, |
| | | 222 | | Dictionary<string, object?>? arguments = null) |
| | | 223 | | { |
| | 11 | 224 | | arguments ??= []; |
| | 11 | 225 | | return host.AddMapRoute(new MapRouteOptions |
| | 11 | 226 | | { |
| | 11 | 227 | | Pattern = pattern, |
| | 11 | 228 | | HttpVerbs = [httpVerbs], |
| | 11 | 229 | | ScriptCode = new LanguageOptions |
| | 11 | 230 | | { |
| | 11 | 231 | | Code = scriptBlock, |
| | 11 | 232 | | Language = language, |
| | 11 | 233 | | Arguments = arguments ?? [] // No additional arguments by default |
| | 11 | 234 | | }, |
| | 11 | 235 | | RequireSchemes = requireSchemes ?? [], // No authorization by default |
| | 11 | 236 | | }); |
| | | 237 | | } |
| | | 238 | | |
| | | 239 | | /// <summary> |
| | | 240 | | /// Adds a route to the KestrunHost that executes a script block for the specified HTTP verbs and pattern. |
| | | 241 | | /// </summary> |
| | | 242 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 243 | | /// <param name="pattern">The route pattern.</param> |
| | | 244 | | /// <param name="httpVerbs">The HTTP verbs for the route.</param> |
| | | 245 | | /// <param name="scriptBlock">The script block to execute.</param> |
| | | 246 | | /// <param name="language">The scripting language to use (default is PowerShell).</param> |
| | | 247 | | /// <param name="requireSchemes">Optional array of authorization schemes required for the route.</param> |
| | | 248 | | /// <param name="arguments">Optional dictionary of arguments to pass to the script.</param> |
| | | 249 | | /// <returns>The KestrunHost instance for chaining.</returns> |
| | | 250 | | public static KestrunHost AddMapRoute(this KestrunHost host, string pattern, |
| | | 251 | | IEnumerable<HttpVerb> httpVerbs, |
| | | 252 | | string scriptBlock, |
| | | 253 | | ScriptLanguage language = ScriptLanguage.PowerShell, |
| | | 254 | | List<string>? requireSchemes = null, |
| | | 255 | | Dictionary<string, object?>? arguments = null) |
| | | 256 | | { |
| | 1 | 257 | | return host.AddMapRoute(new MapRouteOptions |
| | 1 | 258 | | { |
| | 1 | 259 | | Pattern = pattern, |
| | 1 | 260 | | HttpVerbs = [.. httpVerbs], |
| | 1 | 261 | | ScriptCode = new LanguageOptions |
| | 1 | 262 | | { |
| | 1 | 263 | | Code = scriptBlock, |
| | 1 | 264 | | Language = language, |
| | 1 | 265 | | Arguments = arguments ?? [] // No additional arguments by default |
| | 1 | 266 | | }, |
| | 1 | 267 | | RequireSchemes = requireSchemes ?? [], // No authorization by default |
| | 1 | 268 | | }); |
| | | 269 | | } |
| | | 270 | | |
| | | 271 | | /// <summary> |
| | | 272 | | /// Adds a route to the KestrunHost using the specified MapRouteOptions. |
| | | 273 | | /// </summary> |
| | | 274 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 275 | | /// <param name="options">The MapRouteOptions containing route configuration.</param> |
| | | 276 | | /// <returns>The KestrunHost instance for chaining.</returns> |
| | | 277 | | public static KestrunHost AddMapRoute(this KestrunHost host, MapRouteOptions options) |
| | | 278 | | { |
| | 33 | 279 | | if (host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 280 | | { |
| | 24 | 281 | | host.Logger.Debug("AddMapRoute called with pattern={Pattern}, language={Language}, method={Methods}", option |
| | | 282 | | } |
| | 33 | 283 | | if (host.IsConfigured) |
| | | 284 | | { |
| | 31 | 285 | | _ = CreateMapRoute(host, options); |
| | | 286 | | } |
| | | 287 | | else |
| | | 288 | | { |
| | 2 | 289 | | _ = host.Use(app => |
| | 2 | 290 | | { |
| | 1 | 291 | | _ = CreateMapRoute(host, options); |
| | 3 | 292 | | }); |
| | | 293 | | } |
| | 27 | 294 | | return host; // for chaining |
| | | 295 | | } |
| | | 296 | | |
| | | 297 | | /// <summary> |
| | | 298 | | /// Adds a route to the KestrunHost using the specified MapRouteOptions. |
| | | 299 | | /// </summary> |
| | | 300 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 301 | | /// <param name="options">The MapRouteOptions containing route configuration.</param> |
| | | 302 | | /// <returns>The IEndpointConventionBuilder for the created route.</returns> |
| | | 303 | | private static IEndpointConventionBuilder CreateMapRoute(KestrunHost host, MapRouteOptions options) |
| | | 304 | | { |
| | 32 | 305 | | if (host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 306 | | { |
| | 23 | 307 | | host.Logger.Debug("AddMapRoute called with pattern={Pattern}, language={Language}, method={Methods}", option |
| | | 308 | | } |
| | | 309 | | |
| | | 310 | | try |
| | | 311 | | { |
| | | 312 | | // Validate options and get normalized route options |
| | 32 | 313 | | if (!ValidateRouteOptions(host, options, out var routeOptions)) |
| | | 314 | | { |
| | 0 | 315 | | return null!; // Route already exists and should be skipped |
| | | 316 | | } |
| | | 317 | | |
| | 31 | 318 | | var logger = host.Logger.ForContext("Route", routeOptions.Pattern); |
| | | 319 | | |
| | | 320 | | // Compile the script once – return a RequestDelegate |
| | 31 | 321 | | var compiled = CompileScript(host, options.ScriptCode); |
| | | 322 | | |
| | | 323 | | // Create and register the route |
| | 31 | 324 | | return CreateAndRegisterRoute(host, routeOptions, compiled); |
| | | 325 | | } |
| | 0 | 326 | | catch (CompilationErrorException ex) |
| | | 327 | | { |
| | | 328 | | // Log the detailed compilation errors |
| | 0 | 329 | | host.Logger.Error($"Failed to add route '{options.Pattern}' due to compilation errors:"); |
| | 0 | 330 | | host.Logger.Error(ex.GetDetailedErrorMessage()); |
| | | 331 | | |
| | | 332 | | // Re-throw with additional context |
| | 0 | 333 | | throw new InvalidOperationException( |
| | 0 | 334 | | $"Failed to compile {options.ScriptCode.Language} script for route '{options.Pattern}'. {ex.GetErrors(). |
| | 0 | 335 | | ex); |
| | | 336 | | } |
| | 6 | 337 | | catch (Exception ex) |
| | | 338 | | { |
| | 6 | 339 | | throw new InvalidOperationException( |
| | 6 | 340 | | $"Failed to add route '{options.Pattern}' with method '{string.Join(", ", options.HttpVerbs)}' using {op |
| | 6 | 341 | | ex); |
| | | 342 | | } |
| | 26 | 343 | | } |
| | | 344 | | |
| | | 345 | | /// <summary> |
| | | 346 | | /// Validates the host and options for adding a map route. |
| | | 347 | | /// </summary> |
| | | 348 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 349 | | /// <param name="options">The MapRouteOptions to validate.</param> |
| | | 350 | | /// <param name="routeOptions">The validated route options with defaults applied.</param> |
| | | 351 | | /// <returns>True if validation passes and route should be added; false if duplicate route should be skipped.</retur |
| | | 352 | | /// <exception cref="InvalidOperationException">Thrown when WebApplication is not initialized or route already exist |
| | | 353 | | /// <exception cref="ArgumentException">Thrown when required options are invalid.</exception> |
| | | 354 | | internal static bool ValidateRouteOptions(KestrunHost host, MapRouteOptions options, out MapRouteOptions routeOption |
| | | 355 | | { |
| | | 356 | | // Ensure the WebApplication is initialized |
| | 41 | 357 | | if (host.App is null) |
| | | 358 | | { |
| | 0 | 359 | | throw new InvalidOperationException("WebApplication is not initialized. Call EnableConfiguration first."); |
| | | 360 | | } |
| | | 361 | | |
| | | 362 | | // Validate options |
| | 40 | 363 | | if (string.IsNullOrWhiteSpace(options.Pattern)) |
| | | 364 | | { |
| | 2 | 365 | | throw new ArgumentException("Pattern cannot be null or empty.", nameof(options.Pattern)); |
| | | 366 | | } |
| | | 367 | | |
| | | 368 | | // Validate code |
| | 38 | 369 | | if (string.IsNullOrWhiteSpace(options.ScriptCode.Code)) |
| | | 370 | | { |
| | 2 | 371 | | throw new ArgumentException("ScriptBlock cannot be null or empty.", nameof(options.ScriptCode.Code)); |
| | | 372 | | } |
| | | 373 | | |
| | 36 | 374 | | routeOptions = options; |
| | 36 | 375 | | if (options.HttpVerbs.Count == 0) |
| | | 376 | | { |
| | | 377 | | // If no HTTP verbs were specified, default to GET. |
| | 2 | 378 | | routeOptions.HttpVerbs = [HttpVerb.Get]; |
| | | 379 | | } |
| | | 380 | | |
| | 36 | 381 | | if (MapExists(host, routeOptions.Pattern, routeOptions.HttpVerbs)) |
| | | 382 | | { |
| | 3 | 383 | | var msg = $"Route '{routeOptions.Pattern}' with method(s) {string.Join(", ", routeOptions.HttpVerbs)} alread |
| | 3 | 384 | | if (options.ThrowOnDuplicate) |
| | | 385 | | { |
| | 2 | 386 | | throw new InvalidOperationException(msg); |
| | | 387 | | } |
| | | 388 | | |
| | 1 | 389 | | host.Logger.Warning(msg); |
| | 1 | 390 | | return false; // Skip this route |
| | | 391 | | } |
| | | 392 | | |
| | 33 | 393 | | return true; // Continue with route creation |
| | | 394 | | } |
| | | 395 | | |
| | | 396 | | /// <summary> |
| | | 397 | | /// Compiles the script code for the specified language. |
| | | 398 | | /// </summary> |
| | | 399 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 400 | | /// <param name="options">The language options containing the script code and language.</param> |
| | | 401 | | /// <returns>A compiled RequestDelegate that can handle HTTP requests.</returns> |
| | | 402 | | /// <exception cref="NotSupportedException">Thrown when the script language is not supported.</exception> |
| | | 403 | | internal static RequestDelegate CompileScript(this KestrunHost host, LanguageOptions options) |
| | | 404 | | { |
| | 38 | 405 | | return options.Language switch |
| | 38 | 406 | | { |
| | 2 | 407 | | ScriptLanguage.PowerShell => PowerShellDelegateBuilder.Build(host, options.Code!, options.Arguments), |
| | 33 | 408 | | ScriptLanguage.CSharp => CSharpDelegateBuilder.Build(host, options.Code!, options.Arguments, options.ExtraIm |
| | 2 | 409 | | ScriptLanguage.VBNet => VBNetDelegateBuilder.Build(host, options.Code!, options.Arguments, options.ExtraImpo |
| | 0 | 410 | | ScriptLanguage.FSharp => FSharpDelegateBuilder.Build(host, options.Code!), // F# scripting not implemented |
| | 0 | 411 | | ScriptLanguage.Python => PyDelegateBuilder.Build(host, options.Code!), |
| | 0 | 412 | | ScriptLanguage.JavaScript => JScriptDelegateBuilder.Build(host, options.Code!), |
| | 1 | 413 | | _ => throw new NotSupportedException(options.Language.ToString()) |
| | 38 | 414 | | }; |
| | | 415 | | } |
| | | 416 | | |
| | | 417 | | /// <summary> |
| | | 418 | | /// Creates and registers a route with the specified options and compiled handler. |
| | | 419 | | /// </summary> |
| | | 420 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 421 | | /// <param name="routeOptions">The validated route options.</param> |
| | | 422 | | /// <param name="compiled">The compiled script delegate.</param> |
| | | 423 | | /// <returns>An IEndpointConventionBuilder for further configuration.</returns> |
| | | 424 | | internal static IEndpointConventionBuilder CreateAndRegisterRoute(KestrunHost host, MapRouteOptions routeOptions, Re |
| | | 425 | | { |
| | | 426 | | // Wrap with CSRF validation |
| | | 427 | | async Task handler(HttpContext ctx) |
| | | 428 | | { |
| | 11 | 429 | | if (ShouldValidateCsrf(routeOptions, ctx)) |
| | | 430 | | { |
| | 0 | 431 | | if (!await TryValidateAntiforgeryAsync(ctx)) |
| | | 432 | | { |
| | 0 | 433 | | return; // already responded 400 |
| | | 434 | | } |
| | | 435 | | } |
| | 11 | 436 | | await compiled(ctx); |
| | 6 | 437 | | } |
| | | 438 | | |
| | 33 | 439 | | var mapPattern = NormalizeCatchAllPattern(routeOptions.Pattern!); |
| | 69 | 440 | | string[] methods = [.. routeOptions.HttpVerbs.Select(v => v.ToMethodString())]; |
| | 33 | 441 | | var map = host.App!.MapMethods(mapPattern, methods, handler).WithLanguage(routeOptions.ScriptCode.Language); |
| | | 442 | | |
| | 33 | 443 | | if (host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 444 | | { |
| | 24 | 445 | | host.Logger.Debug("Mapped route: {Pattern} with methods: {Methods}", routeOptions.Pattern, string.Join(", ", |
| | | 446 | | } |
| | | 447 | | |
| | 33 | 448 | | host.AddMapOptions(map, routeOptions); |
| | | 449 | | |
| | | 450 | | // Register OpenAPI metadata for each verb |
| | 118 | 451 | | foreach (var method in routeOptions.HttpVerbs) |
| | | 452 | | { |
| | 31 | 453 | | if (routeOptions.OpenAPI.TryGetValue(method, out var value)) |
| | | 454 | | { |
| | 0 | 455 | | ApplyOpenApiMetadata(host, map, value); |
| | | 456 | | } |
| | | 457 | | // Register the route to prevent duplicates |
| | 31 | 458 | | host._registeredRoutes[(mapPattern, method)] = routeOptions; |
| | | 459 | | } |
| | | 460 | | |
| | 28 | 461 | | host.Logger.Information("Added route: {Pattern} with methods: {Methods}", mapPattern, string.Join(", ", methods) |
| | 28 | 462 | | return map; |
| | | 463 | | } |
| | | 464 | | |
| | | 465 | | /// <summary> |
| | | 466 | | /// Adds additional mapping options to the route. |
| | | 467 | | /// </summary> |
| | | 468 | | /// <param name="host">The Kestrun host.</param> |
| | | 469 | | /// <param name="map">The endpoint convention builder.</param> |
| | | 470 | | /// <param name="options">The mapping options.</param> |
| | | 471 | | internal static void AddMapOptions(this KestrunHost host, IEndpointConventionBuilder map, MapRouteOptions options) |
| | | 472 | | { |
| | 51 | 473 | | ApplyShortCircuit(host, map, options); |
| | 51 | 474 | | ApplyAnonymous(host, map, options); |
| | 51 | 475 | | DisableAntiforgery(host, map, options); |
| | 51 | 476 | | DisableResponseCompression(host, map, options); |
| | 51 | 477 | | ApplyRateLimiting(host, map, options); |
| | 51 | 478 | | ApplyAuthSchemes(host, map, options); |
| | 50 | 479 | | ApplyPolicies(host, map, options); |
| | 49 | 480 | | ApplyCors(host, map, options); |
| | 49 | 481 | | ApplyRequiredHost(host, map, options); |
| | 46 | 482 | | AddMetadata(host, map, options); |
| | 46 | 483 | | } |
| | | 484 | | |
| | | 485 | | /// <summary> |
| | | 486 | | /// Tries to parse an endpoint specification string into its components: host, port, and HTTPS flag. |
| | | 487 | | /// </summary> |
| | | 488 | | /// <param name="spec">The endpoint specification string.</param> |
| | | 489 | | /// <param name="host">The host component.</param> |
| | | 490 | | /// <param name="port">The port component.</param> |
| | | 491 | | /// <param name="https"> |
| | | 492 | | /// Indicates HTTPS (<c>true</c>) or HTTP (<c>false</c>) when the scheme is explicitly specified via a full URL. |
| | | 493 | | /// For host:port forms where no scheme information is available the value is <c>null</c>. |
| | | 494 | | /// </param> |
| | | 495 | | /// <returns> |
| | | 496 | | /// <c>true</c> if parsing succeeds; otherwise <c>false</c> and <paramref name="host"/> will be <c>string.Empty</c> |
| | | 497 | | /// </returns> |
| | | 498 | | /// <remarks> |
| | | 499 | | /// Accepted formats (in priority order): |
| | | 500 | | /// <list type="bullet"> |
| | | 501 | | /// <item><description>Full URL: <c>https://host:port</c>, <c>http://host:port</c>, IPv6 literal allowed in brackets |
| | | 502 | | /// <item><description>Bracketed IPv6 host & port: <c>[::1]:5000</c>, <c>[2001:db8::1]:8080</c>.</description></ |
| | | 503 | | /// <item><description>Host or IPv4 with port: <c>localhost:5000</c>, <c>127.0.0.1:8080</c>, <c>example.com:443</c>. |
| | | 504 | | /// </list> |
| | | 505 | | /// Unsupported / rejected examples: non http(s) schemes (e.g. <c>ftp://</c>), missing port in host:port form, empty |
| | | 506 | | /// </remarks> |
| | | 507 | | public static bool TryParseEndpointSpec(string spec, out string host, out int port, out bool? https) |
| | | 508 | | { |
| | 171 | 509 | | host = ""; port = 0; https = null; |
| | | 510 | | |
| | 57 | 511 | | if (string.IsNullOrWhiteSpace(spec)) |
| | | 512 | | { |
| | 5 | 513 | | return false; |
| | | 514 | | } |
| | | 515 | | |
| | | 516 | | // 1. Try full URL form first |
| | 52 | 517 | | if (TryParseUrlSpec(spec, out host, out port, out https)) |
| | | 518 | | { |
| | 16 | 519 | | return true; |
| | | 520 | | } |
| | | 521 | | |
| | | 522 | | // 2. Bracketed IPv6 literal with port: [::1]:5000 |
| | 36 | 523 | | if (TryParseBracketedIpv6Spec(spec, out host, out port)) |
| | | 524 | | { |
| | 4 | 525 | | return true; // https stays null (not specified) |
| | | 526 | | } |
| | | 527 | | |
| | | 528 | | // 3. Regular host:port (hostname, IPv4, or raw IPv6 w/out brackets not supported here) |
| | 32 | 529 | | if (TryParseHostPortSpec(spec, out host, out port)) |
| | | 530 | | { |
| | 12 | 531 | | return true; // https stays null (not specified) |
| | | 532 | | } |
| | | 533 | | |
| | | 534 | | // No match |
| | 60 | 535 | | host = ""; port = 0; https = null; |
| | 20 | 536 | | return false; |
| | | 537 | | } |
| | | 538 | | |
| | | 539 | | /// <summary> |
| | | 540 | | /// Tries to parse a full URL endpoint specification. |
| | | 541 | | /// </summary> |
| | | 542 | | /// <param name="spec">The endpoint specification string.</param> |
| | | 543 | | /// <param name="host">The parsed host component.</param> |
| | | 544 | | /// <param name="port">The parsed port component.</param> |
| | | 545 | | /// <param name="https">The parsed HTTPS flag.</param> |
| | | 546 | | /// <returns><c>true</c> if parsing succeeded; otherwise <c>false</c>.</returns> |
| | | 547 | | private static bool TryParseUrlSpec(string spec, out string host, out int port, out bool? https) |
| | | 548 | | { |
| | 156 | 549 | | host = ""; port = 0; https = null; |
| | | 550 | | // Fast rejection for an explicitly empty port (e.g. "https://localhost:" or "http://[::1]:") |
| | | 551 | | // Uri.TryCreate will happily parse these and supply the default scheme port (80/443), |
| | | 552 | | // which would make us treat an intentionally empty port as a valid implicit port. |
| | | 553 | | // The accepted formats require either no colon at all (implicit default) OR a colon followed by digits. |
| | | 554 | | // Therefore pattern: scheme:// host-part : end-of-string (no digits after colon) should be rejected. |
| | 52 | 555 | | if (EmptyPortDetectionRegex().IsMatch(spec)) |
| | | 556 | | { |
| | 2 | 557 | | return false; |
| | | 558 | | } |
| | 50 | 559 | | if (!Uri.TryCreate(spec, UriKind.Absolute, out var uri)) |
| | | 560 | | { |
| | 22 | 561 | | return false; |
| | | 562 | | } |
| | 28 | 563 | | if (!(uri.Scheme.Equals("https", StringComparison.OrdinalIgnoreCase) || |
| | 28 | 564 | | uri.Scheme.Equals("http", StringComparison.OrdinalIgnoreCase))) |
| | | 565 | | { |
| | 12 | 566 | | return false; // Not http/https → let other parsers try |
| | | 567 | | } |
| | 16 | 568 | | if (uri.Authority.EndsWith(':')) |
| | | 569 | | { |
| | 0 | 570 | | return false; // reject empty port like https://localhost: |
| | | 571 | | } |
| | 16 | 572 | | host = uri.Host; |
| | 16 | 573 | | port = uri.Port; |
| | 16 | 574 | | https = uri.Scheme.Equals("https", StringComparison.OrdinalIgnoreCase) |
| | 16 | 575 | | ? true |
| | 16 | 576 | | : uri.Scheme.Equals("http", StringComparison.OrdinalIgnoreCase) |
| | 16 | 577 | | ? false |
| | 16 | 578 | | : null; |
| | 16 | 579 | | return !string.IsNullOrWhiteSpace(host) && IsValidPort(port); |
| | | 580 | | } |
| | | 581 | | |
| | | 582 | | /// <summary> |
| | | 583 | | /// Tries to parse a bracketed IPv6 endpoint specification. |
| | | 584 | | /// </summary> |
| | | 585 | | /// <param name="spec">The endpoint specification string.</param> |
| | | 586 | | /// <param name="host">The parsed host component.</param> |
| | | 587 | | /// <param name="port">The parsed port component.</param> |
| | | 588 | | /// <returns><c>true</c> if parsing succeeded; otherwise <c>false</c>.</returns> |
| | | 589 | | private static bool TryParseBracketedIpv6Spec(string spec, out string host, out int port) |
| | | 590 | | { |
| | 72 | 591 | | host = ""; port = 0; |
| | 36 | 592 | | var m = BracketedIpv6SpecMatcher().Match(spec); |
| | 36 | 593 | | if (!m.Success) |
| | | 594 | | { |
| | 32 | 595 | | return false; |
| | | 596 | | } |
| | 4 | 597 | | host = m.Groups[1].Value; |
| | 4 | 598 | | if (!int.TryParse(m.Groups[2].Value, out port) || !IsValidPort(port)) |
| | | 599 | | { |
| | 0 | 600 | | host = ""; port = 0; return false; |
| | | 601 | | } |
| | 4 | 602 | | return !string.IsNullOrWhiteSpace(host); |
| | | 603 | | } |
| | | 604 | | |
| | | 605 | | /// <summary> |
| | | 606 | | /// Tries to parse a host:port endpoint specification. |
| | | 607 | | /// </summary> |
| | | 608 | | /// <param name="spec">The endpoint specification string.</param> |
| | | 609 | | /// <param name="host">The parsed host component.</param> |
| | | 610 | | /// <param name="port">The parsed port component.</param> |
| | | 611 | | /// <returns><c>true</c> if parsing succeeded; otherwise <c>false</c>.</returns> |
| | | 612 | | private static bool TryParseHostPortSpec(string spec, out string host, out int port) |
| | | 613 | | { |
| | 64 | 614 | | host = ""; port = 0; |
| | 32 | 615 | | var m = HostPortSpecMatcher().Match(spec); |
| | 32 | 616 | | if (!m.Success) |
| | | 617 | | { |
| | 17 | 618 | | return false; |
| | | 619 | | } |
| | 15 | 620 | | host = m.Groups[1].Value; |
| | 15 | 621 | | if (!int.TryParse(m.Groups[2].Value, out port) || !IsValidPort(port)) |
| | | 622 | | { |
| | 9 | 623 | | host = ""; port = 0; return false; |
| | | 624 | | } |
| | 12 | 625 | | return !string.IsNullOrWhiteSpace(host); |
| | | 626 | | } |
| | | 627 | | private const int MIN_PORT = 1; |
| | | 628 | | private const int MAX_PORT = 65535; |
| | | 629 | | |
| | | 630 | | /// <summary> |
| | | 631 | | /// Validates that the port number is within the acceptable range (1-65535). |
| | | 632 | | /// </summary> |
| | | 633 | | /// <param name="port">The port number to validate.</param> |
| | | 634 | | /// <returns><c>true</c> if the port number is valid; otherwise, <c>false</c>.</returns> |
| | 35 | 635 | | private static bool IsValidPort(int port) => port is >= MIN_PORT and <= MAX_PORT; |
| | | 636 | | |
| | | 637 | | /// <summary> |
| | | 638 | | /// Formats the host and port for use in RequireHost, adding brackets for IPv6 literals. |
| | | 639 | | /// </summary> |
| | | 640 | | /// <param name="host">The host component.</param> |
| | | 641 | | /// <param name="port">The port component.</param> |
| | | 642 | | /// <returns>The formatted host and port string.</returns> |
| | | 643 | | internal static string ToRequireHost(string host, int port) => |
| | 18 | 644 | | IsIPv6Address(host) ? $"[{host}]:{port}" : $"{host}:{port}"; |
| | | 645 | | |
| | | 646 | | /// <summary> |
| | | 647 | | /// Determines if the given host string is an IPv6 address. |
| | | 648 | | /// </summary> |
| | | 649 | | /// <param name="host">The host string to check.</param> |
| | | 650 | | /// <returns>True if the host is an IPv6 address; otherwise, false.</returns> |
| | 18 | 651 | | private static bool IsIPv6Address(string host) => IPAddress.TryParse(host, out var ip) && ip.AddressFamily == System |
| | | 652 | | |
| | | 653 | | /// <summary> |
| | | 654 | | /// Applies required hosts to the route based on the specified endpoints in the options. |
| | | 655 | | /// </summary> |
| | | 656 | | /// <param name="host">The Kestrun host.</param> |
| | | 657 | | /// <param name="map">The endpoint convention builder.</param> |
| | | 658 | | /// <param name="options">The mapping options.</param> |
| | | 659 | | /// <exception cref="ArgumentException">Thrown when the specified endpoints are invalid.</exception> |
| | | 660 | | internal static void ApplyRequiredHost(this KestrunHost host, IEndpointConventionBuilder map, MapRouteOptions option |
| | | 661 | | { |
| | 49 | 662 | | if (options.Endpoints is not { Length: > 0 }) |
| | | 663 | | { |
| | 41 | 664 | | return; |
| | | 665 | | } |
| | | 666 | | |
| | 8 | 667 | | var listeners = host.Options.Listeners; |
| | 8 | 668 | | var require = new List<string>(); |
| | 8 | 669 | | var errs = new List<string>(); |
| | | 670 | | |
| | 38 | 671 | | foreach (var spec in options.Endpoints) |
| | | 672 | | { |
| | 11 | 673 | | if (!TryParseEndpointSpec(spec, out var eh, out var ep, out var eHttps)) |
| | | 674 | | { |
| | 2 | 675 | | errs.Add($"'{spec}' must be 'host:port' or 'http(s)://host:port'."); |
| | 2 | 676 | | continue; |
| | | 677 | | } |
| | | 678 | | |
| | | 679 | | // Is the host a numeric IP? |
| | 9 | 680 | | var isNumericHost = IPAddress.TryParse(eh, out var endpointIp); |
| | | 681 | | |
| | | 682 | | // Find a compatible listener: same port, scheme (if specified), and IP match if numeric host. |
| | 9 | 683 | | var match = listeners.FirstOrDefault(l => |
| | 19 | 684 | | l.Port == ep && |
| | 19 | 685 | | (eHttps is null || l.UseHttps == eHttps.Value) && |
| | 19 | 686 | | (!isNumericHost || |
| | 19 | 687 | | l.IPAddress.Equals(endpointIp) || |
| | 19 | 688 | | l.IPAddress.Equals(IPAddress.Any) || |
| | 19 | 689 | | l.IPAddress.Equals(IPAddress.IPv6Any))); |
| | | 690 | | |
| | 9 | 691 | | if (match is null) |
| | | 692 | | { |
| | 2 | 693 | | errs.Add($"'{spec}' doesn't match any configured listener. " + |
| | 4 | 694 | | $"Known: {string.Join(", ", listeners.Select(l => l.ToString()))}"); |
| | 2 | 695 | | continue; |
| | | 696 | | } |
| | | 697 | | |
| | 7 | 698 | | require.Add(ToRequireHost(eh, ep)); |
| | | 699 | | } |
| | | 700 | | |
| | 8 | 701 | | if (errs.Count > 0) |
| | | 702 | | { |
| | 3 | 703 | | throw new InvalidOperationException("Invalid Endpoints:" + Environment.NewLine + " - " + string.Join(Enviro |
| | | 704 | | } |
| | 5 | 705 | | if (require.Count > 0) |
| | | 706 | | { |
| | 5 | 707 | | host.Logger.Verbose("Applying required hosts: {RequiredHosts} to route: {Pattern}", |
| | 5 | 708 | | string.Join(", ", require), options.Pattern); |
| | 5 | 709 | | _ = map.RequireHost([.. require]); |
| | | 710 | | } |
| | 5 | 711 | | } |
| | | 712 | | |
| | | 713 | | /// <summary> |
| | | 714 | | /// Applies the same route conventions used by the AddMapRoute helpers to an arbitrary endpoint. |
| | | 715 | | /// </summary> |
| | | 716 | | /// <param name="host">The Kestrun host used for validation (auth schemes/policies).</param> |
| | | 717 | | /// <param name="builder">The endpoint convention builder to decorate.</param> |
| | | 718 | | /// <param name="configure">Delegate to configure a fresh <see cref="MapRouteOptions"/> instance. Only applicable pr |
| | | 719 | | /// <remarks> |
| | | 720 | | /// This is useful when you map endpoints manually via <c>app.MapGet</c>/<c>MapPost</c> and still want consistent be |
| | | 721 | | /// (auth, CORS, rate limiting, antiforgery disable, OpenAPI metadata, short-circuiting) without re-implementing log |
| | | 722 | | /// Validation notes: |
| | | 723 | | /// - Pattern, Code are ignored if not relevant. |
| | | 724 | | /// - Authentication schemes and policies are validated against the host registry. |
| | | 725 | | /// - OpenAPI metadata is applied only when non-empty. |
| | | 726 | | /// </remarks> |
| | | 727 | | /// <returns>The original <paramref name="builder"/> for fluent chaining.</returns> |
| | | 728 | | public static IEndpointConventionBuilder ApplyKestrunConventions(this KestrunHost host, IEndpointConventionBuilder b |
| | | 729 | | { |
| | 1 | 730 | | ArgumentNullException.ThrowIfNull(host); |
| | 1 | 731 | | ArgumentNullException.ThrowIfNull(builder); |
| | 1 | 732 | | ArgumentNullException.ThrowIfNull(configure); |
| | | 733 | | |
| | | 734 | | // Start with an empty options record (only convention-related fields will matter) |
| | 1 | 735 | | var options = new MapRouteOptions |
| | 1 | 736 | | { |
| | 1 | 737 | | Pattern = string.Empty, |
| | 1 | 738 | | HttpVerbs = [], |
| | 1 | 739 | | ScriptCode = new LanguageOptions |
| | 1 | 740 | | { |
| | 1 | 741 | | Language = ScriptLanguage.Native, |
| | 1 | 742 | | Code = string.Empty |
| | 1 | 743 | | } |
| | 1 | 744 | | }; |
| | 1 | 745 | | configure(options); |
| | | 746 | | |
| | | 747 | | // Reuse internal helper (kept internal to avoid accidental misuse) for actual application |
| | 1 | 748 | | host.AddMapOptions(builder, options); |
| | 1 | 749 | | return builder; |
| | | 750 | | } |
| | | 751 | | /// <summary> |
| | | 752 | | /// Adds metadata to the route from the script parameters. |
| | | 753 | | /// </summary> |
| | | 754 | | /// <param name="host">The Kestrun host.</param> |
| | | 755 | | /// <param name="map">The endpoint convention builder.</param> |
| | | 756 | | /// <param name="options">The mapping options.</param> |
| | | 757 | | private static void AddMetadata(KestrunHost host, IEndpointConventionBuilder map, MapRouteOptions options) |
| | | 758 | | { |
| | 46 | 759 | | if (options.ScriptCode is null || options.ScriptCode.Parameters is null || options.ScriptCode.Parameters.Count = |
| | | 760 | | { |
| | 46 | 761 | | return; |
| | | 762 | | } |
| | | 763 | | |
| | 0 | 764 | | host.Logger.Verbose("Adding metadata to route: {Pattern}", options.Pattern); |
| | 0 | 765 | | _ = map.WithMetadata(options.ScriptCode.Parameters); |
| | 0 | 766 | | options.DefaultResponseContentType ??= new Dictionary<string, ICollection<ContentTypeWithSchema>>(host.Options.D |
| | 0 | 767 | | if (options.DefaultResponseContentType != null && options.DefaultResponseContentType.Count > 0) |
| | | 768 | | { |
| | 0 | 769 | | _ = map.WithMetadata(new DefaultResponseContentType(options.DefaultResponseContentType)); |
| | | 770 | | } |
| | 0 | 771 | | } |
| | | 772 | | /// <summary> |
| | | 773 | | /// Applies short-circuiting behavior to the route. |
| | | 774 | | /// </summary> |
| | | 775 | | /// <param name="host">The Kestrun host.</param> |
| | | 776 | | /// <param name="map">The endpoint convention builder.</param> |
| | | 777 | | /// <param name="options">The mapping options.</param> |
| | | 778 | | private static void ApplyShortCircuit(KestrunHost host, IEndpointConventionBuilder map, MapRouteOptions options) |
| | | 779 | | { |
| | 51 | 780 | | if (!options.ShortCircuit) |
| | | 781 | | { |
| | 51 | 782 | | return; |
| | | 783 | | } |
| | | 784 | | |
| | 0 | 785 | | host.Logger.Verbose("Short-circuiting route: {Pattern} with status code: {StatusCode}", options.Pattern, options |
| | 0 | 786 | | if (options.ShortCircuitStatusCode is null) |
| | | 787 | | { |
| | 0 | 788 | | throw new ArgumentException("ShortCircuitStatusCode must be set if ShortCircuit is true.", nameof(options.Sh |
| | | 789 | | } |
| | | 790 | | |
| | 0 | 791 | | _ = map.ShortCircuit(options.ShortCircuitStatusCode); |
| | 0 | 792 | | } |
| | | 793 | | |
| | | 794 | | /// <summary> |
| | | 795 | | /// Applies anonymous access behavior to the route. |
| | | 796 | | /// </summary> |
| | | 797 | | /// <param name="host">The Kestrun host.</param> |
| | | 798 | | /// <param name="map">The endpoint convention builder.</param> |
| | | 799 | | /// <param name="options">The mapping options.</param> |
| | | 800 | | private static void ApplyAnonymous(KestrunHost host, IEndpointConventionBuilder map, MapRouteOptions options) |
| | | 801 | | { |
| | 51 | 802 | | if (options.AllowAnonymous) |
| | | 803 | | { |
| | 2 | 804 | | host.Logger.Verbose("Allowing anonymous access for route: {Pattern}", options.Pattern); |
| | 2 | 805 | | _ = map.AllowAnonymous(); |
| | | 806 | | } |
| | | 807 | | else |
| | | 808 | | { |
| | 49 | 809 | | host.Logger.Debug("No anonymous access allowed for route: {Pattern}", options.Pattern); |
| | | 810 | | } |
| | 49 | 811 | | } |
| | | 812 | | |
| | | 813 | | /// <summary> |
| | | 814 | | /// Disables anti-forgery behavior to the route. |
| | | 815 | | /// </summary> |
| | | 816 | | /// <param name="host">The Kestrun host.</param> |
| | | 817 | | /// <param name="map">The endpoint convention builder.</param> |
| | | 818 | | /// <param name="options">The mapping options.</param> |
| | | 819 | | private static void DisableAntiforgery(KestrunHost host, IEndpointConventionBuilder map, MapRouteOptions options) |
| | | 820 | | { |
| | 51 | 821 | | if (!options.DisableAntiforgery) |
| | | 822 | | { |
| | 50 | 823 | | return; |
| | | 824 | | } |
| | | 825 | | |
| | 1 | 826 | | _ = map.DisableAntiforgery(); |
| | 1 | 827 | | host.Logger.Verbose("CSRF protection disabled for route: {Pattern}", options.Pattern); |
| | 1 | 828 | | } |
| | | 829 | | |
| | | 830 | | /// <summary> |
| | | 831 | | /// Disables response compression for the route. |
| | | 832 | | /// </summary> |
| | | 833 | | /// <param name="host">The Kestrun host.</param> |
| | | 834 | | /// <param name="map">The endpoint convention builder.</param> |
| | | 835 | | /// <param name="options">The mapping options.</param> |
| | | 836 | | private static void DisableResponseCompression(KestrunHost host, IEndpointConventionBuilder map, MapRouteOptions opt |
| | | 837 | | { |
| | 51 | 838 | | if (!options.DisableResponseCompression) |
| | | 839 | | { |
| | 50 | 840 | | return; |
| | | 841 | | } |
| | | 842 | | |
| | 1 | 843 | | _ = map.DisableResponseCompression(); |
| | 1 | 844 | | host.Logger.Verbose("Response compression disabled for route: {Pattern}", options.Pattern); |
| | 1 | 845 | | } |
| | | 846 | | /// <summary> |
| | | 847 | | /// Applies rate limiting behavior to the route. |
| | | 848 | | /// </summary> |
| | | 849 | | /// <param name="host">The Kestrun host.</param> |
| | | 850 | | /// <param name="map">The endpoint convention builder.</param> |
| | | 851 | | /// <param name="options">The mapping options.</param> |
| | | 852 | | private static void ApplyRateLimiting(KestrunHost host, IEndpointConventionBuilder map, MapRouteOptions options) |
| | | 853 | | { |
| | 51 | 854 | | if (string.IsNullOrWhiteSpace(options.RateLimitPolicyName)) |
| | | 855 | | { |
| | 51 | 856 | | return; |
| | | 857 | | } |
| | | 858 | | |
| | 0 | 859 | | host.Logger.Verbose("Applying rate limit policy: {RateLimitPolicyName} to route: {Pattern}", options.RateLimitPo |
| | 0 | 860 | | _ = map.RequireRateLimiting(options.RateLimitPolicyName); |
| | 0 | 861 | | } |
| | | 862 | | |
| | | 863 | | /// <summary> |
| | | 864 | | /// Applies authentication schemes to the route. |
| | | 865 | | /// </summary> |
| | | 866 | | /// <param name="host">The Kestrun host.</param> |
| | | 867 | | /// <param name="map">The endpoint convention builder.</param> |
| | | 868 | | /// <param name="options">The mapping options.</param> |
| | | 869 | | private static void ApplyAuthSchemes(KestrunHost host, IEndpointConventionBuilder map, MapRouteOptions options) |
| | | 870 | | { |
| | 51 | 871 | | if (options.RequireSchemes is not null && options.RequireSchemes.Count != 0) |
| | | 872 | | { |
| | 7 | 873 | | foreach (var schema in options.RequireSchemes) |
| | | 874 | | { |
| | 2 | 875 | | if (!host.HasAuthScheme(schema)) |
| | | 876 | | { |
| | 1 | 877 | | throw new ArgumentException($"Authentication scheme '{schema}' is not registered.", nameof(options.R |
| | | 878 | | } |
| | | 879 | | } |
| | 1 | 880 | | host.Logger.Verbose("Requiring authorization for route: {Pattern} with policies: {Policies}", options.Patter |
| | 1 | 881 | | _ = map.RequireAuthorization(new AuthorizeAttribute |
| | 1 | 882 | | { |
| | 1 | 883 | | AuthenticationSchemes = string.Join(',', options.RequireSchemes) |
| | 1 | 884 | | }); |
| | | 885 | | } |
| | | 886 | | else |
| | | 887 | | { |
| | 49 | 888 | | host.Logger.Debug("No authorization required for route: {Pattern}", options.Pattern); |
| | | 889 | | } |
| | 49 | 890 | | } |
| | | 891 | | |
| | | 892 | | /// <summary> |
| | | 893 | | /// Applies authorization policies to the route. |
| | | 894 | | /// </summary> |
| | | 895 | | /// <param name="host">The Kestrun host.</param> |
| | | 896 | | /// <param name="map">The endpoint convention builder.</param> |
| | | 897 | | /// <param name="options">The mapping options.</param> |
| | | 898 | | private static void ApplyPolicies(KestrunHost host, IEndpointConventionBuilder map, MapRouteOptions options) |
| | | 899 | | { |
| | 50 | 900 | | if (options.RequirePolicies is not null && options.RequirePolicies.Count != 0) |
| | | 901 | | { |
| | 7 | 902 | | foreach (var policy in options.RequirePolicies) |
| | | 903 | | { |
| | 2 | 904 | | if (!host.HasAuthPolicy(policy)) |
| | | 905 | | { |
| | 1 | 906 | | throw new ArgumentException($"Authorization policy '{policy}' is not registered.", nameof(options.Re |
| | | 907 | | } |
| | | 908 | | } |
| | 1 | 909 | | _ = map.RequireAuthorization(options.RequirePolicies.ToArray()); |
| | | 910 | | } |
| | | 911 | | else |
| | | 912 | | { |
| | 48 | 913 | | host.Logger.Debug("No authorization policies required for route: {Pattern}", options.Pattern); |
| | | 914 | | } |
| | 48 | 915 | | } |
| | | 916 | | /// <summary> |
| | | 917 | | /// Applies CORS behavior to the route. |
| | | 918 | | /// </summary> |
| | | 919 | | /// <param name="host">The Kestrun host.</param> |
| | | 920 | | /// <param name="map">The endpoint convention builder.</param> |
| | | 921 | | /// <param name="options">The mapping options.</param> |
| | | 922 | | private static void ApplyCors(KestrunHost host, IEndpointConventionBuilder map, MapRouteOptions options) |
| | | 923 | | { |
| | 49 | 924 | | if (!string.IsNullOrWhiteSpace(options.CorsPolicy)) |
| | | 925 | | { |
| | 0 | 926 | | if (!host.DefinedCorsPolicyNames.Contains(options.CorsPolicy)) |
| | | 927 | | { |
| | 0 | 928 | | throw new ArgumentException($"CORS policy '{options.CorsPolicy}' is not registered."); |
| | | 929 | | } |
| | 0 | 930 | | host.Logger.Verbose("Applying CORS policy: {CorsPolicy} to route: {Pattern}", options.CorsPolicy, options.Pa |
| | 0 | 931 | | _ = map.RequireCors(options.CorsPolicy); |
| | 0 | 932 | | return; |
| | | 933 | | } |
| | | 934 | | // No per-route policy requested. |
| | 49 | 935 | | if (host.CorsPolicyDefined) |
| | | 936 | | { |
| | 0 | 937 | | host.Logger.Verbose("No per-route CORS policy set for route: {Pattern}; default CORS policy will apply.", op |
| | | 938 | | } |
| | | 939 | | else |
| | | 940 | | { |
| | 49 | 941 | | host.Logger.Debug("No CORS policy configured for route: {Pattern}", options.Pattern); |
| | | 942 | | } |
| | 49 | 943 | | } |
| | | 944 | | |
| | | 945 | | /// <summary> |
| | | 946 | | /// Applies OpenAPI metadata to the route. |
| | | 947 | | /// </summary> |
| | | 948 | | /// <param name="host">The Kestrun host.</param> |
| | | 949 | | /// <param name="map">The endpoint convention builder.</param> |
| | | 950 | | /// <param name="openAPI">The OpenAPI metadata.</param> |
| | | 951 | | private static void ApplyOpenApiMetadata(KestrunHost host, IEndpointConventionBuilder map, OpenAPIPathMetadata openA |
| | | 952 | | { |
| | 0 | 953 | | if (!string.IsNullOrEmpty(openAPI.OperationId)) |
| | | 954 | | { |
| | 0 | 955 | | host.Logger.Verbose("Adding OpenAPI metadata for route: {Pattern} with OperationId: {OperationId}", openAPI. |
| | 0 | 956 | | _ = map.WithName(openAPI.OperationId); |
| | | 957 | | } |
| | | 958 | | |
| | 0 | 959 | | if (!string.IsNullOrWhiteSpace(openAPI.Summary)) |
| | | 960 | | { |
| | 0 | 961 | | host.Logger.Verbose("Adding OpenAPI summary for route: {Pattern} with Summary: {Summary}", openAPI.Pattern, |
| | 0 | 962 | | _ = map.WithSummary(openAPI.Summary); |
| | | 963 | | } |
| | | 964 | | |
| | 0 | 965 | | if (!string.IsNullOrWhiteSpace(openAPI.Description)) |
| | | 966 | | { |
| | 0 | 967 | | host.Logger.Verbose("Adding OpenAPI description for route: {Pattern} with Description: {Description}", openA |
| | 0 | 968 | | _ = map.WithDescription(openAPI.Description); |
| | | 969 | | } |
| | | 970 | | |
| | 0 | 971 | | if (openAPI.Tags.Count > 0) |
| | | 972 | | { |
| | 0 | 973 | | host.Logger.Verbose("Adding OpenAPI tags for route: {Pattern} with Tags: {Tags}", openAPI.Pattern, string.Jo |
| | 0 | 974 | | _ = map.WithTags([.. openAPI.Tags]); |
| | | 975 | | } |
| | 0 | 976 | | } |
| | | 977 | | |
| | | 978 | | /// <summary> |
| | | 979 | | /// Adds an HTML template route to the KestrunHost for the specified pattern and HTML file path. |
| | | 980 | | /// </summary> |
| | | 981 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 982 | | /// <param name="pattern">The route pattern.</param> |
| | | 983 | | /// <param name="htmlFilePath">The path to the HTML template file.</param> |
| | | 984 | | /// <param name="requireSchemes">Optional array of authorization schemes required for the route.</param> |
| | | 985 | | /// <returns>An IEndpointConventionBuilder for further configuration.</returns> |
| | | 986 | | public static IEndpointConventionBuilder AddHtmlTemplateRoute(this KestrunHost host, string pattern, string htmlFile |
| | | 987 | | { |
| | 0 | 988 | | return host.AddHtmlTemplateRoute(new MapRouteOptions |
| | 0 | 989 | | { |
| | 0 | 990 | | Pattern = pattern, |
| | 0 | 991 | | HttpVerbs = [HttpVerb.Get], |
| | 0 | 992 | | RequireSchemes = requireSchemes ?? [] // No authorization by default |
| | 0 | 993 | | }, htmlFilePath); |
| | | 994 | | } |
| | | 995 | | |
| | | 996 | | /// <summary> |
| | | 997 | | /// Adds an HTML template route to the KestrunHost using the specified MapRouteOptions and HTML file path. |
| | | 998 | | /// </summary> |
| | | 999 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 1000 | | /// <param name="options">The MapRouteOptions containing route configuration.</param> |
| | | 1001 | | /// <param name="htmlFilePath">The path to the HTML template file.</param> |
| | | 1002 | | /// <returns>An IEndpointConventionBuilder for further configuration.</returns> |
| | | 1003 | | public static IEndpointConventionBuilder AddHtmlTemplateRoute(this KestrunHost host, MapRouteOptions options, string |
| | | 1004 | | { |
| | 3 | 1005 | | if (host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 1006 | | { |
| | 2 | 1007 | | host.Logger.Debug("Adding HTML template route: {Pattern}", options.Pattern); |
| | | 1008 | | } |
| | | 1009 | | |
| | 3 | 1010 | | if (options.HttpVerbs.Count != 0 && |
| | 3 | 1011 | | (options.HttpVerbs.Count > 1 || options.HttpVerbs.First() != HttpVerb.Get)) |
| | | 1012 | | { |
| | 1 | 1013 | | host.Logger.Error("HTML template routes only support GET requests. Provided HTTP verbs: {HttpVerbs}", string |
| | 1 | 1014 | | throw new ArgumentException("HTML template routes only support GET requests.", nameof(options.HttpVerbs)); |
| | | 1015 | | } |
| | 2 | 1016 | | if (string.IsNullOrWhiteSpace(htmlFilePath) || !File.Exists(htmlFilePath)) |
| | | 1017 | | { |
| | 1 | 1018 | | host.Logger.Error("HTML file path is null, empty, or does not exist: {HtmlFilePath}", htmlFilePath); |
| | 1 | 1019 | | throw new FileNotFoundException("HTML file not found.", htmlFilePath); |
| | | 1020 | | } |
| | | 1021 | | |
| | 1 | 1022 | | if (string.IsNullOrWhiteSpace(options.Pattern)) |
| | | 1023 | | { |
| | 0 | 1024 | | host.Logger.Error("Pattern cannot be null or empty."); |
| | 0 | 1025 | | throw new ArgumentException("Pattern cannot be null or empty.", nameof(options.Pattern)); |
| | | 1026 | | } |
| | | 1027 | | |
| | 1 | 1028 | | _ = host.AddMapRoute(options.Pattern, HttpVerb.Get, async (ctx) => |
| | 1 | 1029 | | { |
| | 1 | 1030 | | // ② Build your variables map |
| | 0 | 1031 | | var vars = new Dictionary<string, object?>(); |
| | 0 | 1032 | | _ = VariablesMap.GetVariablesMap(ctx, ref vars); |
| | 1 | 1033 | | |
| | 0 | 1034 | | await ctx.Response.WriteHtmlResponseFromFileAsync(htmlFilePath, vars, ctx.Response.StatusCode); |
| | 1 | 1035 | | }, out var map); |
| | 1 | 1036 | | if (host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 1037 | | { |
| | 1 | 1038 | | host.Logger.Debug("Mapped HTML template route: {Pattern} to file: {HtmlFilePath}", options.Pattern, htmlFile |
| | | 1039 | | } |
| | 1 | 1040 | | if (map is null) |
| | | 1041 | | { |
| | 0 | 1042 | | throw new InvalidOperationException("Failed to create HTML template route."); |
| | | 1043 | | } |
| | 1 | 1044 | | AddMapOptions(host, map, options); |
| | 1 | 1045 | | return map; |
| | | 1046 | | } |
| | | 1047 | | |
| | | 1048 | | /// <summary> |
| | | 1049 | | /// Adds a Swagger UI route to the KestrunHost for the specified pattern and OpenAPI endpoint. |
| | | 1050 | | /// </summary> |
| | | 1051 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 1052 | | /// <param name="options">The MapRouteOptions containing route configuration.</param> |
| | | 1053 | | /// <param name="openApiEndpoint">The URI of the OpenAPI endpoint.</param> |
| | | 1054 | | /// <returns>An IEndpointConventionBuilder for further configuration.</returns> |
| | | 1055 | | /// <exception cref="ArgumentException">Thrown when the provided options are invalid.</exception> |
| | | 1056 | | /// <exception cref="InvalidOperationException">Thrown when the Swagger UI route cannot be created.</exception> |
| | | 1057 | | public static IEndpointConventionBuilder AddSwaggerUiRoute( |
| | | 1058 | | this KestrunHost host, |
| | | 1059 | | MapRouteOptions options, |
| | | 1060 | | Uri openApiEndpoint) |
| | | 1061 | | { |
| | 2 | 1062 | | return AddOpenApiUiRoute( |
| | 2 | 1063 | | host, |
| | 2 | 1064 | | options, |
| | 2 | 1065 | | openApiEndpoint, |
| | 2 | 1066 | | uiName: "Swagger", |
| | 2 | 1067 | | defaultPattern: "/docs/swagger", |
| | 2 | 1068 | | resourceName: "Kestrun.Assets.swagger-ui.html"); |
| | | 1069 | | } |
| | | 1070 | | |
| | | 1071 | | /// <summary> |
| | | 1072 | | /// Adds a Redoc UI route to the KestrunHost for the specified pattern and OpenAPI endpoint. |
| | | 1073 | | /// </summary> |
| | | 1074 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 1075 | | /// <param name="options">The route mapping options.</param> |
| | | 1076 | | /// <param name="openApiEndpoint">The OpenAPI endpoint URI.</param> |
| | | 1077 | | /// <returns>An IEndpointConventionBuilder for the mapped route.</returns> |
| | | 1078 | | /// <exception cref="ArgumentException">Thrown when the provided options are invalid.</exception> |
| | | 1079 | | /// <exception cref="InvalidOperationException">Thrown when the Redoc UI route cannot be created.</exception> |
| | | 1080 | | public static IEndpointConventionBuilder AddRedocUiRoute( |
| | | 1081 | | this KestrunHost host, |
| | | 1082 | | MapRouteOptions options, |
| | | 1083 | | Uri openApiEndpoint) |
| | | 1084 | | { |
| | 0 | 1085 | | return AddOpenApiUiRoute( |
| | 0 | 1086 | | host, |
| | 0 | 1087 | | options, |
| | 0 | 1088 | | openApiEndpoint, |
| | 0 | 1089 | | uiName: "Redoc", |
| | 0 | 1090 | | defaultPattern: "/docs/redoc", |
| | 0 | 1091 | | resourceName: "Kestrun.Assets.redoc-ui.html"); |
| | | 1092 | | } |
| | | 1093 | | |
| | | 1094 | | /// <summary> |
| | | 1095 | | /// Adds a Scalar UI route to the KestrunHost for the specified pattern and OpenAPI endpoint. |
| | | 1096 | | /// </summary> |
| | | 1097 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 1098 | | /// <param name="options">The route mapping options.</param> |
| | | 1099 | | /// <param name="openApiEndpoint">The OpenAPI endpoint URI.</param> |
| | | 1100 | | /// <returns>An IEndpointConventionBuilder for the mapped route.</returns> |
| | | 1101 | | /// <exception cref="ArgumentException">Thrown when the provided options are invalid.</exception> |
| | | 1102 | | /// <exception cref="InvalidOperationException">Thrown when the Scalar UI route cannot be created.</exception> |
| | | 1103 | | public static IEndpointConventionBuilder AddScalarUiRoute( |
| | | 1104 | | this KestrunHost host, |
| | | 1105 | | MapRouteOptions options, |
| | | 1106 | | Uri openApiEndpoint) |
| | | 1107 | | { |
| | 0 | 1108 | | return AddOpenApiUiRoute( |
| | 0 | 1109 | | host, |
| | 0 | 1110 | | options, |
| | 0 | 1111 | | openApiEndpoint, |
| | 0 | 1112 | | uiName: "Scalar", |
| | 0 | 1113 | | defaultPattern: "/docs/scalar", |
| | 0 | 1114 | | resourceName: "Kestrun.Assets.scalar.html"); |
| | | 1115 | | } |
| | | 1116 | | |
| | | 1117 | | /// <summary> |
| | | 1118 | | /// Adds a RapiDoc UI route to the KestrunHost for the specified pattern and OpenAPI endpoint. |
| | | 1119 | | /// </summary> |
| | | 1120 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 1121 | | /// <param name="options">The route mapping options.</param> |
| | | 1122 | | /// <param name="openApiEndpoint">The OpenAPI endpoint URI.</param> |
| | | 1123 | | /// <returns>An IEndpointConventionBuilder for the mapped route.</returns> |
| | | 1124 | | public static IEndpointConventionBuilder AddRapiDocUiRoute( |
| | | 1125 | | this KestrunHost host, |
| | | 1126 | | MapRouteOptions options, |
| | | 1127 | | Uri openApiEndpoint) |
| | | 1128 | | { |
| | 0 | 1129 | | return AddOpenApiUiRoute( |
| | 0 | 1130 | | host, |
| | 0 | 1131 | | options, |
| | 0 | 1132 | | openApiEndpoint, |
| | 0 | 1133 | | uiName: "RapiDoc", |
| | 0 | 1134 | | defaultPattern: "/docs/rapidoc", |
| | 0 | 1135 | | resourceName: "Kestrun.Assets.rapidoc.html"); |
| | | 1136 | | } |
| | | 1137 | | |
| | | 1138 | | /// <summary> |
| | | 1139 | | /// Adds an Elements UI route to the KestrunHost for the specified pattern and OpenAPI endpoint. |
| | | 1140 | | /// </summary> |
| | | 1141 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 1142 | | /// <param name="options">The route mapping options.</param> |
| | | 1143 | | /// <param name="openApiEndpoint">The OpenAPI endpoint URI.</param> |
| | | 1144 | | /// <returns>An IEndpointConventionBuilder for the mapped route.</returns> |
| | | 1145 | | public static IEndpointConventionBuilder AddElementsUiRoute( |
| | | 1146 | | this KestrunHost host, |
| | | 1147 | | MapRouteOptions options, |
| | | 1148 | | Uri openApiEndpoint) |
| | | 1149 | | { |
| | 0 | 1150 | | return AddOpenApiUiRoute( |
| | 0 | 1151 | | host, |
| | 0 | 1152 | | options, |
| | 0 | 1153 | | openApiEndpoint, |
| | 0 | 1154 | | uiName: "Elements", |
| | 0 | 1155 | | defaultPattern: "/docs/elements", |
| | 0 | 1156 | | resourceName: "Kestrun.Assets.elements.html"); |
| | | 1157 | | } |
| | | 1158 | | |
| | | 1159 | | /// <summary> |
| | | 1160 | | /// Adds an OpenAPI UI route to the KestrunHost for the specified pattern and OpenAPI endpoint. |
| | | 1161 | | /// </summary> |
| | | 1162 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 1163 | | /// <param name="options">The route mapping options.</param> |
| | | 1164 | | /// <param name="openApiEndpoint">The OpenAPI endpoint URI.</param> |
| | | 1165 | | /// <param name="uiName">The name of the UI.</param> |
| | | 1166 | | /// <param name="defaultPattern">The default route pattern.</param> |
| | | 1167 | | /// <param name="resourceName">The embedded resource name.</param> |
| | | 1168 | | /// <returns>The endpoint convention builder for the mapped route.</returns> |
| | | 1169 | | /// <exception cref="ArgumentException">Thrown when the provided options are invalid.</exception> |
| | | 1170 | | /// <exception cref="InvalidOperationException">Thrown when the OpenAPI UI route cannot be created.</exception> |
| | | 1171 | | private static IEndpointConventionBuilder AddOpenApiUiRoute( |
| | | 1172 | | KestrunHost host, |
| | | 1173 | | MapRouteOptions options, |
| | | 1174 | | Uri openApiEndpoint, |
| | | 1175 | | string uiName, |
| | | 1176 | | string defaultPattern, |
| | | 1177 | | string resourceName) |
| | | 1178 | | { |
| | 2 | 1179 | | if (host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 1180 | | { |
| | 0 | 1181 | | host.Logger.Debug( |
| | 0 | 1182 | | "Adding {UiName} UI route: {Pattern} for OpenAPI endpoint: {OpenApiEndpoint}", |
| | 0 | 1183 | | uiName, |
| | 0 | 1184 | | options.Pattern, |
| | 0 | 1185 | | openApiEndpoint); |
| | | 1186 | | } |
| | | 1187 | | |
| | 2 | 1188 | | if (options.HttpVerbs.Count != 0 && |
| | 2 | 1189 | | (options.HttpVerbs.Count > 1 || options.HttpVerbs.First() != HttpVerb.Get)) |
| | | 1190 | | { |
| | 1 | 1191 | | host.Logger.Error( |
| | 1 | 1192 | | "{UiName} UI routes only support GET requests. Provided HTTP verbs: {HttpVerbs}", |
| | 1 | 1193 | | uiName, |
| | 1 | 1194 | | string.Join(", ", options.HttpVerbs)); |
| | | 1195 | | |
| | 1 | 1196 | | throw new ArgumentException( |
| | 1 | 1197 | | $"{uiName} UI routes only support GET requests.", |
| | 1 | 1198 | | nameof(options.HttpVerbs)); |
| | | 1199 | | } |
| | | 1200 | | |
| | | 1201 | | // Set default pattern if not provided |
| | 1 | 1202 | | if (string.IsNullOrWhiteSpace(options.Pattern)) |
| | | 1203 | | { |
| | 1 | 1204 | | options.Pattern = defaultPattern; |
| | | 1205 | | } |
| | | 1206 | | |
| | | 1207 | | // Load embedded UI HTML |
| | 1 | 1208 | | var map = AddHtmlRouteFromEmbeddedResource(host, options.Pattern, openApiEndpoint, resourceName); |
| | | 1209 | | |
| | 1 | 1210 | | if (host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 1211 | | { |
| | 0 | 1212 | | host.Logger.Debug( |
| | 0 | 1213 | | "Mapped {UiName} UI route: {Pattern} for OpenAPI endpoint: {OpenApiEndpoint}", |
| | 0 | 1214 | | uiName, |
| | 0 | 1215 | | options.Pattern, |
| | 0 | 1216 | | openApiEndpoint); |
| | | 1217 | | } |
| | | 1218 | | |
| | 1 | 1219 | | if (map is null) |
| | | 1220 | | { |
| | 0 | 1221 | | throw new InvalidOperationException($"Failed to create {uiName} UI route."); |
| | | 1222 | | } |
| | | 1223 | | |
| | 1 | 1224 | | AddMapOptions(host, map, options); |
| | 1 | 1225 | | return map; |
| | | 1226 | | } |
| | | 1227 | | |
| | | 1228 | | /// <summary> |
| | | 1229 | | /// Add a HTML route from an embedded resource. |
| | | 1230 | | /// </summary> |
| | | 1231 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 1232 | | /// <param name="pattern">The route pattern.</param> |
| | | 1233 | | /// <param name="openApiEndpoint">The OpenAPI endpoint URI.</param> |
| | | 1234 | | /// <param name="embeddedResource">The embedded resource name.</param> |
| | | 1235 | | /// <exception cref="InvalidOperationException"></exception> |
| | | 1236 | | private static IEndpointConventionBuilder? AddHtmlRouteFromEmbeddedResource(KestrunHost host, string pattern, Uri op |
| | | 1237 | | { |
| | 1 | 1238 | | _ = host.AddMapRoute(pattern: pattern, httpVerb: HttpVerb.Get, async (ctx) => |
| | 1 | 1239 | | { |
| | 1 | 1240 | | var asm = typeof(KestrunHostMapExtensions).Assembly; |
| | 1 | 1241 | | using var stream = asm.GetManifestResourceStream(embeddedResource) |
| | 1 | 1242 | | ?? throw new InvalidOperationException($"Embedded HTML resource not found: {embeddedResource}"); |
| | 1 | 1243 | | |
| | 1 | 1244 | | using var ms = new MemoryStream(); |
| | 1 | 1245 | | stream.CopyTo(ms); |
| | 1 | 1246 | | var htmlBuffer = ms.ToArray(); |
| | 1 | 1247 | | ctx.Response.ContentType = "text/html; charset=utf-8"; |
| | 1 | 1248 | | await ctx.Response.WriteHtmlResponseAsync(htmlBuffer, new Dictionary<string, object?> |
| | 1 | 1249 | | { |
| | 1 | 1250 | | { "OPENAPI_ENDPOINT", openApiEndpoint.ToString() } |
| | 1 | 1251 | | }, ctx.Response.StatusCode); |
| | 2 | 1252 | | }, out var map); |
| | 1 | 1253 | | return map; |
| | | 1254 | | } |
| | | 1255 | | |
| | | 1256 | | /// <summary> |
| | | 1257 | | /// Checks if a route with the specified pattern and optional HTTP method exists in the KestrunHost. |
| | | 1258 | | /// </summary> |
| | | 1259 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 1260 | | /// <param name="pattern">The route pattern to check.</param> |
| | | 1261 | | /// <param name="verbs">The optional HTTP method to check for the route.</param> |
| | | 1262 | | /// <returns>True if the route exists; otherwise, false.</returns> |
| | | 1263 | | public static bool MapExists(this KestrunHost host, string pattern, IEnumerable<HttpVerb> verbs) |
| | | 1264 | | { |
| | 40 | 1265 | | var normalizedPattern = NormalizeCatchAllPattern(pattern); |
| | 82 | 1266 | | var methodSet = verbs.Select(v => v.ToMethodString()).ToHashSet(StringComparer.OrdinalIgnoreCase); |
| | 40 | 1267 | | return host._registeredRoutes.Keys |
| | 11 | 1268 | | .Where(k => string.Equals(k.Pattern, normalizedPattern, StringComparison.OrdinalIgnoreCase)) |
| | 49 | 1269 | | .Any(k => methodSet.Contains(k.Method.ToMethodString())); |
| | | 1270 | | } |
| | | 1271 | | |
| | | 1272 | | /// <summary> |
| | | 1273 | | /// Checks if a route with the specified pattern and optional HTTP method exists in the KestrunHost. |
| | | 1274 | | /// </summary> |
| | | 1275 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 1276 | | /// <param name="pattern">The route pattern to check.</param> |
| | | 1277 | | /// <param name="verb">The optional HTTP method to check for the route.</param> |
| | | 1278 | | /// <returns>True if the route exists; otherwise, false.</returns> |
| | | 1279 | | public static bool MapExists(this KestrunHost host, string pattern, HttpVerb verb) |
| | | 1280 | | { |
| | 9 | 1281 | | var normalizedPattern = NormalizeCatchAllPattern(pattern); |
| | 9 | 1282 | | return host._registeredRoutes.ContainsKey((normalizedPattern, verb)); |
| | | 1283 | | } |
| | | 1284 | | |
| | | 1285 | | /// <summary> |
| | | 1286 | | /// Retrieves the <see cref="MapRouteOptions"/> associated with a given route pattern and HTTP verb, if registered. |
| | | 1287 | | /// </summary> |
| | | 1288 | | /// <param name="host">The <see cref="KestrunHost"/> instance to search for registered routes.</param> |
| | | 1289 | | /// <param name="pattern">The route pattern to look up (e.g. <c>"/hello"</c>).</param> |
| | | 1290 | | /// <param name="verb">The HTTP verb to match (e.g. <see cref="HttpVerb.Get"/>).</param> |
| | | 1291 | | /// <returns> |
| | | 1292 | | /// The <see cref="MapRouteOptions"/> instance for the specified route if found; otherwise, <c>null</c>. |
| | | 1293 | | /// </returns> |
| | | 1294 | | /// <remarks> |
| | | 1295 | | /// This method checks the internal route registry and returns the route options if the pattern and verb |
| | | 1296 | | /// combination was previously added via <c>AddMapRoute</c>. |
| | | 1297 | | /// This lookup is case-insensitive for both the pattern and method. |
| | | 1298 | | /// </remarks> |
| | | 1299 | | /// <example> |
| | | 1300 | | /// <code> |
| | | 1301 | | /// var options = host.GetMapRouteOptions("/hello", HttpVerb.Get); |
| | | 1302 | | /// if (options != null) |
| | | 1303 | | /// { |
| | | 1304 | | /// Console.WriteLine($"Route language: {options.Language}"); |
| | | 1305 | | /// } |
| | | 1306 | | /// </code> |
| | | 1307 | | /// </example> |
| | | 1308 | | public static MapRouteOptions? GetMapRouteOptions(this KestrunHost host, string pattern, HttpVerb verb) |
| | | 1309 | | { |
| | 5 | 1310 | | var normalizedPattern = NormalizeCatchAllPattern(pattern); |
| | 5 | 1311 | | return host._registeredRoutes.TryGetValue((normalizedPattern, verb), out var options) |
| | 5 | 1312 | | ? options |
| | 5 | 1313 | | : null; |
| | | 1314 | | } |
| | | 1315 | | |
| | | 1316 | | /// <summary> |
| | | 1317 | | /// Normalizes catch-all parameters that use "{**name}" into "{*name}" for ASP.NET Core routing. |
| | | 1318 | | /// </summary> |
| | | 1319 | | /// <param name="pattern">The route pattern to normalize.</param> |
| | | 1320 | | /// <returns>The normalized route pattern.</returns> |
| | | 1321 | | private static string NormalizeCatchAllPattern(string pattern) |
| | | 1322 | | { |
| | 101 | 1323 | | return string.IsNullOrWhiteSpace(pattern) |
| | 101 | 1324 | | ? pattern |
| | 101 | 1325 | | : pattern.Replace("{**", "{*", StringComparison.Ordinal); |
| | | 1326 | | } |
| | | 1327 | | |
| | | 1328 | | /// <summary> |
| | | 1329 | | /// Adds a GET endpoint that issues the antiforgery cookie and returns a JSON payload: |
| | | 1330 | | /// { token: "...", headerName: "X-CSRF-TOKEN" }. |
| | | 1331 | | /// The endpoint itself is exempt from antiforgery validation. |
| | | 1332 | | /// </summary> |
| | | 1333 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 1334 | | /// <param name="pattern">The route path to expose (default "/csrf-token").</param> |
| | | 1335 | | /// <returns>IEndpointConventionBuilder for further configuration.</returns> |
| | | 1336 | | public static IEndpointConventionBuilder AddAntiforgeryTokenRoute( |
| | | 1337 | | this KestrunHost host, |
| | | 1338 | | string pattern = "/csrf-token") |
| | | 1339 | | { |
| | 2 | 1340 | | ArgumentException.ThrowIfNullOrWhiteSpace(pattern); |
| | 2 | 1341 | | if (host.App is null) |
| | | 1342 | | { |
| | 0 | 1343 | | throw new InvalidOperationException("WebApplication is not initialized. Call EnableConfiguration first."); |
| | | 1344 | | } |
| | 1 | 1345 | | var options = new MapRouteOptions |
| | 1 | 1346 | | { |
| | 1 | 1347 | | Pattern = pattern, |
| | 1 | 1348 | | HttpVerbs = [HttpVerb.Get], |
| | 1 | 1349 | | ScriptCode = new LanguageOptions |
| | 1 | 1350 | | { |
| | 1 | 1351 | | Language = ScriptLanguage.Native |
| | 1 | 1352 | | }, |
| | 1 | 1353 | | DisableAntiforgery = true, |
| | 1 | 1354 | | AllowAnonymous = true, |
| | 1 | 1355 | | }; |
| | | 1356 | | |
| | | 1357 | | // OpenAPI = new() { Summary = "Get CSRF token", Description = "Returns antiforgery request token and header nam |
| | | 1358 | | |
| | | 1359 | | // Map directly and write directly (no KestrunResponse.ApplyTo) |
| | 1 | 1360 | | var map = host.App.MapMethods(options.Pattern, [HttpMethods.Get], async context => |
| | 1 | 1361 | | { |
| | 1 | 1362 | | var af = context.RequestServices.GetRequiredService<IAntiforgery>(); |
| | 1 | 1363 | | var opts = context.RequestServices.GetRequiredService<IOptions<AntiforgeryOptions>>(); |
| | 1 | 1364 | | |
| | 1 | 1365 | | var tokens = af.GetAndStoreTokens(context); |
| | 1 | 1366 | | |
| | 1 | 1367 | | // Strongly discourage caches (proxies/browsers) from storing this payload |
| | 1 | 1368 | | context.Response.Headers.CacheControl = "no-store, no-cache, must-revalidate"; |
| | 1 | 1369 | | context.Response.Headers.Pragma = "no-cache"; |
| | 1 | 1370 | | context.Response.Headers.Expires = "0"; |
| | 1 | 1371 | | |
| | 1 | 1372 | | context.Response.ContentType = "application/json"; |
| | 1 | 1373 | | await context.Response.WriteAsJsonAsync(new |
| | 1 | 1374 | | { |
| | 1 | 1375 | | token = tokens.RequestToken, |
| | 1 | 1376 | | headerName = opts.Value.HeaderName // may be null if not configured |
| | 1 | 1377 | | }); |
| | 2 | 1378 | | }); |
| | | 1379 | | |
| | | 1380 | | // Apply your pipeline metadata (this adds DisableAntiforgery, CORS, rate limiting, OpenAPI, etc.) |
| | 1 | 1381 | | host.AddMapOptions(map, options); |
| | | 1382 | | |
| | | 1383 | | // (Optional) track in your registry for consistency / duplicate checks |
| | 1 | 1384 | | host._registeredRoutes[(options.Pattern, HttpVerb.Get)] = options; |
| | | 1385 | | |
| | 1 | 1386 | | host.Logger.Information("Added token endpoint: {Pattern} (GET)", options.Pattern); |
| | 1 | 1387 | | return map; |
| | | 1388 | | } |
| | | 1389 | | |
| | | 1390 | | private static bool IsUnsafeVerb(HttpVerb v) |
| | 5 | 1391 | | => v is HttpVerb.Post or HttpVerb.Put or HttpVerb.Patch or HttpVerb.Delete; |
| | | 1392 | | |
| | | 1393 | | private static bool IsUnsafeMethod(string method) |
| | 24 | 1394 | | => HttpMethods.IsPost(method) || HttpMethods.IsPut(method) || HttpMethods.IsPatch(method) || HttpMethods.IsDelet |
| | | 1395 | | |
| | | 1396 | | // New precise helper: only validate for the actual incoming request method when that method is unsafe and antiforge |
| | | 1397 | | private static bool ShouldValidateCsrf(MapRouteOptions o, HttpContext ctx) |
| | | 1398 | | { |
| | 25 | 1399 | | if (o.DisableAntiforgery) |
| | | 1400 | | { |
| | 1 | 1401 | | return false; |
| | | 1402 | | } |
| | 24 | 1403 | | if (!IsUnsafeMethod(ctx.Request.Method)) |
| | | 1404 | | { |
| | 18 | 1405 | | return false; // Safe verb (GET/HEAD/OPTIONS) -> skip |
| | | 1406 | | } |
| | | 1407 | | // Ensure the route was actually configured for this unsafe verb (defensive; normally true inside mapped delegat |
| | 19 | 1408 | | return o.HttpVerbs.Any(v => string.Equals(v.ToMethodString(), ctx.Request.Method, StringComparison.OrdinalIgnore |
| | | 1409 | | } |
| | | 1410 | | |
| | | 1411 | | private static async Task<bool> TryValidateAntiforgeryAsync(HttpContext ctx) |
| | | 1412 | | { |
| | 1 | 1413 | | var af = ctx.RequestServices.GetService<IAntiforgery>(); |
| | 1 | 1414 | | if (af is null) |
| | | 1415 | | { |
| | 1 | 1416 | | return true; // antiforgery not configured → do nothing |
| | | 1417 | | } |
| | | 1418 | | |
| | | 1419 | | try |
| | | 1420 | | { |
| | 0 | 1421 | | await af.ValidateRequestAsync(ctx); |
| | 0 | 1422 | | return true; |
| | | 1423 | | } |
| | 0 | 1424 | | catch (AntiforgeryValidationException ex) |
| | | 1425 | | { |
| | | 1426 | | // short-circuit with RFC 9110 problem+json |
| | 0 | 1427 | | ctx.Response.StatusCode = StatusCodes.Status400BadRequest; |
| | 0 | 1428 | | ctx.Response.ContentType = "application/problem+json"; |
| | 0 | 1429 | | await ctx.Response.WriteAsJsonAsync(new |
| | 0 | 1430 | | { |
| | 0 | 1431 | | type = "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.1", |
| | 0 | 1432 | | title = "Antiforgery validation failed", |
| | 0 | 1433 | | status = 400, |
| | 0 | 1434 | | detail = ex.Message |
| | 0 | 1435 | | }); |
| | 0 | 1436 | | return false; |
| | | 1437 | | } |
| | 1 | 1438 | | } |
| | | 1439 | | |
| | | 1440 | | /// <summary> |
| | | 1441 | | /// Matches a bracketed IPv6 host:port specification in the format "[ipv6]:port", where: |
| | | 1442 | | /// - ipv6 is a valid IPv6 address (e.g. "::1", "2001:0db8:85a3:0000:0000:8a2e:0370:7334") |
| | | 1443 | | /// - port is a numeric value between 1 and 65535 |
| | | 1444 | | /// Examples of valid inputs: |
| | | 1445 | | /// "[::1]:80" |
| | | 1446 | | /// "[2001:0db8:85a3:0000:0000:8a2e:0370:7334]:443" |
| | | 1447 | | /// </summary> |
| | | 1448 | | [GeneratedRegex(@"^\[([^\]]+)\]:(\d+)$")] |
| | | 1449 | | private static partial Regex BracketedIpv6SpecMatcher(); |
| | | 1450 | | |
| | | 1451 | | /// <summary> |
| | | 1452 | | /// Matches a host:port specification in the format "host:port", where: |
| | | 1453 | | /// - host can be any string excluding ':' (to avoid confusion with IPv6 addresses) |
| | | 1454 | | /// - port is a numeric value between 1 and 65535 |
| | | 1455 | | /// Examples of valid inputs: |
| | | 1456 | | /// "example.com:80" |
| | | 1457 | | /// "localhost:443" |
| | | 1458 | | /// "[::1]:8080" (IPv6 address in brackets) |
| | | 1459 | | /// </summary> |
| | | 1460 | | [GeneratedRegex(@"^([^:]+):(\d+)$")] |
| | | 1461 | | private static partial Regex HostPortSpecMatcher(); |
| | | 1462 | | |
| | | 1463 | | /// <summary> |
| | | 1464 | | /// Matches a URL that starts with "http://" or "https://", followed by a host (excluding '/', '?', or '#'), and end |
| | | 1465 | | /// Examples of valid inputs: |
| | | 1466 | | /// "http://example.com:" |
| | | 1467 | | /// "https://localhost:" |
| | | 1468 | | /// "https://my-server:8080:" |
| | | 1469 | | /// </summary> |
| | | 1470 | | [GeneratedRegex(@"^https?://[^/\?#]+:$", RegexOptions.IgnoreCase, "en-US")] |
| | | 1471 | | private static partial Regex EmptyPortDetectionRegex(); |
| | | 1472 | | } |