WIP: Agenting refactoring attempt #272
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
The readSchemaPath function now properly handles relative file paths (e.g., those created with __SOURCE_DIRECTORY__) by attempting to resolve them to absolute paths before treating them as remote URLs. This ensures paths like '__SOURCE_DIRECTORY__ + "/../Schemas/v2/petstore.json"' are correctly recognized as local files instead of being rejected by SSRF validation.
Merge path resolution into readSchemaPath to eliminate redundant calls and improve code clarity: - Move getAbsolutePath logic into readSchemaPath, making it fully self-contained - Remove dead code path that attempted to re-resolve with empty resolutionFolder - Rename Cache modules to SwaggerCache and OpenApiCache to avoid naming conflicts - Update test calls to pass resolutionFolder parameter - All 274 tests pass (116 unit + 158 integration)
There was a problem hiding this comment.
Pull Request Overview
This PR adds SSRF (Server-Side Request Forgery) protection to SwaggerProvider by restricting schema fetching to HTTPS URLs and blocking private/localhost IP addresses by default. A new SsrfProtection parameter (default true) allows developers to disable these restrictions for local development and testing.
Key changes:
- Added comprehensive URL validation to block unsafe schemes (file://, ftp://, gopher://, dict://), HTTP protocol, and private IP ranges (IPv4/IPv6)
- Introduced
SsrfProtectionstatic parameter for both SwaggerClientProvider and OpenApiClientProvider - Added content-type validation to prevent fetching non-schema files
- Updated test files to use
SsrfProtection=falsefor localhost connections
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
src/SwaggerProvider.DesignTime/Utils.fs |
Core SSRF validation logic with IP range checks and URL scheme filtering |
src/SwaggerProvider.DesignTime/Provider.SwaggerClient.fs |
Added SsrfProtection parameter and updated cache key |
src/SwaggerProvider.DesignTime/Provider.OpenApiClient.fs |
Added SsrfProtection parameter and renamed cache module |
tests/SwaggerProvider.Tests/SsrfSecurityTests.fs |
Comprehensive test suite covering SSRF protection scenarios |
tests/SwaggerProvider.Tests/SwaggerProvider.Tests.fsproj |
Added new test file to project |
tests/SwaggerProvider.ProviderTests/v2/Swashbuckle.ReturnControllers.Tests.fs |
Updated to disable SSRF protection for localhost |
tests/SwaggerProvider.ProviderTests/v3/Swashbuckle.ReturnControllers.Tests.fs |
Updated to disable SSRF protection for localhost |
docs/SwaggerClientProvider.md |
Documentation for SSRF protection feature |
docs/OpenApiClientProvider.md |
Documentation for SSRF protection feature |
README.md |
Added security notice about SSRF protection |
AGENTS.md |
Added comprehensive build/test/style guidelines |
.config/dotnet-tools.json |
Updated fantomas version |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.