| | | 1 | | using Microsoft.AspNetCore.Http; |
| | | 2 | | |
| | | 3 | | namespace AsiBackbone.AspNetCore.Endpoints; |
| | | 4 | | |
| | | 5 | | /// <summary> |
| | | 6 | | /// Provides options for ergonomic ASP.NET Core endpoint governance integration. |
| | | 7 | | /// </summary> |
| | | 8 | | public sealed class AsiBackboneEndpointGovernanceOptions |
| | | 9 | | { |
| | | 10 | | /// <summary> |
| | | 11 | | /// Gets or sets the policy version attached to generated endpoint governance evaluation contexts. |
| | | 12 | | /// </summary> |
| | 19 | 13 | | public string? PolicyVersion { get; set; } |
| | | 14 | | |
| | | 15 | | /// <summary> |
| | | 16 | | /// Gets or sets the policy hash attached to generated endpoint governance evaluation contexts. |
| | | 17 | | /// </summary> |
| | 19 | 18 | | public string? PolicyHash { get; set; } |
| | | 19 | | |
| | | 20 | | /// <summary> |
| | | 21 | | /// Gets or sets the endpoint metadata mode used for governance evaluation contexts, audit residue, acknowledgment c |
| | | 22 | | /// </summary> |
| | | 23 | | /// <remarks> |
| | | 24 | | /// The default keeps complete endpoint metadata for traceability. High-throughput hosts may choose |
| | | 25 | | /// <see cref="AsiBackboneEndpointGovernanceMetadataMode.Reduced" /> to forward only the endpoint operation name |
| | | 26 | | /// through the hot path after they have confirmed host policies do not require the omitted metadata values. |
| | | 27 | | /// </remarks> |
| | 80 | 28 | | public AsiBackboneEndpointGovernanceMetadataMode MetadataMode { get; set; } = AsiBackboneEndpointGovernanceMetadataM |
| | | 29 | | |
| | | 30 | | /// <summary> |
| | | 31 | | /// Gets or sets a value indicating whether policy metadata should fail closed when no policy evaluator is configure |
| | | 32 | | /// </summary> |
| | 58 | 33 | | public bool FailClosedWhenPolicyEvaluatorMissing { get; set; } = true; |
| | | 34 | | |
| | | 35 | | /// <summary> |
| | | 36 | | /// Gets or sets a value indicating whether capability metadata should fail closed when no capability validator is c |
| | | 37 | | /// </summary> |
| | 58 | 38 | | public bool FailClosedWhenCapabilityValidatorMissing { get; set; } = true; |
| | | 39 | | |
| | | 40 | | /// <summary> |
| | | 41 | | /// Gets or sets a value indicating whether audit metadata should fail closed when no host-owned audit sink is confi |
| | | 42 | | /// </summary> |
| | 56 | 43 | | public bool FailClosedWhenAuditSinkMissing { get; set; } = true; |
| | | 44 | | |
| | | 45 | | /// <summary> |
| | | 46 | | /// Gets or sets the HTTP status code used when endpoint governance is missing required host configuration. |
| | | 47 | | /// </summary> |
| | 105 | 48 | | public int ConfigurationFailureStatusCode { get; set; } = StatusCodes.Status500InternalServerError; |
| | | 49 | | |
| | | 50 | | /// <summary> |
| | | 51 | | /// Gets or sets the HTTP status code used when endpoint capability validation fails before policy evaluation return |
| | | 52 | | /// </summary> |
| | 105 | 53 | | public int CapabilityFailureStatusCode { get; set; } = StatusCodes.Status403Forbidden; |
| | | 54 | | |
| | | 55 | | /// <summary> |
| | | 56 | | /// Gets or sets the HTTP status code used when a governance decision requires acknowledgment and the endpoint reque |
| | | 57 | | /// </summary> |
| | 101 | 58 | | public int AcknowledgmentChallengeStatusCode { get; set; } = StatusCodes.Status428PreconditionRequired; |
| | | 59 | | |
| | | 60 | | /// <summary> |
| | | 61 | | /// Gets or sets a value indicating whether selected endpoints without AsiBackbone governance metadata should fail c |
| | | 62 | | /// </summary> |
| | 16 | 63 | | public bool RequireGovernanceMetadata { get; set; } |
| | | 64 | | |
| | | 65 | | /// <summary> |
| | | 66 | | /// Gets or sets a value indicating whether local-development ProblemDetails diagnostics should be emitted for endpo |
| | | 67 | | /// </summary> |
| | 16 | 68 | | public bool EnableDevelopmentDiagnostics { get; set; } |
| | | 69 | | |
| | | 70 | | /// <summary> |
| | | 71 | | /// Gets or sets the documentation base URL used when development diagnostics include a troubleshooting link. |
| | | 72 | | /// </summary> |
| | 5 | 73 | | public string? DevelopmentDiagnosticsDocumentationBaseUrl { get; set; } |
| | | 74 | | |
| | | 75 | | /// <summary> |
| | | 76 | | /// Gets a collection of metadata keys whose values should be redacted from development diagnostics. |
| | | 77 | | /// </summary> |
| | 66 | 78 | | public ISet<string> DevelopmentDiagnosticsRedactedMetadataKeys { get; } = new HashSet<string>(StringComparer.Ordinal |
| | | 79 | | |
| | | 80 | | /// <summary> |
| | | 81 | | /// Gets or sets a value indicating whether non-sensitive metadata values may be included in development diagnostics |
| | | 82 | | /// </summary> |
| | 73 | 83 | | public bool IncludeDevelopmentDiagnosticsMetadataValues { get; set; } = true; |
| | | 84 | | |
| | | 85 | | /// <summary> |
| | | 86 | | /// Gets or sets an optional factory for the generic 403 response used by middleware when no explicit failure result |
| | | 87 | | /// </summary> |
| | | 88 | | /// <remarks> |
| | | 89 | | /// Leave this unset for the low-allocation, bodyless default 403 response. Hosts that prefer richer API responses |
| | | 90 | | /// may provide a safe factory, such as a ProblemDetails result, while avoiding sensitive governance details. |
| | | 91 | | /// </remarks> |
| | 9 | 92 | | public Func<HttpContext, IResult>? DefaultForbiddenResultFactory { get; set; } |
| | | 93 | | |
| | | 94 | | /// <summary> |
| | | 95 | | /// Validates endpoint governance options. |
| | | 96 | | /// </summary> |
| | | 97 | | public void Validate() |
| | | 98 | | { |
| | 55 | 99 | | if (!Enum.IsDefined(MetadataMode)) |
| | | 100 | | { |
| | 0 | 101 | | throw new InvalidOperationException($"{nameof(MetadataMode)} must be a defined endpoint governance metadata |
| | | 102 | | } |
| | | 103 | | |
| | 55 | 104 | | ValidateStatusCode(ConfigurationFailureStatusCode, nameof(ConfigurationFailureStatusCode)); |
| | 54 | 105 | | ValidateStatusCode(CapabilityFailureStatusCode, nameof(CapabilityFailureStatusCode)); |
| | 53 | 106 | | ValidateStatusCode(AcknowledgmentChallengeStatusCode, nameof(AcknowledgmentChallengeStatusCode)); |
| | 53 | 107 | | } |
| | | 108 | | |
| | | 109 | | private static void ValidateStatusCode(int statusCode, string propertyName) |
| | | 110 | | { |
| | 162 | 111 | | if (statusCode is < 100 or > 599) |
| | | 112 | | { |
| | 2 | 113 | | throw new InvalidOperationException($"{propertyName} must be a valid HTTP status code."); |
| | | 114 | | } |
| | 160 | 115 | | } |
| | | 116 | | } |