feat(webapi): Limit Content-Length / request body size

oskogstad commented 2 weeks ago

Description

Large request bodies can be used as a form of DDOS, especially when it comes to transmissions because they have a more complex hierarchy validation Limiting the body size on requests to 100 kB

Related Issue(s)

1415

Verification

[ ] Your code builds clean without any errors or warnings
[ ] Manual testing done (required)
[ ] Relevant automated test added (if you find this hard, leave it and we'll help out)

Documentation

[ ] Documentation is updated (either in docs-directory, Altinnpedia or a separate linked PR in altinn-studio-docs., if applicable)

Summary by CodeRabbit

New Features
- Introduced a maximum request body size limit to enhance server request handling.
Bug Fixes
- Improved error handling for invalid endUserId and unknown user types, providing more informative responses.
- Standardized response generation for various error scenarios in the PatchDialogsController.
Documentation
- Enhanced clarity in error handling processes across multiple middleware components.
Refactor
- Streamlined error response construction methods for consistency and efficiency.

coderabbitai[bot] commented 2 weeks ago

📝 Walkthrough

## Walkthrough The pull request introduces several modifications across multiple classes, primarily focusing on error handling improvements. Changes include the implementation of a new response handling method, `GetResponseOrDefault`, which replaces the previous `ResponseBuilder` method in various middleware and controller classes. Additionally, a new constant defining the maximum request body size is introduced. Overall, the changes aim to standardize error responses and enhance the clarity of error handling across the application. ## Changes | File Path | Change Summary | |-------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | src/Digdir.Domain.Dialogporten.WebApi/Common/Authentication/ServiceOwnerOnBehalfOfPersonMiddleware.cs | Modified `InvokeAsync` method to use `context.GetResponseOrDefault` for JSON responses when `endUserId` is invalid. | | src/Digdir.Domain.Dialogporten.WebApi/Common/Authentication/UserTypeValidationMiddleware.cs | Updated `InvokeAsync` method to utilize `context.GetResponseOrDefault` for responses when user type is `UserIdType.Unknown`. | | src/Digdir.Domain.Dialogporten.WebApi/Common/Constants.cs | Added new constant: `internal const int MaxRequestBodySize = 100_000;`. | | src/Digdir.Domain.Dialogporten.WebApi/Common/Extensions/ErrorResponseBuilderExtensions.cs | Replaced `ResponseBuilder` with `DefaultResponse` method; added `GetResponseOrDefault` method; modified `ResponseBuilder` to return `ProblemDetails` instead of a generic object. | | src/Digdir.Domain.Dialogporten.WebApi/Common/Extensions/GlobalExceptionHandler.cs | Refactored `TryHandleAsync` method to use a switch expression for status code determination based on exception types, and introduced conditional logging based on response status code. | | src/Digdir.Domain.Dialogporten.WebApi/Endpoints/V1/ServiceOwner/Dialogs/Patch/PatchDialogsController.cs | Updated `Patch` method to use `HttpContext.GetResponseOrDefault` for constructing responses for various error scenarios (404, 400, 403, 422, 412). | | src/Digdir.Domain.Dialogporten.WebApi/Program.cs | Modified Kestrel server configuration to set `kestrelOptions.Limits.MaxRequestBodySize` to the new constant from `Constants`. | ## Possibly related PRs - **#1124**: The changes in the main PR regarding error handling in the `ServiceOwnerOnBehalfOfPersonMiddleware` class are related to similar modifications in the `UserTypeValidationMiddleware`, which also updates error handling logic using `context.GetResponseOrDefault`. - **#1158**: The `PatchDialogsController` updates its error handling to use `HttpContext.GetResponseOrDefault`, which aligns with the changes made in the main PR to streamline response handling for invalid `endUserId` values. - **#1359**: The changes in the main PR to modify serialization behavior for collections relate to the broader context of API response handling, which is also a focus in the PR that updates the OpenAPI schema to allow nullable properties, enhancing the flexibility of API responses. ## Suggested reviewers - MagnusSandgren - arealmaas

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.