-
Notifications
You must be signed in to change notification settings - Fork 90
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ad0ec3b
commit 0f26f1a
Showing
8 changed files
with
165 additions
and
54 deletions.
There are no files selected for viewing
38 changes: 38 additions & 0 deletions
38
openbas-api/src/main/java/io/openbas/injectors/caldera/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # OpenBAS Caldera Injector | ||
|
|
||
| Table of Contents | ||
|
|
||
| - [OpenBAS Caldera Injector](#openbas-caldera-injector) | ||
| - [Prerequisites](#prerequisites) | ||
| - [Configuration variables](#configuration-variables) | ||
| - [Base injector environment variables](#base-injector-environment-variables) | ||
| - [Behavior](#behavior) | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| You need a caldera instance to be able to use this injector. | ||
|
|
||
| ## Configuration variables | ||
|
|
||
| There are a number of configuration options, which are set either in `docker-compose.yml` (for Docker) or | ||
| in `application.properties` (for manual deployment). | ||
|
|
||
| ### Base injector environment variables | ||
|
|
||
| Below are the parameters you'll need to set for running the injector properly: | ||
|
|
||
| | Parameter | application.properties | Docker environment variable | Mandatory | Description | | ||
| |-------------------------|-----------------------------|-------------------------------|-----------|----------------------------------------------------------| | ||
| | Enable Caldera injector | injector.caldera.enable | `INJECTOR_CALDERA_ENABLE` | Yes | Enable the Caldera. | | ||
| | Injector ID | injector.caldera.id | `INJECTOR_CALDERA_ID` | Yes | A unique `UUIDv4` identifier for this injector instance. | | ||
| | Caldera internal URL | injector.caldera.url | `INJECTOR_CALDERA_URL` | Yes | Internal URL of your Caldera instance. | | ||
| | Caldera public URL | injector.caldera.public-url | `INJECTOR_CALDERA_PUBLIC_URL` | Yes | Public URL of your Caldera instance. | | ||
| | Caldera Api Key | injector.caldera.api-key | `INJECTOR_CALDERA_API_KEY` | Yes | Api Key for communicate to your Caldera instance. | | ||
|
|
||
| ## Behavior | ||
|
|
||
| The Caldera injector is a built-in injector, meaning it is natively included in the platform and can be | ||
| enabled using configuration variables. | ||
|
|
||
| It allows you to collect all abilities from your caldera instance and use them directly in your OpenBAS scenarios and | ||
| simulations. |
12 changes: 12 additions & 0 deletions
12
openbas-api/src/main/java/io/openbas/injectors/challenge/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # OpenBAS Challenge Injector | ||
|
|
||
| Table of Contents | ||
|
|
||
| - [OpenBAS Challenge Injector](#openbas-challenge-injector) | ||
| - [Behavior](#behavior) | ||
|
|
||
| ## Behavior | ||
|
|
||
| The Challenge injector is a built-in injector, meaning it is natively included and enabled in the platform. | ||
|
|
||
| It allows you to create challenges and validate it directly in your OpenBAS scenarios and simulations. |
12 changes: 12 additions & 0 deletions
12
openbas-api/src/main/java/io/openbas/injectors/channel/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # OpenBAS Channel Injector | ||
|
|
||
| Table of Contents | ||
|
|
||
| - [OpenBAS Channel Injector](#openbas-channel-injector) | ||
| - [Behavior](#behavior) | ||
|
|
||
| ## Behavior | ||
|
|
||
| The Channel injector is a built-in injector, meaning it is natively included and enabled in the platform. | ||
|
|
||
| It allows you to simulate contextual pressure in your OpenBAS scenarios and simulations. |
12 changes: 12 additions & 0 deletions
12
openbas-api/src/main/java/io/openbas/injectors/email/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # OpenBAS Email Injector | ||
|
|
||
| Table of Contents | ||
|
|
||
| - [OpenBAS Email Injector](#openbas-email-injector) | ||
| - [Behavior](#behavior) | ||
|
|
||
| ## Behavior | ||
|
|
||
| The Email injector is a built-in injector, meaning it is natively included and enabled in the platform. | ||
|
|
||
| It allows you to send email to teams in your OpenBAS scenarios and simulations. |
45 changes: 26 additions & 19 deletions
45
openbas-api/src/main/java/io/openbas/injectors/lade/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,30 +1,37 @@ | ||
| # OpenBAS Airbus LADE Injector | ||
|
|
||
| The Airbus LADE injector is a built-in injector, meaning it is natively included in the platform and can be enabled using configuration variables. It allows you to use the various capabilities from the Airbus LADE directly in your OpenBAS scenarios and simulations. | ||
| Table of Contents | ||
|
|
||
| ## Summary | ||
| - [OpenBAS Airbus LADE Injector](#openbas-airbus-lade-injector) | ||
| - [Prerequisites](#prerequisites) | ||
| - [Configuration variables](#configuration-variables) | ||
| - [Base injector environment variables](#base-injector-environment-variables) | ||
| - [Behavior](#behavior) | ||
|
|
||
| - [Requirements](#requirements) | ||
| - [Configuration variables](#configuration-variables) | ||
| - [Behavior](#behavior) | ||
| - [Mapping](#mapping) | ||
| - [Sources](#sources) | ||
| ## Prerequisites | ||
|
|
||
| --- | ||
| You need an Airbus Lade instance to be able to use this injector. | ||
|
|
||
| ## Requirements | ||
| ## Configuration variables | ||
|
|
||
| - OpenBAS Platform version 1.0.3 or higher | ||
| - An Airbus LADE cyber range tenant | ||
| There are a number of configuration options, which are set either in `docker-compose.yml` (for Docker) or | ||
| in `application.properties` (for manual deployment). | ||
|
|
||
| ## Configuration variables | ||
| ### Base injector environment variables | ||
|
|
||
| Below are the properties you'll need to set for OpenBAS: | ||
|
|
||
| | Property | application.properties | Docker environment variable | Mandatory | Description | | ||
| |-----------------------------|------------------------------------------------------|-----------------------------|-----------|------------------------------------------| | ||
| | Enable Airbus LADE injector | lade.enable | `LADE_ENABLE` | Yes | Enable the Airbus LADE injector. | | ||
| | Airbus LADE URL | lade.url | `LADE_URL` | Yes | The URL of the Airbus LADE tenant. | | ||
| | Session duration | lade.session | `LADE_SESSION` | No | The duration of the session (technical). | | ||
| | Airbus LADE username | lade.username | `LADE_USERNAME` | Yes | The Airbus LADE tenant username. | | ||
| | Airbus LADE password | lade.password | `LADE_PASSWORD` | Yes | The Airbus LADE tenant password. | | ||
| | Parameter | application.properties | Docker environment variable | Mandatory | Description | | ||
| |-----------------------------|------------------------|-----------------------------|-----------|------------------------------------------| | ||
| | Enable Airbus LADE injector | lade.enable | `LADE_ENABLE` | Yes | Enable the Airbus LADE injector. | | ||
| | Airbus LADE URL | lade.url | `LADE_URL` | Yes | The URL of the Airbus LADE tenant. | | ||
| | Session duration | lade.session | `LADE_SESSION` | No | The duration of the session (technical). | | ||
| | Airbus LADE username | lade.username | `LADE_USERNAME` | Yes | The Airbus LADE tenant username. | | ||
| | Airbus LADE password | lade.password | `LADE_PASSWORD` | Yes | The Airbus LADE tenant password. | | ||
|
|
||
| ## Behavior | ||
|
|
||
| The Airbus LADE injector is a built-in injector, meaning it is natively included in the platform and can be enabled | ||
| using configuration variables. | ||
|
|
||
| It allows you to use the various capabilities from the Airbus LADE directly in your OpenBAS scenarios and simulations. |
12 changes: 12 additions & 0 deletions
12
openbas-api/src/main/java/io/openbas/injectors/manual/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # OpenBAS Manual Injector | ||
|
|
||
| Table of Contents | ||
|
|
||
| - [OpenBAS Manual Injector](#openbas-manual-injector) | ||
| - [Behavior](#behavior) | ||
|
|
||
| ## Behavior | ||
|
|
||
| The Manual injector is a built-in injector, meaning it is natively included and enabled in the platform. | ||
|
|
||
| It allows you to remind you manual action in your OpenBAS scenarios and simulations. |
38 changes: 23 additions & 15 deletions
38
openbas-api/src/main/java/io/openbas/injectors/mastodon/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,35 @@ | ||
| # OpenBAS Mastodon Injector | ||
|
|
||
| The OpenBAS Mastodon injector is a built-in injector, meaning it is natively included in the platform and can be enabled using configuration variables. It allows you to create Mastodon messages and statuses directly in your OpenBAS scenarios and simulations. | ||
| Table of Contents | ||
|
|
||
| ## Summary | ||
| - [OpenBAS Mastodon Injector](#openbas-mastodon-injector) | ||
| - [Prerequisites](#prerequisites) | ||
| - [Configuration variables](#configuration-variables) | ||
| - [Base injector environment variables](#base-injector-environment-variables) | ||
| - [Behavior](#behavior) | ||
|
|
||
| - [Requirements](#requirements) | ||
| - [Configuration variables](#configuration-variables) | ||
| - [Behavior](#behavior) | ||
| - [Mapping](#mapping) | ||
| - [Sources](#sources) | ||
| ## Prerequisites | ||
|
|
||
| --- | ||
| You need a mastodon tenant to be able to use this injector. | ||
|
|
||
| ## Requirements | ||
| ## Configuration variables | ||
|
|
||
| - OpenBAS Platform version 1.0.1 or higher | ||
| - A Mastodon instance | ||
| There are a number of configuration options, which are set either in `docker-compose.yml` (for Docker) or | ||
| in `application.properties` (for manual deployment). | ||
|
|
||
| ## Configuration variables | ||
| ### Base injector environment variables | ||
|
|
||
| Below are the properties you'll need to set for OpenBAS: | ||
| Below are the parameters you'll need to set for running the injector properly: | ||
|
|
||
| | Property | application.properties | Docker environment variable | Mandatory | Description | | ||
| | Parameter | application.properties | Docker environment variable | Mandatory | Description | | ||
| |--------------------------|------------------------|-----------------------------|-----------|---------------------------------| | ||
| | Enable Mastodon injector | mastodon.enable | `MASTODON_ENABLE` | Yes | Enable the Mastodon injector. | | ||
| | Mastodon URL | mastodon.url | `MASTODON_URL` | Yes | The URL of the Mastodon tenant. | | ||
| | Mastodon URL | mastodon.url | `MASTODON_URL` | Yes | The URL of the Mastodon tenant. | | ||
|
|
||
| ## Behavior | ||
|
|
||
| The Mastodon injector is a built-in injector, meaning it is natively included in the platform and can be | ||
| enabled using configuration variables. | ||
|
|
||
| It allows you to send Mastodon posts onto your Mastodon tenant and use them directly in your OpenBAS scenarios and | ||
| simulations. |
50 changes: 30 additions & 20 deletions
50
openbas-api/src/main/java/io/openbas/injectors/ovh/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,30 +1,40 @@ | ||
| # OpenBAS OVHCloud SMS Platform Injector | ||
|
|
||
| The OVHCloud SMS Platform injector is a built-in injector, meaning it is natively included in the platform and can be enabled using configuration variables. It allows you to send SMS through the OVHCloud SMS services directly in your OpenBAS scenarios and simulations. | ||
| Table of Contents | ||
|
|
||
| ## Summary | ||
| - [OpenBAS OVHCloud SMS Platform Injector](#openbas-ovhcloud-sms-platform-injector) | ||
| - [Prerequisites](#prerequisites) | ||
| - [Configuration variables](#configuration-variables) | ||
| - [Base injector environment variables](#base-injector-environment-variables) | ||
| - [Deployment](#deployment) | ||
| - [Docker Deployment](#docker-deployment) | ||
| - [Manual Deployment](#manual-deployment) | ||
| - [Behavior](#behavior) | ||
|
|
||
| - [Requirements](#requirements) | ||
| - [Configuration variables](#configuration-variables) | ||
| - [Behavior](#behavior) | ||
| - [Mapping](#mapping) | ||
| - [Sources](#sources) | ||
| ## Prerequisites | ||
|
|
||
| --- | ||
| You need a valid OVHCloud SMS subscription to be able to use this injector. | ||
|
|
||
| ## Requirements | ||
| ## Configuration variables | ||
|
|
||
| - OpenBAS Platform version 1.0.3 or higher | ||
| - A valid OVHCloud SMS subscription | ||
| There are a number of configuration options, which are set either in `docker-compose.yml` (for Docker) or | ||
| in `application.properties` (for manual deployment). | ||
|
|
||
| ## Configuration variables | ||
| ### Base injector environment variables | ||
|
|
||
| Below are the parameters you'll need to set for running the injector properly: | ||
|
|
||
| | Parameter | application.properties | Docker environment variable | Mandatory | Description | | ||
| |------------------------------|------------------------|-----------------------------|-----------|--------------------------------------| | ||
| | Enable OVHCloud SMS injector | ovh.sms.enable | `OVH_SMS_ENABLE` | Yes | Enable the OVHCloud SMS injector. | | ||
| | OVHCloud Access Key | ovh.sms.ak | `OVH_SMS_AK` | Yes | The OVHCloud API access key. | | ||
| | OVHCloud Access Secret | ovh.sms.as | `OVH_SMS_AS` | Yes | The OVHCloud API secret key. | | ||
| | OVHCloud CK | ovh.sms.ck | `OVH_SMS_CK` | Yes | The OVHCloud API CK. | | ||
| | OVHCloud Service Identifier | ovh.sms.service | `OVH_SMS_SERVICE` | Yes | The OVHCloud SMS service identifier. | | ||
|
|
||
| ## Behavior | ||
|
|
||
| Below are the properties you'll need to set for OpenBAS: | ||
| The OVHCloud SMS Platform injector is a built-in injector, meaning it is natively included in the platform and can be | ||
| enabled using configuration variables. | ||
|
|
||
| | Property | application.properties | Docker environment variable | Mandatory | Description | | ||
| |------------------------------|------------------------|-----------------------------|-----------|---------------------------------------| | ||
| | Enable OVHCloud SMS injector | ovh.sms.enable | `OVH_SMS_ENABLE` | Yes | Enable the OVHCloud SMS injector. | | ||
| | OVHCloud Access Key | ovh.sms.ak | `OVH_SMS_AK` | Yes | The OVHCloud API access key. | | ||
| | OVHCloud Access Secret | ovh.sms.as | `OVH_SMS_AS` | Yes | The OVHCloud API secret key. | | ||
| | OVHCloud CK | ovh.sms.ck | `OVH_SMS_CK` | Yes | The OVHCloud API CK. | | ||
| | OVHCloud Service Identifier | ovh.sms.service | `OVH_SMS_SERVICE` | Yes | The OVHCloud SMS service identifier. | | ||
| It allows you to send SMS through the OVHCloud SMS services directly in your OpenBAS scenarios and simulations. |