นโยบาย HMAC

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

คำนวณและยืนยัน Hash-based Message Authentication Code (HMAC) บางครั้ง เรียกว่า Keyed Message Authentication Code หรือ Keyed hash โดย HMAC จะใช้ฟังก์ชันการแฮชที่เข้ารหัสลับ เช่น SHA-1, SHA-224, SHA-256, SHA-384, SHA-512 หรือ MD-5 กับ "ข้อความ" พร้อมกับคีย์ลับ เพื่อสร้างลายเซ็นหรือรหัสการตรวจสอบสิทธิ์ข้อความในข้อความนั้น คำว่า "ข้อความ" ในที่นี้ หมายถึงสตรีมไบต์ใดก็ได้ ผู้ส่งข้อความยังสามารถส่ง HMAC ไปยังผู้รับได้ด้วย และผู้รับสามารถใช้ HMAC เพื่อตรวจสอบสิทธิ์ข้อความได้

ดูข้อมูลเพิ่มเติมเกี่ยวกับ HMAC, ดูที่ HMAC: Keyed-Hashing สำหรับ Message Authentication (rfc2104)

ตัวอย่าง

<HMAC name='HMAC-1'>

  <Algorithm>SHA256</Algorithm>

  <SecretKey ref='private.secretkey'/>

  <IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables> <!-- optional -->

  <!--
    The "message" can include fixed and multiple variable parts,
    including newlines and static functions.
    Whitespace is significant.
   -->
  <Message>Fixed Part
    {a_variable}
    {timeFormatUTCMs(timeFormatString1,system.timestamp)}
    {nonce}
  </Message>

  <!-- default encoding is base64 -->
  <Output encoding='base16'>name_of_variable</Output>

</HMAC>

<HMAC name='HMAC-1'>

  <Algorithm>SHA256</Algorithm>

  <SecretKey ref='private.secretkey'/>

  <IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables> <!-- optional -->

  <!--
    The "message" can include fixed and multiple variable parts,
    including newlines and static functions.
    Whitespace is significant.
   -->
  <Message>Fixed Part
    {a_variable}
    {timeFormatUTCMs(timeFormatString1,system.timestamp)}
    {nonce}
  </Message>

  <!--
    VerificationValue is optional.
    Include it to perform an HMAC check.
  -->
  <VerificationValue encoding='base16' ref='expected_hmac_value'/>

  <!-- default encoding is base64 -->
  <Output encoding='base16'>name_of_variable</Output>

</HMAC>

ข้อมูลอ้างอิงขององค์ประกอบสำหรับ HMAC

ข้อมูลอ้างอิงของนโยบายจะอธิบายองค์ประกอบและแอตทริบิวต์ของนโยบาย HMAC

แอตทริบิวต์ที่ ใช้กับองค์ประกอบระดับบนสุด

<HMAC name="HMAC" continueOnError="false" enabled="true" async="false">

แอตทริบิวต์ต่อไปนี้เป็นแอตทริบิวต์ทั่วไปขององค์ประกอบระดับบนสุดของนโยบายทั้งหมด

<Algorithm>

<Algorithm>algorithm-name</Algorithm>

ระบุอัลกอริทึมการแฮชเพื่อคำนวณ HMAC

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

ใช้เพิ่มเติมจากแอตทริบิวต์ name เพื่อติดป้ายกำกับนโยบายในเครื่องมือแก้ไขพร็อกซี UI ของ Apigee ด้วยชื่อภาษาธรรมชาติอื่น

<Message>

<Message>message_template_here</Message>
or
<Message ref='variable_here'/>

ระบุเพย์โหลดของข้อความที่จะลงชื่อ อินพุตขององค์ประกอบนี้รองรับ เทมเพลตข้อความ (การแทนที่ตัวแปร) เพื่อให้รวมรายการเพิ่มเติมได้ในรันไทม์ เช่น การประทับเวลา, Nonce, รายการส่วนหัว หรือข้อมูลอื่นๆ ตัวอย่างเช่น

<Message>Fixed Part
    {a_variable}
    {timeFormatUTCMs(timeFormatString1,system.timestamp)}
    {nonce}
</Message>

เทมเพลตข้อความสามารถมีส่วนคงที่และส่วนตัวแปร รวมถึงบรรทัดใหม่และฟังก์ชันแบบคงที่ ช่องว่างมีความสำคัญ

<Output>

<Output encoding='encoding_name'>variable_name</Output>

ระบุชื่อตัวแปรที่นโยบายควรตั้งค่าด้วยค่า HMAC ที่คำนวณได้ และยังระบุการเข้ารหัสที่จะใช้สำหรับเอาต์พุตด้วย

<SecretKey>

<SecretKey encoding='encoding_name' ref='private.secretkey'/>

ระบุคีย์ลับที่ใช้คำนวณ HMAC ระบบจะรับคีย์จากตัวแปรที่อ้างอิง และถอดรหัสตามการเข้ารหัสที่เฉพาะเจาะจง

 <SecretKey encoding='hex' ref='private.encodedsecretkey'/>

<VerificationValue>

<VerificationValue encoding='encoding_name' ref='variable_name'/>
or
<VerificationValue encoding='encoding_name'>string_value</VerificationValue>

(ไม่บังคับ) ระบุค่าการยืนยัน รวมถึงอัลกอริทึมการเข้ารหัสที่ ใช้เข้ารหัสค่าการยืนยัน นโยบายจะใช้อัลกอริทึมนี้เพื่อถอดรหัสค่า

<IgnoreUnresolvedVariables>

<IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables>

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

บูลีน IgnoreUnresolvedVariables จะมีผลกับตัวแปรที่ เทมเพลตข้อความอ้างอิงเท่านั้น แม้ว่า SecretKey และ VerificationValue จะอ้างอิงตัวแปรได้ แต่ทั้ง 2 อย่างนี้ต้องแก้ไขได้ ดังนั้นการตั้งค่า ignore จึงไม่มีผลกับตัวแปรดังกล่าว

ตัวแปรโฟลว์

นโยบายสามารถตั้งค่าตัวแปรเหล่านี้ระหว่างการดำเนินการ

การอ้างอิงข้อผิดพลาด

ส่วนนี้จะอธิบายโค้ดข้อผิดพลาดและข้อความแสดงข้อผิดพลาดที่แสดงผลและตัวแปรความผิดที่ Apigee กำหนดเมื่อนโยบายนี้ทริกเกอร์ข้อผิดพลาด ข้อมูลนี้เป็นสิ่งสำคัญที่ต้องทราบหากคุณกำลังกำหนดกฎข้อผิดพลาดเพื่อจัดการกับข้อผิดพลาด ดูข้อมูลเพิ่มเติมได้ที่สิ่งที่คุณต้องทราบเกี่ยวกับข้อผิดพลาดของนโยบายและการจัดการข้อผิดพลาด

ข้อผิดพลาดเกี่ยวกับรันไทม์

ข้อผิดพลาดเหล่านี้อาจเกิดขึ้นเมื่อนโยบายทำงาน

ข้อผิดพลาดในการทำให้ใช้งานได้

ข้อผิดพลาดเหล่านี้อาจเกิดขึ้นเมื่อคุณใช้พร็อกซีที่มีนโยบายนี้

ตัวแปรความผิดพลาด

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

ตัวอย่างการตอบสนองข้อผิดพลาด

สำหรับการจัดการข้อผิดพลาด แนวทางปฏิบัติแนะนำคือให้ดักจับส่วน errorcode ของข้อผิดพลาด คำตอบ อย่าพึ่งพาข้อความใน faultstring เนื่องจากอาจมีการเปลี่ยนแปลง

ตัวอย่างกฎข้อผิดพลาด

<FaultRules>
    <FaultRule name="HMAC Policy Errors">
        <Step>
            <Name>AM-Unauthorized</Name>
            <Condition>(fault.name Matches "HmacVerificationFailed")</Condition>
        </Step>
        <Condition>hmac.HMAC-1.failed = true</Condition>
    </FaultRule>
</FaultRules>