diff --git a/docs/deployment/breaking-changes.md b/docs/deployment/breaking-changes.md index 47086ba9..4cae4837 100644 --- a/docs/deployment/breaking-changes.md +++ b/docs/deployment/breaking-changes.md @@ -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 + + + +#### 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 @@ -20,7 +46,9 @@ This table regroups all the breaking changes introduced, with the corresponding #### 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) @@ -29,14 +57,19 @@ For more details, see [this migration guide](breaking-changes/2.1.0-encrypting-p ### Deprecation + #### 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) \ No newline at end of file diff --git a/docs/deployment/breaking-changes/2.2.0-opencti-security-coverage.md b/docs/deployment/breaking-changes/2.2.0-opencti-security-coverage.md new file mode 100644 index 00000000..dbfdd732 --- /dev/null +++ b/docs/deployment/breaking-changes/2.2.0-opencti-security-coverage.md @@ -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. diff --git a/mkdocs.yml b/mkdocs.yml index 579624d7..f4fa6f80 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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: diff --git a/overrides/main.html b/overrides/main.html index cd225043..33f9a33d 100644 --- a/overrides/main.html +++ b/overrides/main.html @@ -8,8 +8,8 @@ {% endblock %} {% block announce %} -Breaking Changes in OpenAEV 2.1 - +Breaking Changes in OpenAEV 2.2.0 — Resolved in 2.2.1 + Click here to go to the migration guide. {% endblock %} \ No newline at end of file