JJWT नीति जनरेट करें

Apigee Edge दस्तावेज़ देखा जा रहा है.
Apigee X दस्तावेज़ पर जाएं. जानकारी

यह क्या है

कॉन्फ़िगर किए जा सकने वाले दावों के सेट के साथ, साइन किया हुआ JWT जनरेट करता है. इसके बाद, JWT को क्लाइंट को लौटाया जा सकता है, बैकएंड टारगेट पर भेजा जा सकता है या किसी दूसरे तरीके से इस्तेमाल किया जा सकता है. ज़्यादा जानकारी के लिए, JWS और JWT की नीतियों की खास जानकारी देखें.

वीडियो

साइन किया हुआ JWT जनरेट करने का तरीका जानने के लिए, यह छोटा सा वीडियो देखें.

सैंपल

• HS256 एल्गोरिदम की मदद से साइन किया गया JWT जनरेट करें
• RS256 एल्गोरिदम की मदद से साइन किया गया JWT जनरेट करें

HS256 एल्गोरिदम की मदद से साइन किया गया JWT जनरेट करें

उदाहरण के लिए, यह नीति एक नया JWT जनरेट करती है और HS256 एल्गोरिदम का इस्तेमाल करके साइन करती है. हस्ताक्षर करने और उसकी पुष्टि करने के लिए, HS256 शेयर की गई जानकारी का इस्तेमाल करता है.

नीति से जुड़ी इस कार्रवाई को ट्रिगर करने पर Edge, JWT के हेडर और पेलोड को कोड में बदलता है. इसके बाद, यह JWT को डिजिटल तरीके से साइन करता है. उदाहरण के लिए, ऊपर दिया गया वीडियो देखें. इसमें नीति का अनुरोध करने का तरीका भी बताया गया है.

यहां नीति के कॉन्फ़िगरेशन में, JWT के निर्देशों के मुताबिक स्टैंडर्ड दावों के सेट वाला JWT बनाया जाएगा. इसमें एक घंटे की समयसीमा के साथ-साथ एक और दावा भी शामिल होगा. आपके पास, जितने चाहें उतने और दावे शामिल करने का विकल्प होता है. इस सैंपल नीति में, हर एलिमेंट के लिए ज़रूरी शर्तों और विकल्पों के बारे में जानकारी के लिए, एलिमेंट रेफ़रंस देखें.

<GenerateJWT name="JWT-Generate-HS256">
    <DisplayName>JWT Generate HS256</DisplayName>
    <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-edge-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>

इससे मिलने वाले JWT में यह हेडर होगा ...

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

... और इसमें कुछ इस तरह की सामग्री वाला एक पेलोड होगा:

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

iat, exp, और jti दावों की वैल्यू अलग-अलग होगी.

RS256 एल्गोरिदम की मदद से साइन किया गया JWT जनरेट करें

उदाहरण के तौर पर दी गई यह नीति, एक नया JWT जनरेट करती है और RS256 एल्गोरिदम का इस्तेमाल करके उसे साइन करती है. RS256 सिग्नेचर जनरेट होने पर, आरएसए निजी कुंजी का इस्तेमाल किया जाता है. यह कुंजी, PEM के कोड में बदले गए फ़ॉर्म में दी जानी चाहिए. उदाहरण के लिए, ऊपर दिया गया वीडियो देखें. इसमें नीति का अनुरोध करने का तरीका भी बताया गया है.

जब नीति से जुड़ी इस कार्रवाई को ट्रिगर किया जाता है, तब Edge, दावों के साथ-साथ JWT को कोड में बदलता है और डिजिटल तरीके से साइन करता है. JWT के हिस्सों और उन्हें एन्क्रिप्ट (सुरक्षित) और साइन करने के तरीके के बारे में जानने के लिए, RFC7519 देखें.

<GenerateJWT name="JWT-Generate-RS256">
    <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-edge-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>

मुख्य एलिमेंट सेट करना

JWT जनरेट करने के लिए इस्तेमाल की जाने वाली कुंजी तय करने के लिए इस्तेमाल किए जाने वाले एलिमेंट, चुने गए एल्गोरिदम पर निर्भर करते हैं. जैसा कि इस टेबल में दिखाया गया है:

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

JWT जनरेट करने के लिए एलिमेंट रेफ़रंस

नीति के रेफ़रंस से, JWT जनरेट करने की नीति के एलिमेंट और एट्रिब्यूट के बारे में जानकारी मिलती है.

ध्यान दें: आपके एन्क्रिप्शन एल्गोरिदम के आधार पर, कॉन्फ़िगरेशन कुछ-कुछ अलग होगा. इस्तेमाल के खास उदाहरणों से जुड़े कॉन्फ़िगरेशन की जानकारी देने वाले उदाहरण देखने के लिए, सैंपल देखें.

टॉप-लेवल एलिमेंट पर लागू होने वाले एट्रिब्यूट

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

ये एट्रिब्यूट, नीति के सभी पैरंट एलिमेंट के लिए एक जैसे होते हैं.

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) प्रॉक्सी एडिटर में नीति को एक अलग, आम भाषा के नाम से लेबल करने के लिए, नाम एट्रिब्यूट के साथ-साथ इसका इस्तेमाल करें.

<Algorithm>

<Algorithm>algorithm-here</Algorithm>

टोकन पर हस्ताक्षर करने के लिए, एन्क्रिप्ट (सुरक्षित) करने का एल्गोरिदम तय करता है.

<Audience>

<Audience>audience-here</Audience>

or:

<Audience ref='variable_containing_audience'/>

यह नीति एक जेडब्लयूटी जनरेट करती है, जिसमें किसी खास वैल्यू पर सेट किया गया aud दावा होता है. यह दावा उन उपयोगकर्ताओं की पहचान करता है जिनके लिए JWT है. यह RFC7519 में रजिस्टर किए गए दावों में से एक है.

<अतिरिक्त दावे/दावा>

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

इसकी मदद से, आपको JWT के पेलोड में अतिरिक्त दावे का नाम/वैल्यू पेयर तय करने की सुविधा मिलती है. आपके पास स्ट्रिंग, संख्या, बूलियन, मैप या ऐरे के तौर पर दावे की जानकारी देने का विकल्प होता है. मैप सिर्फ़ नाम/वैल्यू पेयर का सेट होता है.

<Claim> एलिमेंट में ये एट्रिब्यूट शामिल होते हैं:

• name - (ज़रूरी है) दावे का नाम.
• ref - (ज़रूरी नहीं) फ़्लो वैरिएबल का नाम. अगर यह वैल्यू मौजूद है, तो नीति इस वैरिएबल की वैल्यू को दावे के तौर पर इस्तेमाल करेगी. अगर ref एट्रिब्यूट और साफ़ तौर पर दावे की वैल्यू, दोनों के बारे में बताया गया है, तो अश्लील वैल्यू को डिफ़ॉल्ट माना जाता है. इसका इस्तेमाल तब किया जाता है, जब रेफ़र किए गए फ़्लो वैरिएबल से जुड़ी गड़बड़ी का पता नहीं चलता हो.
• type - (ज़रूरी नहीं) इनमें से कोई एक: स्ट्रिंग (डिफ़ॉल्ट), संख्या, बूलियन या मैप
• array - (ज़रूरी नहीं) यह बताने के लिए कि वैल्यू, टाइप का कलेक्शन है या नहीं, true पर सेट करें. डिफ़ॉल्ट: 'गलत'.

<Claim> एलिमेंट शामिल करने पर, नीति को कॉन्फ़िगर करते समय दावे के नाम स्टैटिक रूप से सेट हो जाते हैं. इसके अलावा, दावे के नाम बताने के लिए, JSON ऑब्जेक्ट पास किया जा सकता है. JSON ऑब्जेक्ट, वैरिएबल के तौर पर पास किया जाता है. इसलिए, जनरेट किए गए JWT में दावे के नाम, रनटाइम पर तय किए जाते हैं.

उदाहरण के लिए:

<AdditionalClaims ref='json_claims'/>

जहां वैरिएबल json_claims के फ़ॉर्म में एक JSON ऑब्जेक्ट होता है:

{
  "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 में JSON ऑब्जेक्ट के सभी दावे शामिल होते हैं.

<additionalHeaders/दावा>

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

JWT के हेडर में अतिरिक्त दावे का नाम/वैल्यू पेयर डालता है.

<Claim> एलिमेंट में ये एट्रिब्यूट शामिल होते हैं:

• name - (ज़रूरी है) दावे का नाम.
• ref - (ज़रूरी नहीं) फ़्लो वैरिएबल का नाम. अगर यह वैल्यू मौजूद है, तो नीति इस वैरिएबल की वैल्यू को दावे के तौर पर इस्तेमाल करेगी. अगर ref एट्रिब्यूट और साफ़ तौर पर दावे की वैल्यू, दोनों के बारे में बताया गया है, तो अश्लील वैल्यू को डिफ़ॉल्ट माना जाता है. इसका इस्तेमाल तब किया जाता है, जब रेफ़र किए गए फ़्लो वैरिएबल से जुड़ी गड़बड़ी का पता नहीं चलता हो.
• type - (ज़रूरी नहीं) इनमें से कोई एक: स्ट्रिंग (डिफ़ॉल्ट), संख्या, बूलियन या मैप
• array - (ज़रूरी नहीं) यह बताने के लिए कि वैल्यू, टाइप का कलेक्शन है या नहीं, true पर सेट करें. डिफ़ॉल्ट: 'गलत'.

<CriticalHeaders>

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

or:

<CriticalHeaders ref=’variable_containing_headers’/>

JWT हेडर में ज़रूरी हेडर, crit जोड़ता है. crit हेडर, हेडर के नामों की एक कलेक्शन होता है. यह जेडब्लयूटी रिसीवर के बारे में जानता है और उसकी पहचान कर सकता है. उदाहरण के लिए:

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

रनटाइम के दौरान, VerifyJWT नीति, क्रिट हेडर की जांच करती है. crit हेडर में दिए गए हर आइटम के लिए, यह जांच करता है कि VerifyJWT नीति का <KnownHeaders> एलिमेंट भी उस हेडर को शामिल करता है या नहीं. पुष्टि करने वाली JWT नीति को crit में मिलने वाला ऐसा कोई भी हेडर, जो <KnownHeaders> में भी शामिल नहीं है, पुष्टि करने वाली JWT नीति लागू नहीं हो पाएगी.

<CustomClaims>

ध्यान दें: फ़िलहाल, जब यूज़र इंटरफ़ेस (यूआई) की मदद से नई generateJWT नीति जोड़ी जाती है, तो CustomClaims एलिमेंट शामिल किया जाता है. यह एलिमेंट काम नहीं करता और इसे अनदेखा कर दिया जाता है. इसके बजाय, इस्तेमाल करने के लिए सही एलिमेंट <AdditionalClaims> है. सही एलिमेंट डालने के लिए, यूज़र इंटरफ़ेस (यूआई) को बाद में अपडेट किया जाएगा.

<ExpiresIn>

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

JWT के लंबे समय की अवधि को मिलीसेकंड, सेकंड, मिनट, घंटे या दिनों में बताता है.

<आईडी>

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

खास jti दावे के साथ, JWT जनरेट करता है. टेक्स्ट वैल्यू और ref एट्रिब्यूट दोनों के खाली होने पर, नीति एक रैंडम UUID वाली jti जनरेट करेगी. JWT आईडी (jti) दावा, JWT का एक यूनीक आइडेंटिफ़ायर है. jti के बारे में ज़्यादा जानने के लिए, RFC7519 देखें.

<IgnoreUnresolvedVariables>

<IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables>

अगर नीति में बताए गए किसी भी रेफ़र किए गए वैरिएबल को ठीक नहीं किया जा सकता, तो नीति से गड़बड़ी होने की सूचना मिलने पर, 'गलत' पर सेट करें. किसी भी हल न किए जा सकने वाले वैरिएबल को खाली स्ट्रिंग के तौर पर मेज़र करने के लिए, 'सही' पर सेट करें.

<Issuer>

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

यह नीति एक जेडब्लयूटी जनरेट करती है जिसमें iss नाम का दावा मौजूद है. इसकी वैल्यू तय की गई वैल्यू पर सेट है. ऐसा दावा जिससे JWT जारी करने वाले की पहचान की जा सके. यह RFC7519 में बताए गए दावों के रजिस्टर किए गए सेट में से एक है.

<NotBefore>

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

वह समय बताता है जब टोकन मान्य हो जाता है. तय किए गए समय तक, टोकन अमान्य है. टोकन के जनरेट होने के समय से जुड़ी कोई वैल्यू या ऐब्सलूट टाइम वैल्यू दी जा सकती है.

कुल समय की वैल्यू के लिए, NotBefore एलिमेंट के लिए मान्य समय की वैल्यू

रिलेटिव टाइम वैल्यू के लिए, कोई पूर्णांक और समयावधि तय करें. उदाहरण के लिए:

• 10 सेकंड
• 60 मीटर
• 12 घंटे

<OutputVariable>

<OutputVariable>jwt-variable</OutputVariable>

इससे पता चलता है कि इस नीति के तहत जनरेट किए गए JWT को कहां रखना है. डिफ़ॉल्ट रूप से, इसे फ़्लो वैरिएबल jwt.POLICYNAME.generated_jwt में रखा जाता है.

<PrivateKey/Id>

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

or

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

JWT हेडर में शामिल करने के लिए कुंजी आईडी (बच्चे) तय करता है. इसका इस्तेमाल सिर्फ़ तब करें, जब एल्गोरिदम RS256/RS384/RS512, PS256/PS384/PS512 या ES256/ES384/ES512 में से कोई एक हो.

<PrivateKey/Password>

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

ज़रूरत पड़ने पर, निजी पासकोड को डिक्रिप्ट करने के लिए, नीति के लिए इस्तेमाल किया जाने वाला पासवर्ड तय करें. फ़्लो वैरिएबल में कुंजी पास करने के लिए, ref एट्रिब्यूट का इस्तेमाल करें. इसका इस्तेमाल सिर्फ़ तब करें, जब एल्गोरिदम RS256/RS384/RS512, PS256/PS384/PS512 या ES256/ES384/ES512 में से कोई एक हो.

<PrivateKey/Value>

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

JWT पर हस्ताक्षर करने के लिए इस्तेमाल की जाने वाली PEM-एन्कोडेड निजी कुंजी के बारे में बताता है. फ़्लो वैरिएबल में कुंजी पास करने के लिए, ref एट्रिब्यूट का इस्तेमाल करें. सिर्फ़ तब इस्तेमाल करें, जब एल्गोरिदम RS256/RS384/RS512, PS256/PS384/PS512 या ES256/ES384/ES512 में से एक हो.

<SecretKey/आईडी>

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

or

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

एचएमएसी एल्गोरिदम की मदद से साइन किए गए जेडब्लयूटी हेडर में शामिल करने के लिए, कुंजी आईडी (बच्चे) के बारे में बताता है. इसका इस्तेमाल सिर्फ़ तब करें, जब एल्गोरिदम HS256/HS384/HS512 में से एक हो.

<SecretKey/Value>

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

एचएमएसी एल्गोरिदम की मदद से, टोकन की पुष्टि करने या उन पर हस्ताक्षर करने के लिए इस्तेमाल की जाने वाली सीक्रेट कुंजी देता है. इसका इस्तेमाल सिर्फ़ तब करें, जब एल्गोरिदम HS256/HS384/HS512 में से एक हो. फ़्लो वैरिएबल में कुंजी पास करने के लिए, ref एट्रिब्यूट का इस्तेमाल करें.

Edge, HS256/HS384/HS512 एल्गोरिदम के लिए, ज़रूरी वैल्यू को कम से कम लागू करता है. HS256 के लिए कुंजी की लंबाई कम से कम 32 बाइट होनी चाहिए, HS384 के लिए यह 48 बाइट और HS512 के लिए 64 बाइट होनी चाहिए. कम क्षमता वाली कुंजी का इस्तेमाल करने से रनटाइम में गड़बड़ी होती है.

<Subject>

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

<Subject ref="flow_variable" />

उदाहरण के लिए:

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

यह नीति ऐसा JWT जनरेट करती है जिसमें sub दावा, जो तय की गई वैल्यू पर सेट हो.यह दावा, JWT के विषय की पहचान करता है या उसके बारे में कोई स्टेटमेंट देता है. यह RFC7519 में बताए गए दावों के स्टैंडर्ड सेट में से एक है.

फ़्लो वैरिएबल

JWT जनरेट करें नीति, फ़्लो वैरिएबल सेट नहीं करती.

गड़बड़ी का रेफ़रंस

यह सेक्शन गड़बड़ी के कोड और दिखाए गए गड़बड़ी के मैसेज के बारे में बताता है. साथ ही, इस नीति के ट्रिगर होने पर Edge की मदद से सेट की गई गड़बड़ी के वैरिएबल के बारे में बताता है. यह जानकारी जानना ज़रूरी है कि क्या गड़बड़ियों को ठीक करने के लिए, गड़बड़ी से जुड़े नियम बनाए जा रहे हैं. ज़्यादा जानने के लिए, नीति से जुड़ी गड़बड़ियों के बारे में आपके लिए ज़रूरी जानकारी और गड़बड़ियों को ठीक करने के तरीके देखें.

रनटाइम से जुड़ी गड़बड़ियां

नीति के लागू होने पर ये गड़बड़ियां हो सकती हैं.

डिप्लॉयमेंट से जुड़ी गड़बड़ियां

ये गड़बड़ियां तब हो सकती हैं, जब इस नीति वाले किसी प्रॉक्सी को डिप्लॉय किया जाता है.

गड़बड़ी वाले वैरिएबल

रनटाइम में कोई गड़बड़ी होने पर ये वैरिएबल सेट किए जाते हैं. ज़्यादा जानकारी के लिए, नीति से जुड़ी गड़बड़ियों के बारे में आपके लिए ज़रूरी जानकारी देखें.

गड़बड़ी के जवाब का उदाहरण

गड़बड़ी को ठीक करने के लिए, सबसे सही तरीका यह है कि आप गड़बड़ी के रिस्पॉन्स के errorcode वाले हिस्से को फंसा दें. faultstring के टेक्स्ट पर भरोसा न करें, क्योंकि यह बदल सकता है.

गड़बड़ी के नियम का उदाहरण

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