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

Feature/docs 2642 sbfa and user attribution in api sessions #1412

Merged
12 changes: 4 additions & 8 deletions docs/latest/api-discovery/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,17 +92,13 @@ API Discovery provides the ability to configure the detection process and add yo

### Sensitive business flows

API Discovery automatically [marks](sbf.md) specific endpoints as the key ones for some sensitive business flows, such as:
With the [sensitive business flow](sbf.md) capability, API Discovery can automatically identify endpoints that are critical to specific business flows and functions, such as authentication, account management, billing, and similar critical capabilities.

* Authentication
* Account management
* Billing
* SMS gateway functioning
* ...and others
In addition to automatic identification, you can manually adjust the assigned sensitive business flow tags and manually set tags for the endpoints of your choice.

You can manually adjust the assigned tags and manually set tags for the endpoints of your choice.
Once endpoints are assigned with the sensitive business flow tags, it becomes possible to filter all discovered endpoint by a specific business flow which makes it easier on protecting the most critical business capabilities.
Copy link

Choose a reason for hiding this comment

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

Grammar: Once endpoints are tagged with sensitive business flow labels, it's possible to filter all discovered endpoints by a specific business flow, making it easier to protect the most critical business capabilities.


Once tags are assigned, you can filter your endpoints by flow to regularly check them for vulnerabilities or breaches.
![API Discovery - Filtering by sensitive business flows](../images/about-wallarm-waf/api-discovery/api-discovery-sbf-filter.png)

### Security of data uploaded to the Wallarm Cloud

Expand Down
17 changes: 8 additions & 9 deletions docs/latest/api-discovery/sbf.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Sensitive Business Flows <a href="../../about-wallarm/subscription-plans/#waap-and-advanced-api-security"><img src="../../images/api-security-tag.svg" style="border: none;"></a>

Wallarm's [API Discovery](overview.md) automatically marks specific endpoints as the key ones for some sensitive business flows, such as authentication or account management, billing or SMS gateways functioning, and others. Learn from this article how to use the sensitive business flow functionality.
With the [sensitive business flow](sbf.md) capability, Wallarm's [API Discovery](overview.md) can automatically identify endpoints that are critical to specific business flows and functions, such as authentication, account management, billing, and similar critical capabilities. Learn from this article how to use the sensitive business flow functionality.
Copy link

Choose a reason for hiding this comment

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

Sensitive Business Flow (with capital letters) - it's a name of a capability.

Copy link

Choose a reason for hiding this comment

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

use the sensitive business flow functionality to protect your business.


## Addressed issues
Copy link

Choose a reason for hiding this comment

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

We need to change that title to illustrate what we are actually talking about here. Something about the addressed problem itself e.g. Importance of protecting the sensitive business flows or similar.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think that the "Addressed issues" title provides a clear understanding of what we are talking about. + this is used in other places of the docs similarly.


Expand All @@ -11,7 +11,7 @@ The abuse of the sensitive business flows is ranked six ([API6](https://owasp.or
* Implement stronger security measures (e.g., encryption, authentication, access controls, and rate limits).
* Easily produce audit trails and evidence of data protection measures.

## Automatic marking
## Automatic tagging

Copy link

Choose a reason for hiding this comment

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

Explain the capability first: it is automatic >> you don't need to spend your precious time on manually tagging the endpoints, it work OOTB like magic.

On finding a new endpoint, API Discovery automatically checks if it potentially belongs to one or several sensitive business flows:
Copy link

Choose a reason for hiding this comment

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

On discovering a new endpoint, API Discovery automatically checks whether it potentially belongs to one or more sensitive business flows


Expand All @@ -21,9 +21,9 @@ Automatic checking is performed based on the keywords from the endpoint URL, for

If necessary, later you can manually adjust the list of assigned business flows as described in the section below.
Copy link

Choose a reason for hiding this comment

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

The automatics tagging discovers most of the sensitive business flows. However, it is also possible to customize this capability to adjust it to specific business needs of your company.

Copy link

Choose a reason for hiding this comment

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

@MaximBashurov not fixed. "manually adjust" reads like I have to fix something, customize sounds better 'cause it implies meeting the unique needs of a customer.


## Marking endpoints manually
## Tagging endpoints manually

To adjust the results of [automatic marking](#automatic-marking), you can manually edit the list of sensitive business flow the endpoint belongs to. You can also manually mark endpoints that do not directly fall under the keyword list.
To adjust the results of [automatic tagging](#automatic-tagging), you can manually edit the list of sensitive business flow the endpoint belongs to. You can also manually tag endpoints that do not directly fall under the keyword list.

To edit the list of flows the endpoint belongs to, in Wallarm Console, go to API Discovery, then for your endpoint, in the **Business flow & sensitive data**, select one or several flows from the list.

Expand All @@ -33,15 +33,14 @@ You can do the same in the endpoint details.

## Business flows in Sessions

Wallarm's [API Sessions](../api-sessions/overview.md) group requests of your applications' traffic into user sessions. If some of these requests target the endpoints that in API Discovery were marked as important for some sensitive business flows, such session will be [marked](../api-sessions/exploring.md#sensitive-business-flows) as affecting this business flow as well.
Wallarm's [API Sessions](../api-sessions/overview.md) are used to provide you with the full sequence of user activities and thus give more visibility into the logic of malicious actors. If session's requests affect the endpoints that in API Discovery were tagged as important for some sensitive business flows, such session will be automatically [tagged](../api-sessions/exploring.md#sensitive-business-flows) as affecting this business flow as well.

Once sessions are assigned with the sensitive business flow tags, it becomes possible to filter them by a specific business flow which makes it easier to select the sessions that are most important to analyze.

![!API Sessions - sensitive business flows](../images/api-sessions/api-sessions-sbf-no-select.png)

## Filtering by business flow
Copy link

Choose a reason for hiding this comment

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

business flow or sensitive business flow ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

To keep the heading short, I made this fix INSIDE section text.


Once endpoints are marked with the business flow tags, you can quickly get the list of endpoints belonging to specific business flow to analyze their current state and data.

To do that, use the **Business flow** filter.

Once endpoints are assigned with the sensitive business flow tags, it becomes possible to filter all discovered endpoint by a specific business flow (the **Business flow** filter) which makes it easier on protecting the most critical business capabilities.
Copy link

Choose a reason for hiding this comment

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

What's the name of the filter in the UI? AFAIK it's the Sensitive Business flow filter.

Copy link

Choose a reason for hiding this comment

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

Also, grammar: Once endpoints are assigned sensitive business flow tags, it becomes possible to filter all discovered endpoints by a specific business flow (using the Sensitive Business Flow filter), making it easier to protect the most critical business capabilities.


![API Discovery - Filtering by sensitive business flows](../images/about-wallarm-waf/api-discovery/api-discovery-sbf-filter.png)
6 changes: 5 additions & 1 deletion docs/latest/api-sessions/exploring.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,11 @@ Use the **Time,ms** and **Size,bytes** columns in the session request details to

## Sensitive business flows

If some of the session requests target the endpoints that in [API Discovery](../api-discovery/overview.md) were [marked](../api-discovery/sbf.md) as important for some sensitive business flows, such session will be marked as affecting this business flow as well.
In [API Discovery](../api-discovery/overview.md), the [sensitive business flow](../api-discovery/sbf.md) capability allows automatic and manual identification of endpoints that are critical to specific business flows and functions, such as authentication, account management, billing, and similar critical capabilities.
Copy link

Choose a reason for hiding this comment

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

Sensitive Business Flow


If the sessions' requests affect the endpoints that in API Discovery were tagged as important for some sensitive business flows, such sessions are automatically tagged as affecting this business flow as well.
Copy link

Choose a reason for hiding this comment

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

Grammar: If a session's requests affect endpoints that were tagged as important for sensitive business flows in API Discovery, such sessions are automatically tagged as affecting the corresponding business flow as well.


Once sessions are assigned with the sensitive business flow tags, it becomes possible to filter them by a specific business flow which makes it easier to select the sessions that are most important to analyze.
Copy link

Choose a reason for hiding this comment

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

Grammar: Once endpoints are assigned sensitive business flow tags, it becomes possible to filter all discovered endpoints by a specific business flow (using the Sensitive Business Flow filter), making it easier to protect the most critical business capabilities.


![!API Sessions - sensitive business flows](../images/api-sessions/api-sessions-sbf-no-select.png)

Expand Down