خط مشی RegularExpressionProtection

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

چی

اطلاعات را از یک پیام استخراج می کند (به عنوان مثال، URI Path، Query Param، Header، Form Param، Variable، 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>

درباره خط‌مشی Regular Expression Protection

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 استخراج شود و در برابر عبارت منظم ارائه شده ارزیابی شود.

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

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

  اگر از <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>

عنصر <IgnoreUnresolvedVariables>

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

اگر روی 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>

صفات

عنصر <Header>

مشخص می کند که اطلاعات باید از سرصفحه های درخواست و پاسخ استخراج شود و با عبارات منظم ارائه شده ارزیابی شود. شما باید حداقل یک عنصر <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>

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

<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 ("، &، "، <، یا .) باشد، باید قبل از گنجاندن آن، آن را با XML رمزگذاری کنید.

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

عنصر <JSONPayload>

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

<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 ("، &، "، <، یا .) باشد، باید قبل از گنجاندن آن، آن را با XML رمزگذاری کنید.

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

مرجع خطا

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

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

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

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

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

متغیرهای خطا

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

طرحواره ها

موضوعات مرتبط

خط مشی حفاظت از تهدید JSON

خط مشی حفاظت از تهدیدات XML