در این صفحه، منطق شروط قوانین و فیلترها را بررسی میکنیم. شرطهای هر گروه با و و گروهها با یا ترکیب میشوند (Disjunctive Normal Form). همین قرارداد در پنل و در فیلد constraints در API نسخه ۲.۱ یکسان است.
برای نمونه بهروزرسانی با API، مدیریت دامنه خود را با API خودکار کنید را دنبال میکنیم. مسیرها و قرارداد فیلدها را در CDN and DNS (v2.1) مطالعه میکنیم.
ترکیب گروهها
| لایه | پنل | API (constraints) |
|---|---|---|
| داخل یک گروه | شرطها با و؛ دکمه افزودن شرط جدید (و) | عناصر یک آرایه داخلی |
| بین گروهها | گروهها با یا؛ دکمه افزودن شرط جدید (یا) | عناصر آرایه بیرونی |
فرمول کلی:
(A₁ AND A₂ AND …) OR (B₁ AND B₂ AND …) OR (C₁ AND C₂ AND …)اگر حداقل یکی از گروهها برقرار باشد، یعنی همهی شرطهای آن گروه برقرار باشند، قانون یا فیلتر منطبق محسوب میشود.
| ساختار | معادل |
|---|---|
| دو شرط در یک گروه، بهعلاوه یک گروه دیگر | (A AND B) OR (C) |
| سه گروه | (A AND B) OR (C AND D) OR (E) |
| یک شرط تنها | A |
سقف گروه
حداکثر ۱۰ گروه و در هر گروه حداکثر ۱۰ شرط.
گروه اشتباه، تطابق زودتر
اگر چند شرط باید همزمان برقرار باشند، آنها را در یک گروه (و) میگذاریم. شرطهای گروههای جدا با یا خوانده میشوند و قانون با برقرار بودن فقط یکی از گروهها منطبق میشود.
معکوس کردن شرط
در پنل، عملگرهای «نباشد» و «نشود» نتیجه همان شرط را معکوس میکنند، نه کل گروه را.
در API، همان کار با negate: true روی همان شرط انجام میشود.
مثال مفهومی
دو گروه:
- مسیر برابر
/adminو کشور برابرIR - متد برابر
POST
معادل: مسیر /admin از ایران، یا هر درخواست POST.
ساختار در API
constraints یک آرایه دوبعدی است:
| لایه | معنی |
|---|---|
| آرایه بیرونی | گروهها با OR |
| آرایه داخلی | شرطها با AND |
شکل هر شرط
| فیلد | نوع | معنی |
|---|---|---|
type | string enum | نوع شرط |
negate | bool | اختیاری؛ با true نتیجه همان شرط معکوس میشود |
آبجکت همنام با type | object | عملگر و مقدار؛ دقیقا یکی پر میشود |
نمونه:
{
"type": "known_bots",
"known_bots": {
"operator": "equals",
"expected": "false"
}
}انواع شرط و عملگر
هر type دقیقا یک آبجکت متناظر دارد. این فهرست، قرارداد عمومی سیستم برای constraints است.
type | عملگرهای مجاز | فیلدهای مقدار | معنی |
|---|---|---|---|
country | equals | expected: تا ۱۰ کد کشور | کشور GeoIP کلاینت |
path | equals، contains، starts_with، ends_with، matches | expected: تا ۱۰ مسیر بدون Query | مسیر درخواست |
uri | همان عملگرهای path | expected: تا ۱۰ مسیر بههمراه Query | مسیر + Query |
host | همان عملگرهای path | expected: تا ۱۰ hostname یا IPv4 | Host درخواست |
header | عملگرهای path بهعلاوه exists | name؛ expected اختیاری | هدر درخواست |
cookie | عملگرهای path بهعلاوه exists | name؛ expected اختیاری | Cookie |
args | عملگرهای path بهعلاوه exists | name؛ expected اختیاری | پارامتر Query |
ip | ip_matches | expected: تا ۱۰ CIDR؛ یا ipSet: نام IP Set | آدرس IP کلاینت |
method | equals | expected: GET، POST، PURGE، PUT، HEAD، OPTIONS، DELETE، PATCH | متد HTTP |
port | equals | expected: مثلا 80 یا 443 | پورت |
http_version | equals | expected: مثلا HTTP/1.1، HTTP/2، HTTP/3 | نسخه HTTP |
tls | equals | expected: true / false | HTTP در برابر HTTPS |
known_bots | equals | expected: true / false | بات شناختهشده |
asn | equals، lesser، greater | expected: تا ۱۰ عدد ASN | شماره ASN |
edge | همان عملگرهای path | expected: تا ۱۰ نام لبه | نام نود لبه |
status | equals | expected: تا ۱۰ کد وضعیت | وضعیت پاسخ به کلاینت |
upstream_status | equals | expected: تا ۱۰ کد وضعیت | وضعیت پاسخ آپاستریم |
cache_status | equals | expected: مثلا HIT، MISS، BYPASS | وضعیت کش |
user_agent | equals، contains، starts_with، ends_with، matches | expected: تا ۱۰ رشته | رشته User-Agent |
upstream_address | ip_matches | expected: تا ۱۰ CIDR یا آدرس | آدرس آپاستریم |
matches الگوی Glob است. مجموع الگوهای Glob روی مسیر، URI، Host و Query حداکثر ۱۲۰ مقدار است.
نام Header، Cookie و پارامتر Query حداکثر ۱۲۸ کاراکتر و مقدارهای رشتهای معمولا حداکثر ۴۰۹۶ کاراکتر است. در هر شرط حداکثر ۱۰ مقدار مجاز است.
زمان ارزیابی
شرطهای مبتنی بر درخواست (
path،method،ipو مانند آن) در ارزیابی قانون قبل از پاسخ هم معنا دارند. شرطهای مبتنی بر پاسخ (status،upstream_status،cache_status،upstream_address) پس از مشخص شدن پاسخ معنا دارند و معمولا در فیلتر لاگ استفاده میشوند.
پنل
برخی typeها مانند
port،http_versionوedgeدر همه فرمهای پنل دیده نمیشوند؛ در API قابل ارسالاند. برایipدر برخی فرمها فقط CIDR در دسترس است وipSetنیست.
نمونههای JSON
مسیر /admin از ایران، یا هر POST:
"constraints": [
[
{
"type": "path",
"path": {
"operator": "equals",
"expected": ["/admin"]
}
},
{
"type": "country",
"country": {
"operator": "equals",
"expected": ["IR"]
}
}
],
[
{
"type": "method",
"method": {
"operator": "equals",
"expected": ["POST"]
}
}
]
]GET با کش HIT، یا GET با وضعیت 504:
"constraints": [
[
{
"type": "method",
"method": {
"operator": "equals",
"expected": ["GET"]
}
},
{
"type": "cache_status",
"cache_status": {
"operator": "equals",
"expected": ["HIT"]
}
}
],
[
{
"type": "method",
"method": {
"operator": "equals",
"expected": ["GET"]
}
},
{
"type": "status",
"status": {
"operator": "equals",
"expected": ["504"]
}
}
]
]