خط‌مشی BasicAuthentication

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

چه

به شما امکان می‌دهد از اصالت‌سنجی پایه سبک‌وزن برای امنیت مایل آخر استفاده کنید. این خط‌مشی نام کاربری و گذرواژه را می‌گیرد، آن‌ها را با Base64 کدبندی می‌کند، و مقدار حاصل را در متغیری می‌نویسد. مقدار حاصل در قالب Basic Base64EncodedString است. معمولاً این مقدار را در سرصفحه HTTP، مثل سرصفحه Authorization، می‌نویسید.

این خط‌مشی همچنین به شما امکان می‌دهد اطلاعات اعتباری ذخیره‌شده در رشته کدبندی‌شده Base64 را به نام کاربری و گذرواژه رمزگشایی کنید.

نمونه‌ها

<BasicAuthentication name="ApplyBasicAuthHeader">
   <DisplayName>ApplyBasicAuthHeader</DisplayName>
   <Operation>Encode</Operation>
   <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
   <User ref="credentials.username" />
   <Password ref="credentials.password" />
   <AssignTo createNew="false">request.header.Authorization</AssignTo>
</BasicAuthentication>

{
  "encrypted" : true,
  "entry" : [ {
    "name" : "username",
    "value" : "MyUsername"
  }, {
    "name" : "password",
    "value" : "MyPassword"
  } ],
  "name" : "BasicAuthCredentials"
}
      

<KeyValueMapOperations name="getCredentials" mapIdentifier="BasicAuthCredentials">
  <Scope>apiproxy</Scope>
  <Get assignTo="credentials.username" index='1'>
    <Key>
      <Parameter>username</Parameter>
    </Key>
  </Get>
  <Get assignTo="credentials.password" index='1'>
    <Key>
      <Parameter>password</Parameter>
    </Key>
  </Get>
</KeyValueMapOperations>
      

<BasicAuthentication name="DecodeBaseAuthHeaders">
   <DisplayName>Decode Basic Authentication Header</DisplayName>
   <Operation>Decode</Operation>
   <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
   <User ref="request.header.username" />
   <Password ref="request.header.password" />
   <Source>request.header.Authorization</Source>
</BasicAuthentication>

درباره خط‌مشی «اصالت‌سنجی پایه»

این خط‌مشی دو حالت عملیاتی دارد:

• کدبندی: نام کاربری و گذرواژه ذخیره‌شده در متغیرها را با Base64 کدبندی می‌کند
• رمزگشایی: نام کاربری و گذرواژه را از یک رشته کدبندی‌شده پایه ۶۴تایی رمزگشایی می‌کند

نام کاربری و گذرواژه معمولاً در فروشگاه کلید/مقدار ذخیره می‌شوند و سپس در زمان اجرا از فروشگاه کلید/مقدار خوانده می‌شوند. برای جزئیات استفاده از فروشگاه کلید/مقدار، خط‌مشی عملیات نقشه مقدار کلید را ببینید.

مرجع عنصر

مرجع عنصر عناصر و مشخصه‌های خط‌مشی BasicAuthentication را توصیف می‌کند.

<BasicAuthentication async="false" continueOnError="false" enabled="true" name="Basic-Authentication-1">
   <DisplayName>Basic Authentication 1</DisplayName>
   <Operation>Encode</Operation>
   <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
   <User ref="credentials.username" />
   <Password ref="credentials.password" />
   <AssignTo createNew="false">request.header.Authorization</AssignTo>
   <Source>request.header.Authorization</Source> 
</BasicAuthentication>

مشخصه‌های <BasicAuthentication>

<BasicAuthentication async="false" continueOnError="false" enabled="true" name="Basic-Authentication-1">

جدول زیر ویژگی هایی را توصیف می کند که برای همه عناصر اصلی خط مشی مشترک هستند:

عنصر <DisplayName>

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

<DisplayName>Policy Display Name</DisplayName>

عنصر <Operation>

تعیین می‌کند که آیا خط‌مشی اطلاعات اعتباری را با Base64 کدبندی یا کدگشایی می‌کند.

<Operation>Encode</Operation>

عنصر <IgnoreUnresolvedVariables>

وقتی روی true تنظیم شود، اگر متغیری قابل‌حل نباشد، خط‌مشی خطا نمی‌دهد. وقتی در زمینه خط‌مشی «احراز هویت پایه» استفاده می‌شود، این تنظیم معمولاً روی false تنظیم می‌شود زیرا اگر نام کاربری یا گذرواژه در متغیرهای مشخص‌شده پیدا نشود، معمولاً بهتر است خطا صادر شود.

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

عنصر <User>

• برای کدبندی، از عنصر <User> برای مشخص کردن متغیر حاوی نام کاربری استفاده کنید. مقادیر نام کاربری و گذرواژه قبل‌از کدبندی Base64 با دونقطه به‌هم متصل می‌شوند.
• برای رمزگشایی، متغیری را که نام کاربری رمزگشایی‌شده در آن نوشته می‌شود مشخص کنید.

<User ref="credentials.username" /> 

مشخصه‌ها

عنصر <Password>

• برای کدبندی، از عنصر <Password> برای مشخص کردن متغیر حاوی گذرواژه استفاده کنید.
• برای رمزگشایی، متغیری را که گذرواژه رمزگشایی‌شده در آن نوشته می‌شود مشخص کنید.

<Password ref="credentials.password" />

مشخصه‌ها

عنصر <AssignTo>

برای عملیات Encode، متغیر هدفی را که باید با مقدار کدبندی‌شده تولیدشده توسط این خط‌مشی تنظیم شود مشخص می‌کند.

مثال زیر نشان می‌دهد که خط‌مشی باید سرصفحه پیام Authorization را روی مقدار تولیدشده تنظیم کند:

<AssignTo createNew="false">request.header.Authorization</AssignTo>

مشخصه‌ها

عنصر <Source>

برای رمزگشایی، متغیری که حاوی رشته کدبندی‌شده Base64 است، در قالب Basic Base64EncodedString. برای مثال، request.header.Authorization را مشخص کنید که با سرصفحه مجوز مطابقت دارد.

<Source>request.header.Authorization</Source>

متغیرهای جریان

متغیر جاری زیر زمانی تنظیم می‌شود که خط‌مشی ناموفق باشد:

• ‫BasicAuthentication.{policy_name}.failed (با مقدار درست)

مرجع خطا

این بخش کدهای خطا و پیام‌های خطایی را که برگردانده می‌شوند و متغیرهای خطایی را که Edge هنگام راه‌اندازی خطا در این خط‌مشی تنظیم می‌کند شرح می‌دهد. این اطلاعات برای زمانی که درحال توسعه قوانین خطا برای مدیریت خطاها هستید مهم است. برای کسب اطلاعات بیشتر، آنچه باید درباره خطاهای خط‌مشی بدانیدو رسیدگی به اشکالات را ببینید.

خطاهای زمان اجرا

این خطاها ممکن است هنگام اجرای خط‌مشی رخ دهند.

خطاهای استقرار

این خطاها ممکن است زمانی رخ دهند که یک پراکسی حاوی این خط‌مشی را مستقر می‌کنید.

متغیرهای خطا

این متغیرها زمانی تنظیم می‌شوند که خطای زمان اجرا رخ دهد. برای اطلاعات بیشتر، آنچه باید درباره خطاهای خط‌مشی بدانیدرا ببینید.

نمونه پاسخ خطا

{  
   "fault":{  
      "detail":{  
         "errorcode":"steps.basicauthentication.UnresolvedVariable"
      },
      "faultstring":"Unresolved variable : request.queryparam.password"
   }
}

قانون خطای نمونه

<FaultRule name="Basic Authentication Faults">
    <Step>
        <Name>AM-UnresolvedVariable</Name>
        <Condition>(fault.name Matches "UnresolvedVariable") </Condition>
    </Step>
    <Step>
        <Name>AM-AuthFailedResponse</Name>
        <Condition>(fault.name = "InvalidBasicAuthenticationSource")</Condition>
    </Step>
    <Condition>(BasicAuthentication.BA-Authentication.failed = true) </Condition>
</FaultRule>

طرح‌واره‌ها

موضوعات مرتبط

خط‌مشی عملیات نقشه مقدار کلید