Chính sách về HMAC

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến Tài liệu về Apigee X. thông tin

Tính toán và xác minh Mã xác thực thông báo dựa trên hàm băm (HMAC). Thỉnh thoảng được gọi là Mã xác thực thông điệp được khoá hoặc hàm băm có khoá, HMAC sử dụng hàm băm mật mã như SHA-1, SHA-224, SHA-256, SHA-384, SHA-512 hoặc MD-5 được áp dụng cho một "thông báo" cùng với một khoá bí mật, để tạo chữ ký hoặc mã xác thực thư trên thư đó. Từ khoá "tin nhắn" vào đây tham chiếu đến bất kỳ luồng byte nào. Người gửi thông báo cũng có thể gửi HMAC đến người nhận, và người nhận có thể sử dụng HMAC để xác thực thông báo.

Để tìm hiểu thêm về HMAC, xem HMAC: Keyed-Hahash cho Xác thực Thư (rfc2104).

Mẫu

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

Tham chiếu phần tử cho HMAC

Tài liệu tham khảo chính sách mô tả các thành phần và thuộc tính của chính sách HMAC.

Những thuộc tính mà áp dụng cho phần tử cấp cao nhất

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

Các thuộc tính sau đây áp dụng chung cho tất cả phần tử mẹ của chính sách.

<Algorithm>

<Algorithm>algorithm-name</Algorithm>

Chỉ định thuật toán băm để tính HMAC.

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

Sử dụng cùng với thuộc tính name để gắn nhãn chính sách trong trình chỉnh sửa proxy giao diện người dùng Apigee bằng một tên ngôn ngữ tự nhiên khác.

<Message>

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

Chỉ định tải trọng thông báo cần ký. Dữ liệu đầu vào của phần tử này hỗ trợ mẫu thông báo (thay thế biến) để cho phép đưa các mục bổ sung vào trong thời gian chạy, chẳng hạn như dấu thời gian, số chỉ dùng một lần, danh sách tiêu đề hoặc thông tin khác. Ví dụ:

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

Mẫu thông báo có thể bao gồm các phần cố định và thay đổi được, kể cả dòng mới và hàm tĩnh. Khoảng trắng rất quan trọng.

<Output>

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

Chỉ định tên của biến mà chính sách phải đặt bằng giá trị HMAC đã tính toán. Đồng thời, chỉ định phương thức mã hoá để sử dụng cho đầu ra.

<SecretKey>

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

Chỉ định khoá bí mật dùng để tính toán HMAC. Khoá này lấy từ dữ liệu đã tham chiếu được giải mã theo kiểu mã hoá cụ thể.

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

<VerificationValue>

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

(Không bắt buộc) Chỉ định giá trị xác minh cũng như thuật toán mã hoá được dùng để mã hoá giá trị xác minh. Chính sách sẽ sử dụng thuật toán này để giải mã giá trị.

<IgnoreUnresolvedVariables>

<IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables>

Đặt thành false nếu bạn muốn chính sách gửi lỗi khi bất kỳ biến được tham chiếu nào được chỉ định không thể giải quyết được trong chính sách. Đặt thành true để coi mọi biến không thể giải quyết là một chuỗi trống (rỗng).

Giá trị boolean IgnoreUnresolvedVariables chỉ ảnh hưởng đến các biến được tham chiếu bởi tin nhắn mẫu. Mặc dù SecretKey và VerificationValue đều có thể tham chiếu đến một biến, nhưng cả hai trong số đó cần phải phân giải được, vì vậy cài đặt ignore không áp dụng cho các mục đó.

Biến luồng

Chính sách này có thể đặt các biến này trong quá trình thực thi.

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>