خط مشی 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>

<DisplayName>Policy Display Name</DisplayName>

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

<پیام>

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

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

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

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

<خروجی>

<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 را تنظیم کنید تا هر متغیر غیرقابل حلی را به عنوان یک رشته خالی (تهی) در نظر بگیرید.

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