Temel Kimlik Doğrulama politikası

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi

Ne

Son adım güvenliği için hafif Temel Kimlik Doğrulama özelliğini kullanmanızı sağlar. Politika bir kullanıcı adı ve şifre alır, Base64 bunları kodlar ve sonuçta elde edilen değeri bir değişkene yazar. Elde edilen değer Basic Base64EncodedString biçimindedir. Bu değeri genellikle Authorization başlığı gibi bir HTTP üst bilgisine yazarsınız.

Politika, Base64 olarak kodlanmış bir dizede depolanan kimlik bilgilerinin kodunu kullanıcı adı ve şifreye dönüştürmenize de olanak tanır.

Sana Özel

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

Temel Kimlik Doğrulama politikası hakkında

Politikanın iki işlem modu vardır:

• Kodlama: Base64, değişkenlerde depolanan bir kullanıcı adını ve şifreyi kodlar
• Kod Çöz: Base64 olarak kodlanmış bir dizedeki kullanıcı adı ve şifrenin kodunu çözer.

Kullanıcı adı ve şifre genellikle anahtar/değer deposunda saklanır ve daha sonra, çalışma zamanında anahtar/değer deposundan okunur. Anahtar/değer çifti deposunun kullanımıyla ilgili ayrıntılar için Anahtar/Değer Eşlemesi İşlemleri politikasını inceleyin.

Öğe referansı

Öğe referansı, Basic Authentication politikasının öğelerini ve özelliklerini açıklar.

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

<Basic Authentication> özellikleri

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

Aşağıdaki tabloda, tüm politika üst öğelerinde ortak olan özellikler açıklanmaktadır:

<DisplayName> öğesi

Politikayı, yönetim kullanıcı arayüzü proxy düzenleyicisinde farklı bir doğal dil adıyla etiketlemek için name özelliğine ek olarak kullanın.

<DisplayName>Policy Display Name</DisplayName>

<İşlem> öğesi

Base64 politikasının kimlik bilgilerini kodlayıp kodlamasını çözmeyeceğini belirler.

<Operation>Encode</Operation>

<ignoreUnresolvedVariables> öğesi

true değerine ayarlandığında, bir değişken çözümlenemezse politika hata bildirmez. Temel Kimlik Doğrulama politikası bağlamında kullanıldığında bu ayar genellikle false olarak ayarlanır. Çünkü belirtilen değişkenlerde bir kullanıcı adı veya şifre bulunamazsa hata verilmesi genellikle faydalıdır.

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

<User> öğesi

• Kodlama için kullanıcı adını içeren değişkeni belirtmek üzere <User> öğesini kullanın. Kullanıcı adı ve şifre değerleri, Base64 kodlamasından önce iki nokta üst üste işaretiyle birleştirilir.
• Kod çözme için, kodu çözülmüş kullanıcı adının yazıldığı değişkeni belirtin.

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

Özellikler

<Password> öğesi

• Kodlama için şifreyi içeren değişkeni belirtmek için <Password> öğesini kullanın.
• Kod çözme için, kodu çözülmüş şifrenin yazıldığı değişkeni belirtin.

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

Özellikler

<assignTo> öğesi

Bu politika tarafından oluşturulan kodlanmış veya kodu çözülmüş değerle ayarlanacak hedef değişkeni belirtir.

Aşağıdaki örnek, politikanın mesajın Authorization üstbilgisini oluşturulan değere ayarlaması gerektiğini belirtir:

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

Özellikler

<Source> öğesi

Kod çözme işlemi için Base64 olarak kodlanmış dizeyi içeren, Basic Base64EncodedString biçimindeki değişken. Örneğin, Authorization başlığına karşılık gelen request.header.Authorization değerini belirtin.

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

Akış değişkenleri

Politika başarısız olduğunda aşağıdaki akış değişkeni ayarlanır:

• BasicAuthentication.{policy_name}.failed (true değeriyle)

Hata referansı

Bu bölümde, bu politika bir hatayı tetiklediğinde Edge tarafından ayarlanan hata kodları ile hata mesajları ve döndürülen hata mesajları ile Edge tarafından ayarlanan hata değişkenleri açıklanmaktadır. Bu bilgileri, hataları ele alan hata kuralları geliştiriyorsanız bilmeniz önemlidir. Daha fazla bilgi için Politika hataları hakkında bilmeniz gerekenler ve Hataları işleme bölümlerine bakın.

Çalışma zamanı hataları

Politika yürütüldüğünde bu hatalar ortaya çıkabilir.

Dağıtım hataları

Bu hatalar, bu politikayı içeren bir proxy dağıttığınızda ortaya çıkabilir.

Hata değişkenleri

Bu değişkenler, bir çalışma zamanı hatası oluştuğunda ayarlanır. Daha fazla bilgi için Politika hataları hakkında bilmeniz gerekenler bölümüne bakın.

Örnek hata yanıtı

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

Hata kuralı örneği

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

Şemalar

İlgili konular

Anahtar Değer Eşleme İşlemleri politikası