Allow HTTPS for WebSub hub topic operations from gateway-controller
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 47/100
Research direction
Start with gateway/gateway-controller/pkg/utils/api_deployment.go and trace how the router's WebSub hub listener ports and HTTPS settings are configured. Then read EventGatewayConfig.Validate() and the related configuration and tests to see how options are loaded and checked. Done means the scheme, port and CA settings are covered, HTTPS verifies the router certificate, and invalid or disabled HTTPS configurations are rejected.
Written by the indexing model from the issue text.
Description
Please select the area the issue is related to
Gateway, Event Gateway
Please select the aspect the issue is related to
Aspect/Other (Anything else which does not match above categories)
Suggested Improvement
The gateway-controller registers and deregisters WebSub hub topics by sending a request to the router's internal WebSub hub listener. The URL's scheme is hard-coded to http:
// gateway/gateway-controller/pkg/utils/api_deployment.go
targetURL := fmt.Sprintf("http://%s:%d/websubhub/operations", webSubHubHost, webSubPort)
The router already exposes an HTTPS version of this internal listener on port 8446 (WEBSUB_HUB_INTERNAL_HTTPS_PORT) when HTTPS is enabled. Because the scheme is fixed, the controller can't use it. Deployments that want this traffic over TLS have no supported way to do that, for example when the controller and router run as separate containers or pods instead of sharing localhost.
Proposed Change
- Add a config option under router.event_gateway that selects the scheme, e.g. websub_hub_listener_scheme = "http" | "https". Default to http so existing deployments behave the same.
- When it's set to https:
- Build the target URL with https:// and default the port to 8446 unless one is configured.
- Use an HTTP client whose TLS settings trust the router's certificate. Allow a configurable CA bundle, and don't skip certificate verification.
- Validate the new option in EventGatewayConfig.Validate(). Reject unknown schemes, and reject https when the router's HTTPS listener isn't enabled.
Related Issues
No response
- 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
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from wso2/api-platform
-
Area/DeveloperPortal Aspect/UI Severity/Minor Type/Bug
Difficulty 1/5 Under an hour Newbie friendliness 88/100
wso2/api-platform#4369 ·
Maintainers usually reply within 1 day
-
[Bug]: host-rewrite policy documentation lists fewer allowed host characters than the policy acceptsOpenArea/Policies Aspect/Other Severity/Trivial Type/Bug
Difficulty 1/5 Under an hour Newbie friendliness 91/100
wso2/api-platform#4355 ·
Maintainers usually reply within 1 day
-
Area/Gateway Aspect/API Severity/Minor Type/Bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
wso2/api-platform#4348 ·
Maintainers usually reply within 1 day
-
Aspect/AI Aspect/API. Severity/Major
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
wso2/api-platform#4343 ·
Maintainers usually reply within 1 day
-
Area/Policies Aspect/Configuration Severity/Minor Type/Bug
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
wso2/api-platform#4330 ·
Maintainers usually reply within 1 day
All issues in wso2/api-platform
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Inconsistency between golang and cue in specPossibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
security
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
Tencent/LoopForge#1087 · 1 comment ·
Maintainers usually reply within 1 day