Halaman ini diterjemahkan oleh Cloud Translation API.

kebijakan DecodeJWT

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

Apa

Mendekode JWT tanpa memverifikasi tanda tangan di JWT. Ini paling berguna saat digunakan dalam bersama dengan kebijakan VerifikasiJWT, jika nilai klaim dari dalam JWT harus diketahui sebelum memverifikasi tanda tangan JWT.

Kebijakan Dekode JWT berfungsi terlepas dari algoritma yang digunakan untuk menandatangani JWT. Lihat ringkasan kebijakan JWS dan JWT untuk pengantar mendetail.

Video

Tonton video singkat untuk mempelajari cara mendekode JWT.

Contoh: Mendekode JWT

Kebijakan yang ditampilkan di bawah ini mendekode JWT yang ditemukan dalam variabel flow var.jwt. Ini variabel harus ada dan berisi JWT yang layak (yang dapat didekode). Kebijakan ini dapat memperoleh JWT dari variabel {i>flow<i} apa pun.

<DecodeJWT name="JWT-Decode-HS256">
    <DisplayName>JWT Verify HS256</DisplayName>
    <Source>var.jwt</Source>
</DecodeJWT>

Kebijakan menulis output-nya ke variabel konteks sehingga kebijakan atau kondisi berikutnya di proxy API yang bisa memeriksa nilai-nilai tersebut. Lihat Variabel flow untuk daftar variabel yang ditetapkan oleh kebijakan ini.

Referensi elemen untuk Decode JWT

Referensi kebijakan menjelaskan elemen dan atribut kebijakan Decode JWT.

Atribut yang diterapkan pada elemen tingkat atas

<DecodeJWT name="JWT" continueOnError="false" enabled="true" async="false">

Atribut berikut umum untuk semua elemen induk kebijakan.

Atribut	Deskripsi	Default	Kehadiran
nama	Nama internal kebijakan. Karakter yang dapat Anda gunakan dalam nama dibatasi untuk: `A-Z0-9._\-$ %`. Namun, UI pengelolaan Edge menerapkan seperti menghapus karakter yang bukan alfanumerik secara otomatis. Secara opsional, gunakan elemen `<displayname></displayname>` untuk melabeli kebijakan di editor proxy UI pengelolaan dengan bahasa natural nama.	T/A	Wajib
continueOnError	Tetapkan ke `false` untuk menampilkan error saat kebijakan gagal. Diharapkan untuk sebagian besar kebijakan. Setel ke `true` agar eksekusi alur dapat dilanjutkan bahkan setelah kebijakan gagal.	salah	Opsional
diaktifkan	Setel ke `true` untuk menerapkan kebijakan. Setel ke `false` untuk "matikan" kebijakan tersebut. Kebijakan ini tidak akan diterapkan bahkan jika data itu tetap terlampir pada aliran.	true	Opsional
asinkron	Atribut ini tidak digunakan lagi.	salah	Tidak digunakan lagi

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

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

Default	Jika Anda menghapus elemen ini, nilai atribut nama kebijakan akan digunakan.
Kehadiran	Opsional
Jenis	String

<Source>

<Source>jwt-variable</Source>

Jika ada, tentukan variabel flow yang diharapkan oleh kebijakan untuk menemukan JWT yang melakukan dekode.

Catatan: Secara default, JWT diambil dari variabel request.header.authorization. Dalam hal ini, Edge mencari JWT di meminta header Otorisasi. Jika Anda meneruskan JWT di header Otorisasi, Anda tidak perlu menyertakan elemen Source dalam kebijakan; Namun, Anda harus menyertakan Bearer di header autentikasi. Misalnya, Anda akan meneruskan JWT di Header otorisasi seperti ini:

curl -v http://52.200.92.187:9001/doctest-jwt/verify-rs256 -H "Authorization: Bearer <your JWT>"

Anda dapat mengonfigurasi kebijakan untuk mengambil JWT dari variabel parameter formulir, kueri, atau variabel lainnya. Jika variabel tidak ada atau jika kebijakan itu tidak dapat menemukan JWT, metode kebijakan akan menampilkan error.

Default	`request.header.authorization` (Lihat catatan di atas untuk mengetahui informasi penting tentang {i>default<i}).
Kehadiran	Opsional
Jenis	String
Nilai yang valid	Nama variabel aliran Edge

Variabel flow

Setelah berhasil, kebijakan Verifikasi JWT dan Dekode JWT akan ditetapkan variabel konteks sesuai dengan pola ini:

jwt.{policy_name}.{variable_name}

Misalnya, jika nama kebijakan adalah jwt-parse-token , kebijakan akan menyimpan subjek yang ditentukan dalam JWT ke variabel konteks bernama jwt.jwt-parse-token.decoded.claim.sub. (Untuk kompatibilitas mundur, fitur ini juga akan tersedia di jwt.jwt-parse-token.claim.subject)

Nama variabel	Deskripsi
`claim.audience`	Klaim audiens JWT. Nilai ini dapat berupa string atau array string.
`claim.expiry`	Tanggal/waktu habis masa berlaku, dinyatakan dalam milidetik sejak epoch.
`claim.issuedat`	Tanggal token dikeluarkan, dinyatakan dalam milidetik sejak epoch.
`claim.issuer`	Klaim penerbit JWT.
`claim.notbefore`	Jika JWT menyertakan klaim {i> nbf<i}, variabel ini akan berisi nilai, yang diekspresikan dalam milidetik sejak epoch.
`claim.subject`	Klaim subjek JWT.
`claim.name`	Nilai klaim yang dinamai (standar atau tambahan) dalam payload. Salah satunya akan ditetapkan untuk setiap klaim dalam payload.
`decoded.claim.name`	Nilai JSON yang dapat diuraikan dari klaim bernama (standar atau tambahan) dalam payload. Satu variabel ditetapkan untuk setiap klaim dalam payload. Misalnya, Anda dapat menggunakan `decoded.claim.iat` untuk mengambil waktu diterbitkan pada JWT, dinyatakan dalam detik sejak epoch. Sementara Anda dapat juga menggunakan variabel alur `claim.name`, ini adalah variabel yang direkomendasikan untuk digunakan mengakses klaim.
`decoded.header.name`	Nilai header yang dapat diurai JSON dalam payload. Satu variabel ditetapkan untuk setiap {i>header<i} dalam {i>payload<i}. Meskipun Anda juga dapat menggunakan variabel flow `header.name`, variabel ini adalah variabel yang direkomendasikan untuk mengakses {i>header<i}.
`expiry_formatted`	Tanggal/waktu habis masa berlaku, diformat sebagai string yang dapat dibaca manusia. Contoh: 2017-09-28T21:30:45.000+0000
`header.algorithm`	Algoritma penandatanganan yang digunakan di JWT. Misalnya, RS256, HS384, dan sebagainya. Lihat Parameter Header(Algoritma) untuk mengetahui informasi selengkapnya.
`header.kid`	ID Kunci, jika ditambahkan saat JWT dibuat. Lihat juga "Menggunakan Kumpulan Kunci Web JSON (JWKS)" pada JWT ringkasan kebijakan untuk memverifikasi JWT. Lihat Parameter Header(Key ID) untuk mengetahui informasi selengkapnya.
`header.type`	Akan ditetapkan ke `JWT`.
`header.name`	Nilai header bernama (standar atau tambahan). Salah satunya akan ditetapkan untuk setiap {i>header<i} tambahan di bagian {i> header<i} JWT.
`header-json`	Header dalam format JSON.
`is_expired`	benar atau salah
`payload-claim-names`	Array klaim yang didukung oleh JWT.
`payload-json`	Payload dalam format JSON.
`seconds_remaining`	Jumlah detik sebelum token berakhir. Jika masa berlaku token telah berakhir, angkanya akan negatif.
`time_remaining_formatted`	Sisa waktu sebelum token akan habis masa berlakunya, diformat sebagai string yang dapat dibaca manusia. Contoh: 00:59:59.926
`valid`	Dalam kasus VerifyJWT, variabel ini akan bernilai benar ketika tanda tangan diverifikasi, dan waktu saat ini adalah sebelum masa berlaku token habis, dan setelah nilai token {i>notBefore<i}, jika tersedia. Jika tidak, flag akan bernilai salah. Dalam kasus DecodeJWT, variabel ini belum ditetapkan.

Referensi error

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

Error runtime

Error ini dapat terjadi saat kebijakan dieksekusi.

Kode kesalahan	Status HTTP	Penyebab
`steps.jwt.FailedToDecode`	401	Terjadi saat kebijakan tidak dapat mendekode JWT. JWT mungkin salah format, tidak valid, atau tidak dapat didekode.
`steps.jwt.FailedToResolveVariable`	401	Terjadi saat variabel flow yang ditentukan dalam elemen `<Source>` kebijakan tidak ada.
`steps.jwt.InvalidToken`	401	Terjadi saat variabel flow yang ditentukan dalam elemen `<Source>` kebijakan berada di luar cakupan atau tidak dapat diselesaikan.

Error saat deployment

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

Nama error	Penyebab	Perbaiki
`InvalidEmptyElement`	Terjadi saat variabel flow yang berisi JWT yang akan didekode tidak ditentukan dalam elemen `<Source>` kebijakan.

Variabel kesalahan

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

Variabel	Di mana	Contoh
`fault.name="fault_name"`	`fault_name` adalah nama kesalahan, seperti yang tercantum dalam tabel Error runtime di atas. Nama kesalahan adalah bagian terakhir dari kode kesalahan.	`fault.name Matches "TokenExpired"`
`JWT.failed`	Semua kebijakan JWT menetapkan variabel yang sama jika terjadi kegagalan.	`JWT.failed = true`

Contoh respons error

Kode Kesalahan Kebijakan JWT

Untuk penanganan error, praktik terbaiknya adalah menangkap bagian errorcode dari error yang dihasilkan. Jangan mengandalkan teks di faultstring, karena dapat berubah.

Contoh aturan kesalahan

    <FaultRules>
        <FaultRule name="JWT Policy Errors">
            <Step>
                <Name>JavaScript-1</Name>
                <Condition>(fault.name Matches "TokenExpired")</Condition>
            </Step>
            <Condition>JWT.failed=true</Condition>
        </FaultRule>
    </FaultRules>