Kebijakan GenerateJWT

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat Dokumentasi Apigee Edge.

Apa

Menghasilkan JWT bertanda tangan atau JWT terenkripsi, dengan sekumpulan klaim yang dapat dikonfigurasi. JWT kemudian dapat dikembalikan ke yang dikirim ke target backend, atau digunakan dengan cara lain. Lihat ringkasan kebijakan JWS dan JWT untuk pengantar mendetail.

Kebijakan ini merupakan Kebijakan yang dapat diperluas dan penggunaan kebijakan ini mungkin menimbulkan biaya atau implikasi penggunaan, bergantung pada lisensi Apigee Anda. Untuk mengetahui informasi tentang jenis kebijakan dan implikasi penggunaan, lihat Jenis kebijakan.

Solusi

Kebijakan menghasilkan JWT yang ditandatangani atau dienkripsi bergantung pada elemen yang Anda gunakan untuk menentukan algoritma yang menghasilkan JWT:

• Jika Anda menggunakan elemen <Algorithm>, kebijakan tersebut akan menghasilkan JWT yang ditandatangani.
• Jika Anda menggunakan <Algorithms> , kebijakan tersebut akan menghasilkan JWT terenkripsi.

Video

Tonton video singkat untuk mempelajari cara menghasilkan JWT yang ditandatangani.

Membuat JWT Bertanda Tangan

Bagian ini menjelaskan cara membuat JWT yang ditandatangani. Untuk JWT yang ditandatangani, menggunakan <Algorithm> untuk menentukan algoritma untuk menandatangani kunci.

Sampel untuk JWT yang ditandatangani

Contoh berikut mengilustrasikan cara menghasilkan JWT yang ditandatangani.

<GenerateJWT name="JWT-Generate-HS256">
    <DisplayName>JWT Generate HS256</DisplayName>
    <Type>Signed</Type>
    <Algorithm>HS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <SecretKey>
        <Value ref="private.secretkey"/>
        <Id>1918290</Id>
    </SecretKey>
    <ExpiresIn>1h</ExpiresIn>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalClaims>
        <Claim name="show">And now for something completely different.</Claim>
    </AdditionalClaims>
    <OutputVariable>jwt-variable</OutputVariable>
</GenerateJWT>

{
  "typ" : "JWT",
  "alg" : "HS256",
  "kid" : "1918290"
}

{
  "sub" : "monty-pythons-flying-circus",
  "iss" : "urn://apigee-JWT-policy-test",
  "aud" : "fans",
  "iat" : 1506553019,
  "exp" : 1506556619,
  "jti" : "BD1FF263-3D25-4593-A685-5EC1326E1F37",
  "show": "And now for something completely different."
}

<GenerateJWT name="JWT-Generate-RS256">
    <Type>Signed</Type>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <PrivateKey>
        <Value ref="private.privatekey"/>
        <Password ref="private.privatekey-password"/>
        <Id ref="private.privatekey-id"/>
    </PrivateKey>
    <Subject>apigee-seattle-hatrack-montage</Subject>
    <Issuer>urn://apigee-JWT-policy-test</Issuer>
    <Audience>urn://c60511c0-12a2-473c-80fd-42528eb65a6a</Audience>
    <ExpiresIn>60m</ExpiresIn>
    <Id/>
    <AdditionalClaims>
        <Claim name="show">And now for something completely different.</Claim>
    </AdditionalClaims>
    <OutputVariable>jwt-variable</OutputVariable>
</GenerateJWT>

Contoh di atas menggunakan elemen <Algorithm> sehingga menghasilkan JWT. Elemen <PrivateKey> menentukan kunci kriptografis yang digunakan untuk menandatangani JWT. Ada juga merupakan elemen kunci lainnya. Yang Anda gunakan tergantung pada algoritma yang ditentukan oleh <Algorithm>, seperti yang dijelaskan di bagian berikutnya.

Menyetel elemen kunci untuk JWT yang ditandatangani

Gunakan dengan tepat salah satu elemen berikut untuk menentukan kunci yang digunakan untuk membuat JWT bertanda tangan:

• <SecretKey>
• <PrivateKey>

Elemen yang Anda gunakan bergantung pada algoritma yang dipilih, seperti yang ditunjukkan dalam tabel berikut:

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

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

Pada contoh di atas, <Password> dan <Id> lainnya bersifat opsional.

Untuk informasi selengkapnya tentang persyaratan utama, lihat Tentang tanda tangan algoritma enkripsi.

Membuat JWT terenkripsi

Bagian ini menjelaskan cara membuat JWT terenkripsi. Untuk JWT terenkripsi, menggunakan <Algorithms> untuk menentukan algoritma untuk menandatangani kunci dan isi.

Contoh JWT terenkripsi

Contoh berikut menunjukkan cara membuat JWT terenkripsi. Contoh menggunakan elemen <Algorithms> sehingga menghasilkan atau JWT yang terenkripsi.

<GenerateJWT name="gjwt-1">
  <Type>Encrypted</Type>
  <Algorithms>
    <Key>RSA-OAEP-256</Key>
    <Content>A128GCM</Content>
  </Algorithms>
  <PublicKey>
    <Value ref="rsa_publickey"/>
  </PublicKey>
  <Subject>subject@example.com</Subject>
  <Issuer>urn://apigee</Issuer>
  <ExpiresIn>1h</ExpiresIn>
  <AdditionalHeaders>
    <Claim name="moniker">Harvey</Claim>
  </AdditionalHeaders>
  <OutputVariable>output_var</OutputVariable>
</GenerateJWT>

<GenerateJWT name='gjwt-2'>
  <Algorithms>
    <Key>A128KW</Key>
    <Content>A128GCM</Content>
  </Algorithms>
  <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
  <SecretKey>
    <Value ref='private.secretkey'/>
  </SecretKey>
  <Subject>subject@example.com</Subject>
  <Issuer>urn://apigee</Issuer>
  <ExpiresIn>1h</ExpiresIn>
  <OutputVariable>output_var</OutputVariable>
</GenerateJWT>

Menyetel elemen kunci untuk JWT terenkripsi

Gunakan dengan tepat salah satu dari elemen berikut untuk menentukan kunci enkripsi HasilkanJWT, jika Anda ingin membuat JWT terenkripsi:

• <PublicKey>
• <SecretKey>
• <PasswordKey>
• <DirectKey>

Elemen yang Anda gunakan bergantung pada algoritma ensiripsi kunci, seperti ditunjukkan dalam tabel berikut:

<PublicKey>
  <Value ref="rsa_publickey"/>
</PublicKey>

<PublicKey>
  <Value ref="ec_publickey"/>
</PublicKey>

<SecretKey>
  <Id>optional key identifier here</Id>
  <Value ref="private.secretkey"/>
</SecretKey>

<PasswordKey>
  <Id>optional key identifier here</Id>
  <Value ref="private.passwordkey"/>
  <SaltLength>
  <PBKDF2Iterations>
</PasswordKey>

<DirectKey>
  <Id>optional key identifier here</Id>
  <Value encoding="base16|hex|base64|base64url" ref="private.directkey"/>
</DirectKey>

Untuk informasi selengkapnya tentang persyaratan utama, lihat Tentang tanda tangan algoritma enkripsi.

Referensi elemen untuk Membuat JWT

Referensi kebijakan menjelaskan elemen dan atribut kebijakan Membuat JWT.

Catatan: Konfigurasi akan sedikit berbeda tergantung enkripsi algoritma yang digunakan. Lihat Contoh untuk JWT yang ditandatangani atau Sample untuk JWT terenkripsi contoh yang menunjukkan khusus untuk kasus penggunaan tertentu.

Atribut yang diterapkan pada elemen tingkat atas

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

Atribut berikut umum untuk semua elemen induk kebijakan.

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

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

<Algorithm>

<Algorithm>algorithm-here</Algorithm>

Menentukan algoritma kriptografi yang digunakan untuk menandatangani token. Gunakan <Algorithm> untuk menghasilkan JWT yang ditandatangani.

<Algorithms>

<Algorithms>
    <Key>key-algorithm</Key>
    <Content>content-algorithm</Content>
</Algorithm>

Menentukan algoritma kriptografi untuk enkripsi kunci dan konten. Gunakan <Algorithms> untuk menghasilkan JWT terenkripsi.

Elemen turunan <Algorithms>

Tabel berikut memberikan deskripsi tingkat tinggi tentang elemen turunan dari <Algorithms>:

Algoritma enkripsi kunci

Tabel berikut mencantumkan algoritma yang tersedia untuk enkripsi kunci.

Baca artikel Membuat JWT terenkripsi untuk mengetahui contohnya algoritma enkripsi kunci adalah RSA-OAEP-256, jadi Anda menggunakan elemen <PublicKey> dengan nilai yang di-resolve menjadi kunci publik RSA.

Algoritma enkripsi konten

Algoritma berikut (simetris, berbasis AES) tersedia untuk enkripsi konten:

• A128CBC-HS256
• A192CBC-HS384
• A256CBC-HS512
• A128GCM
• A192GCM
• A256GCM

Untuk informasi selengkapnya tentang semua algoritma ini, lihat RFC7518.

<Audience>

<Audience>audience-here</Audience>

or:

<Audience ref='variable_containing_audience'/>

Kebijakan ini menghasilkan JWT yang berisi klaim aud yang disetel ke dengan sejumlah nilai. Klaim ini mengidentifikasi penerima yang menjadi target JWT. Ini adalah salah satu klaim terdaftar yang disebutkan dalam RFC7519.

&lt;AdditionalClaims/Claim&gt;

<AdditionalClaims>
    <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'/>
</AdditionalClaims>

or:

<AdditionalClaims ref='claim_payload'/>

Memungkinkan Anda menentukan pasangan nama/nilai klaim tambahan dalam payload JWT. Anda dapat menentukan klaim secara eksplisit sebagai string, angka, boolean, peta, atau array. Peta hanyalah kumpulan nama/nilai pasangan.

Elemen <Claim> menggunakan atribut berikut:

• name - (Wajib) Nama klaim.
• ref - (Opsional) Nama variabel flow. Jika ada, kebijakan akan menggunakan nilai variabel sebagai klaim. Jika atribut ref dan nilai klaim eksplisit ditentukan, elemen nilai eksplisit adalah 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: {i>false<i}.

Jika Anda menyertakan elemen <Claim>, nama klaim ditetapkan secara statis saat Anda mengonfigurasi kebijakan. Atau, Anda dapat meneruskan objek JSON untuk menentukan nama klaim. Karena objek JSON diteruskan sebagai variabel, nama klaim dalam JWT yang dihasilkan ditentukan saat runtime.

Contoh:

<AdditionalClaims ref='json_claims'/>

Dengan variabel json_claims berisi objek JSON dalam bentuk:

{
  "sub" : "person@example.com",
  "iss" : "urn://secure-issuer@example.com",
  "non-registered-claim" : {
    "This-is-a-thing" : 817,
    "https://example.com/foobar" : { "p": 42, "q": false }
  }
}

JWT yang dihasilkan mencakup semua klaim dalam objek JSON.

&lt;AdditionalHeaders/Claim&gt;

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

Elemen <Claim> menggunakan atribut berikut:

• name - (Wajib) Nama klaim.
• ref - (Opsional) Nama variabel flow. Jika ada, kebijakan akan menggunakan nilai variabel sebagai klaim. Jika atribut ref dan nilai klaim eksplisit ditentukan, elemen nilai eksplisit adalah 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: {i>false<i}.

<Kompresi>

<Compress>true</Compress>

Menentukan apakah teks dikompresi sebelum dienkripsi. Elemen ini hanya valid saat membuat JWT terenkripsi.

&lt;CriticalHeaders&gt;

<CriticalHeaders>a,b,c</CriticalHeaders>

or:

<CriticalHeaders ref=’variable_containing_headers’/>

Menambahkan header penting, crit, ke header JWT. Header crit adalah larik nama {i>header<i} yang harus diketahui dan dikenali oleh penerima JWT. Contoh:

{
  "typ": "...",
  "alg" : "...",
  "crit" : [ "a", "b", "c" ],
}

Menurut spesifikasi, pihak verifikasi harus memeriksa header crit dan memverifikasi bahwa setiap {i>header <i}itu dapat dipahami. Misalnya, kebijakan VerifikasiJWT akan memeriksa header crit. Untuk setiap item yang tercantum dalam header crit, alat ini memeriksa apakah elemen <KnownHeaders> kebijakan VerifyJWT juga mencantumkan header tersebut. Header apa pun yang ditemukan oleh kebijakan VerifyJWT di crit yang tidak tercantum dalam <KnownHeaders> menyebabkan kebijakan VerifyJWT gagal.

&lt;CustomClaims&gt;

Catatan: Saat ini, elemen Custom Claims disisipkan saat Anda menambahkan elemen Buat kebijakan JWT melalui UI. Elemen ini tidak berfungsi dan akan diabaikan. Pernyataan yang benar yang akan digunakan adalah &lt;AdditionalClaims&gt;. UI akan diperbarui untuk menyisipkan elemen yang benar di lain waktu.

&lt;DirectKey&gt;

<DirectKey>
  <Id>A12345</Id>
  <Value encoding="base16|hex|base64|base64url" ref="private.directkey"/>
</DirectKey>

Menentukan kunci langsung untuk mengenkripsi JWT jika algoritma enkripsinya adalah dir ("enkripsi langsung").

Elemen turunan <DirectKey>

Tabel berikut memberikan deskripsi tingkat tinggi tentang elemen turunan dari <DirectKey>:

Dengan enkripsi kunci langsung, Anda dapat langsung menyediakan serangkaian byte yang akan bertindak sebagai kunci enkripsi konten (CEK). Anda harus menentukan array byte sebagai string yang dienkode. Panjang array byte yang diperlukan bergantung pada kekuatan enkripsi konten algoritma yang dipilih. Misalnya, untuk A256CBC-HS512, Anda harus memberikan kunci yang sama persis 512 bit, atau 64 byte.

Konten variabel private.directkey harus berupa string yang dienkode, baik melalui hex (base16), base64, atau base64url. Misalnya, berikut ini kunci dengan enkode heksadesimal 32 byte:

96 4b e1 71 15 71 5f 87 11 0e 13 52 4c ec 1e ba df 47 62 1a 9d 3b f5 ad d2 7b b2 35 e7 d6 17 11

Untuk encoding heksadesimal, spasi kosong diterima tetapi tidak diperlukan, dan huruf besar atau kecil digunakan diterima (B7 sama dengan b7).

Padanan yang dienkode base64url di atas adalah:

lkvhcRVxX4cRDhNSTOweut9HYhqdO/Wt0nuyNefWFxE

Untuk varian base64*, spasi kosong tidak diterima, dan kapitalisasi itu penting. Jika Anda tidak menentukan encoding, kebijakan akan mengasumsikan bahwa encoding adalah base64.

Berikut penjelasan panjang kunci yang diperlukan:

Catatan: Kunci enkripsi konten yang disediakan melalui <DirectKey> harus persis untuk algoritma enkripsi konten yang ditentukan. Untuk enkripsi kunci apa pun selain dir, kebijakan tersebut akan menghasilkan CEK acak yang merupakan panjang yang tepat, tetapi untuk dir, konfigurasi perlu menyediakan kunci dengan ukuran yang tepat secara eksplisit.

&lt;ExpiresIn&gt;

<ExpiresIn>time-value-here</ExpiresIn>

or:

<ExpiresIn ref='time-value-here'/>

Menentukan masa aktif JWT dalam milidetik, detik, menit, jam, atau hari. Menentukan masa berlakunya menggunakan elemen XML atau atribut ref, tetapi tidak keduanya.

&lt;Id&gt;

<Id>explicit-jti-value-here</Id>
 -or-
<Id ref='variable-name-here'/>
 -or-
<Id/>

Menghasilkan JWT dengan klaim jti tertentu. Jika nilai teks dan atribut ref keduanya kosong, kebijakan akan menghasilkan jti yang berisi UUID acak. Klaim ID JWT (jti) adalah ID unik untuk JWT. Untuk informasi selengkapnya tentang jti, baca RFC7519.

&lt;IgnoreUnresolvedVariables&gt;

<IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables>

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

&lt;Issuer&gt;

<Issuer ref='variable-name-here'/>
<Issuer>issuer-string-here</Issuer>

Kebijakan ini menghasilkan JWT yang berisi klaim dengan nama iss, dengan nilai yang ditetapkan ke nilai yang ditentukan. Klaim yang mengidentifikasi penerbit JWT. Ini adalah salah satu kumpulan klaim terdaftar yang disebutkan dalam RFC7519.

&lt;NotBefore&gt;

<!-- Specify an absolute time. -->
<NotBefore>2017-08-14T11:00:21-07:00</NotBefore>
 -or-
<!-- Specify a time relative to when the token is generated. -->
<NotBefore>6h</NotBefore>

Menentukan waktu saat token menjadi valid. Token tidak valid hingga waktu yang ditentukan. Anda dapat menentukan nilai waktu absolut, atau waktu yang relatif terhadap saat token dibuat.

Nilai waktu yang valid bagi elemen NotBefore untuk nilai waktu absolut

Untuk nilai waktu relatif, tentukan bilangan bulat dan jangka waktu, misalnya:

• 10 dtk
• 60 mnt
• 12 j

&lt;OutputVariable&gt;

<OutputVariable>jwt-variable</OutputVariable>

Menentukan lokasi untuk menempatkan JWT yang dibuat oleh kebijakan ini. Secara default, file ini ditempatkan ke variabel alur jwt.POLICYNAME.generated_jwt.

&lt;PasswordKey&gt;

<PasswordKey>
  <Id>abcdefg</Id>
  <Value ref="private.password"/>
  <SaltLength>8</SaltLength>
  <PBKDF2Iterations>10000</PBKDF2>
</PasswordKey>

Menentukan kunci untuk mengenkripsi JWT jika algoritma enkripsinya adalah salah satu dari faktor berikut:

• PBES2-HS256+A128KW
• PBES2-HS384+A192KW
• PBES2-HS512+A256KW

Untuk masing-masing algoritma kunci ini, Anda harus menyediakan {i>password<i} yang digunakan untuk diperoleh, melalui variabel private.password dalam elemen <Value ref="private.password"/>.

Elemen turunan <PasswordKey>

Tabel berikut memberikan deskripsi tingkat tinggi tentang elemen turunan dari <PasswordKey>:

&lt;PrivateKey&gt;

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

Menentukan kunci pribadi yang akan digunakan saat membuat JWT yang ditandatangani, dan Algorithm adalah varian RSA atau elliptic curve (EC) - salah satu dari RS256/RS384/RS512, PS256/PS384/PS512, atau ES256/ES384/ES512.

Elemen turunan <PrivateKey>

Tabel berikut memberikan deskripsi dari elemen turunan dari <PrivateKey>:

&lt;PublicKey&gt;

<PublicKey>
  <!-- specify exactly one of the following -->
  <Value ref="variable-containing-encoded-publickey"/>
  <Value>PEM encoded public key</Value>
  <Certificate ref="variable-containing-encoded-x509-certificate"/>
  <Certificate>PEM encoded X509 certificate</Certificate>
  <JWKS>jwks-content</JWKS>
  <JWKS ref="variable-containing-jwks-content"/>
  <JWKS uri="variable-containing-jwks-content"/>
  <JWKS uriRef="variable-containing-uri"/>
</PublicKey>

Menentukan kunci publik yang akan digunakan saat membuat JWT terenkripsi, dan algoritme Key adalah varian RSA atau elliptic curve (EC) - RSA-OAEP-256, ECDH-ES, ECDH-ES+A128KW, ECDH-ES+A192KW, atau ECDH-ES+A256KW.

Elemen turunan <PublicKey>

Berikan tepat satu dari Value, Certificate, atau JWKS. Jika Anda menentukan JWKS, Anda juga harus menentukan Id. Tabel berikut memberikan deskripsi tentang elemen turunan dari <PublicKey>:

<PublicKey>
  <Value ref="public.publickey"/>
</PublicKey>

<PublicKey>
  <Value>
   -----BEGIN PUBLIC KEY-----
   MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAw2kPrRzcufvUNHvTH/WW
   2F73IyN....your key will vary....1jC0dwUD1lHV8MfUyRXmpmnNxJHACof
   C5TBtXMORc+us7A2cTtC4gZV256bT4h3sIEMsDl0Joz9K9MPzVPFxa1i0RgNt06n
   ZmkDb/DRW5onclGzxQITBFP3S6JXd4LNESJcTp705ec1cQ9Wp2Kl+nKrKyv1E5Xx
   DQIDAQAB
   -----END PUBLIC KEY-----
  </Value>
</PublicKey>

<PublicKey>
 <Certificate ref="public.pem-encoded-certificate"/>
</PublicKey>

<PublicKey>
  <Certificate>
  -----BEGIN CERTIFICATE-----
  MIIDqDCCApACCQCG/xVb7Yzw3zANBgkqhkiG9w0BAQUFADCBlTELMAkGA1UEBhMC
  2F73IyN....your certificate data will vary....1jC0dwUD1lHV8MfUyR
  VQQKDAZHb29nbGUxDzANBgNVBAsMBkFwaWdlZTEaMBgGA1UEAwwRYXBpZ2VlLmdv
  ...
  YjBaZuNUDVLGvbTSRgWG5lwm85Jar2zeCBcxFDwqyZFvVNV9SfoWF/LgVVpK54n8
  rknZ17USb0ob51ckxPTENmF2DUHBzgptiw10Yw==
  -----END CERTIFICATE-----
  </Certificate>
</PublicKey>

<PublicKey>
  <JWKS uri="uri-that-returns-a-jwks"/>
  <Id ref="variable-containing-a-kid">literal-value-here</Id>
</PublicKey>

&lt;SecretKey&gt;

<SecretKey encoding="base16|hex|base64|base64url" >
 <Id ref="variable-containing-key-id-here">secret-key-id</Id>
 <Value ref="private.variable-here"/>
</SecretKey>

Elemen SecretKey bersifat opsional. Ini menentukan kunci rahasia yang akan digunakan ketika menghasilkan JWT yang ditandatangani yang menggunakan algoritma simetris (HS*) atau ketika menghasilkan JWT terenkripsi yang menggunakan algoritma simetris (AES) untuk kunci enkripsi.

Anak-anak dari <SecretKey>

Tabel berikut memberikan deskripsi tentang elemen dan atribut turunan dari <SecretKey>:

<SecretKey encoding="VALUE_HERE" >
 <Id ref="variable-containing-key-id-here">secret-key-id</Id>
 <Value ref="private.secretkey"/>
</SecretKey>

<SecretKey>
  <Id ref="flow-variable-name-here"/>
 <Value ref="private.variable-here"/>
</SecretKey>

or

<SecretKey>
  <Id>your-id-value-here</Id>
 <Value ref="private.variable-here"/>
</SecretKey>

<SecretKey>
 <Id ref="flow-variable-name-here"/>
  <Value ref="private.my-secret-variable"/>
</SecretKey>

&lt;Subject&gt;

<Subject>subject-string-here</Subject>

<Subject ref="flow_variable" />

Contoh:

<Subject ref="apigee.developer.email"/>

Kebijakan ini menghasilkan JWT yang berisi klaim sub, yang disetel ke nilai value.Klaim ini mengidentifikasi atau membuat pernyataan tentang subjek JWT. Ini adalah salah satu serangkaian klaim standar yang disebutkan dalam IETF RFC 7519.

&lt;Type&gt;

<Type>type-string-here</Type>

Menjelaskan apakah kebijakan menghasilkan JWT yang ditandatangani atau JWT terenkripsi. Tujuan Elemen <Type> bersifat opsional. Anda dapat menggunakannya untuk memberi tahu pembaca tentang konfigurasi apakah kebijakan tersebut menghasilkan JWT yang ditandatangani atau yang terenkripsi.

• Jika elemen <Type> ada:
  • Jika nilai <Type> adalah Signed, kebijakan tersebut menghasilkan JWT yang ditandatangani, dan Elemen <Algorithm> harus ada.
  • Jika nilai <Type> adalah Encrypted, kebijakan akan menghasilkan JWT terenkripsi, dan Elemen <Algorithms> harus ada.
• Jika elemen <Type> tidak ada:
  • Jika elemen <Algorithm> ada, kebijakan mengasumsikan <Type> adalah Signed.
  • Jika elemen <Algorithms> ada, kebijakan akan mengasumsikan <Type> adalah Encrypted.
• Jika <Algorithm> atau <Algorithms> tidak ada, konfigurasinya tidak valid.

Variabel flow

Kebijakan Buat JWT tidak menetapkan variabel alur.

Referensi error

Bagian ini menjelaskan kode kesalahan dan pesan error yang ditampilkan dan variabel kesalahan yang disetel oleh Apigee 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.

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

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="JWT Policy Errors">
            <Step>
                <Name>JavaScript-1</Name>
                <Condition>(fault.name Matches "InvalidToken")</Condition>
            </Step>
            <Condition>JWT.failed=true</Condition>
        </FaultRule>
    </FaultRules>