Anda sedang melihat dokumentasi Apigee Edge.
Buka
dokumentasi Apigee X. info
Apa
Menghasilkan JWS bertanda tangan, dengan kumpulan klaim yang dapat dikonfigurasi. JWS kemudian dapat ditampilkan ke klien, dikirim ke target backend, atau digunakan dengan cara lain. Lihat ringkasan kebijakan JWS dan JWT untuk pengantar yang mendetail.
Untuk mempelajari bagian-bagian JWS dan cara JWS dienkripsi dan ditandatangani, lihat RFC7515.
Video
Tonton video singkat untuk mempelajari cara membuat JWT bertanda tangan. Meskipun video ini khusus untuk menghasilkan JWT, banyak konsepnya yang sama untuk JWS.
Contoh
- Buat JWS terlampir yang ditandatangani dengan algoritma HS256
- Membuat JWS terpisah yang ditandatangani dengan algoritma RS256
Buat JWS terlampir yang ditandatangani dengan algoritma HS256
Kebijakan contoh ini menghasilkan JWS terlampir dan menandatanganinya menggunakan algoritma HS256. HS256 mengandalkan rahasia bersama untuk penandatanganan dan verifikasi tanda tangan.
JWS terlampir berisi header, payload, dan tanda tangan yang dienkode:
header.payload.signature
Setel <DetachContent>
ke benar (true) untuk membuat konten terpisah.
Lihat Bagian-bagian JWS/JWT untuk mengetahui informasi selengkapnya tentang struktur dan format JWS.
Gunakan elemen <Payload>
untuk menentukan payload JWS mentah yang tidak dienkode.
Dalam contoh ini, variabel berisi payload. Saat tindakan kebijakan ini dipicu, Edge akan mengenkode header dan payload JWS, lalu menambahkan tanda tangan yang dienkode untuk menandatangani JWS secara digital.
Konfigurasi kebijakan di bawah membuat JWS dari payload yang terdapat dalam variabel private.payload
.
<GenerateJWS name="JWS-Generate-HS256"> <DisplayName>JWS Generate HS256</DisplayName> <Algorithm>HS256</Algorithm> <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables> <SecretKey> <Value ref="private.secretkey"/> <Id>1918290</Id> </SecretKey> <Payload ref="private.payload" /> <OutputVariable>jws-variable</OutputVariable> </GenerateJWS>
Membuat JWS terpisah yang ditandatangani dengan algoritma RS256
Kebijakan contoh ini menghasilkan JWS terpisah dan menandatanganinya menggunakan algoritma RS256. Pembuatan tanda tangan RS256 bergantung pada kunci pribadi RSA, yang harus disediakan dalam bentuk berenkode PEM.
JWS yang terlepas akan menghilangkan payload dari JWS:
header..signature
Gunakan elemen <Payload>
untuk menentukan payload JWS mentah yang tidak dienkode.
Saat kebijakan ini dipicu, Edge akan mengenkode header dan payload JWS, lalu menggunakannya untuk menghasilkan tanda tangan yang dienkode. Namun, JWS yang dihasilkan menghilangkan payload.
Anda dapat meneruskan payload ke kebijakan VerifyJWS menggunakan elemen <DetachedContent>
dari kebijakan VerifyJWS.
<GenerateJWS name="JWS-Generate-RS256"> <DisplayName>JWS Generate RS256</DisplayName> <Algorithm>RS256</Algorithm> <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables> <PrivateKey> <Value ref="private.privatekey"/> <Password ref="private.privatekey-password"/> <Id ref="private.privatekey-id"/> </PrivateKey> <Payload ref="private.payload" /> <DetachContent>true</DetachContent> <OutputVariable>jws-variable</OutputVariable> </GenerateJWS>
Menetapkan elemen utama
Elemen yang Anda gunakan untuk menentukan kunci yang digunakan untuk menghasilkan JWS bergantung pada algoritme yang dipilih, seperti yang ditunjukkan pada tabel berikut:
Algorithm | Elemen utama | |
---|---|---|
HS{256/384/512}* | <SecretKey> <Value ref="private.secretkey"/> <Id>1918290</Id> </SecretKey> |
|
RS/PS/ES{256/384/512}* | <PrivateKey> <Value ref="private.privatekey"/> <Password ref="private.privatekey-password"/> <Id ref="private.privatekey-id"/> </PrivateKey> Elemen |
|
*Untuk mengetahui informasi selengkapnya tentang persyaratan utama, lihat Tentang algoritma enkripsi tanda tangan. |
Referensi elemen untuk Membuat JWS
Referensi kebijakan menjelaskan elemen dan atribut kebijakan Generate JWS.
Catatan: Konfigurasi akan sedikit berbeda, tergantung algoritma enkripsi yang Anda gunakan. Lihat Contoh untuk mengetahui contoh yang menunjukkan konfigurasi untuk kasus penggunaan tertentu.
Atribut yang diterapkan pada elemen tingkat atas
<GenerateJWS name="JWS" continueOnError="false" enabled="true" async="false">
Atribut berikut bersifat umum untuk semua elemen induk kebijakan.
Atribut | Deskripsi | Default | Kehadiran |
---|---|---|---|
name |
Nama internal kebijakan. Karakter yang dapat digunakan dalam nama dibatasi untuk:
A-Z0-9._\-$ % . Namun, UI pengelolaan Edge menerapkan pembatasan
tambahan, seperti otomatis menghapus karakter yang bukan alfanumerik.
Atau, gunakan elemen |
T/A | Wajib |
continueOnError |
Setel ke false untuk menampilkan error jika kebijakan gagal. Ini adalah perilaku
yang wajar untuk sebagian besar kebijakan.
Setel ke |
false | Opsional |
diaktifkan |
Setel ke true untuk menerapkan kebijakan.
Setel ke |
true | Opsional |
async | Atribut ini sudah tidak digunakan lagi. | false | 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 menghilangkan elemen ini, nilai atribut nama kebijakan akan digunakan. |
Kehadiran | Opsional |
Jenis | String |
<Algorithm>
<Algorithm>algorithm-here</Algorithm>
Menentukan algoritma enkripsi untuk menandatangani token.
Default | T/A |
Kehadiran | Wajib |
Jenis | String |
Nilai yang valid | HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512, PS256, PS384, PS512 |
<Header/Klaim Tambahan>
<AdditionalHeaders> <Claim name='claim1'>explicit-value-of-claim-here</Claim> <Claim name='claim2' ref='variable-name-here'/> <Claim name='claim3' ref='variable-name-here' type='boolean'/> <Claim name='claim4' ref='variable-name' type='string' array='true'/> </AdditionalHeaders>
Menempatkan pasangan nama/nilai klaim tambahan di header untuk JWS.
Default | T/A |
Kehadiran | Opsional |
Nilai yang valid | Nilai apa pun yang ingin Anda gunakan untuk klaim tambahan. Anda dapat menentukan klaim secara eksplisit sebagai string, angka, boolean, peta, atau array. |
Elemen <Claim>
menggunakan atribut berikut:
- name - (Wajib) Nama klaim.
- ref - (Opsional) Nama variabel flow. Jika ada, kebijakan akan menggunakan nilai variabel ini sebagai klaim. Jika atribut ref dan nilai klaim eksplisit ditentukan, nilai eksplisitnya adalah nilai default, dan digunakan jika variabel alur yang direferensikan tidak terselesaikan.
- type - (Opsional) Salah satu dari: string (default), angka, boolean, atau peta
- array - (Opsional) Tetapkan ke true untuk menunjukkan apakah nilai merupakan array jenis. Default: false.
<CriticalHeaders>
<CriticalHeaders>a,b,c</CriticalHeaders> or: <CriticalHeaders ref=’variable_containing_headers’/>
Menambahkan header penting, crit, ke JWS. Header crit adalah array nama header yang harus diketahui dan dikenali oleh penerima JWS. Contoh:
{ “typ: “...”, “alg” : “...”, “crit” : [ “a”, “b”, “c” ], }
Saat runtime, kebijakan VerifyJWS memeriksa header crit.
Untuk setiap header yang tercantum dalam header crit, kode ini akan memeriksa apakah elemen <KnownHeaders>
dalam kebijakan VerifyJWS juga mencantumkan header tersebut. Setiap header yang ditemukan oleh kebijakan VerifyJWS di crit
yang tidak tercantum dalam <KnownHeaders>
akan menyebabkan kebijakan VerifyJWS gagal.
Default | T/A |
Kehadiran | Opsional |
Jenis | Array string yang dipisahkan koma |
Nilai yang valid | Baik array atau nama variabel yang berisi array. |
<DetachContent>
<DetachContent>true|false</DetachContent>
Menentukan apakah akan membuat JWS dengan payload terpisah, <DetachContent>true</DetachContent>
,
atau tidak, <DetachContent>false</DetachContent>
.
Jika Anda menentukan false, secara default, JWS yang dihasilkan adalah dalam bentuk:
header.payload.signature
Jika Anda menentukan true untuk membuat payload terpisah, JWS yang dihasilkan akan menghilangkan payload dan berformat:
header..signature
Dengan payload yang terlepas, Anda dapat meneruskan payload asli yang tidak dienkode ke kebijakan VerifyJWS menggunakan elemen <DetachedContent>
dalam kebijakan VerifyJWS.
Default | false |
Kehadiran | Opsional |
Jenis | Boolean |
Nilai yang valid | benar atau salah |
<IgnoreUnresolvedVariables>
<IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables>
Tetapkan ke false jika Anda ingin kebijakan menampilkan error saat variabel yang direferensikan dan ditentukan dalam kebijakan tidak dapat diselesaikan. Tetapkan ke true untuk memperlakukan variabel yang tidak dapat di-resolve sebagai string kosong (null).
Default | false |
Kehadiran | Opsional |
Jenis | Boolean |
Nilai yang valid | benar atau salah |
<OutputVariable>
<OutputVariable>JWS-variable</OutputVariable>
Menentukan lokasi untuk menempatkan JWS yang dibuat oleh kebijakan ini. Secara default, kolom ini ditempatkan ke
variabel flow jws.POLICYNAME.generated_jws
.
Default | jws.POLICYNAME.generated_jws |
Kehadiran | Opsional |
Jenis | String (nama variabel flow) |
<Payload>
<Payload ref="flow-variable-name-here" /> or <Payload>payload-value</Payload>
Menentukan payload JWS mentah yang tidak dienkode. Tentukan variabel yang berisi payload, atau string.
Default | T/A |
Kehadiran | Wajib |
Jenis | String, array byte, stream, atau representasi lain dari payload JWS yang tidak dienkode. |
<PrivateKey/Id>
<PrivateKey> <Id ref="flow-variable-name-here"/> </PrivateKey> or <PrivateKey> <Id>your-id-value-here</Id> </PrivateKey>
Menentukan ID kunci (anak) untuk disertakan dalam header JWS. Hanya gunakan jika algoritmenya adalah salah satu dari RS256/RS384/RS512, PS256/PS384/PS512, atau ES256/ES384/ES512.
Default | T/A |
Kehadiran | Opsional |
Jenis | String |
Nilai yang valid | String atau variabel flow |
<PrivateKey/Password>
<PrivateKey> <Password ref="private.privatekey-password"/> </PrivateKey>
Tentukan sandi yang harus digunakan kebijakan untuk mendekripsi kunci pribadi, jika diperlukan. Gunakan atribut ref untuk meneruskan kunci dalam variabel flow. Hanya gunakan jika algoritmenya adalah salah satu dari RS256/RS384/RS512, PS256/PS384/PS512, atau ES256/ES384/ES512.
Default | T/A |
Kehadiran | Opsional |
Jenis | String |
Nilai yang valid |
Referensi variabel flow.
Catatan: Anda harus menentukan variabel flow. Edge akan menolak karena konfigurasi kebijakan yang sandinya ditentukan dalam teks biasa tidak valid. Variabel flow
harus memiliki awalan "private". Misalnya, |
<PrivateKey/Value>
<PrivateKey> <Value ref="private.variable-name-here"/> </PrivateKey>
Menentukan kunci pribadi yang dienkode PEM yang digunakan untuk menandatangani JWS. Gunakan atribut ref untuk meneruskan kunci dalam variabel flow. Gunakan hanya jika algoritmenya adalah salah satu dari RS256/RS384/RS512, PS256/PS384/PS512, atau ES256/ES384/ES512.
Default | T/A |
Kehadiran | Diperlukan untuk menghasilkan JWS menggunakan algoritma RS256. |
Jenis | String |
Nilai yang valid |
Variabel flow yang berisi string yang mewakili nilai kunci pribadi RSA berenkode PEM.
Catatan: Variabel flow harus memiliki awalan "private". Contoh,
|
<Kunci/ID Rahasia>
<SecretKey> <Id ref="flow-variable-name-here"/> </SecretKey> or <SecretKey> <Id>your-id-value-here</Id> </SecretKey>
Menentukan ID kunci (anak) yang akan disertakan dalam header JWS JWS yang ditandatangani dengan algoritma HMAC. Gunakan hanya jika algoritmenya adalah salah satu dari HS256/HS384/HS512.
Default | T/A |
Kehadiran | Opsional |
Jenis | String |
Nilai yang valid | String atau variabel flow |
<SecretKey/Value>
<SecretKey> <Value ref="private.your-variable-name"/> </SecretKey>
Memberikan kunci rahasia yang digunakan untuk memverifikasi atau menandatangani token dengan algoritma HMAC. Gunakan hanya jika algoritmenya adalah salah satu dari HS256/HS384/HS512. Gunakan atribut ref untuk meneruskan kunci dalam variabel flow.
Edge memberlakukan kekuatan kunci minimum untuk algoritma HS256/HS384/HS512. Panjang kunci minimum untuk HS256 adalah 32 byte, untuk HS384 adalah 48 byte, dan untuk HS512 adalah 64 byte. Menggunakan kunci dengan kekuatan lebih rendah akan menyebabkan error runtime.
Default | T/A |
Kehadiran | Diperlukan untuk algoritma HMAC. |
Jenis | String |
Nilai yang valid |
Variabel flow yang mengacu pada string
Catatan: Jika variabel flow, variabel tersebut harus memiliki awalan "private". Contoh:
|
Variabel alur
Kebijakan Generate JWS tidak menetapkan variabel alur.
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 Hal yang perlu Anda ketahui tentang error kebijakan dan Menangani kesalahan.
Error runtime
Error ini dapat terjadi saat kebijakan dieksekusi.
Kode kesalahan | Status HTTP | Terjadi saat |
---|---|---|
steps.jws.GenerationFailed |
401 | Kebijakan ini tidak dapat menghasilkan JWS. |
steps.jws.InsufficientKeyLength |
401 | Untuk kunci kurang dari 32 byte untuk algoritma HS256 |
steps.jws.InvalidClaim |
401 | Karena klaim atau klaim tidak cocok, atau ketidakcocokan header atau header tidak ada. |
steps.jws.InvalidCurve |
401 | Kurva yang ditentukan oleh kunci tidak valid untuk algoritma Kurva Eliptis. |
steps.jws.InvalidJsonFormat |
401 | JSON yang tidak valid ditemukan di header JWS. |
steps.jws.InvalidPayload |
401 | Payload JWS tidak valid. |
steps.jws.InvalidSignature |
401 | <DetachedContent> dihilangkan dan JWS memiliki payload konten terpisah. |
steps.jws.KeyIdMissing |
401 | Kebijakan Verifikasi menggunakan JWKS sebagai sumber untuk kunci publik, tetapi JWS yang ditandatangani tidak menyertakan properti kid di header. |
steps.jws.KeyParsingFailed |
401 | Kunci publik tidak dapat diuraikan dari informasi kunci yang diberikan. |
steps.jws.MissingPayload |
401 | Payload JWS tidak ada. |
steps.jws.NoAlgorithmFoundInHeader |
401 | Terjadi saat JWS menghilangkan header algoritma. |
steps.jws.SigningFailed |
401 | Dalam GenerateJWS, untuk kunci yang kurang dari ukuran minimum untuk algoritma HS384 atau HS512 |
steps.jws.UnknownException |
401 | Terjadi pengecualian yang tidak diketahui. |
steps.jws.WrongKeyType |
401 | Jenis kunci yang ditentukan salah. Misalnya, jika Anda menentukan kunci RSA untuk algoritma Kurva Elliptik, atau kunci kurva untuk algoritma RSA. |
Error saat deployment
Error ini dapat terjadi saat Anda men-deploy proxy yang berisi kebijakan ini.
Nama error | Terjadi saat |
---|---|
InvalidAlgorithm |
Satu-satunya nilai yang valid adalah: RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512. |
|
Kemungkinan error deployment lainnya. |
Variabel kesalahan
Variabel ini ditetapkan saat terjadi error runtime. Untuk informasi selengkapnya, lihat Yang perlu Anda ketahui tentang error kebijakan.
Variabel | Dari 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" |
JWS.failed |
Semua kebijakan JWS menetapkan variabel yang sama jika terjadi kegagalan. | jws.JWS-Policy.failed = true |
Contoh respons error
Untuk penanganan error, praktik terbaiknya adalah menjebak bagian errorcode
dari respons
error. Jangan mengandalkan teks di faultstring
, karena dapat berubah.
Contoh aturan kesalahan
<FaultRules> <FaultRule name="JWS Policy Errors"> <Step> <Name>JavaScript-1</Name> <Condition>(fault.name Matches "TokenExpired")</Condition> </Step> <Condition>JWS.failed=true</Condition> </FaultRule> </FaultRules>