Skip to content

Commit d4de3a4

Browse files
patriciasantaanaOxyjun
authored andcommitted
[API Shield] Security Overview update + some naming edits (#24536)
* list * naming * more naming * Apply suggestion from @Oxyjun Co-authored-by: Jun Lee <[email protected]> --------- Co-authored-by: Jun Lee <[email protected]>
1 parent c528c45 commit d4de3a4

File tree

14 files changed

+94
-89
lines changed

14 files changed

+94
-89
lines changed

src/content/docs/api-shield/api-gateway.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
pcx_content_type: concept
3-
43
title: API Gateway
54
sidebar:
65
order: 7
@@ -11,7 +10,7 @@ Cloudflare API Shield empowers you to use Cloudflare as your API Gateway, provid
1110

1211
APIs are fundamental to modern applications but are increasingly targeted by malicious actors. Cloudflare API Shield offers a comprehensive solution to protect, manage, and build your APIs.
1312

14-
- **Enhanced security**: Implement robust runtime protection such as JWT validation, mutual TLS (mTLS) authentication, schema validation, and protection against the [OWASP Top 10 API Security risks](https://owasp.org/www-project-api-security/).
13+
- **Enhanced security**: Implement robust runtime protection such as JWT validation, mutual TLS (mTLS) authentication, Schema validation, and protection against the [OWASP Top 10 API Security risks](https://owasp.org/www-project-api-security/).
1514

1615
- **Efficient management and monitoring**: Utilize tools for endpoint management, analytics, and routing to streamline API operations. Highlight risks with Posture Management, and gain visibility with Security Analytics and Security Center Insights.
1716

src/content/docs/api-shield/changelog.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,19 +39,19 @@ Customers can now organize their endpoints by use case and custom labels using t
3939

4040
**API Shield fields in Custom Rules**
4141

42-
Customers can now use API Shield product feature fields in [custom rules](/waf/custom-rules/), referencing features such as [JWT Validation](/api-shield/security/jwt-validation/), [session identifiers](/api-shield/get-started/#session-identifiers), and [Schema Validation](/api-shield/security/schema-validation/).
42+
Customers can now use API Shield product feature fields in [custom rules](/waf/custom-rules/), referencing features such as [JWT validation](/api-shield/security/jwt-validation/), [session identifiers](/api-shield/get-started/#session-identifiers), and [Schema validation](/api-shield/security/schema-validation/).
4343

4444
## 2024-09-25
4545

46-
**Fallthrough rule for Schema Validation 2.0**
46+
**Fallthrough rule for Schema validation 2.0**
4747

48-
Customers can now enable the [Fallthrough Action](/api-shield/security/schema-validation/#add-validation-by-adding-a-fallthrough-rule) for Schema Validation 2.0 to block or log requests that do not match the endpoints listed in schemas protected by Schema Validation 2.0.
48+
Customers can now enable the [Fallthrough Action](/api-shield/security/schema-validation/#add-validation-by-adding-a-fallthrough-rule) for Schema validation 2.0 to block or log requests that do not match the endpoints listed in schemas protected by Schema validation 2.0.
4949

5050
## 2024-08-28
5151

52-
**Increased capacity for Endpoint management and Schema Validation**
52+
**Increased capacity for Endpoint management and Schema validation**
5353

54-
Endpoint management and Schema Validation now support up to 10,000 saved and validated API endpoints.
54+
Endpoint management and Schema validation now support up to 10,000 saved and validated API endpoints.
5555

5656
## 2024-07-08
5757

@@ -73,9 +73,9 @@ Customers can now use the fields inside [JSON Web Tokens (known as claims)](/api
7373

7474
## 2024-04-30
7575

76-
**Build Sequence Mitigation rules via the Cloudflare dashboard**
76+
**Build sequence mitigation rules via the Cloudflare dashboard**
7777

78-
Customers can now build [Sequence Mitigation](/api-shield/security/sequence-mitigation/) rules with a new user interface inside the API Shield section of the [Cloudflare dashboard](https://dash.cloudflare.com/).
78+
Customers can now build [Sequence mitigation](/api-shield/security/sequence-mitigation/) rules with a new user interface inside the API Shield section of the [Cloudflare dashboard](https://dash.cloudflare.com/).
7979

8080
## 2024-02-23
8181

src/content/docs/api-shield/frequently-asked-questions.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Not currently.
5959

6060
## What version of OpenAPI specification do you support?
6161

62-
The importing ([Schema validation](/api-shield/security/schema-validation/)) and exporting ([Schema Learning](/api-shield/management-and-monitoring/#endpoint-schema-learning)) of OpenAPI schemas from our product to customers is done using **OpenAPI v3.0**. Any specifications using patched versions (3.0.x) are compatible as well.
62+
The importing ([Schema validation](/api-shield/security/schema-validation/)) and exporting ([Schema learning](/api-shield/management-and-monitoring/#endpoint-schema-learning)) of OpenAPI schemas from our product to customers is done using **OpenAPI v3.0**. Any specifications using patched versions (3.0.x) are compatible as well.
6363

6464
---
6565

src/content/docs/api-shield/get-started.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Cloudflare’s machine learning models have already inspected your existing traf
5656

5757
:::note
5858

59-
Schema validation, Schema Learning, JWT validation, Sequence Analytics, Sequence Mitigation, and rate limit recommendations only run on endpoints saved to Endpoint Management.
59+
Schema validation, schema learning, JWT validation, Sequence Analytics, sequence mitigation, and rate limit recommendations only run on endpoints saved to Endpoint Management.
6060
:::
6161

6262
You can save your endpoints directly from [API Discovery](/api-shield/management-and-monitoring/#add-endpoints-from-api-discovery), [Schema validation](/api-shield/management-and-monitoring/#add-endpoints-from-schema-validation), or [manually](/api-shield/management-and-monitoring/#add-endpoints-manually) by method, path, and host.
@@ -101,7 +101,7 @@ You can export your learned schemas in the [Cloudflare dashboard](/api-shield/ma
101101

102102
You can observe the top sequences in your API traffic that contain endpoints stored in Endpoint Management. We rank sequences by Correlation Score. High-scoring sequences contain API requests which are likely to occur together in order.
103103

104-
[Sequence Mitigation](/api-shield/security/sequence-mitigation/) allows you to enforce request patterns for authenticated clients communicating with your API. Use Sequence Analytics to better understand the request sequences used by your API clients.
104+
[Sequence mitigation](/api-shield/security/sequence-mitigation/) allows you to enforce request patterns for authenticated clients communicating with your API. Use Sequence Analytics to better understand the request sequences used by your API clients.
105105

106106
You should apply all possible API Shield protections (rate limiting suggestions, Schema validation, JWT validation, and mTLS) to API endpoints found in high correlation score sequences that make up the critical request flows in your application. You should also check their specific endpoint order with your development team.
107107

src/content/docs/api-shield/management-and-monitoring/endpoint-management/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ There are two ways to add API endpoints from Discovery.
8686
</TabItem>
8787
</Tabs>
8888

89-
### Add endpoints from Schema Validation
89+
### Add endpoints from Schema validation
9090

9191
<Tabs syncKey="dashNewNav">
9292
<TabItem label="Old dashboard">

src/content/docs/api-shield/reference/terraform.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ It is required to configure Endpoint Management if you want to set up Schema val
6868
Refer to the example configuration below to manage [Schema validation 2.0](/api-shield/security/schema-validation/api/) on your zone.
6969

7070
```tf title="Example configuration"
71-
# Schema that should be used for schema validation 2.0
71+
# Schema that should be used for Schema validation 2.0
7272
resource "cloudflare_api_shield_schema" "example_schema" {
7373
zone_id = var.zone_id
7474
name = "example-schema"

src/content/docs/api-shield/security/index.mdx

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
pcx_content_type: navigation
3-
43
title: Security
54
sidebar:
65
order: 4
@@ -11,7 +10,14 @@ import { DirectoryListing } from "~/components"
1110

1211
Cloudflare offers the following features to help secure your APIs:
1312

14-
<DirectoryListing />
13+
| Discovery & management | Posture management | Runtime protection |
14+
| --- | --- | --- |
15+
| [API Discovery](/api-shield/security/api-discovery/) | [Volumetric Abuse Detection](/api-shield/security/volumetric-abuse-detection/) | [Schema validation](/api-shield/security/schema-validation/) |
16+
| [Schema learning](/api-shield/management-and-monitoring/endpoint-management/schema-learning/) | [Authentication Posture](/api-shield/security/authentication-posture/) | [JWT validation](/api-shield/security/jwt-validation/) |
17+
| [Sequence Analytics](/api-shield/security/sequence-analytics/) | [BOLA vulnerability detection](/api-shield/security/bola-vulnerability-detection/) | [Sequence mitigation](/api-shield/security/sequence-mitigation/) |
18+
| | [Risk labels](/api-shield/management-and-monitoring/endpoint-labels/#risk-labels) | [Mutual TLS (mTLS)](/api-shield/security/mtls/) |
19+
| | | [GraphQL query protection](/api-shield/security/graphql-protection/) |
20+
1521

1622
## Example Cloudflare solutions
1723

@@ -21,20 +27,20 @@ The following table provides examples of how you might match Cloudflare products
2127

2228
| OWASP issue | Example Cloudflare solution |
2329
| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
24-
| Broken Object Level Authorization | [Broken Object Level Authorization vulnerability detection](/api-shield/security/bola-vulnerability-detection/), [Sequence Mitigation], [Schema validation], [JWT validation], [Rate Limiting] |
30+
| Broken Object Level Authorization | [BOLA vulnerability detection](/api-shield/security/bola-vulnerability-detection/), [Sequence mitigation], [Schema validation], [JWT validation], [Rate Limiting] |
2531
| Broken Authentication | [Authentication Posture](/api-shield/security/authentication-posture/), [mTLS](/api-shield/security/mtls/), [JWT validation], [Exposed Credential Checks](/waf/managed-rules/check-for-exposed-credentials/), [Bot Management](/bots/) |
2632
| Broken Object Property Level Authorization | [Schema validation], [JWT validation] |
27-
| Unrestricted Resource Consumption | [Rate Limiting], [Sequence Mitigation], [Bot Management], [GraphQL Query Protection] |
33+
| Unrestricted Resource Consumption | [Rate Limiting], [Sequence mitigation], [Bot Management], [GraphQL Query Protection] |
2834
| Broken Function Level Authorization | [Schema validation], [JWT validation] |
29-
| Unrestricted Access to Sensitive Business Flows | [Sequence Mitigation], [Bot Management], [GraphQL Query Protection] |
35+
| Unrestricted Access to Sensitive Business Flows | [Sequence mitigation], [Bot Management], [GraphQL Query Protection] |
3036
| Server Side Request Forgery | [Schema validation], [WAF managed rules], [WAF custom rules](/waf/custom-rules/) |
31-
| Security Misconfiguration | [Sequence Mitigation], [Schema validation], [WAF managed rules], [GraphQL Query Protection] |
32-
| Improper Inventory Management | [Discovery](/api-shield/security/api-discovery/), [Schema Learning](/api-shield/management-and-monitoring/#endpoint-schema-learning) |
37+
| Security Misconfiguration | [Sequence mitigation], [Schema validation], [WAF managed rules], [GraphQL Query Protection] |
38+
| Improper Inventory Management | [Discovery](/api-shield/security/api-discovery/), [Schema learning](/api-shield/management-and-monitoring/#endpoint-schema-learning) |
3339
| Unsafe Consumption of APIs | [JWT validation], [WAF managed rules] |
3440

3541
[Schema validation]: /api-shield/security/schema-validation/
3642

37-
[Sequence Mitigation]: /api-shield/security/sequence-mitigation/
43+
[Sequence mitigation]: /api-shield/security/sequence-mitigation/
3844

3945
[JWT validation]: /api-shield/security/jwt-validation/
4046

src/content/docs/api-shield/security/jwt-validation/jwt-worker.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ head:
1111

1212
import { Steps } from "~/components"
1313

14-
Use a Worker to automatically keep your identity provider’s latest public key in the JWT Validation configuration.
14+
Use a Worker to automatically keep your identity provider’s latest public key in the JWT validation configuration.
1515

1616
## Prerequisites
1717

src/content/docs/api-shield/security/schema-validation/api.mdx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,46 @@
11
---
2-
title: Configure Schema Validation via the API
2+
title: Configure Schema validation via the API
33
pcx_content_type: how-to
44

55
sidebar:
66
label: API
77
head:
88
- tag: title
9-
content: Configure Schema Validation
9+
content: Configure Schema validation
1010
---
1111

1212
import { GlossaryTooltip, Steps, APIRequest } from "~/components"
1313

14-
Schema Validation 2.0 allows all corresponding configuration calls to be made via API. This validation centers more around individual <GlossaryTooltip term="API endpoint">endpoints</GlossaryTooltip> and lets you set mitigation actions for each endpoint individually. Additionally, you can use Cloudflare-provided learned schemas that we [learn automatically](/api-shield/management-and-monitoring/#endpoint-schema-learning) from your traffic for individual endpoints.
14+
Schema validation 2.0 allows all corresponding configuration calls to be made via API. This validation centers more around individual <GlossaryTooltip term="API endpoint">endpoints</GlossaryTooltip> and lets you set mitigation actions for each endpoint individually. Additionally, you can use Cloudflare-provided learned schemas that we [learn automatically](/api-shield/management-and-monitoring/#endpoint-schema-learning) from your traffic for individual endpoints.
1515

1616
:::note
1717

18-
[Classic Schema Validation documentation](/api-shield/reference/classic-schema-validation/) is available for reference only.
18+
[Classic Schema validation documentation](/api-shield/reference/classic-schema-validation/) is available for reference only.
1919
:::
2020

21-
## Upload schemas via the API to Schema Validation
21+
## Upload schemas via the API to Schema validation
2222

2323
<Steps>
2424
1. Upload a schema.
2525
2. Ensure that your endpoints are added in Endpoint Management.
2626
3. Set the schema to `active` if it is not already done.
27-
4. Set the Schema Validation zone-wide action from `none` to `log`.
27+
4. Set the Schema validation zone-wide action from `none` to `log`.
2828
5. Send test traffic that violates the schema.
29-
6. View test traffic in Security Events by filtering for **Service** > **API Shield - Schema Validation**.
29+
6. View test traffic in Security Events by filtering for **Service** > **API Shield - Schema validation**.
3030
7. Optional:
3131
- Set a single endpoint to `block`.
32-
- Set the Schema Validation zone-wide to `block`.
32+
- Set the Schema validation zone-wide to `block`.
3333
- Temporarily override all schemas zone-wide to `none`.
3434
- Remove the temporary override.
3535
</Steps>
3636

37-
Cloudflare recommends you to rerun test traffic and monitor the HTTP response codes after changing any settings to ensure Schema Validation is operating as expected.
37+
Cloudflare recommends you to rerun test traffic and monitor the HTTP response codes after changing any settings to ensure Schema validation is operating as expected.
3838

3939
Settings changes may take a few minutes to implement.
4040

4141
:::note
4242

43-
Endpoints must be listed in Endpoint Management for Schema Validation to match requests.
43+
Endpoints must be listed in Endpoint Management for Schema validation to match requests.
4444
:::
4545

4646
## Configuration
@@ -81,7 +81,7 @@ Upload a schema via the v4 API using `POST`. This example requires a `example_sc
8181
}
8282
```
8383

84-
By default, Schema Validation is disabled for an uploaded schema so that you can inspect it first. You can upload a schema and enable it immediately by setting the form parameter `validation_enabled=true`.
84+
By default, Schema validation is disabled for an uploaded schema so that you can inspect it first. You can upload a schema and enable it immediately by setting the form parameter `validation_enabled=true`.
8585

8686
Use a `PATCH` request to activate a schema after inspection.
8787

@@ -115,7 +115,7 @@ When a schema is active, it executes the mitigation action specified for each op
115115

116116
### Add new operations to Endpoint Management
117117

118-
Schemas contain a set of servers, paths, and methods, which together define an operation. Schema Validation only acts on the requests to operations which have been added to the API Shield Endpoint Management. If a schema contains operations which have not been added to Endpoint Management, they can be retrieved together with the configuration information about added operations.
118+
Schemas contain a set of servers, paths, and methods, which together define an operation. Schema validation only acts on the requests to operations which have been added to the API Shield Endpoint Management. If a schema contains operations which have not been added to Endpoint Management, they can be retrieved together with the configuration information about added operations.
119119

120120
```bash title="cURL command"
121121
curl --request GET "https://api.cloudflare.com/client/v4/zones/{zone_id}/api_gateway/user_schemas/{schema_id}/operations?feature=schema_info&operation_status=new&page=1&per_page=5000" \
@@ -425,9 +425,9 @@ curl --request PUT "https://api.cloudflare.com/client/v4/zones/{zone_id}/api_gat
425425
Parameter schemas are updated between every 24 hours up to one week. To ensure that a parameter schema has not been updated during the inspection, Cloudflare recommends that you pass the `last_updated` timestamp of the parameter-schema feature (not the `last_updated` of the whole operation) as an identifier in the timestamp query parameter.
426426
:::
427427

428-
### Disable Schema Validation
428+
### Disable Schema validation
429429

430-
To quickly disable Schema Validation for a whole zone, use `PATCH`. This operation will override all operation-mitigation actions.
430+
To quickly disable Schema validation for a whole zone, use `PATCH`. This operation will override all operation-mitigation actions.
431431

432432
```bash title="cURL command"
433433
curl --request PATCH "https://api.cloudflare.com/client/v4/zones/{zone_id}/api_gateway/settings/schema_validation" \

0 commit comments

Comments
 (0)