سياسة HMAC

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلىمستندات Apigee X. info

تحسب هذه السياسة رمز مصادقة الرسائل المستند إلى التجزئة (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>algorithm-name</Algorithm>

تحدّد هذه السمة خوارزمية التجزئة لحساب HMAC.

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

يمكنك استخدام هذه السمة بالإضافة إلى سمة name لتسمية السياسة في محرِّر الخادم الوكيل في واجهة مستخدم 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>