Skip to content

[Gateway] Update selector API names #17934

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Nov 4, 2024
Merged

[Gateway] Update selector API names #17934

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b12c5e1
Update source internal IP
maxvp Nov 1, 2024
d45f971
Update source IP
maxvp Nov 1, 2024
fcd614a
Update destination ip
maxvp Nov 1, 2024
14a6286
Update domain
maxvp Nov 1, 2024
72de36f
Update categories
maxvp Nov 1, 2024
b5dbac4
Merge branch 'production' into max/gw/update-http-selectors
maxvp Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/content/docs/cloudflare-one/policies/gateway/egress-policies/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ The country of the user making the request. <Render file="gateway/selectors/sour

<Render
file="gateway/selectors/source-internal-ip"
params={{ one: "egress", two: "net" }}
params={{ one: "egress", two: "net.src.internal_src_ip" }}
/>

### Source IP
Expand Down
38 changes: 19 additions & 19 deletions src/content/docs/cloudflare-one/policies/gateway/http-policies/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,9 +407,9 @@ When using Terraform to create a policy with the [Do Not Inspect](#do-not-inspec

### Content Categories

| UI name | API example |
| ------------------ | ------------------------------------------------------- |
| Content Categories | `not(any(http.request.uri.content_category[*] in {1}))` |
| UI name | API example |
| ------------------ | ------------------------------------------------ |
| Content Categories | `not(any(http.conn.content_category[*] in {1}))` |

For more information, refer to our list of [content categories](/cloudflare-one/policies/gateway/domain-categories/#content-categories).

Expand Down Expand Up @@ -441,9 +441,9 @@ Only applies to traffic sent through the [WARP client](/cloudflare-one/connectio
Only applies to traffic sent through the [WARP client](/cloudflare-one/connections/connect-devices/warp/set-up-warp/#gateway-with-warp-default).
:::

| UI name | API example |
| -------------- | ----------------------------- |
| Destination IP | `http.dst.ip == "10.0.0.0/8"` |
| UI name | API example |
| -------------- | ---------------------------------- |
| Destination IP | `http.conn.dst_ip == "10.0.0.0/8"` |

### Device Posture

Expand All @@ -453,9 +453,9 @@ Only applies to traffic sent through the [WARP client](/cloudflare-one/connectio

Use this selector to match against a domain and all subdomains -- for example, if you want to block `example.com` and subdomains such as `www.example.com`.

| UI name | API example |
| ------- | ----------------------------------------------- |
| Domain | `any(http.request.domains[*] == "example.com")` |
| UI name | API example |
| ------- | -------------------------------------------- |
| Domain | `any(http.conn.domains[*] == "example.com")` |

### Download and Upload File Types

Expand Down Expand Up @@ -540,9 +540,9 @@ Scans HTTP traffic for the presence of social security numbers and other PII. Yo

Use this selector to match only the hostname specified -- for example, if you want to block `test.example.com` but not `example.com` or `www.test.example.com`.

| UI name | API example |
| ------- | ----------------------------------------- |
| Host | `http.request.host == "test.example.com"` |
| UI name | API example |
| ------- | ------------------------------------------ |
| Host | `http.conn.hostname == "test.example.com"` |

:::note
Some hostnames (`example.com`) will invisibly redirect to the www subdomain (`www.example.com`). To match this type of website, use the [Domain](#domain) selector instead of the Host selector.
Expand All @@ -566,9 +566,9 @@ Some hostnames (`example.com`) will invisibly redirect to the www subdomain (`ww

### Security Risks

| UI name | API example |
| -------------- | ------------------------------------------ |
| Security Risks | `any(http.request.uri.category[*] in {1})` |
| UI name | API example |
| -------------- | -------------------------------------------- |
| Security Risks | `any(http.conn.security_category[*] in {1})` |

For more information, refer to our list of [security categories](/cloudflare-one/policies/gateway/domain-categories/#security-categories).

Expand All @@ -584,14 +584,14 @@ The country of the user making the request. <Render file="gateway/selectors/sour

<Render
file="gateway/selectors/source-internal-ip"
params={{ one: "HTTP", two: "http" }}
params={{ one: "HTTP", two: "http.conn.internal_src_ip" }}
/>

### Source IP

| UI name | API example |
| --------- | ----------------------------- |
| Source IP | `http.src.ip == "10.0.0.0/8"` |
| UI name | API example |
| --------- | ---------------------------------- |
| Source IP | `http.conn.src_ip == "10.0.0.0/8"` |

### URL

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/cloudflare-one/policies/gateway/network-policies/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ The country of the user making the request. <Render file="gateway/selectors/sour

<Render
file="gateway/selectors/source-internal-ip"
params={{ one: "network", two: "net" }}
params={{ one: "network", two: "net.src.internal_src_ip" }}
/>

### Source IP
Expand Down
3 changes: 1 addition & 2 deletions src/content/partials/cloudflare-one/gateway/selectors/destination-ip.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
{}

---

The IP address of the request’s target.
The IP address of the request's target.

| UI name | API example |
| -------------- | ---------------------------- |
Expand Down
6 changes: 3 additions & 3 deletions src/content/partials/cloudflare-one/gateway/selectors/source-internal-ip.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ import { Markdown } from "~/components";

Use this selector to apply {props.one} policies to a private IP address, assigned by a user's local network, that requests arrive to Gateway from. This selector will only apply to users connected through a [Magic GRE or IPSec tunnel](/magic-wan/zero-trust/cloudflare-gateway/).

| UI name | API example |
| ------------------ | ----------------------------------------------------------------- |
| Source Internal IP | <code>{props.two}.src.internal_src_ip == "192.168.86.0/27"</code> |
| UI name | API example |
| ------------------ | --------------------------------------------- |
| Source Internal IP | <code>{props.two} == "192.168.86.0/27"</code> |
Loading