Enforce size limit on POST /api/fleet/uploads

[ycombinator]

What is the problem this PR solves?

// Please do not just reference an issue. Explain WHAT the problem this PR solves here.

This PR prevents request bodies of arbitrarily large size to be sent to the POST /api/fleet/uploads API.

How does this PR solve the problem?

// Explain HOW you solved the problem in your code. It is possible that during PR reviews this changes and then this section should be updated.

This PR checks the size of the request body sent to the POST /api/fleet/uploads API and, if it exceeds the configured limit, rejects the request, responding with an HTTP 413 Request Entity Too Large status code. By default, the limit is configured to 5MiB but can be overridden in the Fleet Server input configuration via the server.limits.upload_start_limit.max_body_byte_size setting.

How to test this PR locally

Design Checklist

• I have ensured my design is stateless and will work when multiple fleet-server instances are behind a load balancer.
• I have or intend to scale test my changes, ensuring it will work reliably with 100K+ agents connected.
• I have included fail safe mechanisms to limit the load on fleet-server: rate limiting, circuit breakers, caching, load shedding, etc.

Checklist

• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• I have made corresponding change to the default configuration files
• I have added tests that prove my fix is effective or that my feature works
• I have added an entry in ./changelog/fragments using the changelog tool

Related issues

[mergify]

This pull request does not have a backport label. Could you fix it @ycombinator? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

• backport-./d./d is the label to automatically backport to the 8./d branch. /d is the digit
• backport-active-all is the label that automatically backports to all active branches.
• backport-active-8 is the label that automatically backports to all active minor branches for the 8 major.
• backport-active-9 is the label that automatically backports to all active minor branches for the 9 major.

[pzl]

looks good

pointed out a few places where names or messages were unclear if it was describing large files (.i.e. a file itself being like 3GB with config set lower, and either rejecting file body bytes above that; or when reading this json file-description payload, looking at file.size property and rejecting for that limit). Whereas this is the limit placed on the total JSON payload body of file metadata / header.

The diff in isolation is clear which is being addressed, but down the road I can see this being an easy mixup, which thing is "too large": the file contents itself or the start / header payload.

[michel-laterman]

Do we also want to use the config vars for upload finailize and chunks?

[ycombinator]

Do we also want to use the config vars for upload finailize and chunks?

Sure, I think this makes sense. Will update PR.

[ycombinator]

Do we also want to use the config vars for upload finailize and chunks?

Implemented request body size limit for upload finalize API in 3fbd7c7.

For the upload chunk API, I'm seeing this check already:

fleet-server/internal/pkg/api/handleUpload.go

Lines 130 to 131 in acc7110

	// prevent over-sized chunks
	data := http.MaxBytesReader(w, r.Body, file.MaxChunkSize)

Do we need/want to do more?

[michel-laterman]

@pzl, should we allow for users to specify a custom value for file chunk size?

[pzl]

@pzl, should we allow for users to specify a custom value for file chunk size?

Probably not a good idea without specific reason. This size was chosen quite specifically. A non-exhaustive list of concerns:

1. 4 MiB must remain a hard maximum. There are interconnects with kibana that depend on this
2. Setting the value low can drastically change the network traffic. Even dropping half to 2MiB doubles the amount of chunks. Lower than that can really balloon the amount of requests
3. Setting the value low also changes how many documents are used in elasticsearch. Spreading a document out among many many documents is less efficient, and may cause other issues.

[github-actions]

@Mergifyio backport 8.19 9.2 9.3

[mergify]

backport 8.19 9.2 9.3

✅ Backports have been created

Details

• #6234 [8.19](backport #6159) Enforce size limit on POST /api/fleet/uploads has been created for branch 8.19 but encountered conflicts

Cherry-pick of b91dc36 has failed:

On branch mergify/bp/8.19/pr-6159
Your branch is up to date with 'origin/8.19'.

You are currently cherry-picking commit b91dc36.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	new file:   changelog/fragments/1767789965-upload-limit.yaml
	modified:   internal/pkg/api/error.go
	modified:   internal/pkg/api/handleUpload.go
	modified:   internal/pkg/file/uploader/upload.go

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   internal/pkg/api/handleUpload_test.go

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

• #6235 [9.2](backport #6159) Enforce size limit on POST /api/fleet/uploads has been created for branch 9.2 but encountered conflicts

Cherry-pick of b91dc36 has failed:

On branch mergify/bp/9.2/pr-6159
Your branch is up to date with 'origin/9.2'.

You are currently cherry-picking commit b91dc36.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	new file:   changelog/fragments/1767789965-upload-limit.yaml
	modified:   internal/pkg/api/error.go
	modified:   internal/pkg/api/handleUpload.go
	modified:   internal/pkg/file/uploader/upload.go

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   internal/pkg/api/handleUpload_test.go

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

• #6236 [9.3](backport #6159) Enforce size limit on POST /api/fleet/uploads has been created for branch 9.3