در این صفحه، منطق شروط قوانین و فیلترها را بررسی می‌کنیم. شرط‌های هر گروه با و و گروه‌ها با یا ترکیب می‌شوند (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 روی همان شرط انجام می‌شود.

مثال مفهومی

دو گروه:

  1. مسیر برابر /admin و کشور برابر IR
  2. متد برابر POST

معادل: مسیر /admin از ایران، یا هر درخواست POST.

ساختار در API

constraints یک آرایه دوبعدی است:

لایهمعنی
آرایه بیرونیگروه‌ها با OR
آرایه داخلیشرط‌ها با AND

شکل هر شرط

فیلدنوعمعنی
typestring enumنوع شرط
negateboolاختیاری؛ با true نتیجه همان شرط معکوس می‌شود
آبجکت هم‌نام با typeobjectعملگر و مقدار؛ دقیقا یکی پر می‌شود

نمونه:

{
  "type": "known_bots",
  "known_bots": {
    "operator": "equals",
    "expected": "false"
  }
}

انواع شرط و عملگر

هر type دقیقا یک آبجکت متناظر دارد. این فهرست، قرارداد عمومی سیستم برای constraints است.

typeعملگرهای مجازفیلدهای مقدارمعنی
countryequalsexpected: تا ۱۰ کد کشورکشور GeoIP کلاینت
pathequals، contains، starts_with، ends_with، matchesexpected: تا ۱۰ مسیر بدون Queryمسیر درخواست
uriهمان عملگرهای pathexpected: تا ۱۰ مسیر به‌همراه Queryمسیر + Query
hostهمان عملگرهای pathexpected: تا ۱۰ hostname یا IPv4Host درخواست
headerعملگرهای path به‌علاوه existsname؛ expected اختیاریهدر درخواست
cookieعملگرهای path به‌علاوه existsname؛ expected اختیاریCookie
argsعملگرهای path به‌علاوه existsname؛ expected اختیاریپارامتر Query
ipip_matchesexpected: تا ۱۰ CIDR؛ یا ipSet: نام IP Setآدرس IP کلاینت
methodequalsexpected: GET، POST، PURGE، PUT، HEAD، OPTIONS، DELETE، PATCHمتد HTTP
portequalsexpected: مثلا 80 یا 443پورت
http_versionequalsexpected: مثلا HTTP/1.1، HTTP/2، HTTP/3نسخه HTTP
tlsequalsexpected: true / falseHTTP در برابر HTTPS
known_botsequalsexpected: true / falseبات شناخته‌شده
asnequals، lesser، greaterexpected: تا ۱۰ عدد ASNشماره ASN
edgeهمان عملگرهای pathexpected: تا ۱۰ نام لبهنام نود لبه
statusequalsexpected: تا ۱۰ کد وضعیتوضعیت پاسخ به کلاینت
upstream_statusequalsexpected: تا ۱۰ کد وضعیتوضعیت پاسخ آپ‌استریم
cache_statusequalsexpected: مثلا HIT، MISS، BYPASSوضعیت کش
user_agentequals، contains، starts_with، ends_with، matchesexpected: تا ۱۰ رشتهرشته User-Agent
upstream_addressip_matchesexpected: تا ۱۰ 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"]
      }
    }
  ]
]

ادامه مسیر