นโยบาย HMAC

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

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

หากต้องการเรียนรู้เพิ่มเติมเกี่ยวกับ HMAC ดู HMAC: การแฮชด้วยคีย์ สำหรับ 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>

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

<Message>

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

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

<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)

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

ตัวแปรโฟลว์

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

Error reference

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Example error response

For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

Example fault rule

<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>