Temel Kimlik Doğrulama politikası

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerini görüntüleyin.

Ne

Son kilometre güvenliği için basit Temel Kimlik Doğrulama'yı kullanabilmenizi sağlar. Politika bir kullanıcı adı ile şifre alır, Base64 bunları şifreler ve elde edilen değeri bir değişkene yazar. Elde edilen değer Basic Base64EncodedString biçimindedir. Bu değeri genellikle Yetkilendirme başlığı gibi bir HTTP üst bilgisine yazarsınız.

Politika ayrıca Base64 kodlamalı bir dizede depolanan kimlik bilgilerinin şifresini bir kullanıcı adı ve şifre ile çözmenizi de sağlar.

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 çalışma modu vardır:

• Kodlama: Base64, değişkenlerde depolanan kullanıcı adını ve şifreyi kodlar
• Kod çözme: Kullanıcı adı ve şifrenin Base64 kodlamalı bir dizeden çözülmesi

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

Öğe referansı

Öğe referansı, BasicAuthentication 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>

<TemelKimlik Doğrulama> özellikleri

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

Aşağıdaki tabloda, tüm politika üst öğelerinde yaygın olarak kullanılan özellikler açıklanmaktadır:

<DisplayName> öğesi

Yönetim kullanıcı arayüzü proxy'sinde politikayı 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 çözmediğini belirler.

<Operation>Encode</Operation>

<ignoreUnresolvedVariables> öğesi

true olarak ayarlandığında, bir değişken çözülemezse politika bir hata göndermez. Temel kimlik doğrulama politikası bağlamında kullanıldığında bu ayar genellikle false olarak ayarlanır. Bunun nedeni, belirtilen değişkenlerde bir kullanıcı adı veya şifrenin bulunamaması durumunda genellikle hatanın döndürülmesidir.

<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 ile kullanılır.
• Kodu çözmek 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 üzere <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 kod çözülmüş değerle ayarlanacak hedef değişkeni belirtir.

Aşağıdaki örnekte politika, iletinin Authorization üst bilgisini oluşturulan değere ayarlamalıdır:

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

Özellikler

<Source> öğesi

Kod çözme için Base64 olarak kodlanmış dizeyi içeren değişken Basic Base64EncodedString biçimindedir. Örneğin, Yetkilendirme başlığına karşılık gelen request.header.Authorization 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, döndürülen hata kodları ve hata mesajları ile bu politika bir hatayı tetiklediğinde Edge tarafından ayarlanan hata değişkenleri açıklanmaktadır. Bu bilgiler, hataları ele alacak hata kuralları geliştirip geliştirmediğinizi bilmeniz önemlidir. Daha fazla bilgi için Politika hataları hakkında bilmeniz gerekenler ve Hataları işleme hakkında bilgi edinin.

Çalışma zamanı hataları

Bu hatalar, politika yürütüldüğünde ortaya çıkabilir.

Dağıtım hataları

Bu hatalar, bu politikayı içeren bir proxy dağıttığınızda oluşabilir.

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

Örnek hata kuralı

<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şlemesi İşlemleri politikası