سياسة 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 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 للتعامل مع أي متغيّر غير قابل للتحليل كسلسلة فارغة (فارغ).

تؤثر القيمة المنطقية تجاهلUnresolvedVariables فقط في المتغيرات المشار إليها من خلال نموذج الرسالة. ومع أنّ السمة 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>