[Bug]: [API Portal] A disabled key manager still issues tokens through an application's client mapping

Open
#4,143 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
70/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
docker-compose, javascript, sqlite

Research direction

Start in portals/api-portal/src/controllers/apiPortalController.js at generateOAuthKeys (around line 315), which loads the key manager and calls generateToken without checking kmRecord.enabled. Compare with the refusal in portals/api-portal/src/services/keyManagerRegistry.js around line 189. Done when the generate-token endpoint returns a 4xx with no token for a disabled key manager, which you can confirm by running the six reproduction steps in the issue.

Written by the indexing model from the issue text.

Description

Aspect/API Severity/Major Type/Bug
Please select the area the issue is related to

Developer Portal

Please select the aspect the issue is related to

Aspect/API (API backends, definitions, contracts, interfaces, OpenAPI)

Description

POST /api-portal/api/v0.9/applications/{applicationId}/oauth-keys/{keyMappingId}/generate-token doesn't check whether the key manager is enabled. After an administrator disables a key manager, this endpoint still requests and returns tokens from it.

Disabling a key manager is how an administrator takes an identity provider out of service, so this path bypasses that control. The /oauth2-keys path refuses a disabled key manager, so the two token paths behave differently.

Expected: after the key manager is disabled, the request fails with a 4xx error and returns no token.

Actual: the request returns 200 with a new access token.

Step Result
Issue a token while the key manager is enabled 200, token returned
Call a gateway API that trusts this key manager's issuer with that token 200
Disable the key manager (PUT /key-managers/{id}, {"enabled":false}) 200, "enabled":false
Issue a token while the key manager is disabled 200, new token returned (4xx expected)
Call the same API with the new token 200

The result is the same whether the application belongs to an administrator or a developer.

The gateway in this check was configured separately and isn't connected to the portal. The API calls show that the token issued after disabling is usable; they don't show how a gateway should treat tokens from a disabled key manager.

Cause

  • generateOAuthKeys loads the key manager and calls generateToken without checking kmRecord.enabled (portals/api-portal/src/controllers/apiPortalController.js:315).
  • The /oauth2-keys path goes through keyManagerRegistry, which refuses a disabled key manager (portals/api-portal/src/services/keyManagerRegistry.js:189).
  • generateKeys has no enabled check either, so from the code it can also create new client mappings to a disabled key manager (portals/api-portal/src/controllers/apiPortalController.js:275). This wasn't exercised separately.
Steps to Reproduce

Set BASE to the portal's REST API, for example https://localhost:9543/api-portal/api/v0.9, and get an administrator bearer token. Use any OAuth2 token endpoint that supports the client credentials grant, and a client registered with it.

  1. Create a key manager. It returns 201.

    curl -sk -w '\nHTTP %{http_code}\n' -X POST "$BASE/key-managers" \
      -H "Authorization: Bearer $ADMIN_TOKEN" -H 'Content-Type: application/json' \
      -d '{"id":"manual-km","displayName":"Manual Key Manager","tokenEndpoint":"<token endpoint>"}'
    
  2. Create an application. It returns 201.

    curl -sk -w '\nHTTP %{http_code}\n' -X POST "$BASE/applications" \
      -H "Authorization: Bearer $ADMIN_TOKEN" -H 'Content-Type: application/json' \
      -d '{"id":"manual-app","displayName":"Manual Application","description":"Uses a key manager"}'
    
  3. Map the client to the application, and note keyMappingId from the response.

    curl -sk -w '\nHTTP %{http_code}\n' -X POST "$BASE/applications/manual-app/generate-keys" \
      -H "Authorization: Bearer $ADMIN_TOKEN" -H 'Content-Type: application/json' \
      -d '{"keyManager":"manual-km","type":"PRODUCTION","consumerKey":"<client id>"}'
    
  4. Issue a token. It returns 200 with an accessToken.

    curl -sk -w '\nHTTP %{http_code}\n' -X POST "$BASE/applications/manual-app/oauth-keys/<keyMappingId>/generate-token" \
      -H "Authorization: Bearer $ADMIN_TOKEN" -H 'Content-Type: application/json' \
      -d '{"consumerSecret":"<client secret>"}'
    
  5. Disable the key manager. It returns 200 with "enabled":false.

    curl -sk -w '\nHTTP %{http_code}\n' -X PUT "$BASE/key-managers/manual-km" \
      -H "Authorization: Bearer $ADMIN_TOKEN" -H 'Content-Type: application/json' \
      -d '{"enabled":false}'
    
  6. Repeat step 4. It returns 200 with a new accessToken; a 4xx error and no token are expected.

Severity Level of the Issue

Severity/Major (Important functionality is broken. Should be prioritized. Doesn't need immediate attention)

Environment Details (with versions)
  • API Portal 1.1.0-m6-SNAPSHOT, built locally from source
  • Platform API 0.17.0-SNAPSHOT, for sign-in
  • Gateway 2026.09.24 for the API calls
  • SQLite, running with Docker Compose on macOS
  • A mock OAuth2 token endpoint as the key manager
Dominant language
Go
Stars
85
Forks
137
Avg merge
1d 12h
Merged PRs (30d)
247

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from wso2/api-platform

All issues in wso2/api-platform

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.