خط مشی DecodeJWT

شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات

چه

یک JWT را بدون تأیید امضای JWT رمزگشایی می‌کند. این روش زمانی بیشترین کاربرد را دارد که همراه با سیاست VerifyJWT استفاده شود، زمانی که مقدار یک ادعا از درون JWT باید قبل از تأیید امضای JWT مشخص باشد.

سیاست رمزگشایی JWT صرف نظر از الگوریتمی که برای امضای JWT استفاده شده است، کار می‌کند. برای آشنایی بیشتر با JWS و سیاست‌های JWT، به بخش «مروری بر سیاست‌های JWS و JWT» مراجعه کنید.

ویدئو

برای یادگیری نحوه رمزگشایی JWT، یک ویدیوی کوتاه تماشا کنید.

نمونه: رمزگشایی یک JWT

سیاست نشان داده شده در زیر، JWT موجود در متغیر جریان var.jwt را رمزگشایی می‌کند. این متغیر باید وجود داشته باشد و حاوی یک JWT قابل اجرا (قابل رمزگشایی) باشد. این سیاست می‌تواند JWT را از هر متغیر جریانی دریافت کند.

<DecodeJWT name="JWT-Decode-HS256">
    <DisplayName>JWT Verify HS256</DisplayName>
    <Source>var.jwt</Source>
</DecodeJWT>

این خط‌مشی خروجی خود را در متغیرهای زمینه می‌نویسد تا خط‌مشی‌ها یا شرایط بعدی در پروکسی API بتوانند آن مقادیر را بررسی کنند. برای فهرستی از متغیرهای تنظیم‌شده توسط این خط‌مشی، به متغیرهای جریان مراجعه کنید.

مرجع عنصر برای Decode JWT

مرجع سیاست، عناصر و ویژگی‌های سیاست Decode JWT را شرح می‌دهد.

ویژگی‌هایی که به عنصر سطح بالا اعمال می‌شوند

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

ویژگی‌های زیر برای همه عناصر والد سیاست مشترک هستند.

<نام نمایشی>

<DisplayName>Policy Display Name</DisplayName>

علاوه بر ویژگی نام، از این ویژگی برای برچسب‌گذاری سیاست در ویرایشگر پروکسی رابط کاربری مدیریت با یک نام متفاوت به زبان طبیعی استفاده کنید.

<منبع>

<Source>jwt-variable</Source>

در صورت وجود، متغیر جریانی را مشخص می‌کند که در آن سیاست انتظار دارد JWT را برای رمزگشایی پیدا کند.

متغیرهای جریان

پس از موفقیت، سیاست های Verify JWT و Decode JWT متغیرهای زمینه را مطابق این الگو تنظیم می کنند:

jwt.{policy_name}.{variable_name}

به عنوان مثال، اگر نام خط مشی jwt-parse-token باشد، آنگاه این خط مشی موضوع مشخص شده در JWT را در متغیر زمینه به نام jwt.jwt-parse-token.decoded.claim.sub ذخیره می کند. (برای سازگاری به عقب، در jwt.jwt-parse-token.claim.subject نیز موجود خواهد بود)

مرجع خطا

این بخش کدهای خطا و پیام‌های خطایی را که برگردانده می‌شوند و متغیرهای خطا را که توسط 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>