خط مشی DecodeJWT

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

چی

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

خط مشی JWT Decode بدون توجه به الگوریتمی که برای امضای 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 بتوانند آن مقادیر را بررسی کنند. برای لیستی از متغیرهای تنظیم شده توسط این خط مشی، متغیرهای جریان را ببینید.

مرجع عنصر برای رمزگشایی JWT

مرجع خط مشی عناصر و ویژگی های خط مشی Decode JWT را توصیف می کند.

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

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

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

<DisplayName>

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