خط مشی HMAC

شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات

یک کد احراز هویت پیام مبتنی بر هش (HMAC) را محاسبه و تأیید می‌کند. HMAC که گاهی اوقات با نام کد احراز هویت پیام کلیددار یا هش کلیددار شناخته می‌شود، از یک تابع هش رمزنگاری مانند SHA-1، SHA-224، SHA-256، SHA-384، SHA-512 یا MD-5 استفاده می‌کند که به همراه یک کلید مخفی، بر روی یک "پیام" اعمال می‌شود تا یک امضا یا کد احراز هویت پیام را در آن پیام ایجاد کند. اصطلاح "پیام" در اینجا به هر جریانی از بایت‌ها اشاره دارد. فرستنده پیام همچنین می‌تواند یک HMAC را به گیرنده ارسال کند و گیرنده می‌تواند از HMAC برای احراز هویت پیام استفاده کند.

برای کسب اطلاعات بیشتر در مورد HMAC، به HMAC: Keyed-Hashing for 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-name</Algorithm>

الگوریتم هش برای محاسبه HMAC را مشخص می‌کند.

<نام نمایشی>

<DisplayName>Policy Display Name</DisplayName>

علاوه بر ویژگی نام، از این ویژگی برای برچسب‌گذاری سیاست در ویرایشگر پروکسی Apigee UI با یک نام متفاوت به زبان طبیعی استفاده کنید.

<پیام>

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

بار پیام برای امضا را مشخص می‌کند. ورودی این عنصر از قالب‌های پیام (جایگزینی متغیر) پشتیبانی می‌کند تا امکان افزودن موارد اضافی در زمان اجرا، مانند مهرهای زمانی، عدم قطعیت‌ها، لیست هدرها یا سایر اطلاعات، فراهم شود. به عنوان مثال:

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

قالب پیام می‌تواند شامل بخش‌های ثابت و متغیر، از جمله خطوط جدید و توابع استاتیک باشد. فضای خالی (Whitespace) مهم است.

<خروجی>

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

نام متغیری را که سیاست باید با مقدار HMAC محاسبه‌شده تنظیم کند، مشخص می‌کند. همچنین کدگذاری مورد استفاده برای خروجی را مشخص می‌کند.

<کلید مخفی>

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

کلید مخفی مورد استفاده برای محاسبه HMAC را مشخص می‌کند. این کلید از متغیر ارجاع‌شده به دست می‌آید و طبق کدگذاری خاص رمزگشایی می‌شود.

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

<مقدار تأیید>

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

(اختیاری) مقدار تأیید و همچنین الگوریتم رمزگذاری مورد استفاده برای رمزگذاری مقدار تأیید را مشخص می‌کند. این خط‌مشی از این الگوریتم برای رمزگشایی مقدار استفاده خواهد کرد.

<نادیده گرفتن متغیرهای حل نشده>

<IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables>

اگر می‌خواهید سیاست در صورت غیرقابل حل بودن هر متغیر ارجاع‌شده در سیاست، خطا صادر کند، روی false تنظیم کنید. اگر می‌خواهید هر متغیر غیرقابل حل را به عنوان یک رشته خالی (null) در نظر بگیرید، روی true تنظیم کنید.

مقدار بولی IgnoreUnresolvedVariables فقط روی متغیرهایی تأثیر می‌گذارد که توسط الگوی پیام به آنها ارجاع داده شده است. در حالی که SecretKey و VerificationValue می‌توانند به یک متغیر ارجاع دهند، هر دوی آنها باید قابل حل باشند، بنابراین تنظیم 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>