خط مشی احراز هویت اولیه

شما در حال مشاهده مستندات 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 نام کاربری و رمز عبور ذخیره شده در متغیرها را رمزگذاری می‌کند.
• رمزگشایی : نام کاربری و رمز عبور را از یک رشته کدگذاری شده 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 async="false" continueOnError="false" enabled="true" name="Basic-Authentication-1">

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

عنصر <DisplayName>

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

<DisplayName>Policy Display Name</DisplayName>

عنصر <عملیات>

تعیین می‌کند که آیا سیاست Base64 اعتبارنامه‌ها را رمزگذاری یا رمزگشایی می‌کند.

<Operation>Encode</Operation>

عنصر <نادیده گرفتن متغیرهای حل نشده>

وقتی روی true تنظیم شود، اگر متغیری قابل حل نباشد، این خط‌مشی خطایی ایجاد نمی‌کند. وقتی در چارچوب خط‌مشی BasicAuthentication استفاده شود، معمولاً روی false تنظیم می‌شود زیرا معمولاً مفید است که اگر نام کاربری یا رمز عبور در متغیرهای مشخص شده یافت نشود، خطا ایجاد شود.

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

عنصر <کاربر>

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

<User ref="credentials.username" /> 

ویژگی‌ها

عنصر <رمز عبور>

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

<Password ref="credentials.password" />

ویژگی‌ها

عنصر <AssignTo>

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

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

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

ویژگی‌ها

عنصر <منبع>

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

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

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

متغیر جریان زیر زمانی تنظیم می‌شود که سیاست با شکست مواجه شود:

• BasicAuthentication.{policy_name}.failed (با مقدار true)

مرجع خطا

این بخش کدهای خطا و پیام‌های خطایی را که برگردانده می‌شوند و متغیرهای خطا را که توسط 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>

طرحواره‌ها

مباحث مرتبط

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