[Bug]: [API Portal] REST API accepts view handles that are not URL-safe

オープン
#4,142 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
半日
初心者へのやさしさ
62/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
javascript, openapi
領域
api

調査の方向性

Start with addView in portals/api-portal/src/services/apiMetadataService.js near line 1606, which copies req.body.id into handle unvalidated. Then check ViewCreateRequest.id in portals/api-portal/resources/openapi/api-portal-openapi-spec-v0.9.yaml near line 7926 and add a pattern matching the Settings UI rule. Done when POST with uppercase, spaced or slashed handles returns 400 and nothing is stored, and the same rule applies in updateView. Existing invalid views are a separate decision.

索引モデルが issue の本文から書いたものです。

説明

Aspect/API Severity/Minor 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/views stores the view handle (id) exactly as sent, without validating it. Handles with uppercase letters, spaces or slashes are accepted with 201.

The handle becomes part of the view's URL (/views/<handle>/...), so it must be URL-safe. The Settings UI enforces this with "Handle must be lowercase letters, numbers and hyphens only.", but the REST API doesn't, so scripts and other API clients can create views the UI would refuse.

Expected: each invalid handle is refused with 400, and nothing is stored.

Actual: each invalid handle gets 201 and can be read back with 200.

Handle sent Problem POST /views GET /views/<encoded handle>
Manual-Upper-View Not lowercase 201 200
manual-spaced view Contains a space 201 200
manual-slash/apis Contains a slash 201 200

Impact

  • A slash reads as another URL path segment, and a space has to be encoded, so these handles don't work as normal view URLs.
  • Mixed-case handles are inconsistent with the lowercase handles the portal generates.
  • The Settings form validates the handle on save, so it refuses to save a view with an invalid handle until the handle is changed.

Cause

  • addView copies req.body.id into handle without validation (portals/api-portal/src/services/apiMetadataService.js:1606).
  • ViewCreateRequest.id has no pattern and is documented as "stored as-is", so the OpenAPI request validator allows it (portals/api-portal/resources/openapi/api-portal-openapi-spec-v0.9.yaml:7926).

Suggested fix

  • Add a pattern to ViewCreateRequest.id that matches the rule the UI enforces, and remove "stored as-is" from its description.
  • Apply the same rule to handle changes in updateView and to any other path that creates views.
  • Decide separately how to handle views already stored with invalid handles.
Steps to Reproduce
  1. Get a bearer token for an administrator and set BASE to the portal's REST API, for example https://localhost:9543/api-portal/api/v0.9.

  2. Create a view with a valid handle as a control. It returns 201.

    curl -sk -w '\nHTTP %{http_code}\n' -X POST "$BASE/views" \
      -H "Authorization: Bearer $ADMIN_TOKEN" -H 'Content-Type: application/json' \
      -d '{"id":"manual-valid-view","displayName":"Valid View"}'
    
  3. Create a view with an uppercase handle. It returns 201; 400 is expected.

    curl -sk -w '\nHTTP %{http_code}\n' -X POST "$BASE/views" \
      -H "Authorization: Bearer $ADMIN_TOKEN" -H 'Content-Type: application/json' \
      -d '{"id":"Manual-Upper-View","displayName":"Refused View"}'
    
  4. Read it back. It returns 200; 404 is expected.

    curl -sk -w '\nHTTP %{http_code}\n' "$BASE/views/Manual-Upper-View" -H "Authorization: Bearer $ADMIN_TOKEN"
    
  5. Repeat steps 3 and 4 with manual-spaced view (read back as manual-spaced%20view) and manual-slash/apis (read back as manual-slash%2Fapis). The results are the same.

Severity Level of the Issue

Severity/Minor (Non-critical functionality. Can be fixed in future releases)

Environment Details (with versions)
  • API Portal 1.1.0-m6-SNAPSHOT, built locally from source
  • Platform API 0.17.0-SNAPSHOT, for sign-in
  • SQLite, running with Docker Compose on macOS
主要言語
Go
スター
85
フォーク
137
平均マージ
1日 12時間
マージ済み PR(30日)
247

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

wso2/api-platform のほかの issue

wso2/api-platform の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。