นโยบาย RegularExpressionProtection

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล

อะไร

ดึงข้อมูลจากข้อความ (เช่น เส้นทาง URI, พารามิเตอร์การค้นหา, ส่วนหัว, พารามิเตอร์แบบฟอร์ม, ตัวแปร, เพย์โหลด XML หรือเพย์โหลด JSON) และประเมินเนื้อหานั้นเทียบกับนิพจน์ทั่วไปที่กำหนดไว้ล่วงหน้า หากนิพจน์ทั่วไปที่ระบุมีค่าเป็นจริง ข้อความนั้นถือเป็นภัยคุกคามและจะถูกปฏิเสธ

วิดีโอ

ดูวิดีโอต่อไปนี้เพื่อดูข้อมูลเพิ่มเติมเกี่ยวกับนโยบายการป้องกันนิพจน์ทั่วไป

ลองฟัง

<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 คือชุดของสตริงที่ระบุรูปแบบในสตริง นิพจน์ทั่วไปช่วยให้เนื้อหาได้รับการประเมินแบบเป็นโปรแกรมสำหรับรูปแบบ คุณใช้นิพจน์ทั่วไปได้ เช่น ในการประเมินอีเมลเพื่อให้แน่ใจว่ามีโครงสร้างที่ถูกต้อง ดูข้อมูลเพิ่มเติมที่นิพจน์ทั่วไปในบทแนะนำ Java

การใช้งาน 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 ยอมรับทั้ง 2 อย่าง จากนั้นคุณสามารถกำหนดนโยบายการป้องกันนิพจน์ทั่วไปที่ใช้ทั้งองค์ประกอบ <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 เพื่อติดป้ายกำกับนโยบายในเครื่องมือแก้ไขพร็อกซี UI การจัดการด้วยชื่อที่เป็นภาษาธรรมชาติที่แตกต่างออกไป

<DisplayName>Policy Display Name</DisplayName>

องค์ประกอบ <Source>

ระบุข้อความที่ต้องการดึงข้อมูล

หากละเว้นองค์ประกอบ <Source> ค่าเริ่มต้นจะเป็น message เช่น <Source>message</Source> เมื่อตั้งค่าเป็น message นโยบายจะใช้ข้อความคำขอเป็นแหล่งที่มาเมื่อแนบไปกับโฟลว์คำขอ ในทำนองเดียวกัน นโยบายจะใช้ข้อความตอบกลับเมื่อแนบไปกับขั้นตอนการตอบกลับด้วย

หากข้อความต้นฉบับแก้ไขไม่ได้ หรือแก้ไขเป็นประเภทที่ไม่ใช่ข้อความ นโยบายจะแสดงข้อผิดพลาด

<Source>response</Source>

องค์ประกอบ < ignoreUnresolvedVariable>

กำหนดว่านโยบายจะแสดงผลข้อผิดพลาดหรือไม่เมื่อตรวจพบตัวแปรที่แก้ไขไม่ได้

หากตั้งค่าเป็น false (ค่าเริ่มต้น) นโยบายจะแสดงผลข้อผิดพลาดเมื่อพบตัวแปรที่แก้ไขไม่ได้ หากตั้งค่าเป็น true ระบบจะถือว่าตัวแปรที่ยังไม่ได้แก้ไขเป็นสตริงว่างเปล่า (Null)

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

อีลิเมนต์ <URIPath>

ระบุว่าต้องดึงข้อมูลจากเส้นทาง URI คำขอและประเมินเทียบกับนิพจน์ทั่วไปที่ให้ไว้ คุณต้องระบุองค์ประกอบ <Pattern> อย่างน้อย 1 รายการที่ระบุรูปแบบนิพจน์ทั่วไปให้ตรงกัน

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

องค์ประกอบ <QueryParam>

ระบุว่าต้องดึงข้อมูลจากพารามิเตอร์การค้นหาของคำขอและประเมินเทียบกับนิพจน์ทั่วไปที่ระบุ คุณต้องระบุองค์ประกอบ <Pattern> อย่างน้อย 1 รายการที่ระบุรูปแบบนิพจน์ทั่วไปให้ตรงกัน

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

Attributes

องค์ประกอบ <Header>

ระบุว่าต้องดึงข้อมูลจากส่วนหัวของคำขอและคำตอบและประเมินเทียบกับนิพจน์ทั่วไปที่ระบุ คุณต้องระบุองค์ประกอบ <Pattern> อย่างน้อย 1 รายการที่ระบุรูปแบบนิพจน์ทั่วไปให้ตรงกัน

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

Attributes

องค์ประกอบ <FormParam>

ระบุว่าต้องดึงข้อมูลจากพารามิเตอร์ของแบบฟอร์มคําขอและประเมินเทียบกับนิพจน์ทั่วไปที่ระบุ คุณต้องระบุองค์ประกอบ <Pattern> อย่างน้อย 1 รายการที่ระบุรูปแบบนิพจน์ทั่วไปให้ตรงกัน

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

Attributes

องค์ประกอบ <Variable>

ระบุว่าต้องดึงข้อมูลจากตัวแปรที่ระบุและประเมินเทียบกับนิพจน์ทั่วไปที่ให้ไว้

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

Attributes

องค์ประกอบ <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>

Attributes

องค์ประกอบ <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>

Attributes

องค์ประกอบ <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