Skip to content
Open
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
30 changes: 30 additions & 0 deletions docs/deployment/breaking-changes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Breaking changes and migrations

This section lists breaking changes introduced in OpenAEV, per version starting with the latest.

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.

| Change | Deprecated in | Changed in |
|:--------------------------------------|:--------------|:-----------|
| [OpenAEV renaming](#openaev-renaming) | 1.18.20 | 2.0.0 |

## OpenAEV 2.0.0

### Deprecation

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

Since OpenBAS (Open Breach & Attack Simulation) evolves, it became OpenAEV (Open Adversarial Exposure Validation).

This new 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 include manual modifications to upgrade from previous versions of OpenBAS, even if a lot have been automated.

Take note that the first start can be longer, all modifications have to apply, and it can take a few more time than usual.

For more details, see [this migration guide](breaking-changes/2.0.0-openaev-renaming.md)
54 changes: 54 additions & 0 deletions docs/deployment/breaking-changes/2.0.0-openaev-renaming.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# OpenAEV renaming

!!! info ""

* **Deprecated in**: `OpenBAS 1.18.20`
* **Removed in**: `OpenAEV 2.0.0`

## Description of changes

A lot of processes have been automated, but there are still little changes to do manually.

**OpenAEV namespace renaming**

All our Docker images have been moved to a new namespace. If you're using one of them, be careful to load them from the new [Docker repository](https://hub.docker.com/search?q=openaev)

**OpenAEV Configuration migration**

Check configuration consistency for SAML and global variables if used on your platform properties.

**CrowdStrike Response Scripts renaming**

Check configuration consistency for CrowdStrike if used on your platform properties.

**Agent updates**

Agent folders on Assets are automatically updated from OpenBAS to OpenAEV, except for agents installed in Advanced installation as User (service).

To avoid losing any data, the attack logs and execution files have not been deleted and are preserved in the old OpenBAS agent folder.
During the reinstallation of the new OpenAEV agent, a new agent is created on OpenAEV, rendering the old OpenBAS agents obsolete.


## Migration guide

**OpenAEV namespace renaming**

- If you're using our official [docker compose](https://github.com/OpenAEV-Platform/docker), be sure to use the platform image from the new OpenAEV Docker repository.

**OpenAEV Configuration migration**

- It should be automatic, but if you have any issue at startup, check if you are well synced with all new variables into the [documentation](../../deployment/configuration.md).
- If you use the SAML, be careful with the renaming variable names from OPENBAS_PROVIDER_XXX, to OPENAEV_PROVIDER_XXX. You can find more details on the [documentation](../../deployment/authentication.md).

**CrowdStrike Response Scripts renaming**

- If you use CrowdStrike Agents, be careful with the renaming variable response script names from "OpenBAS Subprocessor (XXX)"
, to "OpenAEV Subprocessor (XXX)". You can find more details on the [documentation](../../deployment/ecosystem/executors.md#crowdstrike-falcon-agent).

**Agent updates**

!!! warning

These tasks are only to be performed for agents installed in Advanced installation as User (service).

- Follow this [link](../../usage/openbas-agent.md) to uninstall (follow the instruction at the end of your operating system table) your OpenBAS Agent, and to install the new OpenAEV Agent.
2 changes: 1 addition & 1 deletion docs/deployment/ecosystem/executors.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ Endpoints from the selected computer groups should now appear in the **OpenBAS E
You are now ready to leverage your Tanium platform to run OpenBAS payloads!

---

<a id="crowdstrike-falcon-agent"></a>
## CrowdStrike Falcon Agent

The CrowdStrike Falcon agent can be leveraged to execute implants as detached processes that will then execute payloads
Expand Down
4 changes: 4 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,10 @@ nav:
- Platform managers: deployment/managers.md
- Clustering: deployment/clustering.md
- Troubleshooting: deployment/troubleshooting.md
- Breaking changes:
- Index: deployment/breaking-changes.md
- Migration guides:
- OpenAEV renaming: deployment/breaking-changes/2.0.0-openaev-renaming.md
- User Guide:
- Getting started: usage/getting-started.md
- Foundations:
Expand Down