خط‌مشی HMAC

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

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

برای کسب اطلاعات بیشتر درباره HMAC، به HMAC: درهم‌سازی کلیددار برای اصالت‌سنجی پیام (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>

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

<Message>

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

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

<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 تنظیم کنید.

متغیر بولی 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>