DecodeJWS নীতি

আপনি Apigee Edge ডকুমেন্টেশন দেখছেন।
Apigee X ডকুমেন্টেশনে যান । তথ্য

কি

JWS-এ স্বাক্ষর যাচাই না করেই JWS হেডারকে ডিকোড করে এবং প্রতিটি হেডারকে একটি ফ্লো ভেরিয়েবলে লেখে। ভেরিফাইজেডব্লিউএস নীতির সাথে কনসার্টে ব্যবহার করা হলে এই নীতিটি সবচেয়ে উপযোগী, যখন জেডব্লিউএস-এর স্বাক্ষর যাচাই করার আগে জেডব্লিউএস-এর মধ্যে থেকে হেডারের মান জানতে হবে।

একটি JWS-এর একটি সংযুক্ত পেলোড থাকতে পারে, যেমন ফর্মে রয়েছে:

header.payload.signature

অথবা, JWS পেলোড বাদ দিতে পারে, যাকে একটি বিচ্ছিন্ন পেলোড বলা হয় এবং ফর্মে থাকতে পারে:

header..signature

DecodeJWS নীতি উভয় ফর্মের সাথে কাজ করে কারণ এটি শুধুমাত্র JWS-এর হেডার অংশকে ডিকোড করে। JWS সাইন করার জন্য যে অ্যালগরিদম ব্যবহার করা হয়েছিল তা নির্বিশেষে DecodeJWS নীতিও কাজ করে।

একটি JWS এবং JWT নীতি ওভারভিউ একটি বিস্তারিত ভূমিকা এবং একটি JWS বিন্যাসের একটি ওভারভিউ জন্য দেখুন.

ভিডিও

একটি JWT ডিকোড কিভাবে শিখতে একটি ছোট ভিডিও দেখুন. যদিও এই ভিডিওটি একটি JWT-এর জন্য নির্দিষ্ট, অনেক ধারণা JWS-এর জন্য একই।

নমুনা: একটি JWS ডিকোড করুন

নীচে দেখানো নীতিটি ফ্লো ভেরিয়েবল var.JWS- এ পাওয়া একটি JWS ডিকোড করে। এই ভেরিয়েবলটি অবশ্যই উপস্থিত থাকতে হবে এবং এতে একটি কার্যকর (ডিকোডেবল) JWS থাকতে হবে। পলিসি যেকোনো ফ্লো ভেরিয়েবল থেকে JWS পেতে পারে।

<DecodeJWS name="JWS-Decode-HS256">
    <DisplayName>JWS Verify HS256</DisplayName>
    <Source>var.JWS</Source>
</DecodeJWS>

JWS-এর হেডার অংশে প্রতিটি হেডারের জন্য, নীতি একটি ফ্লো ভেরিয়েবল সেট করে যার নাম:

jws.policy-name.header.header-name

যদি JWS এর একটি সংযুক্ত পেলোড থাকে, তাহলে এটি jws. policy-name .header.payload পেলোডের ফ্লো ভেরিয়েবল। একটি বিচ্ছিন্ন পেলোডের জন্য, payload খালি। এই নীতি দ্বারা সেট করা ভেরিয়েবলের সম্পূর্ণ তালিকার জন্য ফ্লো ভেরিয়েবল দেখুন।

ডিকোড JWS এর জন্য উপাদান রেফারেন্স

নীতির রেফারেন্স ডিকোড JWS নীতির উপাদান এবং বৈশিষ্ট্য বর্ণনা করে।

উচ্চ-স্তরের উপাদানে প্রযোজ্য বৈশিষ্ট্য 

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

নিম্নলিখিত বৈশিষ্ট্যগুলি সমস্ত নীতির মূল উপাদানগুলির জন্য সাধারণ৷

বৈশিষ্ট্য বর্ণনা ডিফল্ট উপস্থিতি
নাম নীতির অভ্যন্তরীণ নাম। আপনি নামের মধ্যে যে অক্ষরগুলি ব্যবহার করতে পারেন তাতে সীমাবদ্ধ: A-Z0-9._\-$ % । যাইহোক, এজ ম্যানেজমেন্ট UI অতিরিক্ত বিধিনিষেধ প্রয়োগ করে, যেমন স্বয়ংক্রিয়ভাবে অক্ষরগুলিকে অপসারণ করা যা আলফানিউমেরিক নয়।

ঐচ্ছিকভাবে, <displayname></displayname> এলিমেন্টটি ব্যবহার করুন ম্যানেজমেন্ট UI প্রক্সি এডিটরে নীতিটিকে একটি ভিন্ন, প্রাকৃতিক-ভাষার নামের সাথে লেবেল করতে।

 N/A প্রয়োজন
continueOnError একটি নীতি ব্যর্থ হলে একটি ত্রুটি ফেরত দিতে false সেট করুন৷ এটি বেশিরভাগ নীতির জন্য প্রত্যাশিত আচরণ।

একটি নীতি ব্যর্থ হওয়ার পরেও ফ্লো এক্সিকিউশন চালিয়ে যেতে true সেট করুন৷

 মিথ্যা ঐচ্ছিক
সক্রিয় নীতি প্রয়োগ করতে true সেট করুন৷

নীতি "বন্ধ" করতে false সেট করুন৷ নীতিটি প্রবাহের সাথে সংযুক্ত থাকলেও তা কার্যকর করা হবে না।

 সত্য ঐচ্ছিক
অ্যাসিঙ্ক এই বৈশিষ্ট্যটি অবমূল্যায়ন করা হয়েছে৷ মিথ্যা অবচয়

<DisplayName> 

<DisplayName>Policy Display Name</DisplayName>

ম্যানেজমেন্ট UI প্রক্সি এডিটরে নীতিটিকে একটি ভিন্ন, প্রাকৃতিক-ভাষা নামের সাথে লেবেল করতে নামের বৈশিষ্ট্য ছাড়াও ব্যবহার করুন।

ডিফল্ট আপনি এই উপাদানটি বাদ দিলে, নীতির নামের বৈশিষ্ট্যের মান ব্যবহার করা হবে।
উপস্থিতি ঐচ্ছিক
টাইপ স্ট্রিং

<উৎস> 

<Source>JWS-variable</Source>

যদি উপস্থিত থাকে, তাহলে ফ্লো ভেরিয়েবল নির্দিষ্ট করে যেখানে নীতি JWS-কে ডিকোড করার জন্য খুঁজে পাওয়ার আশা করে।

ডিফল্ট request.header.authorization (ডিফল্ট সম্পর্কে গুরুত্বপূর্ণ তথ্যের জন্য উপরের নোটটি দেখুন)।
উপস্থিতি ঐচ্ছিক
টাইপ স্ট্রিং
বৈধ মান একটি এজ ফ্লো পরিবর্তনশীল নাম

Flow variables

Upon success, the Verify JWS and Decode JWS policies set context variables according to this pattern:

jws.{policy_name}.{variable_name}

For example, if the policy name is verify-jws, then the policy will store the algorithm specified in the JWS to this context variable: jws.verify-jws.header.algorithm

Variable name Description
decoded.header.name The JSON-parsable value of a header in the payload. One variable is set for every header in the payload. While you can also use the header.name flow variables, this is the recommended variable to use to access a header.
header.algorithm The signing algorithm used on the JWS. For example, RS256, HS384, and so on. See (Algorithm) Header Parameter for more.
header.kid The Key ID, if added when the JWS was generated. See also "Using a JSON Web Key Set (JWKS)" at JWT and JWS policies overview to verify a JWS. See (Key ID) Header Parameter for more.
header.type The header type value. See (Type) Header Parameter for more.
header.name The value of the named header (standard or additional). One of these will be set for every additional header in the header portion of the JWS.
header-json The header in JSON format.
payload The JWS payload if the JWS has an attached payload. For a detached payload, this variable is empty.
valid In the case of VerifyJWS, this variable will be true when the signature is verified, and the current time is before the token expiry, and after the token notBefore value, if they are present. Otherwise false.

In the case of DecodeJWS, this variable is not set.

ত্রুটি উল্লেখ

এই বিভাগটি ফল্ট কোড এবং ত্রুটির বার্তাগুলি বর্ণনা করে যেগুলি ফেরত দেওয়া হয় এবং ত্রুটি ভেরিয়েবলগুলি যেগুলি এজ দ্বারা সেট করা হয় যখন এই নীতিটি একটি ত্রুটি ট্রিগার করে৷ এই তথ্যটি জানা গুরুত্বপূর্ণ যে আপনি ত্রুটিগুলি পরিচালনা করার জন্য ত্রুটির নিয়ম তৈরি করছেন কিনা। আরও জানতে, নীতিগত ত্রুটি এবং হ্যান্ডলিং ফল্ট সম্পর্কে আপনার যা জানা দরকার তা দেখুন৷

রানটাইম ত্রুটি

নীতি কার্যকর করার সময় এই ত্রুটিগুলি ঘটতে পারে৷

ফল্ট কোড HTTP স্থিতি ঘটে যখন
steps.jws.FailedToDecode 401 নীতি JWS ডিকোড করতে অক্ষম ছিল. JWS সম্ভবত দূষিত হয়.
steps.jws.FailedToResolveVariable 401 যখন নীতির <Source> উপাদানে নির্দিষ্ট করা ফ্লো ভেরিয়েবল বিদ্যমান থাকে না তখন ঘটে।
steps.jws.InvalidClaim 401 একটি অনুপস্থিত দাবি বা দাবি অমিল, বা একটি অনুপস্থিত শিরোনাম বা শিরোনাম অমিলের জন্য৷
steps.jws.InvalidJsonFormat 401 JWS হেডারে অবৈধ JSON পাওয়া গেছে।
steps.jws.InvalidJws 401 এই ত্রুটিটি ঘটে যখন JWS স্বাক্ষর যাচাইকরণ ব্যর্থ হয়।
steps.jws.InvalidPayload 401 JWS পেলোড অবৈধ।
steps.jws.InvalidSignature 401 <DetachedContent> বাদ দেওয়া হয়েছে এবং JWS-এর একটি বিচ্ছিন্ন কন্টেন্ট পেলোড রয়েছে।
steps.jws.MissingPayload 401 JWS পেলোড অনুপস্থিত.
steps.jws.NoAlgorithmFoundInHeader 401 JWS অ্যালগরিদম হেডার বাদ দিলে ঘটে।
steps.jws.UnknownException 401 একটি অজানা ব্যতিক্রম ঘটেছে.

স্থাপনার ত্রুটি

আপনি যখন এই নীতি সম্বলিত একটি প্রক্সি স্থাপন করেন তখন এই ত্রুটিগুলি ঘটতে পারে৷

ত্রুটির নাম ঘটে যখন
InvalidAlgorithm শুধুমাত্র বৈধ মানগুলি হল: RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512৷

EmptyElementForKeyConfiguration

FailedToResolveVariable

InvalidConfigurationForActionAndAlgorithmFamily

InvalidConfigurationForVerify

InvalidEmptyElement

InvalidFamiliesForAlgorithm

InvalidKeyConfiguration

InvalidNameForAdditionalClaim

InvalidNameForAdditionalHeader

InvalidPublicKeyId

InvalidPublicKeyValue

InvalidSecretInConfig

InvalidTypeForAdditionalClaim

InvalidTypeForAdditionalHeader

InvalidValueForElement

InvalidValueOfArrayAttribute

InvalidVariableNameForSecret

MissingConfigurationElement

MissingElementForKeyConfiguration

MissingNameForAdditionalClaim

MissingNameForAdditionalHeader

 অন্যান্য সম্ভাব্য স্থাপনার ত্রুটি।

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Variables Where Example
fault.name="fault_name" fault_name is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code. fault.name Matches "TokenExpired"
JWS.failed All JWS policies set the same variable in the case of a failure. jws.JWS-Policy.failed = true

Example error response

For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

Example fault rule

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