Implementation for SEP-2350 Client-side scope accumulation in step-up authorization (#1591)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Tarek Mahmoud Sayed <tarekms@microsoft.com>
This commit is contained in:
Mike Kistler 2026-06-22 06:20:35 -07:00 • committed by GitHub
commit 9b783d7a3b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 511 additions and 12 deletions

View file

@ -48,6 +48,14 @@ internal sealed partial class ClientOAuthProvider : McpHttpClient
private string? _tokenEndpointAuthMethod;
private ITokenCache _tokenCache;
private AuthorizationServerMetadata? _authServerMetadata;
// The accumulated scope set lives for this provider's lifetime and is intentionally not keyed by
// resource or authorization server. This is safe today because one ClientOAuthProvider is created
// per HttpClientTransport, i.e. per endpoint/resource. If a provider were ever reused across
// multiple resources or auth servers, accumulated scopes could be sent to a server that rejects
// them (invalid_scope). Accumulation is scoped per "resource and operation" combination (SEP-2350).
private readonly HashSet<string> _accumulatedScopes = new(StringComparer.Ordinal);
private readonly object _scopeAccumulatorLock = new();
private bool _hasAttemptedStepUp;
/// <summary>
/// Initializes a new instance of the <see cref="ClientOAuthProvider"/> class using the specified options.
@ -245,6 +253,28 @@ internal sealed partial class ClientOAuthProvider : McpHttpClient
ThrowFailedToHandleUnauthorizedResponse("No authorization servers found in authentication challenge");
}
// SEP-2350: A step-up may legitimately introduce new scopes, so at least one interactive
// (re-)authorization attempt is always allowed. However, once a step-up has already been
// attempted, a subsequent insufficient_scope challenge that introduces no scope beyond those
// already requested cannot make progress by re-running authorization. Treat that repeated,
// unproductive challenge as a permanent authorization failure instead of prompting the user
// again for the same resource and operation combination.
if (response.StatusCode == System.Net.HttpStatusCode.Forbidden)
{
bool introducesNewScopes = ChallengeIntroducesNewScopes(protectedResourceMetadata);
lock (_scopeAccumulatorLock)
{
if (_hasAttemptedStepUp && !introducesNewScopes)
{
ThrowFailedToHandleUnauthorizedResponse(
"A repeated insufficient_scope challenge added no scope beyond those already requested, " +
"so step-up authorization cannot satisfy the request.");
}
_hasAttemptedStepUp = true;
}
}
// Convert string URIs to Uri objects for the selector
List<Uri> authServerUris = [];
foreach (var serverUriString in availableAuthorizationServers)
@ -730,16 +760,92 @@ internal sealed partial class ClientOAuthProvider : McpHttpClient
private string? GetScopeParameter(ProtectedResourceMetadata protectedResourceMetadata)
{
if (!string.IsNullOrEmpty(protectedResourceMetadata.WwwAuthenticateScope))
// Determine the scopes for the current operation from the challenge or metadata.
var currentOperationScopes = GetCurrentOperationScopes(protectedResourceMetadata);
if (currentOperationScopes.Count == 0)
{
return protectedResourceMetadata.WwwAuthenticateScope;
}
else if (protectedResourceMetadata.ScopesSupported.Count > 0)
{
return string.Join(" ", protectedResourceMetadata.ScopesSupported);
lock (_scopeAccumulatorLock)
{
// If we have previously requested scopes but nothing new, return the accumulated set.
return _accumulatedScopes.Count > 0
? string.Join(" ", _accumulatedScopes.OrderBy(s => s, StringComparer.Ordinal))
: null;
}
}
return _configuredScopes;
// Per SEP-2350: Compute the union of previously requested scopes and newly challenged scopes
// to avoid losing permissions needed for other operations during step-up authorization.
// Note: the accumulator stores only server-challenged / scopes_supported / configured scopes.
// offline_access (AugmentScopeWithOfflineAccess) and any ScopeSelector are applied per request
// in ComputeEffectiveScope and are intentionally not accumulated, so the selector always sees
// the full union and the operation stays idempotent.
lock (_scopeAccumulatorLock)
{
foreach (var scope in currentOperationScopes)
{
_accumulatedScopes.Add(scope);
}
// Sort scopes for stable, deterministic output (scopes are unordered per RFC 6749 §3.3).
return string.Join(" ", _accumulatedScopes.OrderBy(s => s, StringComparer.Ordinal));
}
}
/// <summary>
/// Determines the scopes required for the current operation, preferring the <c>WWW-Authenticate</c>
/// challenge scope, then <c>scopes_supported</c> from the protected resource metadata, then the
/// configured scopes. Returns the individual scope tokens so callers can compare and accumulate them
/// without re-joining and re-splitting. This does not mutate the accumulated scope set.
/// </summary>
private IReadOnlyList<string> GetCurrentOperationScopes(ProtectedResourceMetadata protectedResourceMetadata)
{
if (!string.IsNullOrEmpty(protectedResourceMetadata.WwwAuthenticateScope))
{
return SplitScopes(protectedResourceMetadata.WwwAuthenticateScope!);
}
var scopesSupported = protectedResourceMetadata.ScopesSupported;
if (scopesSupported.Count > 0)
{
// scopes_supported is already a list of individual scopes; avoid join/split round-tripping.
return scopesSupported as IReadOnlyList<string> ?? [.. scopesSupported];
}
return _configuredScopes is null ? [] : SplitScopes(_configuredScopes);
}
private static string[] SplitScopes(string scopes) =>
scopes.Split(new[] { ' ' }, StringSplitOptions.RemoveEmptyEntries);
/// <summary>
/// Returns <see langword="true"/> if the current challenge requires at least one scope that has not
/// already been requested in a previous (re-)authorization. The caller combines this with step-up
/// attempt tracking: per SEP-2350, a step-up that adds a new scope is always allowed, but once a
/// step-up has been attempted, a later challenge that adds no new scope is treated as a permanent
/// failure because re-running interactive authorization cannot make progress.
/// </summary>
private bool ChallengeIntroducesNewScopes(ProtectedResourceMetadata protectedResourceMetadata)
{
var currentOperationScopes = GetCurrentOperationScopes(protectedResourceMetadata);
if (currentOperationScopes.Count == 0)
{
// No concrete scope to request, so a re-authorization cannot add anything new.
return false;
}
lock (_scopeAccumulatorLock)
{
foreach (var scope in currentOperationScopes)
{
if (!_accumulatedScopes.Contains(scope))
{
return true;
}
}
}
return false;
}
/// <summary>

View file

@ -190,7 +190,8 @@ public sealed class ProtectedResourceMetadata
/// The scopes included in the WWW-Authenticate challenge MAY match scopes_supported, be a subset or superset of it,
/// or an alternative collection that is neither a strict subset nor superset. Clients MUST NOT assume any particular
/// set relationship between the challenged scope set and scopes_supported. Clients MUST treat the scopes provided
/// in the challenge as authoritative for satisfying the current request.
/// in the challenge as authoritative for the current operation. When re-authorizing, clients SHOULD include these
/// scopes alongside any previously granted scopes to avoid losing permissions needed for other operations (SEP-2350).
///
/// https://modelcontextprotocol.io/specification/2025-11-25/basic/authorization#protected-resource-metadata-discovery-requirements
/// </summary>