Skip to content
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

Add CSPM Severity Framework to Docs Site #20954

Merged
merged 31 commits into from
Dec 18, 2023

Conversation

Frichetten
Copy link
Contributor

What does this PR do? What is the motivation?

This PR adds the new CSPM severity framework to the public documentation site, along with some examples of how to use it.

Merge instructions

Please do not merge this immediately. It needs to be reviewed by some other parties first.

Additional notes

This work is tied to this ticket.

@Frichetten Frichetten requested a review from a team as a code owner December 8, 2023 16:21
Copy link
Contributor

github-actions bot commented Dec 8, 2023

Preview links (active after the build_preview check completes)

New or renamed files

@Frichetten Frichetten added the Do Not Merge Just do not merge this PR :) label Dec 8, 2023
@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Dec 11, 2023
Copy link
Contributor

@christophetd christophetd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great overall, left a few comments!

content/en/security/severity_scoring.md Outdated Show resolved Hide resolved

### Misconfigurations and Identity Risks

Starting in early 2024, all CSM Misconfigurations and Identity Risk rules will migrate to our severity score framework. This framework is designed to compare the likelihood that an adversary will take advantage of a misconfiguration to the risk posed to your environment. By weighting both of these aspects, findings can be prioritized more accurately by their real-world risks. The matrices below show how to compute a misconfiguration's severity score depending on certain criteria.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

feels like we should publish the docs page once this is done only

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, that was actually a request from product. They want the docs to be available before we start migrating rules.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Who? I think we might want to challenge that. I feel like this gives a bad look, "we're showing that we have no clue how to assign a severity, and doing nothing about it"

content/en/security/severity_scoring.md Outdated Show resolved Hide resolved
#### Likelihood

The likelihood component is made up of two subcomponents; The attack vector, the means through which a misconfiguration can be exploited, and the accessibility, if the resource is publicly accessible or not.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This table makes sense but the formatting made it challenging to understand

content/en/security/severity_scoring.md Outdated Show resolved Hide resolved
content/en/security/severity_scoring.md Outdated Show resolved Hide resolved
content/en/security/severity_scoring.md Outdated Show resolved Hide resolved
@Frichetten Frichetten added the WORK IN PROGRESS No review needed, it's a wip ;) label Dec 13, 2023
@drichards-87 drichards-87 self-requested a review December 15, 2023 14:55
@Frichetten Frichetten removed WORK IN PROGRESS No review needed, it's a wip ;) Do Not Merge Just do not merge this PR :) labels Dec 18, 2023
@Frichetten Frichetten added the editorial review Waiting on a more in-depth review label Dec 18, 2023

## Misconfigurations, Identity Risks, and Security Inbox Misconfigurations

This framework is designed to compare the likelihood that an adversary would take advantage of a misconfiguration to the risk posed to your environment. By weighting both of these aspects, findings can be prioritized more accurately by their real-world risks. The matrices below show how to compute a misconfiguration's severity score depending on certain criteria.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This framework is designed to compare the likelihood that an adversary would take advantage of a misconfiguration to the risk posed to your environment. By weighting both of these aspects, findings can be prioritized more accurately by their real-world risks. The matrices below show how to compute a misconfiguration's severity score depending on certain criteria.
The framework compares the likelihood that an adversary would take advantage of a misconfiguration to the risk posed to your environment. By weighting both of these aspects, findings can be prioritized more accurately based on their real-world risks. The matrices below show how to compute a misconfiguration's severity score depending on certain criteria.

Comment on lines 24 to 25
* Attack vector: The means through which a misconfiguration can be exploited.
* Accessibility: If the resource is publicly accessible or not.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Attack vector: The means through which a misconfiguration can be exploited.
* Accessibility: If the resource is publicly accessible or not.
* **Attack vector**: The means through which a misconfiguration can be exploited.
* **Accessibility**: If the resource is publicly accessible or not.

* Attack vector: The means through which a misconfiguration can be exploited.
* Accessibility: If the resource is publicly accessible or not.

The attack vector is determined by the following criteria:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The attack vector is determined by the following criteria:
#### Attack vector
The attack vector is determined by the following criteria:

| Vulnerability | Requires a vulnerable component to abuse, such as a software vulnerability on a compute instance or a leaked password/access key. |
| No Authorization | Requires no authorization/authentication to abuse. |

The accessibility is determined by the following criteria:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The accessibility is determined by the following criteria:
#### Accessibility
Accessibility is determined by the following criteria:

| Attack Vector | Definition |
|:-------------------:|:---------------------------------------------------------------------------------------------------------:|
| Required Privileges | Requires specific privileges or access to abuse. |
| Vulnerability | Requires a vulnerable component to abuse, such as a software vulnerability on a compute instance or a leaked password/access key. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| Vulnerability | Requires a vulnerable component to abuse, such as a software vulnerability on a compute instance or a leaked password/access key. |
| Vulnerability | Requires a vulnerable component to abuse, such as a software vulnerability on a compute instance or a leaked password or access key. |

|:-------------------:|:---------------------------------------------------------------------------------------------------------:|
| Required Privileges | Requires specific privileges or access to abuse. |
| Vulnerability | Requires a vulnerable component to abuse, such as a software vulnerability on a compute instance or a leaked password/access key. |
| No Authorization | Requires no authorization/authentication to abuse. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| No Authorization | Requires no authorization/authentication to abuse. |
| No Authorization | Requires no authorization or authentication to abuse. |


| Accessibility | Definition |
|:-------------:|:------------------------------------------------------------------:|
| Private | The vulnerable component/resource is in a private network. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| Private | The vulnerable component/resource is in a private network. |
| Private | The vulnerable component or resource is in a private network. |

| Accessibility | Definition |
|:-------------:|:------------------------------------------------------------------:|
| Private | The vulnerable component/resource is in a private network. |
| Public | The vulnerable component/resource is accessible from the internet. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| Public | The vulnerable component/resource is accessible from the internet. |
| Public | The vulnerable component or resource is accessible from the Internet. |

| Private | The vulnerable component/resource is in a private network. |
| Public | The vulnerable component/resource is accessible from the internet. |

These subcomponents determine the Likelihood score:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
These subcomponents determine the Likelihood score:
Together, these subcomponents determine the Likelihood score:

@drichards-87 drichards-87 merged commit df7d9b2 into master Dec 18, 2023
12 checks passed
@drichards-87 drichards-87 deleted the nick.frichette/add_cspm_severity_framework branch December 18, 2023 21:26
MaelNamNam pushed a commit that referenced this pull request Jan 17, 2024
* Added initial likelihood matrix to test table look

* Added additional matrices

* Made table headers bold

* Added severity scoring exammples

* Moved severity matrix up a level

* Fixed the link numbers in severity_scoring.md

* Removed unused links from misconfigurations index

* Reformatted severity scoring page

* Added aliases

* Added additional docs for other producs to severity scoring

* Added severity scoring page to menu

* Removed threats from the severity scoring page

* Update content/en/security/severity_scoring.md

Co-authored-by: Christophe Tafani-Dereeper <[email protected]>

* Added more links to further_reading for severity_scoring

* Fixed some minor issues with severity_scoring

* Moved the Severity Scoring page to be under CSM

* Changed the headers of severity_scoring

* Fixed some minor issues with severity_scoring

* Added CSM Vulnerabilities section for severity_scoring

* Removed temporal language from severity_scoring

* Minor edits

* Changed the format of the matrices in severity_scoring

* Minor edits

* Added introduction to severity_scoring

* Update menu

---------

Co-authored-by: Christophe Tafani-Dereeper <[email protected]>
Co-authored-by: DeForest Richards <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Architecture Everything related to the Doc backend editorial review Waiting on a more in-depth review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants