Skip to content

feat: oauth2 - add RFC 8707 resource indicators and audience validation #18575

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: thomask33/06-24-feat_oauth2_add_authorization_server_metadata_endpoint_and_pkce_support
Choose a base branch
from

Conversation

ThomasK33
Copy link
Member

@ThomasK33 ThomasK33 commented Jun 25, 2025

This pull request implements RFC 8707, Resource Indicators for OAuth 2.0 (https://datatracker.ietf.org/doc/html/rfc8707), to enhance the security of our OAuth 2.0 provider.

This change enables proper audience validation and binds access tokens to their intended resource, which is crucial
for preventing token misuse in multi-tenant environments or deployments with multiple resource servers.

Key Changes:

  • Resource Parameter Support: Adds support for the resource parameter in both the authorization (/oauth2/authorize) and token (/oauth2/token) endpoints, allowing clients to specify the intended resource server.
  • Audience Validation: Implements server-side validation to ensure that the resource parameter provided during the token exchange matches the one from the authorization request.
  • API Middleware Enforcement: Introduces a new validation step in the API authentication middleware (coderd/httpmw/apikey.go) to verify that the audience of the access token matches the resource server being accessed.
  • Database Schema Updates:
    • Adds a resource_uri column to the oauth2_provider_app_codes table to store the resource requested during authorization.
    • Adds an audience column to the oauth2_provider_app_tokens table to bind the issued token to a specific audience.
  • Enhanced PKCE: Includes a minor enhancement to the PKCE implementation to protect against timing attacks.
  • Comprehensive Testing: Adds extensive new tests to coderd/oauth2_test.go to cover various RFC 8707 scenarios, including valid flows, mismatched resources, and refresh token validation.

How it Works:

  1. An OAuth2 client specifies the target resource (e.g., https://coder.example.com) using the resource parameter in the authorization request.
  2. The authorization server stores this resource URI with the authorization code.
  3. During the token exchange, the server validates that the client provides the same resource parameter.
  4. The server issues an access token with an audience claim set to the validated resource URI.
  5. When the client uses the access token to call an API endpoint, the middleware verifies that the token's audience matches the URL of the Coder deployment, rejecting any tokens intended for a different resource.

This ensures that a token issued for one Coder deployment cannot be used to access another, significantly strengthening our authentication security.


Change-Id: I3924cb2139e837e3ac0b0bd40a5aeb59637ebc1b
Signed-off-by: Thomas Kosiewski tk@coder.com

@ThomasK33 ThomasK33 force-pushed the thomask33/06-24-feat_oauth2_add_authorization_server_metadata_endpoint_and_pkce_support branch from 018694a to 3daa2ab Compare June 25, 2025 14:06
@ThomasK33 ThomasK33 force-pushed the thomask33/06-25-feat_oauth2_add_rfc_8707_resource_indicators_and_audience_validation branch from fb90065 to d14c08e Compare June 25, 2025 14:06
@ThomasK33 ThomasK33 changed the title feat(oauth2): add RFC 8707 resource indicators and audience validation feat: oauth2 - add RFC 8707 resource indicators and audience validation Jun 25, 2025
@ThomasK33 ThomasK33 force-pushed the thomask33/06-25-feat_oauth2_add_rfc_8707_resource_indicators_and_audience_validation branch 3 times, most recently from f4fbe1d to c8d2599 Compare June 25, 2025 16:27
@ThomasK33 ThomasK33 marked this pull request as ready for review June 25, 2025 17:56
@ThomasK33 ThomasK33 requested review from Emyrk and johnstcn June 25, 2025 17:56
@ThomasK33 ThomasK33 force-pushed the thomask33/06-24-feat_oauth2_add_authorization_server_metadata_endpoint_and_pkce_support branch from 3daa2ab to b50e322 Compare June 25, 2025 18:16
@ThomasK33 ThomasK33 force-pushed the thomask33/06-25-feat_oauth2_add_rfc_8707_resource_indicators_and_audience_validation branch from c8d2599 to 4130e42 Compare June 25, 2025 18:16
// The expected behavior depends on whether the middleware detects Host differences
if _, err := client2.User(ctx, codersdk.Me); err != nil {
// This is expected if audience validation is working properly
t.Logf("Cross-resource token properly rejected: %v", err)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you mean to perform an assertion here?

func validateOAuth2ProviderAppTokenAudience(ctx context.Context, db database.Store, key database.APIKey, r *http.Request) error {
// Get the OAuth2 provider app token to check its audience
//nolint:gocritic // System needs to access token for audience validation
token, err := db.GetOAuth2ProviderAppTokenByAPIKeyID(dbauthz.AsSystemRestricted(ctx), key.ID)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

review: This is a legitimate use of dbauthz.SystemRestricted.

Comment on lines +44 to +45
// New OAuth2 resource-indicator methods (RFC 8707); tests to be added
"GetOAuth2ProviderAppTokenByAPIKeyID": "Not relevant",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be added in a separate PR? Or in this PR?

if err := validateOAuth2ProviderAppTokenAudience(ctx, cfg.DB, *key, r); err != nil {
return optionalWrite(http.StatusForbidden, codersdk.Response{
Message: "Token audience mismatch",
Detail: err.Error(),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this potentially leak information? Should we maybe log this instead but not return it?

@ThomasK33 ThomasK33 force-pushed the thomask33/06-25-feat_oauth2_add_rfc_8707_resource_indicators_and_audience_validation branch from 4130e42 to e525b11 Compare June 26, 2025 14:28
@ThomasK33 ThomasK33 force-pushed the thomask33/06-24-feat_oauth2_add_authorization_server_metadata_endpoint_and_pkce_support branch from b50e322 to 3dd6c7e Compare June 26, 2025 14:28
@ThomasK33 ThomasK33 force-pushed the thomask33/06-25-feat_oauth2_add_rfc_8707_resource_indicators_and_audience_validation branch from e525b11 to aec4923 Compare June 26, 2025 15:45
@ThomasK33 ThomasK33 force-pushed the thomask33/06-24-feat_oauth2_add_authorization_server_metadata_endpoint_and_pkce_support branch from 3dd6c7e to 224784a Compare June 26, 2025 15:45
@ThomasK33 ThomasK33 force-pushed the thomask33/06-25-feat_oauth2_add_rfc_8707_resource_indicators_and_audience_validation branch from aec4923 to 819ce2e Compare June 26, 2025 16:20
@ThomasK33 ThomasK33 force-pushed the thomask33/06-24-feat_oauth2_add_authorization_server_metadata_endpoint_and_pkce_support branch from 224784a to c2d85d9 Compare June 26, 2025 16:20
@ThomasK33 ThomasK33 force-pushed the thomask33/06-24-feat_oauth2_add_authorization_server_metadata_endpoint_and_pkce_support branch from c2d85d9 to 69eb5c8 Compare June 26, 2025 16:23
@ThomasK33 ThomasK33 force-pushed the thomask33/06-25-feat_oauth2_add_rfc_8707_resource_indicators_and_audience_validation branch from 819ce2e to 002ffdf Compare June 26, 2025 16:23
@ThomasK33 ThomasK33 force-pushed the thomask33/06-24-feat_oauth2_add_authorization_server_metadata_endpoint_and_pkce_support branch from 69eb5c8 to 80c695b Compare June 26, 2025 16:24
@ThomasK33 ThomasK33 force-pushed the thomask33/06-25-feat_oauth2_add_rfc_8707_resource_indicators_and_audience_validation branch from 002ffdf to 0b43477 Compare June 26, 2025 16:24
@ThomasK33 ThomasK33 force-pushed the thomask33/06-24-feat_oauth2_add_authorization_server_metadata_endpoint_and_pkce_support branch 2 times, most recently from 03c4724 to 870e5eb Compare June 26, 2025 16:34
@ThomasK33 ThomasK33 force-pushed the thomask33/06-25-feat_oauth2_add_rfc_8707_resource_indicators_and_audience_validation branch 2 times, most recently from 058cbe7 to 495cecc Compare June 26, 2025 16:40
Implements RFC 8707 Resource Indicators for OAuth2 provider to enable proper
audience validation and token binding for multi-tenant scenarios.

Key changes:
- Add resource parameter support to authorization and token endpoints
- Implement server-side audience validation for opaque tokens
- Add database fields: ResourceUri (codes) and Audience (tokens)
- Add comprehensive resource parameter validation logic
- Add cross-resource audience validation in API middleware
- Add extensive test coverage for RFC 8707 scenarios
- Enhance PKCE implementation with timing attack protection

This enables OAuth2 clients to specify target resource servers and prevents
token abuse across different Coder deployments through proper audience binding.

Change-Id: I3924cb2139e837e3ac0b0bd40a5aeb59637ebc1b
Signed-off-by: Thomas Kosiewski <tk@coder.com>
@ThomasK33 ThomasK33 force-pushed the thomask33/06-25-feat_oauth2_add_rfc_8707_resource_indicators_and_audience_validation branch from f46d478 to abbe929 Compare June 27, 2025 17:29
@ThomasK33 ThomasK33 force-pushed the thomask33/06-24-feat_oauth2_add_authorization_server_metadata_endpoint_and_pkce_support branch from dd622d0 to 3092108 Compare June 27, 2025 17:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants