Skip to content

Commit a4c0943

Browse files
authored
[docs] feat(csrf): add breaking change for csrf (#287)p
* [docs] feat(csrf): add breaking change for csrf (#287) * [docs] feat(csrf): review version on breaking changes (#287)
1 parent 7483fef commit a4c0943

2 files changed

Lines changed: 61 additions & 1 deletion

File tree

docs/deployment/breaking-changes.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ implemented.
1414
| [OpenCTI / OpenAEV compatibility](#octi-oaev-compatibility) | - | 2.2.0 |
1515
| [OpenAEV encryption of secret](#openaev-encryption) | - | 2.1.0 |
1616
| [OpenAEV renaming](#openaev-renaming) | 1.18.20 | 2.0.0 |
17+
| [OpenAEV CSRF](#openaev-csrf) | - | 2.3.4 |
1718

1819
## OpenAEV 2.2.0
1920

@@ -72,4 +73,17 @@ automated.
7273
Take note that the first startup can be longer, all modifications have to be applied, and it can take a bit longer than
7374
usual.
7475

75-
For more details, see [this migration guide](breaking-changes/2.0.0-openaev-renaming.md)
76+
For more details, see [this migration guide](breaking-changes/2.0.0-openaev-renaming.md)
77+
78+
## OpenAEV 2.3.4
79+
80+
### Introduction
81+
82+
<a id="openaev-csrf"></a>
83+
84+
#### OpenAEV CSRF protection for frontend API calls
85+
86+
Starting with **OpenAEV 2.3.4**, frontend-initiated API calls must include a valid CSRF token.
87+
To prevent API authentication and connection issues, make sure all ecosystem components are upgraded to versions compatible with OpenAEV 2.3.4.
88+
89+
For more details, see [this migration guide](breaking-changes/2.3.4-csrf-token-enforcement.md)
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# CSRF token enforcement for frontend API calls
2+
3+
!!! info ""
4+
5+
* **Introduced in**: `OpenAEV 2.3.4`
6+
7+
## Description of changes
8+
9+
Starting with **OpenAEV 2.3.4**, API calls initiated from the **OpenAEV frontend** must include a valid **CSRF token**.
10+
11+
This security change protects authenticated sessions against cross-site request forgery and affects request flows between the UI and backend APIs.
12+
13+
Components that interact with OpenAEV APIs through authenticated web sessions must support this CSRF mechanism.
14+
15+
## Impact
16+
17+
If some platform components are upgraded while others remain on older versions, API calls can fail during authentication or state-changing requests.
18+
19+
Typical symptoms include:
20+
21+
- `401 Unauthorized` responses
22+
- `403 Forbidden` responses (missing or invalid CSRF token)
23+
- Connector failures when creating, updating, or triggering operations through the OpenAEV API
24+
25+
## Migration guide
26+
27+
To avoid service disruption, upgrade all OpenAEV ecosystem components together to versions compatible with **OpenAEV 2.3.4**.
28+
29+
This includes, at minimum:
30+
31+
- Injectors
32+
- Collectors
33+
- Agents
34+
- Connectors
35+
- Any custom integration using authenticated frontend/API flows
36+
37+
!!! warning
38+
39+
Do not run mixed versions in production (for example: OpenAEV `2.3.4` with older injectors or collectors). Upgrade all components in the same maintenance window.
40+
41+
## Validation checklist after upgrade
42+
43+
1. Log in to the OpenAEV UI and trigger a standard action (for example, launch an inject or collect data).
44+
2. Confirm the action succeeds without authentication errors.
45+
3. Check platform and connector logs for `401`/`403` responses.
46+
4. Verify that no component reports API connection failures.

0 commit comments

Comments
 (0)