خط مشی JSONThreatProtection

شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات

چه

با فراهم کردن امکان تعیین محدودیت برای ساختارهای مختلف JSON، مانند آرایه‌ها و رشته‌ها، خطر حملات سطح محتوا را به حداقل می‌رساند.

ویدیو: برای کسب اطلاعات بیشتر در مورد اینکه چگونه سیاست JSONThreatProtection شما را قادر می‌سازد تا APIها را در برابر حملات سطح محتوا ایمن کنید، یک ویدیوی کوتاه تماشا کنید.

ویدیو: این ویدیوی کوتاه را در مورد پلتفرم API ابری Apigee ببینید.

مرجع عنصر

مرجع عنصر، عناصر و ویژگی‌های سیاست JSONThreatProtection را توصیف می‌کند.

<JSONThreatProtection async="false" continueOnError="false" enabled="true" name="JSON-Threat-Protection-1">
   <DisplayName>JSONThreatProtection 1</DisplayName>
   <ArrayElementCount>20</ArrayElementCount>
   <ContainerDepth>10</ContainerDepth>
   <ObjectEntryCount>15</ObjectEntryCount>
   <ObjectEntryNameLength>50</ObjectEntryNameLength>
   <Source>request</Source>
   <StringValueLength>500</StringValueLength>
</JSONThreatProtection>

ویژگی‌های <JSONThreatProtection> 

<JSONThreatProtection async="false" continueOnError="false" enabled="true" name="JSON-Threat-Protection-1">

جدول زیر ویژگی هایی را توصیف می کند که برای همه عناصر اصلی خط مشی مشترک هستند:

صفت توضیحات پیش فرض حضور
name

نام داخلی سیاست. مقدار مشخصه name می تواند شامل حروف، اعداد، فاصله، خط تیره، زیرخط و نقطه باشد. این مقدار نمی تواند بیش از 255 کاراکتر باشد.

در صورت تمایل، از عنصر <DisplayName> برای برچسب گذاری خط مشی در ویرایشگر پروکسی UI مدیریت با نامی به زبان طبیعی دیگر استفاده کنید.

 N/A مورد نیاز
continueOnError

برای بازگرداندن خطا در صورت شکست خط مشی، روی false تنظیم کنید. این رفتار مورد انتظار برای اکثر سیاست ها است.

روی true تنظیم کنید تا اجرای جریان حتی پس از شکست خط مشی ادامه یابد.

 نادرست اختیاری
enabled

برای اجرای خط مشی روی true تنظیم کنید.

برای خاموش کردن خط مشی، روی false تنظیم کنید. این سیاست حتی اگر به یک جریان وابسته باشد اجرا نخواهد شد.

 درست است اختیاری
async

این ویژگی منسوخ شده است.

 نادرست منسوخ شده است

عنصر <DisplayName>

علاوه بر ویژگی name برای برچسب‌گذاری خط‌مشی در ویرایشگر پروکسی رابط کاربری مدیریت با نامی متفاوت و به زبان طبیعی، از آن استفاده کنید.

<DisplayName>Policy Display Name</DisplayName>
پیش فرض

N/A

اگر این عنصر را حذف کنید، از مقدار ویژگی name خط مشی استفاده می شود.

حضور اختیاری
تایپ کنید رشته

عنصر <ArrayElementCount>

حداکثر تعداد عناصر مجاز در یک آرایه را مشخص می‌کند.

<ArrayElementCount>20</ArrayElementCount>
پیش‌فرض: اگر این عنصر را مشخص نکنید، یا اگر یک عدد صحیح منفی مشخص کنید، سیستم محدودیتی اعمال نمی‌کند.
حضور: اختیاری
نوع: عدد صحیح

عنصر <ContainerDepth>

حداکثر عمق مجاز برای نگهداری داده‌ها را مشخص می‌کند، در مواردی که کانتینرها اشیاء یا آرایه‌ها باشند. برای مثال، آرایه‌ای که شامل یک شیء است و آن شیء نیز شامل یک شیء دیگر است، منجر به عمق نگهداری ۳ خواهد شد.

<ContainerDepth>10</ContainerDepth>
پیش‌فرض: اگر این عنصر را مشخص نکنید، یا اگر یک عدد صحیح منفی مشخص کنید، سیستم هیچ محدودیتی اعمال نمی‌کند.
حضور: اختیاری
نوع: عدد صحیح

عنصر <ObjectEntryCount>

حداکثر تعداد ورودی‌های مجاز در یک شیء را مشخص می‌کند.

<ObjectEntryCount>15</ObjectEntryCount>
پیش‌فرض: اگر این عنصر را مشخص نکنید، یا اگر یک عدد صحیح منفی مشخص کنید، سیستم هیچ محدودیتی اعمال نمی‌کند.
حضور: اختیاری
نوع: عدد صحیح

عنصر <ObjectEntryNameLength>

حداکثر طول رشته مجاز برای نام یک ویژگی درون یک شیء را مشخص می‌کند.

<ObjectEntryNameLength>50</ObjectEntryNameLength>
پیش‌فرض: اگر این عنصر را مشخص نکنید، یا اگر یک عدد صحیح منفی مشخص کنید، سیستم محدودیتی اعمال نمی‌کند.
حضور: اختیاری
نوع: عدد صحیح

عنصر <منبع>

پیامی که باید برای حملات JSON payload بررسی شود. این گزینه معمولاً روی request تنظیم می‌شود، زیرا معمولاً نیاز به اعتبارسنجی درخواست‌های ورودی از برنامه‌های کلاینت دارید. وقتی روی message تنظیم شود، این عنصر به طور خودکار پیام درخواست را هنگام اتصال به جریان درخواست و پیام پاسخ را هنگام اتصال به جریان پاسخ ارزیابی می‌کند.

<Source>request</Source>
پیش‌فرض: درخواست
حضور: اختیاری
نوع:

رشته.

مقادیر معتبر: درخواست، پاسخ یا پیام.

عنصر <StringValueLength>

حداکثر طول مجاز برای یک مقدار رشته‌ای را مشخص می‌کند.

<StringValueLength>500</StringValueLength>
پیش‌فرض: اگر این عنصر را مشخص نکنید، یا اگر یک عدد صحیح منفی مشخص کنید، سیستم محدودیتی اعمال نمی‌کند.
حضور: اختیاری
نوع: عدد صحیح

مرجع خطا

این بخش کدهای خطا و پیام‌های خطایی را که برگردانده می‌شوند و متغیرهای خطا را که توسط Edge تنظیم می‌شوند، هنگامی که این خط‌مشی خطا را راه‌اندازی می‌کند، توضیح می‌دهد. این اطلاعات برای دانستن اینکه آیا در حال توسعه قوانین خطا برای رسیدگی به خطاها هستید، مهم است. برای کسب اطلاعات بیشتر، آنچه را که باید در مورد خطاهای خط مشی و مدیریت خطاها بدانید را ببینید.

خطاهای زمان اجرا

این خطاها ممکن است هنگام اجرای سیاست رخ دهند.

کد خطا وضعیت HTTP علت رفع کنید
steps.jsonthreatprotection.ExecutionFailed 500 خط مشی JSONThreatProtection می تواند انواع مختلفی از خطاهای ExecutionFailed را ایجاد کند. بیشتر این خطاها زمانی رخ می‌دهند که از یک آستانه مشخص در خط‌مشی تجاوز کند. این نوع خطاها عبارتند از: طول نام ورودی شیء ، تعداد ورودی شیء ، تعداد عناصر آرایه ، عمق ظرف ، طول مقدار رشته رشته . این خطا همچنین زمانی رخ می‌دهد که payload دارای یک شی JSON نامعتبر باشد.
steps.jsonthreatprotection.SourceUnavailable 500 این خطا در صورتی رخ می دهد که متغیر پیام مشخص شده در عنصر <Source> یکی از این موارد باشد:
  • خارج از محدوده (در جریان خاصی که سیاست در آن اجرا می شود موجود نیست)
  • یکی از مقادیر معتبر request ، response یا message نیست
steps.jsonthreatprotection.NonMessageVariable 500 این خطا در صورتی رخ می دهد که عنصر <Source> روی متغیری تنظیم شود که از نوع پیام نیست.

خطاهای استقرار

هیچ کدام

متغیرهای خطا

این متغیرها زمانی تنظیم می شوند که این خط مشی خطایی را ایجاد کند. برای اطلاعات بیشتر، به آنچه باید در مورد خطاهای خط مشی بدانید مراجعه کنید.

متغیرها کجا مثال
fault.name=" fault_name " fault_name نام خطا است، همانطور که در جدول خطاهای Runtime در بالا ذکر شده است. نام خطا آخرین قسمت کد خطا است. fault.name Matches "SourceUnavailable"
jsonattack. policy_name .failed policy_name نام سیاستی است که توسط کاربر مشخص شده است که خطا را ایجاد کرده است. jsonattack.JTP-SecureRequest.failed = true

نمونه پاسخ خطا 

{
  "fault": {
    "faultstring": "JSONThreatProtection[JPT-SecureRequest]: Execution failed. reason: JSONThreatProtection[JTP-SecureRequest]: Exceeded object entry name length at line 2",
    "detail": {
      "errorcode": "steps.jsonthreatprotection.ExecutionFailed"
    }
  }
}

مثال قانون خطا 

<FaultRule name="JSONThreatProtection Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ExecutionFailed") </Condition>
    </Step>
    <Condition>(jsonattack.JPT-SecureRequest.failed = true) </Condition>
</FaultRule>

طرحواره‌ها

یادداشت‌های استفاده

مانند سرویس‌های مبتنی بر XML، APIهایی که از نمادگذاری شیء جاوااسکریپت (JSON) پشتیبانی می‌کنند، در برابر حملات سطح محتوا آسیب‌پذیر هستند. حملات ساده JSON تلاش می‌کنند از ساختارهایی استفاده کنند که تجزیه‌کننده‌های JSON را تحت الشعاع قرار می‌دهند تا یک سرویس را از کار بیندازند و حملات انکار سرویس در سطح برنامه را القا کنند. همه تنظیمات اختیاری هستند و باید تنظیم شوند تا نیازهای سرویس شما در برابر آسیب‌پذیری‌های احتمالی بهینه شود.

مباحث مرتبط

سیاست JSONtoXML

سیاست محافظت در برابر تهدیدات XML

سیاست محافظت از عبارات منظم