خط مشی RegularExpressionProtection

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

چه

اطلاعات را از یک پیام (به عنوان مثال، مسیر URI، پارامتر پرس و جو، هدر، پارامتر فرم، متغیر، XML Payload یا JSON Payload) استخراج می‌کند و آن محتوا را در برابر عبارات منظم از پیش تعریف شده ارزیابی می‌کند. اگر هر یک از عبارات منظم مشخص شده درست ارزیابی شوند، پیام به عنوان یک تهدید در نظر گرفته شده و رد می‌شود.

ویدیوها

برای کسب اطلاعات بیشتر در مورد سیاست حفاظت از عبارات منظم، ویدیوهای زیر را تماشا کنید.

نمونه‌ها

<RegularExpressionProtection name="JsonPathRegExProtection">
    <DisplayName>Regular Expression Protection 1</DisplayName>
    <Source>request</Source>
    <JSONPayload escapeSlashCharacter="true">
       <JSONPath>
          <Expression>$</Expression>
          <Pattern>&lt;\s*script\b[^&gt;]*&gt;[^&lt;]+&lt;\s*\/\s*script\s*&gt;
          </Pattern>
          <Pattern>n\s*\\\\\s*slash</Pattern>
          <Pattern>n\s*\/\s*slash</Pattern>
          <Pattern>n\s*\\"\s*quotes</Pattern>
          <Pattern>n\s*\\b\s*space</Pattern>
          <Pattern>n\s*\\f\s*forwardfeed</Pattern>
          <Pattern>n\s*\\n\s*newline</Pattern>
          <Pattern>n\s*\\r\s*carria</Pattern>
          <Pattern>n\s*\\t\s*tab</Pattern>
          <Pattern>n\s*\\uFFFF\s*hex</Pattern>
       </JSONPath>
    </JSONPayload>
 </RegularExpressionProtection>

<Pattern>[\s]*(?i)((delete)|(exec)|(drop\s*table)|(insert)|(shutdown)|(update)|(\bor\b))</Pattern>

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

Apigee Edge شما را قادر می‌سازد تا عبارات منظمی را پیکربندی کنید که می‌توانند در زمان اجرا در برابر ترافیک API ارزیابی شوند تا تهدیدات رایج در سطح محتوا را که از الگوهای خاصی پیروی می‌کنند، شناسایی کنند.

یک عبارت منظم یا به اختصار regex ، مجموعه‌ای از رشته‌ها است که یک الگو را در یک رشته مشخص می‌کند. عبارات منظم امکان ارزیابی محتوا را از نظر الگوها به صورت برنامه‌نویسی فراهم می‌کنند. به عنوان مثال، می‌توان از عبارات منظم برای ارزیابی یک آدرس ایمیل استفاده کرد تا از ساختار صحیح آن اطمینان حاصل شود. برای اطلاعات بیشتر، به بخش عبارات منظم در آموزش‌های جاوا مراجعه کنید.

رایج‌ترین کاربرد RegularExpressionProtection ارزیابی داده‌های JSON و XML برای یافتن محتوای مخرب است.

هیچ عبارت منظمی نمی‌تواند تمام حملات مبتنی بر محتوا را از بین ببرد و باید چندین مکانیسم برای فعال کردن دفاع در عمق ترکیب شوند. این بخش برخی از الگوهای توصیه شده برای حذف محتوا را شرح می‌دهد.

الگوهای طرد مثال

عبارات منظم باید در فایل پیکربندی XML مربوط به سیاست، به صورت XML کدگذاری شوند.

[\s]*((delete)|(exec)|(drop\s*table)|(insert)|(shutdown)|(update)|(\bor\b))

<!--#(include|exec|echo|config|printenv)\s+.*

<!--#(include|exec|echo|config|printenv)\s+.*

(/(@?[\w_?\w:\*]+(\[[^]]+\])*)?)+

/?(ancestor(-or-self)?|descendant(-or-self)?|following(-sibling))

<\s*script\b[^>]*>[^<]+<\s*/\s*script\s*>

<\s*script\b[^>]*>[^<]+<\s*/\s*script\s*>

.*?Exception in thread.*

هدر Content-Type را در درخواستی با بار داده XML یا JSON تنظیم کنید.

محتوای سیاست حفاظت از عبارات منظم می‌تواند شامل عناصر زیر باشد:

• عنصر <XMLPayload> : مشخص می‌کند که اطلاعات باید از یک XML payload استخراج شده و در برابر عبارت منظم ارائه شده ارزیابی شود.

  اگر از <XMLPayload> در سیاست استفاده می‌کنید، سرآیند Content-Type درخواست باید یک نوع محتوای XML مانند application/xml یا text/xml باشد.

• عنصر <JSONPayload> : مشخص می‌کند که اطلاعات باید از یک JSON payload استخراج شده و در برابر عبارت منظم ارائه شده ارزیابی شود.

  اگر از <JSONPayload> در سیاست استفاده می‌کنید، سرآیند Content-Type درخواست باید از نوع محتوای JSON مانند application/json باشد.

معمولاً شما یک API را طوری طراحی می‌کنید که XML یا JSON را بپذیرد. با این حال، ممکن است سناریویی وجود داشته باشد که API هر دو را بپذیرد. سپس می‌توانید یک سیاست محافظت از عبارات منظم تعریف کنید که از هر دو عنصر <XMLPayload> و <JSONPayload> استفاده کند. فقط یک عنصر برای یک درخواست خاص بر اساس مقدار هدر Content-Type اعمال می‌شود.

مرجع عنصر

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

<RegularExpressionProtection async="false" continueOnError="false" enabled="true" name="Regular-Expression-Protection-1">
   <DisplayName>Regular Expression Protection 1</DisplayName>
   <Source>response</Source>
   <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
   <URIPath>
     <Pattern>REGEX PATTERN</Pattern>
     <Pattern>REGEX PATTERN</Pattern>
   </URIPath>
   <QueryParam name="a-query-param">
     <Pattern>REGEX PATTERN</Pattern>
     <Pattern>REGEX PATTERN</Pattern>
   </QueryParam>
   <Header name="a-header">
     <Pattern>REGEX PATTERN</Pattern>
     <Pattern>REGEX PATTERN</Pattern>
   </Header>
   <FormParam name="a-form-param">
     <Pattern>REGEX PATTERN</Pattern>
     <Pattern>REGEX PATTERN</Pattern>
   </FormParam>
   <Variable name="request.content">
     <Pattern>REGEX PATTERN</Pattern>
     <Pattern>REGEX PATTERN</Pattern>
   </Variable>
   <XMLPayload>
     <Namespaces>
       <Namespace prefix="apigee">http://www.apigee.com</Namespace>
     </Namespaces>
     <XPath>
       <Expression>/apigee:Greeting/apigee:User</Expression>
       <Type>string</Type>
       <Pattern>REGEX PATTERN</Pattern>
       <Pattern>REGEX PATTERN</Pattern>
     </XPath>
   </XMLPayload>
   <JSONPayload>
     <JSONPath>
       <Expression>$.store.book[*].author</Expression>
       <Pattern>REGEX PATTERN</Pattern>
       <Pattern>REGEX PATTERN</Pattern>
     </JSONPath>
    </JSONPayload>
</RegularExpressionProtection>

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

<RegularExpressionProtection async="false" continueOnError="false" enabled="true" name="Regular-Expression-Protection-1">

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

عنصر <DisplayName>

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

<DisplayName>Policy Display Name</DisplayName>

عنصر <منبع>

پیامی را نشان می‌دهد که باید اطلاعات از آن استخراج شود.

اگر عنصر <Source> حذف شود، مقدار پیش‌فرض آن message است. برای مثال، <Source>message</Source> . وقتی روی message تنظیم شود، این سیاست از پیام درخواست به عنوان منبع هنگام اتصال به یک جریان درخواست استفاده می‌کند. به همین ترتیب، این سیاست از پیام پاسخ هنگام اتصال به یک جریان پاسخ استفاده می‌کند.

اگر پیام مبدا قابل حل نباشد یا اگر به نوعی غیر از پیام تبدیل شود، این خط‌مشی خطا برمی‌گرداند.

<Source>response</Source>

عنصر <نادیده گرفتن متغیرهای حل نشده>

تعیین می‌کند که آیا این سیاست هنگام مواجهه با متغیری که غیرقابل حل است، خطایی را برمی‌گرداند یا خیر.

اگر روی false تنظیم شود (پیش‌فرض)، این خط‌مشی هنگام مواجهه با یک متغیر غیرقابل حل، خطایی برمی‌گرداند. اگر روی true تنظیم شود، متغیر حل نشده به عنوان رشته خالی (Null) در نظر گرفته می‌شود.

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

عنصر <URIPath>

مشخص می‌کند که اطلاعات باید از مسیر URI درخواست استخراج شده و در برابر عبارات منظم ارائه شده ارزیابی شوند. شما باید حداقل یک عنصر <Pattern> ارائه دهید که الگوی عبارت منظم را برای مطابقت مشخص کند.

<URIPath>
  <Pattern>REGEX PATTERN</Pattern>
  <Pattern>REGEX PATTERN</Pattern>
</URIPath>

عنصر <QueryParam>

مشخص می‌کند که اطلاعات باید از پارامتر درخواست پرس‌وجو استخراج شده و در برابر عبارات منظم ارائه شده ارزیابی شوند. شما باید حداقل یک عنصر <Pattern> ارائه دهید که الگوی عبارت منظم مورد نظر برای مطابقت را مشخص کند.

<QueryParam name="a-query-param">
  <Pattern>REGEX PATTERN</Pattern>
  <Pattern>REGEX PATTERN</Pattern>
</QueryParam>

ویژگی‌ها

عنصر <سربرگ>

مشخص می‌کند که اطلاعات باید از هدرهای درخواست و پاسخ استخراج شده و در برابر عبارات منظم ارائه شده ارزیابی شوند. شما باید حداقل یک عنصر <Pattern> ارائه دهید که الگوی عبارت منظم را برای مطابقت مشخص کند.

<Header name="a-header">
  <Pattern>REGEX PATTERN</Pattern>
  <Pattern>REGEX PATTERN</Pattern>
</Header>

ویژگی‌ها

عنصر <FormParam>

مشخص می‌کند که اطلاعات باید از پارامتر فرم درخواست استخراج شده و در برابر عبارات منظم ارائه شده ارزیابی شوند. شما باید حداقل یک عنصر <Pattern> ارائه دهید که الگوی عبارت منظم را برای مطابقت مشخص کند.

<FormParam name="a-form-param">
   <Pattern>REGEX PATTERN</Pattern>
   <Pattern>REGEX PATTERN</Pattern>
</FormParam>

ویژگی‌ها

عنصر <متغیر>

مشخص می‌کند که اطلاعات باید از متغیر داده شده استخراج شده و در برابر عبارات منظم ارائه شده ارزیابی شوند.

<Variable name="request.content">
   <Pattern>REGEX PATTERN</Pattern>
   <Pattern>REGEX PATTERN</Pattern>
</Variable>

ویژگی‌ها

عنصر <XMLPayload>

مشخص می‌کند که اطلاعات باید از یک فایل XML استخراج شده و در برابر عبارات منظم ارائه شده ارزیابی شود.

<XMLPayload>
   <Namespaces>
      <Namespace prefix="apigee">http://www.apigee.com</Namespace>
   </Namespaces>
   <XPath>
      <Expression>/apigee:Greeting/apigee:User</Expression>
      <Type>string</Type>
      <Pattern>REGEX PATTERN</Pattern>
      <Pattern>REGEX PATTERN</Pattern>
   </XPath>
</XMLPayload>

عنصر <XMLPayload>/<Namespaces>

فضاهای نامی که قرار است در ارزیابی XPath استفاده شوند را مشخص می‌کند.

<XMLPayload>
   <Namespaces>
      <Namespace prefix="apigee">http://www.apigee.com</Namespace>
   </Namespaces>
   <XPath>
      <Expression>/apigee:Greeting/apigee:User</Expression>
      <Type>string</Type>
      <Pattern>REGEX PATTERN</Pattern>
      <Pattern>REGEX PATTERN</Pattern>
   </XPath>
</XMLPayload>

عنصر <XMLPayload>/<Namespaces>/<Namespace>

<Namespaces>
   <Namespace prefix="apigee">http://www.apigee.com</Namespace>
</Namespaces>

ویژگی‌ها

عنصر <XMLPayload>/<XPath>

<XPath>
   <Expression>/apigee:Greeting/apigee:User</Expression>
   <Type>string</Type>
   <Pattern>REGEX PATTERN</Pattern>
   <Pattern>REGEX PATTERN</Pattern>
</XPath>

عنصر <XMLPayload>/<XPath>/<Expression>

<XPath>
   <Expression>/apigee:Greeting/apigee:User</Expression>
   <Type>string</Type>
   <Pattern>REGEX PATTERN</Pattern>
   <Pattern>REGEX PATTERN</Pattern>
</XPath>

عنصر <XMLPayload>/<XPath>/<Type>

<XPath>
   <Expression>/apigee:Greeting/apigee:User</Expression>
   <Type>string</Type>
   <Pattern>REGEX PATTERN</Pattern>
   <Pattern>REGEX PATTERN</Pattern>
</XPath>

عنصر <XMLPayload>/<XPath>/<Pattern>

الگوی عبارت منظم را تعریف می‌کند. اگر یک عبارت منظم در عنصر <Pattern> شما شامل کاراکترهای رزرو شده XML (",", &, ', <, or .") باشد، قبل از گنجاندن آن، باید آن را با XML-encode کنید.

<XPath>
   <Expression>/apigee:Greeting/apigee:User</Expression>
   <Type>string</Type>
   <Pattern>REGEX PATTERN</Pattern>
   <Pattern>REGEX PATTERN</Pattern>
</XPath>

عنصر <JSONPayload>

مشخص می‌کند که اطلاعات باید از یک JSON payload استخراج شده و در برابر عبارات منظم ارائه شده ارزیابی شود.

<JSONPayload>
   <JSONPath>
      <Expression>$.store.book[*].author</Expression>
      <Pattern>REGEX PATTERN</Pattern>
      <Pattern>REGEX PATTERN</Pattern>
   </JSONPath>
</JSONPayload>

ویژگی‌ها

عنصر <JSONPayload>/<JSONPath>/<Expression>

عبارت JSONPath تعریف شده برای متغیر را مشخص می‌کند.

<JSONPath>
   <Expression>$.store.book[*].author</Expression>
   <Pattern>REGEX PATTERN</Pattern>
   <Pattern>REGEX PATTERN</Pattern>
</JSONPath>

عنصر <JSONPayload>/<JSONPath>/<Pattern>

الگوی عبارت منظم را تعریف می‌کند. اگر یک عبارت منظم در عنصر <Pattern> شما شامل کاراکترهای رزرو شده XML (",", &, ', <, or .") باشد، قبل از گنجاندن آن، باید آن را با XML-encode کنید.

<JSONPath>
   <Expression>$.store.book[*].author</Expression>
   <Pattern>REGEX PATTERN</Pattern>
   <Pattern>REGEX PATTERN</Pattern>
</JSONPath>

مرجع خطا

این بخش کدهای خطا و پیام‌های بازگردانده شده و متغیرهای خطای تنظیم شده توسط Edge را هنگامی که این خط‌مشی خطایی ایجاد می‌کند، توضیح می‌دهد. این اطلاعات برای دانستن اینکه آیا در حال توسعه قوانین خطا برای رسیدگی به خطاها هستید، مهم است. اگر می‌خواهید خطا را ثبت کنید و خطای سفارشی خود را مطرح کنید، ویژگی continueOnError="true" را روی عنصر ریشه سیاست تنظیم کنید. برای کسب اطلاعات بیشتر، آنچه را که باید در مورد خطاهای خط مشی و مدیریت خطاها بدانید را ببینید.

خطاهایی که از خط‌مشی‌های Edge برگردانده می‌شوند از یک قالب ثابت پیروی می‌کنند که در مرجع کد خطا توضیح داده شده است.

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

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

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

متغیرهای خطا

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

طرحواره‌ها

مباحث مرتبط

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

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