| | | 1 | | using AsiBackbone.Core.Signing; |
| | | 2 | | |
| | | 3 | | namespace AsiBackbone.Core.CapabilityTokens; |
| | | 4 | | |
| | | 5 | | public static class CapabilityGrantValidator |
| | | 6 | | { |
| | | 7 | | public static async ValueTask<CapabilityGrantValidationResult> ValidateAsync( |
| | | 8 | | SignedGovernanceArtifact<CapabilityTokenGrant> signedGrant, |
| | | 9 | | CapabilityGrantValidationOptions? options = null, |
| | | 10 | | IAsiBackboneSignatureVerificationService? verificationService = null, |
| | | 11 | | ICapabilityGrantUseStore? useStore = null, |
| | | 12 | | CancellationToken cancellationToken = default) |
| | | 13 | | { |
| | 35 | 14 | | ArgumentNullException.ThrowIfNull(signedGrant); |
| | 34 | 15 | | cancellationToken.ThrowIfCancellationRequested(); |
| | | 16 | | |
| | 33 | 17 | | CapabilityGrantValidationOptions effectiveOptions = options ?? CapabilityGrantValidationOptions.Create(); |
| | 33 | 18 | | CapabilityTokenGrant grant = signedGrant.Artifact; |
| | 33 | 19 | | DateTimeOffset validationUtc = (effectiveOptions.ValidationUtc ?? DateTimeOffset.UtcNow).ToUniversalTime(); |
| | | 20 | | |
| | 33 | 21 | | if (effectiveOptions.RequireProof) |
| | | 22 | | { |
| | 11 | 23 | | CapabilityGrantValidationResult? proofResult = await ValidateProofAsync( |
| | 11 | 24 | | signedGrant, |
| | 11 | 25 | | grant, |
| | 11 | 26 | | verificationService, |
| | 11 | 27 | | cancellationToken).ConfigureAwait(false); |
| | | 28 | | |
| | 11 | 29 | | if (proofResult is not null) |
| | | 30 | | { |
| | 10 | 31 | | return proofResult; |
| | | 32 | | } |
| | | 33 | | } |
| | | 34 | | |
| | 23 | 35 | | CapabilityGrantValidationResult? metadataResult = ValidateMetadata(grant, effectiveOptions, validationUtc); |
| | | 36 | | |
| | 23 | 37 | | if (metadataResult is not null) |
| | | 38 | | { |
| | 13 | 39 | | return metadataResult; |
| | | 40 | | } |
| | | 41 | | |
| | 10 | 42 | | if (effectiveOptions.RequireUseCheck) |
| | | 43 | | { |
| | 9 | 44 | | CapabilityGrantValidationResult? useResult = await ValidateUseAsync( |
| | 9 | 45 | | grant, |
| | 9 | 46 | | effectiveOptions, |
| | 9 | 47 | | useStore, |
| | 9 | 48 | | validationUtc, |
| | 9 | 49 | | cancellationToken).ConfigureAwait(false); |
| | | 50 | | |
| | 9 | 51 | | if (useResult is not null) |
| | | 52 | | { |
| | 7 | 53 | | return useResult; |
| | | 54 | | } |
| | | 55 | | } |
| | | 56 | | |
| | 3 | 57 | | return CapabilityGrantValidationResult.Valid(grant); |
| | 33 | 58 | | } |
| | | 59 | | |
| | | 60 | | private static async ValueTask<CapabilityGrantValidationResult?> ValidateProofAsync( |
| | | 61 | | SignedGovernanceArtifact<CapabilityTokenGrant> signedGrant, |
| | | 62 | | CapabilityTokenGrant grant, |
| | | 63 | | IAsiBackboneSignatureVerificationService? verificationService, |
| | | 64 | | CancellationToken cancellationToken) |
| | | 65 | | { |
| | 11 | 66 | | if (verificationService is null) |
| | | 67 | | { |
| | 1 | 68 | | return CapabilityGrantValidationResult.Failed( |
| | 1 | 69 | | grant, |
| | 1 | 70 | | CapabilityTokenValidationCategory.MissingProof, |
| | 1 | 71 | | VerificationPolicyAction.Deny, |
| | 1 | 72 | | "capability.proof-verifier-missing", |
| | 1 | 73 | | "A proof verifier is required for this validation context."); |
| | | 74 | | } |
| | | 75 | | |
| | 10 | 76 | | VerificationPolicyOutcome verificationOutcome = await GovernanceArtifactVerifier.VerifyAsync( |
| | 10 | 77 | | signedGrant, |
| | 10 | 78 | | verificationService, |
| | 10 | 79 | | cancellationToken: cancellationToken).ConfigureAwait(false); |
| | | 80 | | |
| | 10 | 81 | | return verificationOutcome.ShouldAllow |
| | 10 | 82 | | ? null |
| | 10 | 83 | | : CapabilityGrantValidationResult.Failed( |
| | 10 | 84 | | grant, |
| | 10 | 85 | | MapVerificationCategory(verificationOutcome.Category), |
| | 10 | 86 | | MapVerificationAction(verificationOutcome.Action), |
| | 10 | 87 | | verificationOutcome.FailureCode ?? "capability.proof-invalid", |
| | 10 | 88 | | verificationOutcome.FailureMessage); |
| | 11 | 89 | | } |
| | | 90 | | |
| | | 91 | | private static CapabilityGrantValidationResult? ValidateMetadata( |
| | | 92 | | CapabilityTokenGrant grant, |
| | | 93 | | CapabilityGrantValidationOptions options, |
| | | 94 | | DateTimeOffset validationUtc) |
| | | 95 | | { |
| | 23 | 96 | | return options.Issuer is not null && !string.Equals(options.Issuer, grant.Issuer, StringComparison.Ordinal) |
| | 23 | 97 | | ? CapabilityGrantValidationResult.Failed(grant, CapabilityTokenValidationCategory.WrongIssuer, VerificationP |
| | 23 | 98 | | : options.Audience is not null && !string.Equals(options.Audience, grant.Audience, StringComparison.Ordinal) |
| | 23 | 99 | | ? CapabilityGrantValidationResult.Failed(grant, CapabilityTokenValidationCategory.WrongAudience, Verificatio |
| | 23 | 100 | | : grant.NotBeforeUtc.HasValue && validationUtc < grant.NotBeforeUtc.Value |
| | 23 | 101 | | ? CapabilityGrantValidationResult.Failed(grant, CapabilityTokenValidationCategory.NotYetValid, VerificationP |
| | 23 | 102 | | : validationUtc >= grant.ExpiresUtc |
| | 23 | 103 | | ? CapabilityGrantValidationResult.Failed(grant, CapabilityTokenValidationCategory.Expired, VerificationPolic |
| | 23 | 104 | | : options.Scopes.Count > 0 && !ContainsRequiredScopes(grant.Scopes, options.Scopes) |
| | 23 | 105 | | ? CapabilityGrantValidationResult.Failed(grant, CapabilityTokenValidationCategory.WrongScope, VerificationPo |
| | 23 | 106 | | : (options.PolicyVersion is not null && !string.Equals(options.PolicyVersion, grant.PolicyVersion, StringCom |
| | 23 | 107 | | || (options.PolicyHash is not null && !string.Equals(options.PolicyHash, grant.PolicyHash, StringComparison. |
| | 23 | 108 | | ? CapabilityGrantValidationResult.Failed(grant, CapabilityTokenValidationCategory.PolicyMismatch, Verificati |
| | 23 | 109 | | : options.RequireAcknowledgmentReference && !grant.HasAcknowledgmentReference |
| | 23 | 110 | | ? CapabilityGrantValidationResult.Failed(grant, CapabilityTokenValidationCategory.MissingAcknowledgmentRefer |
| | 23 | 111 | | : options.AcknowledgmentId is not null && !string.Equals(options.AcknowledgmentId, grant.AcknowledgmentId, S |
| | 23 | 112 | | ? CapabilityGrantValidationResult.Failed(grant, CapabilityTokenValidationCategory.AcknowledgmentMismatch, Ve |
| | 23 | 113 | | : options.HandshakeId is not null && !string.Equals(options.HandshakeId, grant.HandshakeId, StringComparison |
| | 23 | 114 | | ? CapabilityGrantValidationResult.Failed(grant, CapabilityTokenValidationCategory.HandshakeMismatch, Verific |
| | 23 | 115 | | : options.GatewayBinding is not null && !string.Equals(options.GatewayBinding, grant.GatewayBinding, StringC |
| | 23 | 116 | | ? CapabilityGrantValidationResult.Failed(grant, CapabilityTokenValidationCategory.GatewayMismatch, Verificat |
| | 23 | 117 | | : options.ResourceBinding is not null && !string.Equals(options.ResourceBinding, grant.ResourceBinding, Stri |
| | 23 | 118 | | ? CapabilityGrantValidationResult.Failed(grant, CapabilityTokenValidationCategory.ResourceMismatch, Verifica |
| | 23 | 119 | | : null; |
| | | 120 | | } |
| | | 121 | | |
| | | 122 | | private static async ValueTask<CapabilityGrantValidationResult?> ValidateUseAsync( |
| | | 123 | | CapabilityTokenGrant grant, |
| | | 124 | | CapabilityGrantValidationOptions options, |
| | | 125 | | ICapabilityGrantUseStore? useStore, |
| | | 126 | | DateTimeOffset validationUtc, |
| | | 127 | | CancellationToken cancellationToken) |
| | | 128 | | { |
| | 9 | 129 | | if (useStore is null) |
| | | 130 | | { |
| | 1 | 131 | | return CapabilityGrantValidationResult.Failed(grant, CapabilityTokenValidationCategory.ReplayStoreUnavailabl |
| | | 132 | | } |
| | | 133 | | |
| | 8 | 134 | | CapabilityGrantUseResult result = await useStore |
| | 8 | 135 | | .TryConsumeAsync(grant, options.MaxUseCount, validationUtc, cancellationToken) |
| | 8 | 136 | | .ConfigureAwait(false); |
| | | 137 | | |
| | 8 | 138 | | return result.State switch |
| | 8 | 139 | | { |
| | 2 | 140 | | GrantUseState.Accepted => null, |
| | 1 | 141 | | GrantUseState.UseLimitExceeded => CapabilityGrantValidationResult.Failed(grant, CapabilityTokenValidationCat |
| | 1 | 142 | | GrantUseState.Stopped => CapabilityGrantValidationResult.Failed(grant, CapabilityTokenValidationCategory.Rev |
| | 1 | 143 | | GrantUseState.Cancelled => CapabilityGrantValidationResult.Failed(grant, CapabilityTokenValidationCategory.C |
| | 2 | 144 | | GrantUseState.Unavailable => CapabilityGrantValidationResult.Failed(grant, CapabilityTokenValidationCategory |
| | 1 | 145 | | _ => CapabilityGrantValidationResult.Failed(grant, CapabilityTokenValidationCategory.Failed, VerificationPol |
| | 8 | 146 | | }; |
| | 9 | 147 | | } |
| | | 148 | | |
| | | 149 | | private static bool ContainsRequiredScopes(IReadOnlyList<string> actualScopes, IReadOnlyList<string> requiredScopes) |
| | | 150 | | { |
| | 19 | 151 | | HashSet<string> actualScopeSet = new(actualScopes, StringComparer.Ordinal); |
| | | 152 | | |
| | 76 | 153 | | foreach (string requiredScope in requiredScopes) |
| | | 154 | | { |
| | 20 | 155 | | if (!actualScopeSet.Contains(requiredScope)) |
| | | 156 | | { |
| | 2 | 157 | | return false; |
| | | 158 | | } |
| | | 159 | | } |
| | | 160 | | |
| | 17 | 161 | | return true; |
| | 2 | 162 | | } |
| | | 163 | | |
| | | 164 | | private static CapabilityTokenValidationCategory MapVerificationCategory(SignatureVerificationCategory category) |
| | | 165 | | { |
| | 9 | 166 | | return category switch |
| | 9 | 167 | | { |
| | 1 | 168 | | SignatureVerificationCategory.MissingSignature => CapabilityTokenValidationCategory.MissingProof, |
| | 0 | 169 | | SignatureVerificationCategory.Valid => CapabilityTokenValidationCategory.Valid, |
| | 1 | 170 | | SignatureVerificationCategory.InvalidSignature => CapabilityTokenValidationCategory.InvalidProof, |
| | 1 | 171 | | SignatureVerificationCategory.HashMismatch => CapabilityTokenValidationCategory.InvalidProof, |
| | 1 | 172 | | SignatureVerificationCategory.RevokedKey => CapabilityTokenValidationCategory.Revoked, |
| | 1 | 173 | | SignatureVerificationCategory.ProviderUnavailable => CapabilityTokenValidationCategory.Failed, |
| | 1 | 174 | | SignatureVerificationCategory.UnknownKeyVersion => CapabilityTokenValidationCategory.Failed, |
| | 1 | 175 | | SignatureVerificationCategory.CanonicalizationMismatch => CapabilityTokenValidationCategory.Failed, |
| | 1 | 176 | | SignatureVerificationCategory.UnsupportedAlgorithm => CapabilityTokenValidationCategory.InvalidProof, |
| | 1 | 177 | | SignatureVerificationCategory.Failed => CapabilityTokenValidationCategory.Failed, |
| | 0 | 178 | | _ => CapabilityTokenValidationCategory.Failed |
| | 9 | 179 | | }; |
| | | 180 | | } |
| | | 181 | | |
| | | 182 | | private static VerificationPolicyAction MapVerificationAction(VerificationPolicyAction action) |
| | | 183 | | { |
| | 9 | 184 | | return action is VerificationPolicyAction.Allow |
| | 9 | 185 | | ? VerificationPolicyAction.Allow |
| | 9 | 186 | | : action; |
| | | 187 | | } |
| | | 188 | | } |