This repository was archived by the owner on Jun 30, 2026. It is now read-only.
Repository navigation
[docs] feat(csrf): add breaking change for csrf (#287) #288
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
46 changes: 46 additions & 0 deletions
46
docs/deployment/breaking-changes/2.3.3-csrf-token-enforcement.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # CSRF token enforcement for frontend API calls | ||
|
|
||
| !!! info "" | ||
|
|
||
| * **Introduced in**: `OpenAEV 2.3.3` | ||
|
gabriel-peze marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## Description of changes | ||
|
|
||
| Starting with **OpenAEV 2.3.3**, API calls initiated from the **OpenAEV frontend** must include a valid **CSRF token**. | ||
|
gabriel-peze marked this conversation as resolved.
Outdated
|
||
|
|
||
| This security change protects authenticated sessions against cross-site request forgery and affects request flows between the UI and backend APIs. | ||
|
|
||
| Components that interact with OpenAEV APIs through authenticated web sessions must support this CSRF mechanism. | ||
|
|
||
| ## Impact | ||
|
|
||
| If some platform components are upgraded while others remain on older versions, API calls can fail during authentication or state-changing requests. | ||
|
|
||
| Typical symptoms include: | ||
|
|
||
| - `401 Unauthorized` responses | ||
| - `403 Forbidden` responses (missing or invalid CSRF token) | ||
| - Connector failures when creating, updating, or triggering operations through the OpenAEV API | ||
|
|
||
| ## Migration guide | ||
|
|
||
| To avoid service disruption, upgrade all OpenAEV ecosystem components together to versions compatible with **OpenAEV 2.3.3**. | ||
|
|
||
| This includes, at minimum: | ||
|
|
||
| - Injectors | ||
| - Collectors | ||
| - Agents | ||
| - Connectors | ||
| - Any custom integration using authenticated frontend/API flows | ||
|
|
||
| !!! warning | ||
|
|
||
| Do not run mixed versions in production (for example: OpenAEV `2.3.3` with older injectors or collectors). Upgrade all components in the same maintenance window. | ||
|
gabriel-peze marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## Validation checklist after upgrade | ||
|
|
||
| 1. Log in to the OpenAEV UI and trigger a standard action (for example, launch an inject or collect data). | ||
| 2. Confirm the action succeeds without authentication errors. | ||
| 3. Check platform and connector logs for `401`/`403` responses. | ||
| 4. Verify that no component reports API connection failures. | ||
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.
Uh oh!
There was an error while loading. Please reload this page.