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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# OpenBAS Documentation Space
# OpenAEV Documentation Space

[![Website](https://img.shields.io/badge/website-openbas.io-blue.svg)](https://openbas.io)
[![Website](https://img.shields.io/badge/website-openaev.io-blue.svg)](https://openaev.io)
[![Slack Status](https://img.shields.io/badge/slack-3K%2B%20members-4A154B)](https://community.filigran.io)

## Introduction

This is the main repository of the OpenBAS Documentation space. The online version is available directly on [docs.openbas.io](https://docs.openbas.io).
This is the main repository of the OpenAEV Documentation space. The online version is available directly on [docs.openaev.io](https://docs.openaev.io).

## Development (local setup)
### Prerequisites
Expand All @@ -28,7 +28,7 @@ Please follow the Manual instructions below.
### Alternative: manual local build and serve
Clone the repository:
```shell
$ git clone [email protected]:OpenBAS-Platform/docs.git
$ git clone [email protected]:OpenAEV-Platform/docs.git
```

Install dependencies; consider a virtual environment for doing so
Expand Down
Binary file removed docs/administration/assets/agent_assets_status.png
Binary file not shown.
Binary file modified docs/administration/assets/enterprise-activate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/administration/assets/enterprise-license-agreement.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/administration/assets/login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 14 additions & 14 deletions docs/administration/enterprise.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
!!! tip "Filigran"

[Filigran](https://filigran.io) is providing an [Enterprise Edition](https://filigran.io/offerings/openbas-enterprise-edition) of the platform, whether [on-premise](https://filigran.io/offerings/professional-support-packages) or in the [SaaS](https://filigran.io/offerings/software-as-a-service).
[Filigran](https://filigran.io) is providing an [Enterprise Edition](https://filigran.io/offerings/openaev-enterprise-edition) of the platform, whether [on-premise](https://filigran.io/offerings/professional-support-packages) or in the [SaaS](https://filigran.io/offerings/software-as-a-service).

## What is OpenBAS EE?
## What is OpenAEV EE?

OpenBAS Enterprise Edition is based on the open core concept. This means that the source code of OBAS EE remains open
OpenAEV Enterprise Edition is based on the open core concept. This means that the source code of OBAS EE remains open
source and included in the main GitHub repository of the platform but is published under a specific license. As
specified in the GitHub license file:

- The OpenBAS Community Edition is licensed under the Apache License, Version 2.0 (the “Apache License”).
- The OpenBAS Enterprise Edition is licensed under the OpenBAS Enterprise Edition License (the “Enterprise Edition
- The OpenAEV Community Edition is licensed under the Apache License, Version 2.0 (the “Apache License”).
- The OpenAEV Enterprise Edition is licensed under the OpenAEV Enterprise Edition License (the “Enterprise Edition
Licensee”).

The source files in this repository have a header indicating which license they are under. If no such header is
Expand All @@ -20,18 +20,18 @@ provided, this means that the file belongs to the Community Edition under the Ap
Enterprise edition is easy to activate. You need to go the platform settings and click on the "Manage your Enterprise
Edition License" button.

![OpenBAS activation](assets/enterprise-activate.png)
![OpenAEV activation](assets/enterprise-activate.png)

Then you will need to put a valid OpenBAS EE license. If you don't have it, you
Then you will need to put a valid OpenAEV EE license. If you don't have it, you
can [generate a trial license](https://filigran.io/enterprise-editions-trial/).

![OpenBAS EE EULA](assets/enterprise-license-agreement.png)
![OpenAEV EE EULA](assets/enterprise-license-agreement.png)

As a reminder:

- OpenBAS EE is free-to-use for development, testing and research purposes as well as for non-profit organizations.
- OpenBAS EE is included for all Filigran SaaS customers without additional fee.
- **For all other usages, OpenBAS EE is reserved to organizations that have signed a Filigran Enterprise agreement.**
- OpenAEV EE is free-to-use for development, testing and research purposes as well as for non-profit organizations.
- OpenAEV EE is included for all Filigran SaaS customers without additional fee.
- **For all other usages, OpenAEV EE is reserved to organizations that have signed a Filigran Enterprise agreement.**

## Available features

Expand All @@ -42,12 +42,12 @@ Be able to use AI for content generation including emails, media pressure articl
### CrowdStrike Falcon Agent

The CrowdStrike Falcon Agent can be leveraged to execute implants as detached processes that will then execute payloads
according to the [OpenBas architecture](../../deployment/overview/#architecture)
according to the [OpenAEV architecture](../deployment/platform/overview.md#architecture)

### Tanium Agent

The Tanium Agent can be leveraged to execute implants as detached processes that will then execute payloads
according to the [OpenBas architecture](../../deployment/overview/#architecture)
according to the [OpenAEV architecture](../deployment/platform/overview.md#architecture)

## Remediations in CVES

Expand All @@ -61,7 +61,7 @@ and [Atomic testing remediations](../usage/atomic.md).

## More to come

More features will be available in OpenBAS in the future. Features like:
More features will be available in OpenAEV in the future. Features like:

- Security posture automatic evaluation.
- Premium mitigations and recommendation for configuration changes.
2 changes: 1 addition & 1 deletion docs/administration/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

!!! tip "Under construction"

We are doing our best to complete this page. If you want to participate, don't hesitate to join the [Filigran Community on Slack](https://community.filigran.io) or submit your pull request on the [Github doc repository](https://github.com/OpenBAS-Platform/docs).
We are doing our best to complete this page. If you want to participate, don't hesitate to join the [Filigran Community on Slack](https://community.filigran.io) or submit your pull request on the [Github doc repository](https://github.com/OpenAEV-Platform/docs).
2 changes: 1 addition & 1 deletion docs/administration/parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

!!! tip "Under construction"

We are doing our best to complete this page. If you want to participate, don't hesitate to join the [Filigran Community on Slack](https://community.filigran.io) or submit your pull request on the [Github doc repository](https://github.com/OpenBAS-Platform/docs).
We are doing our best to complete this page. If you want to participate, don't hesitate to join the [Filigran Community on Slack](https://community.filigran.io) or submit your pull request on the [Github doc repository](https://github.com/OpenAEV-Platform/docs).
14 changes: 7 additions & 7 deletions docs/administration/taxonomies.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# Taxonomies

Taxonomies in OpenBAS refer to the structured classification systems that help in organizing and categorizing platform
Taxonomies in OpenAEV refer to the structured classification systems that help in organizing and categorizing platform
data. They are essential to the platform, enabling users to systematically tag and retrieve information based on
predefined categories and terms.

## Tags

Tags in OpenBAS serve as a powerful tool for organizing, categorizing, and prioritizing data.
Tags in OpenAEV serve as a powerful tool for organizing, categorizing, and prioritizing data.

Tags can be used to tag assets or teams with specific categories, making it easier to filter and search through large
datasets.

## Kill chain phases

Kill chain phases are used in OpenBAS to structure and analyze the data related to cyber threats and attacks. They
Kill chain phases are used in OpenAEV to structure and analyze the data related to cyber threats and attacks. They
describe the stages of an attack from the perspective of the attacker and provide a framework for identifying, analysing
and responding to threats.

OpenBAS supports the following kill chain models:
OpenAEV supports the following kill chain models:

- **MITRE ATT&CK Framework (Entreprise, PRE, Mobile and ICS)**

Expand All @@ -28,10 +28,10 @@ injects, simulations or scenarios.
## Attack Patterns

Attack patterns are structured representations of the tactics, techniques, and procedures (TTPs) used by adversaries to
compromise systems. In OpenBAS, attack patterns help analyze and classify threats, providing a standardized approach to
compromise systems. In OpenAEV, attack patterns help analyze and classify threats, providing a standardized approach to
identifying and mitigating cyber risks.

OpenBAS supports the following attack pattern models:
OpenAEV supports the following attack pattern models:

- **MITRE ATT&CK Framework (Enterprise, PRE, Mobile, and ICS)**

Expand All @@ -43,7 +43,7 @@ CVEs (Common Vulnerabilities and Exposures) are standardized identifiers for pub
vulnerabilities. Each CVE provides a unique reference, enabling consistent communication and tracking across tools and
teams.

In OpenBAS, CVEs are used to associate known vulnerabilities with assets, payloads, and injects. This allows users to
In OpenAEV, CVEs are used to associate known vulnerabilities with assets, payloads, and injects. This allows users to
simulate attacks based on real-world flaws, enhancing the relevance and precision of security testing.

You can add, edit, or delete CVEs.
2 changes: 1 addition & 1 deletion docs/administration/users_and_rbac.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Users

You can manage users in `Settings > Security > Users`. If you are using Single Sign-On (SSO), user accounts in OpenBAS are automatically created upon login.
You can manage users in `Settings > Security > Users`. If you are using Single Sign-On (SSO), user accounts in OpenAEV are automatically created upon login.

![User list](assets/user-list.png)

Expand Down
Binary file modified docs/assets/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/deployment/assets/agents.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
47 changes: 19 additions & 28 deletions docs/deployment/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,29 @@

## Introduction

Welcome to the authentication documentation for OpenBAS. This documentation provides details on setting up and utilizing the authentication system, which supports multiple authentication methods to cater to different user needs and security requirements.
This documentation provides details on setting up and utilizing the authentication system, which supports multiple authentication methods to cater to different user needs and security requirements.

## Supported authentication methods

### Local users
!!! tip "Production deployment"

OpenBAS use this strategy as the default, but it's not the one we recommend for security reasons.
Please use the LDAP/Auth0/OpenID/SAML strategy for production deployment.

| Parameter | Environment variable | Default value | Description |
|:-------------------------------|:-------------------------------|:----------------------|:--------------------------------------------------------------|
| openbas.auth-local-enable | OPENBAS_AUTH-LOCAL-ENABLE | true | Set this to `true` to enable username/password authentication. |
### Local users

!!! tip "Production deployment"
OpenAEV use this strategy as the default, but it's not the one we recommend for security reasons.

Please use the LDAP/Auth0/OpenID/SAML strategy for production deployment.
| Parameter | Environment variable | Default value | Description |
|:--------------------------|:--------------------------|:----------------------|:--------------------------------------------------------------|
| openaev.auth-local-enable | OPENAEV_AUTH-LOCAL-ENABLE | true | Set this to `true` to enable username/password authentication. |

### OpenID

This method allows to use the [OpenID Connect Protocol](https://openid.net/connect) to handle the authentication.

| Parameter | Environment variable | Default value | Description |
|:-------------------------------|:-------------------------------|:----------------------|:--------------------------------------------------------------|
| openbas.auth-openid-enable | OPENBAS_AUTH-OPENID-ENABLE | false | Set this to `true` to enable OAuth (OpenID) authentication. |
| Parameter | Environment variable | Default value | Description |
|:-------------------------------|:---------------------------|:----------------------|:--------------------------------------------------------------|
| openaev.auth-openid-enable | OPENAEV_AUTH-OPENID-ENABLE | false | Set this to `true` to enable OAuth (OpenID) authentication. |

Example for Auth0:

Expand All @@ -33,7 +33,7 @@ SPRING_SECURITY_OAUTH2_CLIENT_PROVIDER_{registrationId}_ISSUER-URI=https://auth.
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_{registrationId}_CLIENT-NAME=Login with auth0
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_{registrationId}_CLIENT-ID=
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_{registrationId}_CLIENT-SECRET=
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_{registrationId}_REDIRECT-URI=${openbas.base-url}/login/oauth2/code/{registrationId}
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_{registrationId}_REDIRECT-URI=${openaev.base-url}/login/oauth2/code/{registrationId}
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_{registrationId}_SCOPE=openid,profile,email
```

Expand All @@ -55,14 +55,14 @@ This strategy can be used to authenticate your user with your company SAML.

| Parameter | Environment variable | Default value | Description |
|:-------------------------------|:-------------------------------|:----------------------|:--------------------------------------------------------------|
| openbas.auth-saml2-enable | OPENBAS_AUTH-SAML2-ENABLE | false | Set this to `true` to enable SAML2 authentication. |
| openaev.auth-saml2-enable | OPENAEV_AUTH-SAML2-ENABLE | false | Set this to `true` to enable SAML2 authentication. |

Example for Microsoft :
```properties
SPRING_SECURITY_SAML2_RELYINGPARTY_REGISTRATION_{registrationId}_ENTITY-ID=
SPRING_SECURITY_SAML2_RELYINGPARTY_REGISTRATION_{registrationId}_ASSERTINGPARTY_METADATA-URI=
OPENBAS_PROVIDER_{registrationId}_FIRSTNAME_ATTRIBUTE_KEY=
OPENBAS_PROVIDER_{registrationId}_LASTNAME_ATTRIBUTE_KEY=
OPENAEV_PROVIDER_{registrationId}_FIRSTNAME_ATTRIBUTE_KEY=
OPENAEV_PROVIDER_{registrationId}_LASTNAME_ATTRIBUTE_KEY=
```

!!! tip "Tips"
Expand All @@ -76,25 +76,16 @@ OPENBAS_PROVIDER_{registrationId}_LASTNAME_ATTRIBUTE_KEY=

Url for the config of your sso provider
```
${openbas.base-url}/login/saml2/sso/{registrationId}
${openaev.base-url}/login/saml2/sso/{registrationId}
```

### Map administrators to specific roles (OpenID and SAML 2)

To grant administrative roles, you can utilize OAuth and SAML2 integration. If you opt for this approach, you'll need to include the following variables:

```properties
OPENBAS_PROVIDER_{registrationId}_ROLES_PATH=http://schemas.microsoft.com/ws/2008/06/identity/claims/role
OPENBAS_PROVIDER_{registrationId}_ROLES_ADMIN=
OPENAEV_PROVIDER_{registrationId}_ROLES_PATH=http://schemas.microsoft.com/ws/2008/06/identity/claims/role
OPENAEV_PROVIDER_{registrationId}_ROLES_ADMIN=
```

However, if you intend to manage administrative roles within the OpenBAS platform itself, there's no need to provide these variables.


## Error Handling

!!! tip "Under construction"

We are doing our best to complete this page.
If you want to participae, dont hesitate to join the [Filigran Community on Slack](https://community.filigran.io)
or submit your pull request on the [Github doc repository](https://github.com/OpenBAS-Platform/docs).
However, if you intend to manage administrative roles within the OpenAEV platform itself, there's no need to provide these variables.
5 changes: 0 additions & 5 deletions docs/deployment/clustering.md

This file was deleted.

Loading