| | | 1 | | using System.Collections.ObjectModel; |
| | | 2 | | |
| | | 3 | | namespace AsiBackbone.Core.Metadata; |
| | | 4 | | |
| | | 5 | | /// <summary> |
| | | 6 | | /// Defines optional host-owned budget limits for governance metadata dictionaries. |
| | | 7 | | /// </summary> |
| | | 8 | | /// <remarks> |
| | | 9 | | /// The budget is intentionally advisory and helper-oriented. AsiBackbone cannot determine whether |
| | | 10 | | /// host-provided metadata is sensitive in a specific deployment, but hosts can use these limits to |
| | | 11 | | /// keep audit and governance metadata bounded before durable storage, emission, or signing. |
| | | 12 | | /// </remarks> |
| | | 13 | | public sealed class GovernanceMetadataBudget |
| | | 14 | | { |
| | | 15 | | /// <summary> |
| | | 16 | | /// Gets the default recommended maximum number of metadata entries. |
| | | 17 | | /// </summary> |
| | | 18 | | public const int DefaultMaxCount = 32; |
| | | 19 | | |
| | | 20 | | /// <summary> |
| | | 21 | | /// Gets the default recommended maximum metadata key length, in characters. |
| | | 22 | | /// </summary> |
| | | 23 | | public const int DefaultMaxKeyLength = 64; |
| | | 24 | | |
| | | 25 | | /// <summary> |
| | | 26 | | /// Gets the default recommended maximum metadata value length, in characters. |
| | | 27 | | /// </summary> |
| | | 28 | | public const int DefaultMaxValueLength = 512; |
| | | 29 | | |
| | | 30 | | /// <summary> |
| | | 31 | | /// Gets the default recommended estimated serialized metadata size, in UTF-8 bytes. |
| | | 32 | | /// </summary> |
| | | 33 | | public const int DefaultMaxSerializedBytes = 8192; |
| | | 34 | | |
| | 2 | 35 | | private static readonly ReadOnlyCollection<string> DefaultReservedKeyFragments = |
| | 2 | 36 | | new( |
| | 2 | 37 | | new[] |
| | 2 | 38 | | { |
| | 2 | 39 | | "accesstoken", |
| | 2 | 40 | | "apikey", |
| | 2 | 41 | | "authorization", |
| | 2 | 42 | | "bearer", |
| | 2 | 43 | | "connectionstring", |
| | 2 | 44 | | "credential", |
| | 2 | 45 | | "password", |
| | 2 | 46 | | "privatekey", |
| | 2 | 47 | | "refreshtoken", |
| | 2 | 48 | | "secret", |
| | 2 | 49 | | "socialsecurity", |
| | 2 | 50 | | "ssn" |
| | 2 | 51 | | }); |
| | | 52 | | |
| | 8 | 53 | | private GovernanceMetadataBudget( |
| | 8 | 54 | | int maxCount, |
| | 8 | 55 | | int maxKeyLength, |
| | 8 | 56 | | int maxValueLength, |
| | 8 | 57 | | int maxSerializedBytes, |
| | 8 | 58 | | IReadOnlyList<string> reservedKeyFragments) |
| | | 59 | | { |
| | 8 | 60 | | ThrowIfLessThanOne(maxCount, nameof(maxCount)); |
| | 7 | 61 | | ThrowIfLessThanOne(maxKeyLength, nameof(maxKeyLength)); |
| | 7 | 62 | | ThrowIfLessThanOne(maxValueLength, nameof(maxValueLength)); |
| | 7 | 63 | | ThrowIfLessThanOne(maxSerializedBytes, nameof(maxSerializedBytes)); |
| | 7 | 64 | | ArgumentNullException.ThrowIfNull(reservedKeyFragments); |
| | | 65 | | |
| | 7 | 66 | | MaxCount = maxCount; |
| | 7 | 67 | | MaxKeyLength = maxKeyLength; |
| | 7 | 68 | | MaxValueLength = maxValueLength; |
| | 7 | 69 | | MaxSerializedBytes = maxSerializedBytes; |
| | 7 | 70 | | ReservedKeyFragments = reservedKeyFragments; |
| | 7 | 71 | | } |
| | | 72 | | |
| | | 73 | | /// <summary> |
| | | 74 | | /// Gets the recommended governance metadata budget. |
| | | 75 | | /// </summary> |
| | | 76 | | public static GovernanceMetadataBudget Recommended { get; } = Create(); |
| | | 77 | | |
| | | 78 | | /// <summary> |
| | | 79 | | /// Gets the maximum number of normalized metadata entries allowed by the budget. |
| | | 80 | | /// </summary> |
| | | 81 | | public int MaxCount { get; } |
| | | 82 | | |
| | | 83 | | /// <summary> |
| | | 84 | | /// Gets the maximum normalized metadata key length allowed by the budget, in characters. |
| | | 85 | | /// </summary> |
| | | 86 | | public int MaxKeyLength { get; } |
| | | 87 | | |
| | | 88 | | /// <summary> |
| | | 89 | | /// Gets the maximum normalized metadata value length allowed by the budget, in characters. |
| | | 90 | | /// </summary> |
| | | 91 | | public int MaxValueLength { get; } |
| | | 92 | | |
| | | 93 | | /// <summary> |
| | | 94 | | /// Gets the maximum estimated serialized metadata size allowed by the budget, in UTF-8 bytes. |
| | | 95 | | /// </summary> |
| | | 96 | | public int MaxSerializedBytes { get; } |
| | | 97 | | |
| | | 98 | | /// <summary> |
| | | 99 | | /// Gets normalized reserved or discouraged metadata key fragments. |
| | | 100 | | /// </summary> |
| | | 101 | | public IReadOnlyList<string> ReservedKeyFragments { get; } |
| | | 102 | | |
| | | 103 | | /// <summary> |
| | | 104 | | /// Creates a governance metadata budget. |
| | | 105 | | /// </summary> |
| | | 106 | | public static GovernanceMetadataBudget Create( |
| | | 107 | | int maxCount = DefaultMaxCount, |
| | | 108 | | int maxKeyLength = DefaultMaxKeyLength, |
| | | 109 | | int maxValueLength = DefaultMaxValueLength, |
| | | 110 | | int maxSerializedBytes = DefaultMaxSerializedBytes, |
| | | 111 | | IEnumerable<string>? reservedKeyFragments = null) |
| | | 112 | | { |
| | 8 | 113 | | return new GovernanceMetadataBudget( |
| | 8 | 114 | | maxCount, |
| | 8 | 115 | | maxKeyLength, |
| | 8 | 116 | | maxValueLength, |
| | 8 | 117 | | maxSerializedBytes, |
| | 8 | 118 | | NormalizeReservedKeyFragments(reservedKeyFragments ?? DefaultReservedKeyFragments)); |
| | | 119 | | } |
| | | 120 | | |
| | | 121 | | internal static string NormalizeKeyForComparison(string key) |
| | | 122 | | { |
| | 44 | 123 | | string normalizedKey = key.Trim().ToLowerInvariant(); |
| | 44 | 124 | | char[] buffer = new char[normalizedKey.Length]; |
| | 44 | 125 | | int count = 0; |
| | | 126 | | |
| | 892 | 127 | | foreach (char character in normalizedKey) |
| | | 128 | | { |
| | 402 | 129 | | if (char.IsLetterOrDigit(character)) |
| | | 130 | | { |
| | 397 | 131 | | buffer[count] = character; |
| | 397 | 132 | | count++; |
| | | 133 | | } |
| | | 134 | | } |
| | | 135 | | |
| | 44 | 136 | | return new string(buffer, 0, count); |
| | | 137 | | } |
| | | 138 | | |
| | | 139 | | private static ReadOnlyCollection<string> NormalizeReservedKeyFragments(IEnumerable<string> reservedKeyFragments) |
| | | 140 | | { |
| | 8 | 141 | | string[] normalizedFragments = [.. reservedKeyFragments |
| | 8 | 142 | | .Where(fragment => !string.IsNullOrWhiteSpace(fragment)) |
| | 8 | 143 | | .Select(NormalizeKeyForComparison) |
| | 8 | 144 | | .Where(fragment => fragment.Length > 0) |
| | 8 | 145 | | .Distinct(StringComparer.Ordinal) |
| | 8 | 146 | | .OrderBy(fragment => fragment, StringComparer.Ordinal)]; |
| | | 147 | | |
| | 8 | 148 | | return normalizedFragments.Length == 0 |
| | 8 | 149 | | ? Array.AsReadOnly(Array.Empty<string>()) |
| | 8 | 150 | | : Array.AsReadOnly(normalizedFragments); |
| | | 151 | | } |
| | | 152 | | |
| | | 153 | | private static void ThrowIfLessThanOne(int value, string parameterName) |
| | | 154 | | { |
| | 29 | 155 | | if (value < 1) |
| | | 156 | | { |
| | 1 | 157 | | throw new ArgumentOutOfRangeException(parameterName, value, "Value must be greater than or equal to one."); |
| | | 158 | | } |
| | 28 | 159 | | } |
| | | 160 | | } |