Chính sách về HMAC

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu 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). Đôi khi được gọi là Mã xác thực tin nhắn có khoá hoặc hàm băm có khoá, HMAC sử dụng một 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 "tin nhắn", cùng với một khoá bí mật, để tạo ra một chữ ký hoặc mã xác thực tin nhắn trên tin nhắn đó. Thuật ngữ "thông báo" ở đây đề cập đến mọi luồng byte. Người gửi tin nhắn cũng có thể gửi HMAC cho người nhận và người nhận có thể dùng HMAC để xác thực tin nhắn.

Để tìm hiểu thêm về HMAC, hãy xem HMAC: Keyed-Hashing for Message Authentication (rfc2104) (HMAC: Băm khoá để xác thực thông báo (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>

Tài liệu tham khảo về phần tử cho HMAC

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

Các thuộc tính á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 là thuộc tính chung của tất cả các phần tử chính của chính sách.

<Algorithm>

<Algorithm>algorithm-name</Algorithm>

Chỉ định thuật toán hàm băm để tính toán 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 Apigee UI bằng một tên khác bằng ngôn ngữ tự nhiên.

<Message>

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

Chỉ định tải trọng thông báo cần ký. Đầ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 thêm các mục vào 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, bao gồm cả dòng mới và các hàm tĩnh. Khoảng trắng là một yếu 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 sẽ đặt bằng giá trị HMAC đã tính. Cũng 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á được lấy từ biến được tham chiếu, được giải mã theo phương thức 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á đã 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 này đưa ra lỗi khi không thể phân giải bất kỳ biến được tham chiếu nào mà bạn chỉ định trong chính sách. Đặt thành true để coi mọi biến không phân giải được là một chuỗi trống (rỗng).

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

Biến dòng

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

Tham chiếu lỗi

Phần này mô tả các mã lỗi và thông báo lỗi được trả về cũng như các biến lỗi mà Apigee đặt ra khi chính sách này kích hoạt lỗi. Thông tin này đóng vai trò quan trọng trong việc phát triển các quy tắc lỗi để xử lý lỗi. Để tìm hiểu thêm, hãy xem Những điều bạn cần biết về lỗi chính sách và Xử lý lỗi.

Lỗi thời gian chạy

Những lỗi này có thể xảy ra khi thực thi chính sách.

Lỗi triển khai

Những lỗi này có thể xảy ra khi bạn triển khai proxy chứa chính sách này.

Biến lỗi

Các biến này được đặt khi xảy ra lỗi thời gian chạy. Để biết thêm thông tin, hãy xem Những điều bạn cần biết về lỗi chính sách.

Ví dụ về phản hồi khi gặp lỗi

Để xử lý lỗi, phương pháp hay nhất là bẫy phần errorcode của lỗi của bạn. Đừng dựa vào văn bản trong faultstring vì văn bản này có thể thay đổi.

Ví dụ về quy tắc lỗi

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