Mengonfigurasi Prosesor Pesan untuk mengizinkan header duplikat

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

Sesuai dengan Spesifikasi HTTP RFC 7230, bagian 3.2.2: Field Order, Apigee Edge mengharapkan agar permintaan HTTP dari klien atau respons HTTP dari server backend tidak berisi header yang sama yang diteruskan lebih dari sekali dengan nilai yang sama atau berbeda, kecuali jika header tertentu memiliki pengecualian dan diizinkan untuk memiliki duplikat.

Secara default, Apigee Edge mengizinkan duplikat dan beberapa nilai diteruskan ke sebagian besar header HTTP. Namun, header tertentu yang tercantum dalam Header yang tidak boleh memiliki duplikat dan beberapa nilai tidak diizinkan. Jadi:

  • Anda akan mendapatkan 400 Bad Request dengan kode error protocol.http.DuplicateHeader jika klien mengirim permintaan HTTP dengan header tertentu lebih dari sekali atau dengan beberapa nilai untuk header HTTP yang tidak diizinkan memiliki duplikat/beberapa nilai di Apigee Edge.
  • Demikian pula, Anda akan mendapatkan 502 Bad Gateway dengan kode error protocol.http.DuplicateHeader jika server backend mengirimkan respons HTTP dengan header tertentu lebih dari sekali atau dengan beberapa nilai untuk header HTTP yang tidak diizinkan memiliki duplikat atau beberapa nilai di Apigee Edge

Solusi yang direkomendasikan untuk mengatasi error ini adalah memperbaiki aplikasi klien dan server backend agar tidak mengirim header duplikat dan mematuhi spesifikasi RFC 7230, bagian 3.2.2: Urutan Kolom seperti yang dijelaskan dalam playbook pemecahan masalah berikut:

Namun, dalam beberapa kasus, Anda mungkin ingin menambahkan pengecualian untuk menyertakan duplikat dan beberapa nilai untuk beberapa header HTTP. Dalam situasi seperti itu, Anda dapat mengizinkan header duplikat dan beberapa nilai untuk header HTTP tertentu dengan menyetel properti HTTPHeader.HEADER_NAME di level Message Processor.

Dokumen ini memberikan informasi tentang properti ini, menjelaskan cara mengaktifkan properti ini untuk menghindari error yang disebutkan di atas, dan membagikan praktik terbaik terkait hal tersebut.

Properti header HTTP untuk mengizinkan duplikat dan beberapa nilai

Apigee Edge menyediakan dua properti berikut untuk mengontrol perilaku yang memungkinkan duplikat dan beberapa nilai untuk header HTTP. Perhatikan bahwa ini hanya dapat dikonfigurasi di Message Processor menggunakan sintaksis token yang dijelaskan dalam Cara mengonfigurasi Edge.

Nama properti Deskripsi Nilai yang diizinkan
HTTPHeader.ANY

Properti ini menunjukkan apakah duplikat atau beberapa nilai diizinkan untuk semua header HTTP, termasuk header kustom yang dikirim sebagai bagian dari permintaan HTTP yang dibuat oleh klien atau respons HTTP yang dikirim oleh server backend ke Apigee Edge.

Nilai default:

multiValued, allowDuplicates,
  1. blank: Duplikat dan beberapa nilai untuk header HTTP tidak diizinkan.
  2. multiValued: Memisahkan header multi-nilai menjadi beberapa header. Beberapa nilai diizinkan untuk header HTTP, tetapi duplikat tidak diizinkan. Nilai multiValued diaktifkan, yang berarti bahwa test-header=a,b akan dikonversi menjadi test-header=a dan test-header=b.
  3. allowDuplicates: Mengizinkan beberapa header HTTP (duplikat) dengan nama yang sama.
  4. multiValued, allowDuplicates: Beberapa nilai dan duplikat diizinkan untuk header HTTP.

HTTPHeader.HEADER_NAME

Properti ini digunakan untuk mengganti perilaku header tertentu dari apa yang ditentukan oleh HTTPHeader.ANY

Sama seperti di atas.

Header yang tidak diizinkan memiliki duplikat dan beberapa nilai

Seperti yang dijelaskan sebelumnya, Apigee Edge memungkinkan duplikat dan beberapa nilai untuk sebagian besar header HTTP secara default. Hal ini karena properti HTTPHeader.ANY dikonfigurasi dengan nilai multiValued, allowDuplicates.

Konfigurasi ditimpa

Untuk beberapa header tertentu, konfigurasi default diganti menggunakan salah satu metode berikut:

  • HTTPHeader.HEADER_NAME=multiValued, allowDuplicates

    Konfigurasi ini tidak mengubah perilaku default. Artinya, header tertentu diizinkan untuk memiliki duplikat dan beberapa nilai

    .

  • HTTPHeader.HEADER_NAME=

    Konfigurasi ini mengubah perilaku default. Artinya, header tertentu tidak boleh memiliki duplikat dan beberapa nilai.

Menentukan header yang tidak boleh memiliki duplikat dan beberapa nilai

Bagian ini menjelaskan cara mengidentifikasi hal berikut:

  • Header tertentu yang tidak boleh memiliki duplikat dan beberapa nilai pada penyiapan Apigee Edge Private Cloud Anda, dan
  • Header tertentu dengan konfigurasi yang sudah ada

  1. Di mesin Message Processor, telusuri properti HTTPHeader. di direktori /opt/apigee/edge-message-processor/conf seperti yang ditunjukkan di bawah:

    grep -ri "HTTPHeader." /opt/apigee/edge-message-processor/conf

    Contoh output:

    # grep -ri "HTTPHeader" /opt/apigee/edge-message-processor/conf
/opt/apigee/edge-message-processor/conf/http.properties:HTTPHeader.ANY=allowDuplicates, multiValued
/opt/apigee/edge-message-processor/conf/http.properties:HTTPHeader.Connection=allowDuplicates, multiValued
… <snipped>
/opt/apigee/edge-message-processor/conf/http.properties:HTTPHeader.Host=
/opt/apigee/edge-message-processor/conf/http.properties:HTTPHeader.Expires=
/opt/apigee/edge-message-processor/conf/http.properties:HTTPHeader.Date=allowDuplicates
…
<snipped>
  2. Seperti yang dijelaskan di bagian Konfigurasi diganti, perhatikan informasi berikut dalam contoh output di atas:
    1. Header HTTP Connection ditimpa, tetapi diizinkan untuk memiliki duplikat dan beberapa nilai
    2. Header HTTP Host dan Expires diganti dan tidak boleh memiliki duplikat dan beberapa nilai
    3. Header HTTP Date ditimpa dan diizinkan memiliki duplikat tetapi tidak diizinkan memiliki beberapa nilai
    4. Semua header yang muncul di sini (Connection, Host, Expires, dan Date dalam contoh di atas) disebut sebagai header dengan konfigurasi yang sudah ada sebelumnya dalam dokumen ini.

Perilaku Apigee Edge

Tabel berikut menjelaskan perilaku Apigee Edge saat header dikirim sebagai duplikat dan dengan beberapa nilai, bergantung pada cara properti HTTPHeader dikonfigurasi di Pemroses Pesan dengan contoh HTTPHeader test-header.

Permintaan HEADER keluar berdasarkan nilai conf/http.properties+HTTPHeader.test-header=
<Blank> allowDuplicates multiValued allowDuplicates, multiValued (DEFAULT)
test‑header=a,b test‑header=a,b test‑header=a,b

protocol.http.
DuplicateHeader

Secara internal, kami membagi test-header=a,b menjadi:

  • test-header=a, dan
  • test-header=b,

dan kemudian error DuplicateHeader terjadi.

test‑header=a,b

Secara internal, kami membagi test-header=a,b menjadi:

  • test-header=a, dan
  • test-header=b,

Namun, formulir asli dikirim ke target.
test‑header=a
test‑header=b		 protocol.http.
DuplicateHeader		 test‑header=a
test‑header=b		 protocol.http.
DuplicateHeader		 test‑header=a
test‑header=b

Sebelum memulai

Sebelum menggunakan langkah-langkah dalam dokumen ini, pastikan Anda memahami cara mengonfigurasi properti untuk Edge di Private Cloud, yang dijelaskan dalam Cara mengonfigurasi Edge.

Mengonfigurasi allowDuplicates dan beberapa nilai untuk header

Seperti yang dijelaskan dalam Properti header HTTP untuk mengizinkan duplikat dan beberapa nilai, nilai properti HTTPHeader.ANY = allowDuplicates, multiValued menyiratkan bahwa semua header diizinkan untuk memiliki duplikat dan beberapa nilai di Apigee Edge. Namun, ada header tertentu yang nilainya diganti secara eksplisit agar tidak mengizinkan header duplikat atau beberapa nilai untuk header ini menggunakan properti HTTPHeader.HEADER_NAME.

Bagian ini menjelaskan cara mengonfigurasi properti HTTPHeader.HEADER_NAME untuk mengizinkan duplikat dan beberapa nilai untuk header HTTP tersebut di Pemroses Pesan, menggunakan token yang sesuai dengan sintaksis yang dijelaskan dalam Cara mengonfigurasi Edge.

Di bagian ini, kita akan menggunakan Expires (dan myheader) sebagai contoh header yang ingin kita izinkan duplikat dan beberapa nilainya seperti yang dijelaskan di bawah:

  1. Tentukan nilai saat ini dari properti HTTPHeaderHEADER_NAME untuk memastikan properti tersebut belum diaktifkan untuk mengizinkan duplikat dan beberapa nilai menggunakan perintah berikut: 
    grep -ri "HTTPHeader.HEADER_NAME" /opt/apigee/edge-message-processor/conf

    Misalnya, jika Anda mencoba menyetel properti untuk header Expires, maka periksa nilai token properti HTTPHeader.Expires saat ini di Message Processor: 

    grep -ri "HTTPHeader.Expires" /opt/apigee/edge-message-processor/conf

    Output perintah di atas akan menghasilkan salah satu dari berikut ini:

    1. Properti ditetapkan ke kosong, lalu menyiratkan bahwa nilai ditimpa (dan ini adalah header dengan konfigurasi yang sudah ada sebelumnya) agar TIDAK mengizinkan header duplikat dan beberapa nilai. Artinya, Anda tidak diizinkan mengirim header Expires lebih dari sekali sebagai bagian dari permintaan HTTP atau respons HTTP ke Apigee.
    2. Tidak ada hit untuk properti tertentu, berarti nilai tersebut tidak ditimpa (dan ini BUKAN header dengan konfigurasi yang sudah ada sebelumnya). Artinya, header tertentu dapat dikirim lebih dari sekali (duplikat diizinkan) sebagai bagian dari permintaan HTTP atau respons HTTP ke Apigee Edge.
    3. Properti ditetapkan dengan nilai allowDuplicates, multiValued, yang berarti nilai tersebut ditimpa secara eksplisit (dan ini adalah header dengan konfigurasi yang sudah ada sebelumnya). Artinya, header tertentu dapat dikirim lebih dari sekali (duplikat diizinkan) sebagai bagian dari permintaan HTTP atau respons HTTP ke Apigee.

    Contoh output perintah penelusuran:

    /opt/apigee/edge-message-processor/conf/http.properties:HTTPHeader.Expires=

    Output contoh di atas menunjukkan bahwa properti HTTPHeader.Expires ditetapkan ke kosong. Artinya, properti ditimpa menjadi tidak mengizinkan nilai duplikat atau beberapa nilai untuk header Expires.

  2. Jika Anda melihat bahwa properti yang sesuai dengan header tertentu ditimpa secara eksplisit menjadi tidak mengizinkan nilai duplikat atau beberapa nilai seperti pada contoh output di atas, baru kemudian lakukan langkah-langkah berikut. Jika tidak diganti secara eksplisit, lewati langkah-langkah lainnya di bagian ini.
  3. Edit. Jika tidak ada, Anda dapat membuatnya: 
    /opt/apigee/customer/application/message-processor.properties

    Misalnya, untuk membuka file menggunakan vi, masukkan perintah berikut:

    vi /opt/apigee/customer/application/message-processor.properties
  4. Tambahkan baris dalam format berikut: 
    conf_http_HTTPHeader.Expires=allowDuplicates, multiValued
  5. Simpan perubahan.

  6. Pastikan file properti dimiliki oleh pengguna apigee. Jika tidak, jalankan perintah berikut:

    chown apigee:apigee /opt/apigee/customer/application/message-processor.properties

  7. Mulai ulang Pemroses Pesan:

    /opt/apigee/apigee-service/bin/apigee-service edge-message-processor restart

    Untuk memulai ulang tanpa memengaruhi traffic, lihat Memulai ulang Message Processor secara bertahap tanpa memengaruhi traffic.

  8. Jika Anda memiliki lebih dari satu Pemroses Pesan, ulangi langkah-langkah di atas di semua Pemroses Pesan.

Memverifikasi bahwa header dikonfigurasi untuk memiliki duplikat dan beberapa nilai

Bagian ini menjelaskan cara memverifikasi bahwa properti HTTPHeader.HEADER_NAME untuk header tertentu telah berhasil diperbarui untuk mengizinkan duplikat di Pemroses Pesan.

Kita akan menggunakan Expires sebagai header contoh dan memeriksa apakah properti yang sesuai, yaitu HTTPHeader.Expires, telah diperbarui.

Meskipun Anda menggunakan token conf_http_HTTPHeader.Expires untuk memperbarui nilai di Pemroses Pesan, Anda perlu memverifikasi apakah properti HTTPHeader.Expires yang sebenarnya telah ditetapkan dengan nilai baru.

  1. Di mesin Message Processor, telusuri properti HTTPHeader.HEADER_NAME di direktori /opt/apigee/edge-message-processor/conf dan periksa apakah properti tersebut telah ditetapkan dengan nilai baru seperti yang ditunjukkan di bawah: 
    grep -ri "HTTPHeader.HEADER_NAME" /opt/apigee/edge-message-processor/conf

    Misalnya, jika Anda ingin memeriksa apakah properti HTTPHeader.Expires ditetapkan dengan nilai baru, jalankan perintah berikut:

    grep -ri "HTTPHeader.Expires" /opt/apigee/edge-message-processor/conf
  2. Jika nilai baru berhasil ditetapkan untuk HTTPHeader.HEADER_NAME di Message Processor, perintah di atas akan menampilkan nilai baru dalam file http.properties.

  3. Contoh hasil dari perintah di atas setelah Anda mengonfigurasi allowDuplicates dan multiValued adalah sebagai berikut:

    /opt/apigee/edge-message-processor/conf/http.properties:HTTPHeader.Expires=allowDuplicates, multiValued
  4. Dalam contoh output di atas, perhatikan bahwa properti HTTPHeader.Expires telah ditetapkan dengan nilai baru allowDuplicates, multiValued di http.properties. Hal ini menunjukkan bahwa perilaku untuk mengizinkan duplikat dan beberapa nilai dalam HTTPHeader berhasil dikonfigurasi di Pemroses Pesan.
  5. Jika Anda masih melihat nilai lama untuk properti HTTPHeader.HEADER_NAME, maka pastikan Anda telah mengikuti semua langkah yang diuraikan dalam Mengonfigurasi allowDuplicates dan beberapa nilai untuk header dengan benar. Jika Anda melewatkan langkah apa pun, ulangi semua langkah dengan benar.

    Pastikan proxy Anda berfungsi seperti yang diharapkan, terutama jika ada logika fungsional untuk mendapatkan dan menyetel header di proxy.

  6. Jika Anda masih tidak dapat mengubah properti, hubungi Dukungan Apigee Edge

Menonaktifkan allowDuplicates untuk header

Bagian ini menjelaskan cara mengonfigurasi properti HTTPHeader.{Headername} agar tidak mengizinkan duplikat dan beberapa nilai untuk header HTTP tertentu di Message Processors, menggunakan token yang sesuai menurut sintaksis yang dijelaskan dalam Cara mengonfigurasi Edge.

Di bagian ini, kita akan menggunakan Expires (dan myheader) sebagai contoh header yang tidak boleh memiliki duplikat seperti yang dijelaskan di bawah:

  1. Tentukan nilai saat ini dari properti HTTPHeaderHEADER_NAME untuk memastikan belum dinonaktifkan untuk mengizinkan duplikat dan beberapa nilai menggunakan perintah berikut: 
    grep -ri "HTTPHeader.HEADER_NAME" /opt/apigee/edge-message-processor/conf

    Misalnya, jika Anda mencoba menyetel properti untuk header Expires, periksa nilai saat ini dari token properti HTTPHeader.Expires di Pemroses Pesan: 

    grep -ri "HTTPHeader.Expires" /opt/apigee/edge-message-processor/conf

    Output perintah di atas akan menghasilkan salah satu dari berikut ini:

    1. Properti disetel ke kosong, lalu menyiratkan bahwa nilai iditimpa menjadi TIDAK untuk mengizinkan header duplikat dan beberapa nilai. Artinya, Anda tidak diizinkan mengirim header Expires lebih dari sekali sebagai bagian dari permintaan HTTP atau respons HTTP ke Apigee.
    2. Tidak ada hit untuk properti tertentu, berarti nilai tersebut tidak ditimpa dan ini adalah header NOT dengan konfigurasi yang sudah ada sebelumnya. Artinya, header tertentu dapat dikirim lebih dari sekali (duplikat diizinkan) sebagai bagian dari permintaan HTTP atau respons HTTP ke Apigee Edge.
    3. Properti disetel dengan nilai allowDuplicates, multiValued, yang berarti nilai tersebut ditimpa secara eksplisit dan ini adalah konfigurasi yang ada. Namun, header tertentu dapat dikirim lebih dari sekali (duplikat diizinkan) sebagai bagian dari permintaan HTTP atau respons HTTP ke Apigee.

    Contoh output #1

    Contoh Output #1 perintah penelusuran:

    /opt/apigee/edge-message-processor/conf/http.properties:HTTPHeader.Expires=allowDuplicates, multiValued

    Output sampel menunjukkan bahwa properti HTTPHeader.Expires disetel ke allowDuplicates, multiValued. Artinya, properti is ditimpa untuk mengizinkan nilai duplikat atau beberapa nilai untuk header Expires.

    Contoh output #2

    Contoh Perintah dan Output #2 dari perintah penelusuran

    grep -ri "HTTPHeader.myheader" /opt/apigee/edge-message-processor/conf

    Output sampel tidak menampilkan output, yang berarti properti HTTPHeader.myheader ditetapkan ke allowDuplicates, multiValued secara default. Hal ini juga menyiratkan bahwa properti tidak ditimpa untuk header myheader,

  2. Jika Anda melihat salah satu hal berikut, lakukan langkah-langkah lainnya di bagian ini:
    1. Properti yang sesuai dengan header tertentu akan diganti untuk mengizinkan duplikat dan beberapa nilai seperti pada Contoh output #1 di atas (header dengan konfigurasi yang sudah ada)
    2. Tidak ada hit untuk properti yang sesuai dengan header tertentu seperti pada Contoh output #2 di atas (bukan header dengan konfigurasi yang sudah ada)

    Jika tidak, lewati langkah-langkah lainnya di bagian ini.

  3. Edit file berikut. Jika tidak ada, Anda dapat membuatnya. 
    /opt/apigee/customer/application/message-processor.properties

    Misalnya, untuk membuka file menggunakan vi, masukkan perintah berikut: 

    vi /opt/apigee/customer/application/message-processor.properties
  4. Tambahkan baris dalam format berikut ke file properti:

    Konfigurasi yang sudah ada

    Skenario #1: Header dengan konfigurasi yang sudah ada:

    conf_http_HTTPHeader.Expires=

    Tidak ada konfigurasi yang sudah ada

    Skenario #2: Bukan header dengan konfigurasi yang sudah ada:

    conf/http.properties+HTTPHeader.myheader=
  5. Simpan perubahan.
  6. Pastikan file properti dimiliki oleh pengguna apigee. Jika tidak, jalankan perintah berikut: 
    chown apigee:apigee /opt/apigee/customer/application/message-processor.properties
  7. Mulai ulang Pemroses Pesan: 
    /opt/apigee/apigee-service/bin/apigee-service edge-message-processor restart

    Untuk memulai ulang tanpa memengaruhi traffic, lihat Memulai ulang Message Processor secara bertahap tanpa memengaruhi traffic.

  8. Jika Anda memiliki lebih dari satu Pemroses Pesan, ulangi langkah-langkah di atas di semua Pemroses Pesan.

Memverifikasi bahwa header dikonfigurasi agar tidak mengizinkan duplikat dan beberapa nilai

Bagian ini menjelaskan cara memverifikasi bahwa properti HTTPHeader.HEADER_NAME untuk header tertentu telah berhasil diperbarui agar tidak mengizinkan duplikat di Pemroses Pesan.

Kita akan menggunakan Expires (dan myheader) sebagai header contoh dan memeriksa apakah properti HTTPHeader.Expires (dan HTTPHeader.myheader) yang sesuai telah diperbarui.

  1. Di mesin Message Processor, telusuri properti HTTPHeader.HEADER_NAME di direktori /opt/apigee/edge-message- processor/conf dan periksa apakah properti tersebut telah ditetapkan dengan nilai baru seperti yang ditunjukkan di bawah:

    grep -ri "HTTPHeader.HEADER_NAME" /opt/apigee/edge-message-processor/conf

    Misalnya, jika Anda ingin memeriksa apakah properti HTTPHeader.Expires ditetapkan dengan nilai baru, Anda dapat menjalankan perintah berikut:

    Konfigurasi yang sudah ada

    grep -ri "HTTPHeader.Expires" /opt/apigee/edge-message-processor/conf

    Tidak ada konfigurasi yang sudah ada

    grep -ri "HTTPHeader.myheader" /opt/apigee/edge-message-processor/conf
  2. Jika nilai header HTTP baru berhasil ditetapkan untuk HTTPHeader.HEADER_NAME I di Message Processor, perintah di atas akan menampilkan nilai baru dalam file http.properties.
  3. Contoh hasil dari perintah di atas setelah Anda menonaktifkan allowDuplicates adalah sebagai berikut:

    Konfigurasi yang sudah ada

    Skenario #1: Header Expired (header dengan konfigurasi yang sudah ada)

    /opt/apigee/edge-message-processor/conf/http.properties:HTTPHeader.Expires=

    Tidak ada konfigurasi yang sudah ada

    Skenario #2: Header myheader (bukan header dengan konfigurasi yang sudah ada)

    /opt/apigee/edge-message-processor/conf/http.properties:HTTPHeader.myheader=
  4. Dalam contoh output di atas, perhatikan bahwa properti HTTPHeader.Expires ( dan HTTPHeader.myheader) telah ditetapkan dengan nilai baru {blank} di http.properties. Hal ini menunjukkan bahwa perilaku untuk mengizinkan duplikat dan beberapa nilai untuk header HTTP Expires (dan myheader) tertentu berhasil dinonaktifkan di Pemroses Pesan.

  5. Jika Anda masih melihat nilai lama untuk properti HTTPHeader.Expires (or HTTPHeader.myheader), pastikan Anda telah mengikuti semua langkah yang diuraikan dalam Mengonfigurasi allowDuplicates dan beberapa nilai untuk header dengan benar. Jika Anda melewatkan langkah apa pun, ulangi semua langkah dengan benar.

    Pastikan proxy Anda berfungsi seperti yang diharapkan, terutama jika ada logika fungsional untuk mendapatkan dan menyetel header di proxy.

  6. Jika Anda masih tidak dapat mengubah properti, hubungi Dukungan Apigee Edge.