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

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

چی

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

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

نمونه ها

<BasicAuthentication name="ApplyBasicAuthHeader">
   <DisplayName>ApplyBasicAuthHeader</DisplayName>
   <Operation>Encode</Operation>
   <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
   <User ref="BasicAuth.credentials.username" />
   <Password ref="BasicAuth.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>

درباره سیاست احراز هویت اولیه

این سیاست دارای دو حالت عملیاتی است:

• Encode : 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="request.queryparam.username" />
   <Password ref="request.queryparam.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 تنظیم شود، اگر متغیری قابل حل نباشد، خط مشی خطایی ایجاد نمی کند. هنگامی که در زمینه یک خط‌مشی BasicAuthentication استفاده می‌شود، این تنظیم معمولاً روی false تنظیم می‌شود، زیرا اگر نام کاربری یا رمز عبور در متغیرهای مشخص‌شده یافت نشد، معمولاً خطا ایجاد می‌کند.

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

عنصر <کاربر>

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

<User ref="request.queryparam.username" /> 

صفات

عنصر <گذرواژه>

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

<Password ref="request.queryparam.password" />

صفات

عنصر <AssignTo>

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

مثال زیر نشان می دهد که این خط مشی باید سرصفحه 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)

مرجع خطا

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle errors. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Example error response

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

Example fault rule

<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>

طرحواره ها

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

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