Kebijakan BasicAuthentication

Anda sedang melihat dokumentasi Apigee Edge.
Buka Dokumentasi Apigee X. info

Apa

Memungkinkan Anda menggunakan Autentikasi Dasar ringan untuk keamanan kilometer terakhir. Kebijakan ini mengambil nama pengguna dan {i>password<i}, Base64 mengenkodenya, dan menulis nilai yang dihasilkan ke suatu variabel. Nilai yang dihasilkan akan dalam bentuk Basic Base64EncodedString. Anda biasanya menulis nilai ini ke header HTTP, seperti header Authorization.

Kebijakan ini juga memungkinkan Anda mendekode kredensial yang disimpan dalam string berenkode Base64 ke nama pengguna dan sandi.

Contoh

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

Tentang kebijakan Autentikasi Dasar

Kebijakan ini memiliki dua mode operasi:

• Encode: Base64 mengenkode nama pengguna dan sandi yang disimpan di variabel
• Dekode: Mendekode nama pengguna dan sandi dari String berenkode base64

Nama pengguna dan {i>password<i} biasanya disimpan di penyimpanan kunci/nilai dan kemudian dibaca dari penyimpanan kunci/nilai saat runtime. Untuk mengetahui detail tentang penggunaan penyimpanan kunci/nilai, lihat Operasi Peta Nilai Kunci kebijakan kami.

Referensi elemen

Referensi elemen menjelaskan elemen dan atribut BasicAuthentication lebih lanjut.

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

&lt;BasicAuthentication&gt; atribut

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

Tabel berikut menjelaskan atribut yang umum untuk semua elemen induk kebijakan:

&lt;DisplayName&gt; elemen

Gunakan selain atribut name untuk memberi label kebijakan di editor proxy UI dengan nama natural language yang berbeda.

<DisplayName>Policy Display Name</DisplayName>

&lt;Operation&gt; elemen

Menentukan apakah kebijakan Base64 mengenkode atau mendekode kredensial.

<Operation>Encode</Operation>

&lt;IgnoreUnresolvedVariables&gt; elemen

Jika disetel ke true, kebijakan tidak akan menampilkan error jika variabel tidak dapat ditampilkan diselesaikan. Jika digunakan dalam konteks kebijakan BasicAuthentication, setelan ini biasanya ditetapkan ke false, karena biasanya menampilkan error jika nama pengguna atau password tidak dapat ditemukan dalam variabel yang ditentukan.

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

&lt;User&gt; elemen

• Untuk encoding, gunakan elemen <User> untuk menentukan variabel yang berisi nama pengguna. Nilai nama pengguna dan {i>password<i} disambungkan dengan titik dua sebelum Encoding base64.
• Untuk decoding, tentukan variabel tempat nama pengguna yang didekode ditulis.

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

Atribut

&lt;Password&gt; elemen

• Untuk encoding, gunakan elemen <Password> untuk menentukan variabel yang berisi kata sandi.
• Untuk decoding, tentukan variabel tempat sandi yang didekode ditulis.

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

Atribut

&lt;AssignTo&gt; elemen

Menentukan variabel target yang akan ditetapkan dengan nilai yang dienkode atau didekode yang dihasilkan oleh variabel ini lebih lanjut.

Contoh berikut menunjukkan bahwa kebijakan harus menyetel Authorization header pesan ke nilai yang dihasilkan:

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

Atribut

&lt;Source&gt; elemen

Untuk decoding, variabel yang berisi string berenkode Base64, di dari Basic Base64EncodedString. Misalnya, menentukan request.header.Authorization, yang sesuai dengan header Authorization.

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

Variabel flow

Variabel alur berikut ditetapkan saat kebijakan gagal:

• BasicAuthentication.{policy_name}.failed (dengan nilai true)

Referensi error

Bagian ini menjelaskan kode kesalahan dan pesan kesalahan yang dikembalikan dan variabel kesalahan yang disetel oleh Edge saat kebijakan ini memicu kesalahan. Informasi ini penting untuk diketahui jika Anda mengembangkan aturan kesalahan untuk menangani error. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Penanganan kesalahan.

Error runtime

Error ini dapat terjadi saat kebijakan dijalankan.

Error saat deployment

Error ini dapat terjadi saat Anda men-deploy proxy yang berisi kebijakan ini.

Variabel kesalahan

Variabel ini ditetapkan saat terjadi error runtime. Untuk informasi selengkapnya, lihat Yang perlu Anda ketahui tentang error kebijakan.

Contoh respons error

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

Contoh aturan kesalahan

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

Skema

Topik terkait

Peta Nilai Kunci Kebijakan operasi