Kebijakan GenerateJWS

Anda sedang melihat dokumentasi Apigee Edge.
Lihat dokumentasi Apigee X.

Apa

Menghasilkan JWS yang ditandatangani, dengan kumpulan klaim yang dapat dikonfigurasi. JWS kemudian dapat ditampilkan ke klien, ditransmisikan ke target backend, atau digunakan dengan cara lain. Lihat Ringkasan kebijakan JWS dan JWT untuk pengantar mendetail.

Untuk mempelajari bagian-bagian JWS dan cara enkripsi serta penandatanganannya, lihat RFC7515.

Video

Tonton video singkat untuk mempelajari cara membuat JWT yang ditandatangani. Meskipun video ini khusus untuk membuat JWT, banyak konsepnya sama untuk JWS.

Sample

• Membuat JWS terlampir yang ditandatangani dengan algoritme HS256
• Membuat JWS terpisah yang ditandatangani dengan algoritme RS256

Membuat JWS terlampir yang ditandatangani dengan algoritme HS256

Kebijakan contoh ini menghasilkan JWS terlampir dan menandatanganinya menggunakan algoritme HS256. HS256 mengandalkan rahasia bersama untuk menandatangani dan memverifikasi tanda tangan.

JWS terlampir berisi header, payload, dan tanda tangan yang dienkode:

header.payload.signature

Menetapkan <DetachContent> ke true untuk menghasilkan konten yang dilepas. Lihat Bagian dari JWS/JWT untuk 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 algoritme RS256

Contoh kebijakan ini menghasilkan JWS yang terpisah dan menandatanganinya menggunakan algoritme RS256. Pembuatan tanda tangan RS256 bergantung pada kunci pribadi RSA, yang harus diberikan dalam bentuk yang dienkode dengan PEM.

JWS yang terpisah menghilangkan payload dari JWS:

header..signature

Gunakan elemen <Payload> untuk menentukan payload JWS mentah yang tidak dienkode. Saat kebijakan ini dipicu, Edge mengenkode header dan payload JWS, lalu menggunakannya untuk membuat tanda tangan yang dienkode. Namun, JWS yang dihasilkan menghilangkan payload. Anda dapat meneruskan payload ke kebijakan VerifyJWS dengan 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 membuat JWS bergantung pada algoritme yang dipilih, seperti yang ditunjukkan pada tabel berikut:

<SecretKey>
  <Value ref="private.secretkey"/>
  <Id>1918290</Id>
</SecretKey>

<PrivateKey>
  <Value ref="private.privatekey"/>
  <Password ref="private.privatekey-password"/>
  <Id ref="private.privatekey-id"/>
</PrivateKey>

Referensi elemen untuk Generate JWS

Referensi kebijakan menjelaskan elemen dan atribut kebijakan Generate JWS.

Catatan: Konfigurasi akan sedikit berbeda bergantung pada algoritme enkripsi yang Anda gunakan. Lihat Contoh untuk contoh yang menunjukkan konfigurasi untuk kasus penggunaan tertentu.

Atribut yang berlaku untuk elemen tingkat atas

<GenerateJWS name="JWS" continueOnError="false" enabled="true" async="false">

Atribut berikut sama untuk semua elemen induk kebijakan.

<NamaTampilan>

<DisplayName>Policy Display Name</DisplayName>

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

<Algoritme>

<Algorithm>algorithm-here</Algorithm>

Menentukan algoritme enkripsi untuk menandatangani token.

<AdditionalHeader/Klaim>

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

Memasangkan nama/nilai klaim tambahan dalam header untuk JWS.

Elemen <Claim> menggunakan atribut berikut:

• name - (Wajib) Nama klaim.
• ref - (Opsional) Nama variabel alur. Jika ada, kebijakan akan menggunakan nilai variabel ini sebagai klaim. Jika atribut ref dan nilai klaim eksplisit ditentukan, nilai eksplisitnya akan menjadi default, dan digunakan jika variabel alur yang direferensikan belum diselesaikan.
• type - (Opsional) Salah satu dari: string (default), angka, boolean, atau peta
• array - (Opsional) Tetapkan ke true untuk menunjukkan apakah nilainya adalah array jenis. Default: false (salah).

<PentingHeader>

<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 akan memeriksa header crit. Untuk setiap header yang tercantum di header crit, header tersebut akan memeriksa apakah elemen <KnownHeaders> dari kebijakan VerifyJWS juga mencantumkan header tersebut. Header apa pun yang ditemukan oleh kebijakan VerifyJWS di kriteria yang tidak tercantum dalam <KnownHeaders> akan menyebabkan kebijakan VerifyJWS gagal.

<DetachContent>

<DetachContent>true|false</DetachContent>

Menentukan apakah JWS akan dibuat dengan payload terpisah, <DetachContent>true</DetachContent>, atau tidak, <DetachContent>false</DetachContent>.

Jika Anda menentukan false (salah), defaultnya, JWS yang dihasilkan akan berbentuk:

header.payload.signature

Jika Anda menentukan true untuk membuat payload terpisah, JWS yang dihasilkan akan menghilangkan payload dan berformat:

header..signature

Dengan payload yang dilepas, Anda dapat meneruskan payload asli yang tidak dienkode ke kebijakan VerifyJWS dengan menggunakan elemen <DetachedContent> dari kebijakan VerifyJWS.

<AbaikanUnresolvedVariables>

<IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables>

Tetapkan ke false jika Anda ingin kebijakan ini menampilkan error saat variabel yang direferensikan yang ditentukan dalam kebijakan tidak dapat diselesaikan. Tetapkan ke true untuk memperlakukan variabel yang tidak dapat diselesaikan sebagai string kosong (null).

<VariabelOutput>

<OutputVariable>JWS-variable</OutputVariable>

Menentukan lokasi JWS yang dihasilkan oleh kebijakan ini. Secara default, variabel ini ditempatkan ke dalam variabel flow jws.POLICYNAME.generated_jws.

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

<PrivateKey/Id>

<PrivateKey>
  <Id ref="flow-variable-name-here"/>
</PrivateKey>

or

<PrivateKey>
  <Id>your-id-value-here</Id>
</PrivateKey>

Menentukan ID kunci (anak) yang akan disertakan di header JWS. Gunakan hanya jika algoritme-nya adalah salah satu dari RS256/RS384/RS512, PS256/PS384/PS512, atau ES256/ES384/ES512.

<PrivateKey/Sandi>

<PrivateKey>
  <Password ref="private.privatekey-password"/>
</PrivateKey>

Tentukan sandi yang harus digunakan oleh kebijakan untuk mendekripsi kunci pribadi, jika diperlukan. Gunakan atribut ref untuk meneruskan kunci dalam variabel flow. Gunakan hanya jika algoritme-nya adalah salah satu dari RS256/RS384/RS512, PS256/PS384/PS512, atau ES256/ES384/ES512.

<PrivateKey/Nilai>

<PrivateKey>
  <Value ref="private.variable-name-here"/>
</PrivateKey>

Menentukan kunci pribadi berenkode PEM yang digunakan untuk menandatangani JWS. Gunakan atribut ref untuk meneruskan kunci dalam variabel flow. Hanya gunakan saat algoritme adalah salah satu dari RS256/RS384/RS512, PS256/PS384/PS512, atau ES256/ES384/ES512.

<SecretKey/Id>

<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 dari JWS yang ditandatangani dengan algoritme HMAC. Gunakan hanya jika algoritme-nya adalah salah satu dari HS256/HS384/HS512.

<Kunci/Kunci Rahasia>

<SecretKey>
  <Value ref="private.your-variable-name"/>
</SecretKey>

Menyediakan kunci rahasia yang digunakan untuk memverifikasi atau menandatangani token dengan algoritme HMAC. Gunakan hanya jika algoritme-nya adalah salah satu dari HS256/HS384/HS512. Gunakan atribut ref untuk meneruskan kunci dalam variabel flow.

Edge menerapkan kekuatan kunci minimum untuk algoritme HS256/HS384/HS512. Panjang kunci minimum untuk HS256 adalah 32 byte, untuk HS384 adalah 48 byte, dan untuk HS512 adalah 64 byte. Penggunaan kunci dengan kekuatan yang lebih rendah akan menyebabkan error runtime.

Variabel flow

Kebijakan Generate JWS tidak menetapkan variabel flow.

Referensi error

Bagian ini menjelaskan kode kesalahan dan pesan error yang dikembalikan, serta variabel kesalahan yang disetel oleh Edge saat kebijakan ini memicu error. Informasi ini penting untuk diketahui jika Anda mengembangkan aturan fault untuk menangani fault. 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 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

Untuk penanganan error, praktik terbaiknya adalah dengan menangkap 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>