-
Notifications
You must be signed in to change notification settings - Fork 7
[docs] feat(scv): add domains documentation (#236) #237
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
GaetanSantucci
wants to merge
7
commits into
main
Choose a base branch
from
issue/236
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
f07ff52
Add domains notion
GaetanSantucci a985bb2
Update docs
GaetanSantucci 4b2c914
[docs] feat(SCV): add injectors/collectors documentation (#4266)
gabriel-peze 08fcd49
Update
GaetanSantucci 43021db
Fix docs
GaetanSantucci 1cec7f2
improve doc
GaetanSantucci 4e3363a
update doc
GaetanSantucci File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,62 @@ | ||
| # Overview | ||
| Domains provide a classification layer that describes the type of security control involved during the execution of a scenario in OpenAEV. This classification identifies the defensive capability being evaluated and allows scenarios and payloads to be interpreted with clearer operational intent. | ||
|
|
||
| ## Domains | ||
|
|
||
| A Domain represents the security control category targeted by a payload or injector execution. This classification helps to: | ||
|
|
||
| - Clarify the objective and security angle of each execution | ||
| - Improve visibility when reviewing results based on security control categories | ||
| - Align test coverage with the organization's security capabilities (endpoint, network, cloud, email, etc.) | ||
|
|
||
| Domains are currently predefined by the platform and cannot be created or modified by users. They are assigned automatically based on the Payload (and in certain cases the Injector Contract). User-defined management of Domains may be introduced in future releases. | ||
|
|
||
| ## Available Domains | ||
|
|
||
| The following Domains are currently supported in OpenAEV: | ||
|
|
||
| | Domain | Description | | ||
| |------------------------|--------------------------------------------------------------------------------------------------------------------| | ||
| | **ENDPOINT** | Evaluates endpoints security controls such as EDR, SIEM | | ||
| | **DATA EXFILTRATION** | Assesses the ability to detect or block attempts to exfiltrate data and check security controls like DLP & SIEM | | ||
| | **URL FILTERING** | Validates mechanisms controlling web access and URL categorization or filtering with security systems like proxy, ZTNA | | ||
| | **TABLE-TOP** | Represents process-oriented or organizational exercises involving manual decision-making or coordinated response | | ||
| | **CLOUD** | Evaluates cloud-native security controls including IAM, SIEM | | ||
| | **NETWORK** | Targets network security capabilities such as segmentation, IDS/IPS, firewalls, traffic inspection and SIEM | | ||
| | **EMAIL INFILTRATION** | Tests security controls protecting email flows, including phishing detection and malicious attachment filtering to your SIEM, Antispam solution, Antispoofing policies | | ||
| | **WEB APP** | Focuses on the security of web applications and related controls such as vulnerability detection and WAF behavior and SIEM | | ||
|
|
||
| ## How Domains Are Applied | ||
|
|
||
| ### Payloads define the Domain | ||
| Domains are primarily defined at the Payload level. Each payload declares one or more Domains that describe the security control category involved in its execution. This ensures consistent and predictable classification across the platform. | ||
|
|
||
| ### Injector Contracts | ||
| In some cases, an Injector Contract may also carry a Domain. | ||
| However, when an injector uses a Payload, the Payload’s Domain always takes precedence. This ensures that the Domain reflects the actual technical behavior of the executed action. | ||
|
|
||
| ## Usage | ||
|
|
||
| Domains allow users to: | ||
|
|
||
| - Filter and interpret scenario results based on the type of security control tested | ||
| - Design scenario flows that focus on specific areas of the security stack | ||
| - Generate reports organized by security capability (endpoint, network, cloud, etc.) | ||
|
|
||
| ## Domains defined by Injectors and Collectors | ||
| Some Injectors and Collectors can define and **manage their own Domains**. | ||
|
|
||
| In these cases: | ||
|
|
||
| - The Injectors/Collectors declares the Domain associated with the Injector Contracts/Payloads it produces | ||
| - The Domain attached by the Injector or Collector is then applied to the corresponding Injector Contracts/Payload executions | ||
| - This mechanism allows certain integrations to carry a Domain that is closest to their technical and operational behavior, without requiring manual configuration on the platform | ||
|
|
||
| ## Automatic weekly updates of Domains | ||
| Injectors and Collectors are **updated on a weekly basis**. | ||
|
|
||
| During these updates: | ||
|
|
||
| - The list of Domains associated with their Payloads is synchronized with the platform | ||
| - If a Domain that should be present, according to the latest Injector or Collector definition, has been removed or modified on the platform, it will be restored to its expected value during the next update | ||
| - Domains that have been manually added by the user, in addition to those defined by the Injector or Collector, are preserved. Only missing Domains are re-added; no user-added Domains are removed | ||
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is is important to describe which cases or not ?