Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 43 additions & 10 deletions docs/deployment/breaking-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,38 @@ Please follow the migration guides if you need to upgrade your platform.

## Breakdown per version

This table regroups all the breaking changes introduced, with the corresponding version in which the change was implemented.
This table regroups all the breaking changes introduced, with the corresponding version in which the change was
implemented.

| Change | Deprecated in | Changed in |
|:--------------------------------------|:--------------|:-----------|
| [OpenAEV encryption of secret](#openaev-encryption) | - | 2.1.0 |
| [OpenAEV renaming](#openaev-renaming) | 1.18.20 | 2.0.0 |
| Change | Deprecated in | Changed in |
|:------------------------------------------------------------|:--------------|:-----------|
| [OpenCTI / OpenAEV compatibility](#octi-oaev-compatibility) | - | 2.2.0 |
| [OpenAEV encryption of secret](#openaev-encryption) | - | 2.1.0 |
| [OpenAEV renaming](#openaev-renaming) | 1.18.20 | 2.0.0 |

## OpenAEV 2.2.0

### Introduction

<a id="octi-oaev-compatibility"></a>

#### Scenario Generation from OpenCTI Security Coverage

In **OpenAEV 2.2.0**, the interconnection between OpenCTI and OpenAEV requires matching major versions:

- **OpenAEV 2.2.0** only works with **OpenCTI V7**
- **OpenCTI V7** only works with **OpenAEV 2.2.0**

Due to API and interconnection changes introduced in OpenCTI V7, previous versions of OpenCTI are not compatible
with OpenAEV 2.2.0, and conversely, OpenCTI V7 is not compatible with earlier versions of OpenAEV.

!!! success "Resolved in OpenAEV 2.2.1"

Backwards compatibility with older OpenCTI versions has been restored starting from **OpenAEV 2.2.1**. This breaking change only affects **OpenAEV 2.2.0**.

If you are upgrading to OpenAEV 2.2.0, please make sure to upgrade both OpenCTI and OpenAEV simultaneously to avoid service disruption.

For more details, see [this migration guide](breaking-changes/2.2.0-opencti-security-coverage.md)

## OpenAEV 2.1.0

Expand All @@ -20,7 +46,9 @@ This table regroups all the breaking changes introduced, with the corresponding
<a id="openaev-encryption"></a>
#### OpenAEV encryption

With the introduction of the OpenAEV catalog, built-in connectors now store their configuration in the database. To ensure security, secrets and passwords within these configurations must be encrypted. This requires two new mandatory properties to be configured.
With the introduction of the OpenAEV catalog, built-in connectors now store their configuration in the database. To
ensure security, secrets and passwords within these configurations must be encrypted. This requires two new mandatory
properties to be configured.

For more details, see [this migration guide](breaking-changes/2.1.0-encrypting-password.md)

Expand All @@ -29,14 +57,19 @@ For more details, see [this migration guide](breaking-changes/2.1.0-encrypting-p
### Deprecation

<a id="openaev-renaming"></a>

#### OpenAEV renaming

Following the evolution of scope in OpenBAS (Open Breach & Attack Simulation), it was decided to rename the project to OpenAEV (Open Adversarial Exposure Validation).
Following the evolution of scope in OpenBAS (Open Breach & Attack Simulation), it was decided to rename the project to
OpenAEV (Open Adversarial Exposure Validation).

This platform allows you to entirely create custom attack scenarios to emulate on endpoints. You can even create your own automated tabletop crisis simulation.
This platform allows you to entirely create custom attack scenarios to emulate on endpoints. You can even create your
own automated tabletop crisis simulation.

All those changes require manual modifications to upgrade from previous versions of OpenBAS, even if a lot have been automated.
All those changes require manual modifications to upgrade from previous versions of OpenBAS, even if a lot have been
automated.

Take note that the first startup can be longer, all modifications have to be applied, and it can take a bit longer than usual.
Take note that the first startup can be longer, all modifications have to be applied, and it can take a bit longer than
usual.

For more details, see [this migration guide](breaking-changes/2.0.0-openaev-renaming.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Scenario Generation from OpenCTI Security Coverage

!!! info ""

* **Introduced in**: `OpenAEV 2.2.0`
* **Resolved in**: `OpenAEV 2.2.1`

## Description of changes

In **OpenAEV 2.2.0**, the interconnection between **OpenCTI** and **OpenAEV** requires matching major
versions:

- **OpenAEV 2.2.0** only works with **OpenCTI V7**
- **OpenCTI V7** only works with **OpenAEV 2.2.0**

Due to API and interconnection changes introduced in OpenCTI V7, previous versions of OpenCTI are not compatible
with OpenAEV 2.2.0, and conversely, OpenCTI V7 is not compatible with earlier versions of OpenAEV.

!!! success "Resolved in OpenAEV 2.2.1"

Backwards compatibility with older OpenCTI versions has been restored starting from **OpenAEV 2.2.1**. This breaking change only affects **OpenAEV 2.2.0**.

If you upgrade to OpenAEV 2.2.0 without upgrading OpenCTI, the interconnection will not function properly. Both
platforms
must be upgraded simultaneously when moving to OpenAEV 2.2.0.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ nav:
- Migration guides:
- OpenAEV renaming: deployment/breaking-changes/2.0.0-openaev-renaming.md
- OpenAEV encryption: deployment/breaking-changes/2.1.0-encrypting-password.md
- Scenario Generation from OpenCTI Security Coverage: deployment/breaking-changes/2.2.0-opencti-security-coverage.md
- User Guide:
- Getting started: usage/getting-started.md
- Foundations:
Expand Down
4 changes: 2 additions & 2 deletions overrides/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
{% endblock %}

{% block announce %}
Breaking Changes in OpenAEV 2.1
<a href="{{ '/2.1.X/deployment/breaking-changes/2.1.0-encrypting-password/' }}">
Breaking Changes in OpenAEV 2.2.0 — Resolved in 2.2.1
<a href="{{ '/2.1.X/deployment/breaking-changes/2.2.0-opencti-security-coverage/' }}">
<strong>Click here to go to the migration guide.</strong>
</a>
{% endblock %}