کتابخانه‌ی استاندارد · امنیت و رمزنگاری

جی دبلیو تی jwt

ساختن و بررسی توکن JWT و محافظت از مسیرهای API.

واردسازی جی دبلیو تی

نام آرگومان‌ها شناسه‌ی خود کد است و معادل فارسی ندارد؛ گونه‌ها، کلیدواژه‌ها و نام بسته‌ها با معادل فارسی نوشته می‌شوند.

JWT توکنی است که سرور پس از ورود کاربر امضا می‌کند و کارخواه با هر درخواست می‌فرستد؛ سرور با بررسی امضا بی‌نیاز از پایگاه داده می‌داند کاربر کیست. این بسته توکن‌ها را با الگوریتم‌های HMAC، یعنی HS256، HS384 و HS512، امضا و بررسی می‌کند، الگوریتم none را هرگز نمی‌پذیرد و برای گرداننده‌های اچ تی تی پی تابع‌های کمکی دارد. هر سرویسی که توکن را بررسی می‌کند همان کلید را لازم دارد، پس برای یک سرور یا چند سرویس مورد اعتماد مناسب است؛ امضای کلید عمومی RS256 یا ES256 ندارد. وقتی کارخواه مرورگرِ سایت خودتان است، نشست سمت سرور اغلب ساده‌تر است و بی‌درنگ باطل می‌شود.

برای یک API، یک نگهبان با کلید بسازید و در ابتدای هر گرداننده نیاز یا یکی از تابع‌های هم‌خانواده‌اش را صدا بزنید؛ اگر توکن نباشد یا نادرست باشد، پاسخ ۴۰۱ یا ۴۰۳ خودکار فرستاده می‌شود. کلید باید بلند و تصادفی باشد، مثلاً از توکن تصادفی ایمن در رمزنگاری.

چیزهایی که بیشتر غافلگیر می‌کنند:

  • توکن بدون exp برای همیشه پذیرفته می‌شود، مگر این‌که opts.require_exp را روشن کنید. توکن‌های صدور همیشه آن را دارند، ولی توکنی که راه دیگری امضا شده شاید نداشته باشد.
  • قدرت کلید بررسی نمی‌شود. هر رشته‌ی ناخالی همان‌طور به کار می‌رود؛ کلید کوتاه را می‌شود از روی یک توکن به‌صورت آفلاین حدس زد.
  • ادعاها امضا می‌شوند، نه رمز. هر کسی توکن را داشته باشد با یک رمزگشای base64 آن‌ها را می‌خواند، پس رازی در آن‌ها نگذارید.
  • توکن را پیش از انقضا نمی‌شود پس گرفت؛ توکن دسترسی را کوتاه نگه دارید، همان‌طور که بخش توکن تازه‌سازی نشان می‌دهد.

محافظت از مسیرهای API با نگهبان

شکل معمول: /login کاربر را بررسی می‌کند (این‌جا حذف شده) و با توکنی از صدور پاسخ می‌دهد که exp، iat و الگوریتم نگهبان را می‌افزاید. هر گرداننده‌ی محافظت‌شده با یک فراخوانی نیاز ... شروع می‌شود و اگر نادرست بود بی‌درنگ برمی‌گردد. نیاز به دامنه ادعای scope را که با فاصله جدا شده می‌خواند، پس همان توکن /orders را باز می‌کند ولی در /admin پاسخ ۴۰۳ می‌گیرد. درخواست آخر توکنی دارد که با کلید درست ولی بدون exp امضا شده؛ چون نگهبان require_exp را روشن کرده، رد می‌شود.

jwt-guard.salam
واردسازی کدگذاری.جیسون
واردسازی جی دبلیو تی
واردسازی شبکه.اچ تی تی پی
واردسازی شبکه.مسیریاب

ناپایا نگهبان من := جی دبلیو تی.نگهبان جدید("k8R2pX7wQ4mZ9vL1cT6yB3nH5sD0fG2a")

تابع ورود کاربر(ز: صحیح۶۴):
    ناپایا ادعا := جی دبلیو تی.ادعاهای جدید()
    ادعا.موضوع = اچ تی تی پی.فرم(ز، "user")
    جی دبلیو تی.تنظیم رشته(ادعا، "scope"، "orders:read")
    تلاش:
        توکن := جی دبلیو تی.صدور(نگهبان من، ادعا، ۹۰۰)
        اچ تی تی پی.جیسون(ز، "{\"token\":\"" + توکن + "\"}")
    گرفتن خطا خ:
        اچ تی تی پی.تنظیم وضعیت(ز، ۵۰۰)
        اچ تی تی پی.متن(ز، خ.پیام)
    پایان
پایان

تابع سفارش‌ها(ز: صحیح۶۴):
    ناپایا ت := جی دبلیو تی.توکن {}
    اگر وارونه جی دبلیو تی.نیاز به دامنه(ز، نگهبان من، "orders:read"، ت): برگشت پایان
    اچ تی تی پی.جیسون(ز، "{\"orders_for\":\"" + ت.ادعاها.موضوع + "\"}")
پایان

تابع مدیریت(ز: صحیح۶۴):
    ناپایا ت := جی دبلیو تی.توکن {}
    اگر وارونه جی دبلیو تی.نیاز به دامنه(ز، نگهبان من، "admin"، ت): برگشت پایان
    اچ تی تی پی.متن(ز، "خوش آمدید، مدیر")
پایان

تابع درخواست(مسیر: رشته، توکن: رشته):
    ناپایا سرها := اچ تی تی پی.سرصفحه جدید()
    اگر توکن.طول() بزرگتر ۰: سرها.درج("Authorization"، "Bearer " + توکن) پایان
    پ := اچ تی تی پی.دریافت با("http://127.0.0.1:18662" + مسیر، سرها)
    سرچاپ مسیر، اچ تی تی پی.وضعیت(پ)، اچ تی تی پی.بدنه(پ)
پایان

تابع ریشه:
    نگهبان من.گزینه‌ها.انقضا لازم = درست
    ناپایا م := مسیریاب.مسیریاب جدید()
    مسیریاب.ارسال(م، "/login"، ورود کاربر)
    مسیریاب.دریافت(م، "/orders"، سفارش‌ها)
    مسیریاب.دریافت(م، "/admin"، مدیریت)
    ناپایا س := اچ تی تی پی.سرور جدید(۱۸۶۶۲)
    اچ تی تی پی.تنظیم میزبان(س، "127.0.0.1")
    اچ تی تی پی.استفاده(س، م)
    اگر وارونه اچ تی تی پی.اجرا در پس زمینه(س):
        سرچاپ "درگاه ۱۸۶۶۲ گرفته است"
        برگشت ۱
    پایان
    پاسخ := اچ تی تی پی.ارسال("http://127.0.0.1:18662/login"، "user=sara")
    توکن := جیسون.دریافت(اچ تی تی پی.بدنه(پاسخ)، "token")
    درخواست("/orders"، "")
    درخواست("/orders"، توکن)
    درخواست("/admin"، توکن)

    ناپایا همیشگی := جی دبلیو تی.ادعاهای جدید()
    همیشگی.موضوع = "sara"
    جی دبلیو تی.تنظیم رشته(همیشگی، "scope"، "orders:read")
    تلاش:
        درخواست("/orders"، جی دبلیو تی.امضای اچ اس۲۵۶(همیشگی، نگهبان من.کلید امضا))
    گرفتن خطا خ:
        سرچاپ "امضا نشد:"، خ.پیام
    پایان
    برگشت ۰
پایان
خروجی/orders 401 {"error":"unauthorized","reason":"missing bearer token"} /orders 200 {"orders_for":"sara"} /admin 403 {"error":"forbidden","reason":"missing scope: admin"} /orders 401 {"error":"unauthorized","reason":"required claim missing"}

نیاز توکن را از سرآیند Authorization: Bearer برمی‌دارد، یا اگر سرآیند نباشد از کوکی‌ای که نامش در cookie نگهبان آمده. پاسخ ۴۰۱ سرآیند WWW-Authenticate را هم، همان‌طور که قاعده‌های HTTP می‌خواهند، دارد.

چرا یک توکن رد می‌شود

تایید به ترتیب بررسی می‌کند که توکن سه بخش داشته باشد، الگوریتمش همانی باشد که انتظار دارید، امضا درست باشد، و سپس زمان‌ها و ادعاهایی را که در گزینه ها خواسته‌اید. این تابع، مثل کدگشایی، تابع‌های امضا و صدور، بررسی و کدگشایی پایه۶۴ نشانی، خطادار است: نخستین شکست به صورت یک خطا پرتاب می‌شود. آن را با تلاش: ... گرفتن خطا خ: بگیرید، یا در تابعی که خودش خطادار است پیش از فراخوانی تلاش بنویسید تا خطا به بالا برود. خ.پیام دلیلی کوتاه است و خ.کد نامی پایدار برای تصمیم گرفتن. برنامه‌ی زیر now را ثابت می‌گذارد تا هر بار همان خط‌ها را چاپ کند؛ در سرور now را صفر بگذارید تا ساعت واقعی به کار رود.

jwt-errors.salam
واردسازی جی دبلیو تی
واردسازی رشته

تابع گزارش(برچسب: رشته، توکن: رشته، راز: رشته، گزینه: جی دبلیو تی.گزینه ها):
    تلاش:
        _ := جی دبلیو تی.تایید(توکن، راز، گزینه)
        سرچاپ برچسب + ": درست"
    گرفتن خطا خ:
        سرچاپ برچسب + ": " + خ.پیام + " (" + خ.کد + ")"
    پایان
پایان

تابع ریشه خطادار:
    راز := "a-long-random-secret-for-this-demo"
    ناپایا ادعا := جی دبلیو تی.ادعاهای جدید()
    ادعا.موضوع = "7"
    ادعا.صادرکننده = "auth.example.com"
    ادعا.زمان صدور = ۱۷۹۰۰۰۰۰۰۰
    ادعا.آغاز اعتبار = ۱۷۹۰۰۰۰۰۰۰
    ادعا.زمان انقضا = ۱۷۹۰۰۰۰۹۰۰
    توکن := تلاش جی دبلیو تی.امضای اچ اس۲۵۶(ادعا، راز)

    ناپایا گزینه := جی دبلیو تی.گزینه های پیش فرض()
    گزینه.صادرکننده = "auth.example.com"
    گزینه.اکنون = ۱۷۹۰۰۰۰۳۰۰
    گزارش("توکن تازه"، توکن، راز، گزینه)
    گزارش("راز نادرست"، توکن، "guess"، گزینه)

    بخش‌ها := رشته.تفکیک کردن(توکن، ".")
    جعلی := بخش‌ها.بگیر(۰) + "." + جی دبلیو تی.کدگذاری پایه۶۴ نشانی("{\"sub\":\"1\",\"iss\":\"auth.example.com\"}") + "." + بخش‌ها.بگیر(۲)
    گزارش("بار دست‌کاری شده"، جعلی، راز، گزینه)

    گزینه.اکنون = ۱۷۹۰۰۰۱۰۰۰
    گزارش("۱۰۰ ثانیه پس از انقضا"، توکن، راز، گزینه)
    گزینه.تحمل اختلاف = ۱۲۰
    گزارش("همان، با ۱۲۰ ثانیه ارفاق"، توکن، راز، گزینه)

    گزینه.تحمل اختلاف = ۰
    گزینه.اکنون = ۱۷۸۹۹۹۹۰۰۰
    گزارش("پیش از nbf"، توکن، راز، گزینه)

    گزینه.اکنون = ۱۷۹۰۰۰۰۳۰۰
    گزینه.صادرکننده = "evil.example.com"
    گزارش("صادرکننده‌ی دیگر"، توکن، راز، گزینه)

    قوی := تلاش جی دبلیو تی.امضای اچ اس۵۱۲(ادعا، راز)
    ناپایا گزینه‌ی سخت‌گیر := جی دبلیو تی.گزینه ها برای(جی دبلیو تی.الگوریتم اچ اس۲۵۶)
    گزینه‌ی سخت‌گیر.اکنون = ۱۷۹۰۰۰۰۳۰۰
    گزارش("توکن HS512 به جای HS256"، قوی، راز، گزینه‌ی سخت‌گیر)
پایان
خروجیتوکن تازه: درست راز نادرست: signature does not match (jwt.bad_signature) بار دست‌کاری شده: signature does not match (jwt.bad_signature) ۱۰۰ ثانیه پس از انقضا: token expired (jwt.expired) همان، با ۱۲۰ ثانیه ارفاق: درست پیش از nbf: token not yet valid (jwt.not_yet_valid) صادرکننده‌ی دیگر: issuer mismatch (jwt.bad_claim) توکن HS512 به جای HS256: algorithm mismatch (jwt.alg_mismatch)

سه نکته: دست بردن حتی در یک ادعا امضا را خراب می‌کند، پس کارخواه نمی‌تواند دسترسی خودش را بالا ببرد. leeway اختلاف کوچک ساعت میان دستگاهی که امضا کرده و دستگاهی که بررسی می‌کند را نادیده می‌گیرد؛ یکی دو دقیقه معمول است. و توکنی که با HS512 امضا شده وقتی گزینه‌ها HS256 می‌خواهند رد می‌شود: الگوریتم از گزینه‌های شما می‌آید و هرگز از خود توکن، و این بسته از همین راه جلوی حمله‌های شناخته شده‌ی alg را می‌گیرد.

همه‌ی کدهایی که این بسته پرتاب می‌کند:

خ.کدخ.نوعکی
jwt.malformedنحوسه بخش جداشده با نقطه نیست، یا بخش سرآیند یا بدنه خالی است.
jwt.bad_base64نحویک بخش بیس۶۴ نشانی‌امن نیست؛ خ.مسیر برابر header یا payload است و خ.جایگاه جای مشکل در توکن را نشان می‌دهد.
jwt.bad_jsonنحوسرآیند دقیقاً یک alg ندارد، یا یک ادعای ثبت‌شده دو بار آمده؛ خ.مسیر نام آن را دارد.
jwt.bad_algپشتیبانی نشدهالگوریتمی جز HS256، HS384 و HS512، از جمله none.
jwt.bad_typپشتیبانی نشدهسرآیند typ نه JWT است و نه ...+jwt.
jwt.critپشتیبانی نشدهسرآیند فهرست crit دارد که این بسته آن را نمی‌فهمد.
jwt.empty_secretآرگومان نامعتبرراز خالی است، چه هنگام امضا و چه هنگام بررسی.
jwt.alg_mismatchدسترسی رد شدالگوریتم توکن همانی نیست که در گزینه‌ها آمده.
jwt.bad_signatureدسترسی رد شدامضا نمی‌خواند.
jwt.expiredدسترسی رد شداکنون، پس از ارفاق، به exp رسیده یا از آن گذشته.
jwt.not_yet_validدسترسی رد شداکنون پیش از nbf است.
jwt.issued_in_futureدسترسی رد شداکنون پیش از iat است.
jwt.bad_claimدسترسی رد شدصادرکننده، موضوع یا مخاطب همانی نیست که خواسته‌اید؛ خ.مسیر برابر iss، sub یا aud است.
jwt.missing_claimکلید ناموجودادعایی که گزینه‌ها لازم دانسته‌اند نیامده؛ خ.مسیر نام آن را دارد.
jwt.missing_tokenیافت نشدبررسی در درخواست توکنی پیدا نکرد.

خ.پیام دلیل کوتاه انگلیسی است، مثل token expired؛ نیاز و هم‌خانواده‌هایش همین را دلیل پاسخ ۴۰۱ می‌فرستند. با بررسی پاسخ را خودتان انتخاب می‌کنید، همان‌طور که مسیر /check در نمونه‌ی نگهبان می‌کند: برای jwt.missing_token تابع بدون گواهی و برای هر کد دیگر غیرمجاز.

توکن دسترسی کوتاه و توکن تمدید

توکنی را که صادر شده نمی‌توان پس گرفت، پس عمر توکن دسترسی باید چند دقیقه باشد نه چند روز. برای این‌که کاربر هر پانزده دقیقه دوباره وارد نشود، هنگام ورود یک توکن دوم با عمر بلند هم بدهید و آن را فقط در یک مسیر بپذیرید، جایی که با آن توکن دسترسی تازه گرفته می‌شود. روی هر توکن بنویسید برای چه کاری است تا توکن تمدید به جای توکن دسترسی پذیرفته نشود. صدور جفت روی یک نگهبان هر دو را با یک فراخوانی می‌سازد؛ برنامه‌ی زیر برای نشان دادن بررسی‌ها کار را دستی انجام می‌دهد.

jwt-refresh.salam
واردسازی جی دبلیو تی

تابع صدور(کاربر: رشته، کاربرد: رشته، زمان صدور: صحیح۶۴، عمر: صحیح۶۴، راز: رشته): رشته خطادار:
    ناپایا ادعا := جی دبلیو تی.ادعاهای جدید()
    ادعا.موضوع = کاربر
    ادعا.زمان صدور = زمان صدور
    ادعا.زمان انقضا = زمان صدور + عمر
    جی دبلیو تی.تنظیم رشته(ادعا، "use"، کاربرد)
    برگشت تلاش جی دبلیو تی.امضای اچ اس۲۵۶(ادعا، راز)
پایان

تابع پذیرش(توکن: رشته، کاربرد لازم: رشته، اکنون: صحیح۶۴، راز: رشته): منطقی:
    ناپایا گزینه := جی دبلیو تی.گزینه های پیش فرض()
    گزینه.اکنون = اکنون
    گزینه.انقضا لازم = درست
    ناپایا ت := جی دبلیو تی.توکن {}
    تلاش:
        ت = جی دبلیو تی.تایید(توکن، راز، گزینه)
    گرفتن خطا خ:
        سرچاپ "  رد شد:"، خ.پیام
        برگشت نادرست
    پایان
    اگر جی دبلیو تی.رشته(ت، "use") نابرابر کاربرد لازم:
        سرچاپ "  رد شد: لازم بود"، کاربرد لازم، "ولی آمد"، جی دبلیو تی.رشته(ت، "use")
        برگشت نادرست
    پایان
    برگشت درست
پایان

تابع ریشه خطادار:
    راز := "server-side-secret-of-at-least-32-bytes"
    ورود := ۱۷۹۰۰۰۰۰۰۰ برگردان صحیح۶۴
    دسترسی := تلاش صدور("42"، "access"، ورود، ۹۰۰، راز)
    تمدید := تلاش صدور("42"، "refresh"، ورود، ۳۰ * ۸۶۴۰۰، راز)

    سرچاپ "درخواست پس از ۵ دقیقه:"، پذیرش(دسترسی، "access"، ورود + ۳۰۰، راز)
    سرچاپ "درخواست پس از ۲۰ دقیقه:"، پذیرش(دسترسی، "access"، ورود + ۱۲۰۰، راز)
    سرچاپ "تمدید پس از ۲۰ دقیقه:"، پذیرش(تمدید، "refresh"، ورود + ۱۲۰۰، راز)
    دسترسی تازه := تلاش صدور("42"، "access"، ورود + ۱۲۰۰، ۹۰۰، راز)
    سرچاپ "درخواست با توکن تازه:"، پذیرش(دسترسی تازه، "access"، ورود + ۱۳۰۰، راز)
    سرچاپ "توکن تمدید به جای دسترسی:"، پذیرش(تمدید، "access"، ورود + ۱۳۰۰، راز)
پایان
خروجیدرخواست پس از ۵ دقیقه: true رد شد: token expired درخواست پس از ۲۰ دقیقه: false تمدید پس از ۲۰ دقیقه: true درخواست با توکن تازه: true رد شد: لازم بود access ولی آمد refresh توکن تمدید به جای دسترسی: false

توکن تمدید را در یک کوکی HttpOnly نگه دارید (تنظیم کوکی نشست) نه در جاوااسکریپت، و اگر لازم است پیش از انقضا باطلش کنید، jti آن را روی سرور نگه دارید.

عوض کردن راز

دیر یا زود راز باید عوض شود. اگر یک‌باره عوضش کنید، همه‌ی کاربران از حساب بیرون می‌افتند. به جای آن به هر راز یک شناسه بدهید و با امضا با شناسه کلید آن را در سرآیند توکن بگذارید. برای بررسی، سرآیند را با کدگشایی بخوانید که هیچ چیز را تایید نمی‌کند، راز همان kid را بردارید و تنها پس از آن تایید را صدا بزنید. توکن‌های تازه را با کلید تازه امضا کنید و کلید کهنه را تا انقضای آخرین توکنی که با آن امضا شده نگه دارید.

jwt-key-rotation.salam
واردسازی جی دبلیو تی

تابع راز کلید(شناسه: رشته): رشته:
    کلیدها := نگاشت {} برگردان نگاشت<رشته، رشته>
    کلیدها.درج("2026-09"، "old-secret-kept-for-one-more-week")
    کلیدها.درج("2026-10"، "current-secret-used-for-new-tokens")
    اگر کلیدها.دارد(شناسه):
        برگشت کلیدها.بگیر(شناسه)
    پایان
    برگشت ""
پایان

تابع بررسی(توکن: رشته) خطادار:
    سرآیند := تلاش جی دبلیو تی.کدگشایی(توکن)
    راز := راز کلید(سرآیند.شناسه کلید)
    اگر راز.طول() برابر ۰:
        سرچاپ "کلید"، سرآیند.شناسه کلید، "رد شد: کلید ناشناخته"
        برگشت
    پایان
    ناپایا گزینه := جی دبلیو تی.گزینه های پیش فرض()
    گزینه.اکنون = ۱۷۹۰۰۰۰۱۰۰
    ت := تلاش جی دبلیو تی.تایید(توکن، راز، گزینه)
    سرچاپ "کلید"، سرآیند.شناسه کلید، "معتبر:"، ت.معتبر، "کاربر:"، ت.ادعاها.موضوع
پایان

تابع ریشه خطادار:
    ناپایا ادعا := جی دبلیو تی.ادعاهای جدید()
    ادعا.موضوع = "user-17"
    ادعا.زمان صدور = ۱۷۹۰۰۰۰۰۰۰
    ادعا.زمان انقضا = ۱۷۹۰۰۰۳۶۰۰
    کهنه := تلاش جی دبلیو تی.امضا با شناسه کلید(ادعا، جی دبلیو تی.الگوریتم اچ اس۲۵۶، "2026-09"، "old-secret-kept-for-one-more-week")
    تازه := تلاش جی دبلیو تی.امضا با شناسه کلید(ادعا، جی دبلیو تی.الگوریتم اچ اس۲۵۶، "2026-10"، "current-secret-used-for-new-tokens")
    سرگردان := تلاش جی دبلیو تی.امضا با شناسه کلید(ادعا، جی دبلیو تی.الگوریتم اچ اس۲۵۶، "2025-01"، "a-secret-nobody-has-anymore")
    تلاش بررسی(کهنه)
    تلاش بررسی(تازه)
    تلاش بررسی(سرگردان)
پایان
خروجیکلید 2026-09 معتبر: true کاربر: user-17 کلید 2026-10 معتبر: true کاربر: user-17 کلید 2025-01 رد شد: کلید ناشناخته

به هیچ چیز دیگری از کدگشایی اعتماد نکنید: ادعاهایی که برمی‌گرداند تایید نشده‌اند و فقط شناسه‌ی کلید را می‌شود به کار برد، چون تنها تعیین می‌کند بررسی واقعی با کدام راز انجام شود.

کدام تابع برای کدام کار

کارتابع
محافظت از مسیرهای HTTPنگهبان جدید، سپس نیاز یا هم‌خانواده‌هایش در هر گرداننده
ورود کاربرصدور یا صدور برای، و برای مرورگر تنظیم کوکی نشست
توکن دسترسی و تمدید با همصدور جفت
امضای توکن بیرون از HTTPادعاهای جدید، تنظیم رشته و هم‌خانواده‌هایش، سپس امضای اچ اس۲۵۶
بررسی توکن و خواندن ادعاهاتایید، سپس رشته، عدد، منطقی و دامنه دارد
فقط پاسخ آری یا نهمعتبر است
خواندن شناسه‌ی کلید پیش از بررسیکدگشایی

گونه‌ها

توکن Token

ساختار توکن
توکن کدگشایی‌شده.
نامانگلیسیگونهتوضیح
الگوریتمalgرشته = ""الگوریتم امضا، مثل HS256.
نوعtypرشته = ""نوع، معمولاً JWT.
شناسه کلیدkidرشته = ""شناسه‌ی کلید، اگر در سرآیند باشد.
ادعاهاclaimsادعاهاادعاهای استاندارد.
سرآیند جیسونheader_jsonرشته = ""متن جیسون سرآیند.
بدنه جیسونpayload_jsonرشته = ""متن جیسون بدنه.
ورودی امضاsigning_inputرشته = ""بخشی که امضا شده: سرآیند و بدنه با نقطه.
امضاsignatureرشته = ""امضا به شکل بیس۶۴ نشانی‌امن.
معتبرvalidمنطقی = نادرستامضا و زمان‌ها بررسی شده و درست بوده‌اند.
jwt-Sign.salam
واردسازی جی دبلیو تی

تابع دلیل(توکن: رشته، راز: رشته، گ: جی دبلیو تی.گزینه ها): رشته:
    تلاش:
        _ := جی دبلیو تی.تایید(توکن، راز، گ)
        برگشت "ok"
    گرفتن خطا خ:
        برگشت خ.کد + " " + خ.پیام
    پایان
پایان

تابع ریشه خطادار:
    ناپایا ا := جی دبلیو تی.ادعاهای جدید()
    ا.صادرکننده = "salamlang.ir"
    ا.موضوع = "42"
    ا.مخاطب = "api"
    ا.زمان صدور = ۱۷۰۰۰۰۰۰۰۰
    ا.زمان انقضا = ۱۷۰۰۰۰۳۶۰۰
    جی دبلیو تی.تنظیم رشته(ا، "name"، "مریم")
    جی دبلیو تی.تنظیم عدد(ا، "level"، ۳)
    جی دبلیو تی.تنظیم منطقی(ا، "admin"، نادرست)
    جی دبلیو تی.تنظیم خام(ا، "scope"، `"read write"`)
    جی دبلیو تی.تنظیم خام(ا، "roles"، `["editor","viewer"]`)
    سرچاپ جی دبلیو تی.جیسون ادعاها(ا)

    توکن := تلاش جی دبلیو تی.امضای اچ اس۲۵۶(ا، "راز-بلند-و-تصادفی")
    سرچاپ توکن.طول() > ۰
    سرچاپ توکن

    ناپایا گ := جی دبلیو تی.گزینه های پیش فرض()
    گ.اکنون = ۱۷۰۰۰۰۱۰۰۰
    گ.صادرکننده = "salamlang.ir"
    گ.مخاطب = "api"
    ت := تلاش جی دبلیو تی.تایید(توکن، "راز-بلند-و-تصادفی"، گ)
    سرچاپ ت.معتبر، ت.الگوریتم، ت.نوع، ت.ادعاها.موضوع
    سرچاپ جی دبلیو تی.رشته(ت، "name")، جی دبلیو تی.عدد(ت، "level")، جی دبلیو تی.منطقی(ت، "admin")، جی دبلیو تی.دارد(ت، "email")
    سرچاپ جی دبلیو تی.خام(ت، "level")، جی دبلیو تی.دامنه دارد(ت، "write")، جی دبلیو تی.مخاطب دارد(ت، "api")، جی دبلیو تی.فهرست دارد(ت، "roles"، "editor")

    سرچاپ دلیل(توکن، "راز-دیگر"، گ)
    گ.اکنون = ۱۸۰۰۰۰۰۰۰۰
    سرچاپ دلیل(توکن، "راز-بلند-و-تصادفی"، گ)
    گ.اکنون = ۱۷۰۰۰۰۱۰۰۰
    گ.صادرکننده = "example.com"
    سرچاپ جی دبلیو تی.معتبر است(توکن، "راز-بلند-و-تصادفی"، گ)
    تلاش:
        _ := جی دبلیو تی.کدگشایی("abc")
    گرفتن خطا خ:
        سرچاپ خ.کد، خ.است(نوع خطا.نحو)
    پایان
پایان
خروجی{"iss":"salamlang.ir","sub":"42","aud":"api","exp":1700003600,"iat":1700000000,"name":"مریم","level":3,"admin":false,"scope":"read write","roles":["editor","viewer"]} true eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzYWxhbWxhbmcuaXIiLCJzdWIiOiI0MiIsImF1ZCI6ImFwaSIsImV4cCI6MTcwMDAwMzYwMCwiaWF0IjoxNzAwMDAwMDAwLCJuYW1lIjoi2YXYsduM2YUiLCJsZXZlbCI6MywiYWRtaW4iOmZhbHNlLCJzY29wZSI6InJlYWQgd3JpdGUiLCJyb2xlcyI6WyJlZGl0b3IiLCJ2aWV3ZXIiXX0.DUKhTpjA2zLl36cgfbSy8WB_He7u9xvLRJ1TsG7RaFg true HS256 JWT 42 مریم 3 false false 3 true true true jwt.bad_signature signature does not match jwt.expired token expired false jwt.malformed true

نگهبان Guard

ساختار نگهبان
نگهبان مسیرهای HTTP: کلید، گزینه‌های بررسی و نام کوکی.
نامانگلیسیگونهتوضیح
کلید امضاsecretرشته = ""کلید امضا.
گزینه‌هاoptsگزینه هاگزینه‌های بررسی.
کوکیcookieرشته = ""نام کوکی‌ای که توکن از آن هم خوانده شود؛ خالی یعنی فقط سرآیند Authorization.
قلمروrealmرشته = "api"نامی که در سرآیند WWW-Authenticate می‌آید.
jwt-Guard.salam
واردسازی جی دبلیو تی
واردسازی شبکه.اچ تی تی پی
واردسازی شبکه.مسیریاب

ناپایا نگه := جی دبلیو تی.نگهبان جدید("راز-سرور-که-فقط-سرور-می-داند")

تابع ورود(ز: صحیح۶۴):
    ناپایا ا := جی دبلیو تی.ادعاهای جدید()
    ا.موضوع = "42"
    جی دبلیو تی.تنظیم رشته(ا، "scope"، "read")
    جی دبلیو تی.تنظیم خام(ا، "roles"، `["editor"]`)
    تلاش:
        توکن := جی دبلیو تی.صدور(نگه، ا، ۳۶۰۰)
        جی دبلیو تی.تنظیم کوکی نشست ناامن(ز، نگه، توکن، ۳۶۰۰)
        اچ تی تی پی.متن(ز، توکن)
    گرفتن خطا خ:
        اچ تی تی پی.تنظیم وضعیت(ز، ۵۰۰)
        اچ تی تی پی.متن(ز، خ.پیام)
    پایان
پایان

تابع من(ز: صحیح۶۴):
    ناپایا ت := جی دبلیو تی.توکن {}
    اگر جی دبلیو تی.نیاز(ز، نگه، ت):
        اچ تی تی پی.متن(ز، "سلام کاربر " + ت.ادعاها.موضوع)
    پایان
پایان

تابع مدیر(ز: صحیح۶۴):
    ناپایا ت := جی دبلیو تی.توکن {}
    اگر جی دبلیو تی.نیاز به دامنه(ز، نگه، "admin"، ت):
        اچ تی تی پی.متن(ز، "پنل مدیر")
    پایان
پایان

تابع ویرایش(ز: صحیح۶۴):
    ناپایا ت := جی دبلیو تی.توکن {}
    اگر جی دبلیو تی.نیاز به ادعا(ز، نگه، "roles"، "editor"، ت):
        اچ تی تی پی.متن(ز، "ویرایشگر")
    پایان
پایان

تابع پرونده(ز: صحیح۶۴):
    ناپایا ت := جی دبلیو تی.توکن {}
    اگر جی دبلیو تی.نیاز به موضوع(ز، نگه، اچ تی تی پی.پارامتر(ز، "id")، ت):
        اچ تی تی پی.متن(ز، "پرونده‌ی خودت")
    پایان
پایان

تابع بررسی دستی(ز: صحیح۶۴):
    تلاش:
        ت := جی دبلیو تی.بررسی(ز، نگه)
        اگر ت.ادعاها.موضوع == "0":
            جی دبلیو تی.ممنوع(ز، "کاربر مسدود است")
        وگرنه:
            اچ تی تی پی.متن(ز، "معتبر")
        پایان
    گرفتن خطا خ:
        اگر خ.کد == "jwt.missing_token":
            جی دبلیو تی.بدون گواهی(ز، نگه)
        وگرنه:
            جی دبلیو تی.غیرمجاز(ز، نگه، خ.پیام)
        پایان
    پایان
پایان

تابع ورود امن(ز: صحیح۶۴):
    تلاش:
        توکن := جی دبلیو تی.صدور برای(نگه، "42"، ۳۶۰۰)
        جی دبلیو تی.تنظیم کوکی نشست(ز، نگه، توکن، ۳۶۰۰)
        اچ تی تی پی.متن(ز، "وارد شدید")
    گرفتن خطا خ:
        اچ تی تی پی.تنظیم وضعیت(ز، ۵۰۰)
        اچ تی تی پی.متن(ز، خ.پیام)
    پایان
پایان

تابع خروج(ز: صحیح۶۴):
    جی دبلیو تی.پاک کردن کوکی نشست(ز، نگه)
    اچ تی تی پی.متن(ز، "خارج شدید")
پایان

تابع ریشه خطادار:
    نگه.کوکی = "session"
    ناپایا م := مسیریاب.مسیریاب جدید()
    مسیریاب.ارسال(م، "/login"، ورود)
    مسیریاب.دریافت(م، "/me"، من)
    مسیریاب.دریافت(م، "/admin"، مدیر)
    مسیریاب.دریافت(م، "/edit"، ویرایش)
    مسیریاب.دریافت(م، "/users/:id"، پرونده)
    مسیریاب.دریافت(م، "/check"، بررسی دستی)
    مسیریاب.ارسال(م، "/login/secure"، ورود امن)
    مسیریاب.ارسال(م، "/logout"، خروج)
    ناپایا س := اچ تی تی پی.سرور جدید(۱۹۶۱۰)
    اچ تی تی پی.استفاده(س، م)
    _ := اچ تی تی پی.اجرا در پس زمینه(س)
    پایه := "http://127.0.0.1:19610"

    ورود پاسخ := اچ تی تی پی.ارسال(پایه + "/login"، "")
    توکن := اچ تی تی پی.بدنه(ورود پاسخ)
    سرچاپ اچ تی تی پی.نگاشت کوکی(ورود پاسخ).دریافت("session") == توکن
    امن پاسخ := اچ تی تی پی.ارسال(پایه + "/login/secure"، "")
    سرچاپ اچ تی تی پی.بدنه(امن پاسخ)، اچ تی تی پی.نگاشت کوکی(امن پاسخ).دریافت("session").طول() > ۰
    ناپایا سر := اچ تی تی پی.سرصفحه جدید()
    سر.درج("Authorization"، "Bearer " + توکن)
    سرچاپ جی دبلیو تی.تجزیه حامل("Bearer " + توکن) == توکن
    بپرس(پایه، "/me"، سر)
    بپرس(پایه، "/admin"، سر)
    بپرس(پایه، "/edit"، سر)
    بپرس(پایه، "/users/42"، سر)
    بپرس(پایه، "/users/7"، سر)
    بپرس(پایه، "/check"، سر)
    بپرس(پایه، "/me"، اچ تی تی پی.سرصفحه جدید())
    ناپایا بد := اچ تی تی پی.سرصفحه جدید()
    بد.درج("Authorization"، "Bearer x.y.z")
    بپرس(پایه، "/check"، بد)
    ناپایا کوکی := اچ تی تی پی.سرصفحه جدید()
    کوکی.درج("Cookie"، "session=" + توکن)
    بپرس(پایه، "/me"، کوکی)

    ناپایا دسترسی := ""
    ناپایا تازه‌سازی := ""
    تلاش جی دبلیو تی.صدور جفت(نگه، "42"، ۹۰۰، ۸۶۴۰۰، دسترسی، تازه‌سازی)
    سرچاپ دسترسی.طول() > ۰، دسترسی != تازه‌سازی
    یک := تلاش جی دبلیو تی.صدور برای(نگه، "42"، ۶۰)
    بررسی‌شده := تلاش جی دبلیو تی.تایید(یک، نگه.کلید امضا، نگه.گزینه‌ها)
    سرچاپ بررسی‌شده.ادعاها.موضوع، نگه.قلمرو
پایان

تابع بپرس(پایه: رشته، مسیر: رشته، سر: نگاشت<رشته، رشته>):
    پ := اچ تی تی پی.دریافت با(پایه + مسیر، سر)
    سرچاپ مسیر، اچ تی تی پی.وضعیت(پ)، اچ تی تی پی.بدنه(پ)
پایان
خروجیtrue وارد شدید true true /me 200 سلام کاربر 42 /admin 403 {"error":"forbidden","reason":"missing scope: admin"} /edit 200 ویرایشگر /users/42 200 پرونده‌ی خودت /users/7 403 {"error":"forbidden","reason":"not your resource"} /check 200 معتبر /me 401 {"error":"unauthorized","reason":"missing bearer token"} /check 401 {"error":"unauthorized","reason":"invalid base64url segment"} /me 200 سلام کاربر 42 true true 42 api

ادعاها Claims

ساختار ادعاها
ادعاهای یک توکن.
نامانگلیسیگونهتوضیح
صادرکنندهissرشته = ""صادرکننده.
موضوعsubرشته = ""موضوع، معمولاً شناسه‌ی کاربر.
مخاطبaudرشته = ""مخاطب.
مخاطب جیسونaud_rawرشته = ""مخاطب به شکل جیسون، اگر آرایه باشد.
زمان انقضاexpصحیح۶۴ = 0زمان انقضا بر حسب ثانیه‌ی یونیکس.
آغاز اعتبارnbfصحیح۶۴ = 0زمانی که پیش از آن معتبر نیست.
زمان صدورiatصحیح۶۴ = 0زمان صدور.
شناسه توکنjtiرشته = ""شناسه‌ی یکتای توکن.
ادعاهای دیگرextraرشته = ""ادعاهای دیگر به شکل جیسون.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Sign.salam

گزینه ها Options

ساختار گزینه ها
گزینه‌های بررسی.
نامانگلیسیگونهتوضیح
الگوریتمalgرشته = "HS256"الگوریتمی که انتظار می‌رود؛ توکن با الگوریتم دیگر رد می‌شود.
صادرکنندهissuerرشته = ""صادرکننده‌ی لازم؛ خالی یعنی بررسی نشود.
مخاطبaudienceرشته = ""مخاطب لازم.
موضوعsubjectرشته = ""موضوع لازم.
تحمل اختلافleewayصحیح۶۴ = 0چند ثانیه اختلاف ساعت پذیرفته شود.
اکنونnowصحیح۶۴ = 0زمان بررسی؛ صفر یعنی اکنون. برای آزمایش.
انقضا لازمrequire_expمنطقی = نادرستتوکن بدون exp رد شود. به‌طور پیش‌فرض خاموش است، پس بدون آن توکن بی‌انقضا برای همیشه معتبر است.
آغاز اعتبار لازمrequire_nbfمنطقی = نادرستبدون nbf رد شود.
زمان صدور لازمrequire_iatمنطقی = نادرستبدون iat رد شود.
موضوع لازمrequire_subمنطقی = نادرستبدون sub رد شود.
شناسه لازمrequire_jtiمنطقی = نادرستبدون jti رد شود.
بررسی نوعcheck_typمنطقی = درستنوع JWT بررسی شود.
jwt-Algorithms.salam
واردسازی جی دبلیو تی

تابع دلیل رد(توکن: رشته، گ: جی دبلیو تی.گزینه ها): رشته:
    تلاش:
        _ := جی دبلیو تی.تایید(توکن، "k"، گ)
        برگشت "ok"
    گرفتن خطا خ:
        برگشت خ.کد
    پایان
پایان

تابع ریشه خطادار:
    سرچاپ جی دبلیو تی.الگوریتم اچ اس۲۵۶، جی دبلیو تی.الگوریتم اچ اس۳۸۴، جی دبلیو تی.الگوریتم اچ اس۵۱۲
    سرچاپ جی دبلیو تی.الگوریتم پشتیبانی می شود("HS512")، جی دبلیو تی.الگوریتم پشتیبانی می شود("none")، جی دبلیو تی.اندازه چکیده("HS384")

    ناپایا ا := جی دبلیو تی.ادعاهای جدید()
    ا.موضوع = "7"
    ا.شناسه توکن = "t-1"
    جی دبلیو تی.انقضا در(ا، ۳۶۰۰)
    جی دبلیو تی.معتبر نه پیش از(ا، ۰)
    یک := تلاش جی دبلیو تی.امضای اچ اس۳۸۴(ا، "k")
    دو := تلاش جی دبلیو تی.امضای اچ اس۵۱۲(ا، "k")
    سه := تلاش جی دبلیو تی.امضا(ا، جی دبلیو تی.الگوریتم اچ اس۲۵۶، "k")
    چهار := تلاش جی دبلیو تی.امضا با شناسه کلید(ا، "HS256"، "key-2026"، "k")
    د۱ := تلاش جی دبلیو تی.کدگشایی(یک)
    د۲ := تلاش جی دبلیو تی.کدگشایی(دو)
    د۴ := تلاش جی دبلیو تی.کدگشایی(چهار)
    سرچاپ د۱.الگوریتم، د۲.الگوریتم، د۴.شناسه کلید

    ت := تلاش جی دبلیو تی.تایید اچ اس۲۵۶(سه، "k")
    سرچاپ ت.معتبر، جی دبلیو تی.ثانیه های باقی مانده(ت) > ۳۵۰۰
    ب := تلاش جی دبلیو تی.تایید(یک، "k"، جی دبلیو تی.گزینه ها برای("HS384"))
    سرچاپ ب.معتبر
    سرچاپ دلیل رد(یک، جی دبلیو تی.گزینه های پیش فرض())

    خام := تلاش جی دبلیو تی.امضای جیسون(`{"sub":"1"}`، "HS256"، ""، "k")
    سرچاپ خام
    د := تلاش جی دبلیو تی.کدگشایی(خام)
    سرچاپ د.سرآیند جیسون، د.بدنه جیسون
    سرچاپ جی دبلیو تی.امضای ورودی(د.ورودی امضا، "HS256"، "k") == د.امضا

    کد := جی دبلیو تی.کدگذاری پایه۶۴ نشانی("سلام؟")
    سرچاپ کد.طول()
    سرچاپ تلاش جی دبلیو تی.کدگشایی پایه۶۴ نشانی(کد)
    سرچاپ جی دبلیو تی.کدگذاری پایه۶۴ نشانی بایت("hi?" برگردان تهی*، ۳)
    تلاش:
        _ := جی دبلیو تی.کدگشایی پایه۶۴ نشانی("aGk/")
    گرفتن خطا خ:
        سرچاپ خ.کد، خ.جایگاه، خ.پیام
    پایان
    تلاش:
        _ := جی دبلیو تی.امضای اچ اس۲۵۶(ا، "")
    گرفتن خطا خ:
        سرچاپ خ.کد، خ.است(نوع خطا.آرگومان نامعتبر)، خ.پیام
    پایان
    ناپایا سخت‌گیر := جی دبلیو تی.گزینه ها برای("HS384")
    سخت‌گیر.صادرکننده = "salamlang.ir"
    سرچاپ دلیل رد(یک، سخت‌گیر)، دلیل رد("a.b"، سخت‌گیر)، دلیل رد("e30.e30.x"، سخت‌گیر)
پایان
خروجیHS256 HS384 HS512 true false 48 HS384 HS512 key-2026 true true true jwt.alg_mismatch eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxIn0.q9rSPf4ratZ1Xkhd3M-FudlLIKYdlSzrHeXV7AICSuw {"alg":"HS256","typ":"JWT"} {"sub":"1"} true 14 سلام؟ aGk_ jwt.bad_base64 3 invalid character '/' jwt.empty_secret true empty secret jwt.bad_claim jwt.malformed jwt.bad_json

پایاها و متغیرها

الگوریتم اچ اس۲۵۶ JWT_HS256

پایا الگوریتم اچ اس۲۵۶: رشته = "HS256"
الگوریتم HS256.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Algorithms.salam

الگوریتم اچ اس۳۸۴ JWT_HS384

پایا الگوریتم اچ اس۳۸۴: رشته = "HS384"
الگوریتم HS384.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Algorithms.salam

الگوریتم اچ اس۵۱۲ JWT_HS512

پایا الگوریتم اچ اس۵۱۲: رشته = "HS512"
الگوریتم HS512.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Algorithms.salam

تابع‌ها

دارد Has

تابع دارد(t: توکن، key: رشته): منطقی
توکن این ادعا را دارد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Sign.salam

خام Raw

تابع خام(t: توکن، key: رشته): رشته
متن جیسون یک ادعا.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Sign.salam

رشته Str

تابع رشته(t: توکن، key: رشته): رشته
ادعای رشته‌ای.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Sign.salam

عدد Int

تابع عدد(t: توکن، key: رشته): صحیح۶۴
ادعای عددی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Sign.salam

منطقی Bool

تابع منطقی(t: توکن، key: رشته): منطقی
ادعای بولی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Sign.salam

مخاطب دارد HasAudience

تابع مخاطب دارد(t: توکن، want: رشته): منطقی
مخاطب توکن، چه رشته و چه آرایه، این مقدار را دارد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Sign.salam

فهرست دارد ListHas

تابع فهرست دارد(t: توکن، key: رشته، want: رشته): منطقی
ادعای آرایه‌ای این مقدار را دارد؛ مثل نقش‌ها.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Sign.salam

دامنه دارد HasScope

تابع دامنه دارد(t: توکن، want: رشته): منطقی
ادعای scope، که دامنه‌ها را با فاصله جدا می‌کند، این دامنه را دارد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Sign.salam

ثانیه های باقی مانده SecondsRemaining

تابع ثانیه های باقی مانده(t: توکن): صحیح۶۴
چند ثانیه تا انقضا مانده؛ اگر منقضی شده، صفر.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Algorithms.salam

الگوریتم پشتیبانی می شود IsSupportedAlg

تابع الگوریتم پشتیبانی می شود(alg: رشته): منطقی
این الگوریتم پشتیبانی می‌شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Algorithms.salam

اندازه چکیده DigestSize

تابع اندازه چکیده(alg: رشته): صحیح
طول امضای الگوریتم بر حسب بایت.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Algorithms.salam

صدور Issue

تابع صدور(g: نگهبان، c: ادعاها، ttl: صحیح۶۴): Throws<رشته>
مثل امضا خطا پرتاب می‌کند. exp را اکنون به‌علاوه‌ی ttl ثانیه و iat را اکنون می‌گذارد، اگر ادعاها صادرکننده و مخاطب نداشته باشند آن‌ها را از نگهبان پر می‌کند و با الگوریتم نگهبان امضا می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Algorithms.salam

صدور برای IssueFor

تابع صدور برای(g: نگهبان، subject: رشته، ttl: صحیح۶۴): Throws<رشته>
توکنی فقط با موضوع و انقضا.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Guard.salam

صدور جفت IssuePair

تابع صدور جفت(g: نگهبان، subject: رشته، access_ttl: صحیح۶۴، refresh_ttl: صحیح۶۴، access &: رشته، refresh &: رشته): Throws<منطقی>
یک توکن دسترسی کوتاه‌عمر و یک توکن تازه‌سازی بلندعمر می‌سازد و در access و refresh می‌گذارد؛ ادعای kind آن‌ها را از هم جدا می‌کند. مثل صدور خطا پرتاب می‌کند و آن‌گاه به هیچ‌کدام دست نمی‌زند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Guard.salam

تنظیم کوکی نشست SetSessionCookie

تابع تنظیم کوکی نشست(ctx: صحیح۶۴، g: نگهبان، token: رشته، max_age: صحیح)
توکن را در کوکی امن و HttpOnly نگهبان می‌گذارد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Guard.salam

تنظیم کوکی نشست ناامن SetSessionCookieInsecure

تابع تنظیم کوکی نشست ناامن(ctx: صحیح۶۴، g: نگهبان، token: رشته، max_age: صحیح)
مثل تابع بالا، بدون پرچم Secure؛ فقط برای آزمایش روی HTTP.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Guard.salam

پاک کردن کوکی نشست ClearSessionCookie

تابع پاک کردن کوکی نشست(ctx: صحیح۶۴، g: نگهبان)
کوکی نشست را پاک می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Guard.salam

نگهبان جدید NewGuard

تابع نگهبان جدید(secret: رشته): نگهبان
نگهبان تازه با کلید و گزینه‌های پیش‌فرض؛ برای API، opts.require_exp را روی آن روشن کنید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Guard.salam

تجزیه حامل ParseBearer

تابع تجزیه حامل(header_value: رشته): رشته
توکن را از مقدار سرآیند Bearer ... جدا می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Guard.salam

توکن حامل BearerToken

تابع توکن حامل(ctx: صحیح۶۴): رشته
توکن سرآیند Authorization درخواست.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Guard.salam

توکن از TokenFrom

تابع توکن از(ctx: صحیح۶۴، g: نگهبان): رشته
توکن درخواست، از سرآیند یا کوکی نگهبان.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Guard.salam

بررسی Check

تابع بررسی(ctx: صحیح۶۴، g: نگهبان): Throws<توکن>
توکن درخواست را بررسی می‌کند و خودش پاسخی نمی‌فرستد. اگر درخواست توکنی نداشته باشد jwt.missing_token و در غیر این صورت هر خطایی که تایید بدهد پرتاب می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Guard.salam

غیرمجاز Unauthorized

تابع غیرمجاز(ctx: صحیح۶۴، g: نگهبان، reason: رشته)
پاسخ ۴۰۱ با دلیل.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Guard.salam

بدون گواهی MissingCredential

تابع بدون گواهی(ctx: صحیح۶۴، g: نگهبان)
پاسخ ۴۰۱ برای درخواستی که اصلاً توکن ندارد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Guard.salam

ممنوع Forbidden

تابع ممنوع(ctx: صحیح۶۴، reason: رشته)
پاسخ ۴۰۳: توکن درست است ولی اجازه ندارد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Guard.salam

نیاز Require

تابع نیاز(ctx: صحیح۶۴، g: نگهبان، t &: توکن): منطقی
توکن را بررسی می‌کند؛ اگر نبود یا نادرست بود، خودش پاسخ ۴۰۱ را با پیام خطا به عنوان دلیل می‌فرستد و نادرست برمی‌گرداند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Guard.salam

نیاز به دامنه RequireScope

تابع نیاز به دامنه(ctx: صحیح۶۴، g: نگهبان، scope: رشته، t &: توکن): منطقی
مثل تابع بالا و توکن باید این دامنه را داشته باشد، وگرنه ۴۰۳.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Guard.salam

نیاز به ادعا RequireClaim

تابع نیاز به ادعا(ctx: صحیح۶۴، g: نگهبان، key: رشته، value: رشته، t &: توکن): منطقی
توکن باید در این ادعای آرایه‌ای این مقدار را داشته باشد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Guard.salam

نیاز به موضوع RequireSubject

تابع نیاز به موضوع(ctx: صحیح۶۴، g: نگهبان، subject: رشته، t &: توکن): منطقی
موضوع توکن باید همین باشد؛ برای اینکه کاربر فقط به داده‌ی خودش برسد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Guard.salam

کدگذاری پایه۶۴ نشانی بایت B64UrlEncodeBytes

تابع کدگذاری پایه۶۴ نشانی بایت(p: تهی*، n: صحیح): رشته
بایت‌ها را به بیس۶۴ نشانی‌امن بدون = تبدیل می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Algorithms.salam

کدگذاری پایه۶۴ نشانی B64UrlEncode

تابع کدگذاری پایه۶۴ نشانی(s: رشته): رشته
رشته را به بیس۶۴ نشانی‌امن تبدیل می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Algorithms.salam

کدگشایی پایه۶۴ نشانی B64UrlDecode

تابع کدگشایی پایه۶۴ نشانی(s: رشته): Throws<رشته>
بیس۶۴ نشانی‌امن بدون = را کدگشایی می‌کند. برای نویسه‌ای بیرون از الفبای نشانی‌امن خطای نحو با جایگاه آن، و وقتی یک نویسه اضافه بماند اتمام ناگهانی پرتاب می‌کند؛ کد خطا jwt.bad_base64 است.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Algorithms.salam

امضای جیسون SignJSON

تابع امضای جیسون(payload_json: رشته، alg: رشته، kid: رشته، secret: رشته): Throws<رشته>
بدنه‌ی جیسون آماده را امضا می‌کند. برای الگوریتم پشتیبانی‌نشده jwt.bad_alg و برای راز خالی jwt.empty_secret پرتاب می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Algorithms.salam

امضای ورودی SignatureOf

تابع امضای ورودی(signing_input: رشته، alg: رشته، secret: رشته): رشته
امضای یک ورودی را حساب می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Algorithms.salam

امضا با شناسه کلید SignWithKid

تابع امضا با شناسه کلید(c: ادعاها، alg: رشته، kid: رشته، secret: رشته): Throws<رشته>
مثل امضا، با شناسه‌ی کلید در سرآیند؛ برای چرخاندن کلیدها.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Algorithms.salam

امضا Sign

تابع امضا(c: ادعاها، alg: رشته، secret: رشته): Throws<رشته>
ادعاها را با الگوریتم داده‌شده امضا می‌کند؛ مثل امضای جیسون خطا پرتاب می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Sign.salam

امضای اچ اس۲۵۶ SignHS256

تابع امضای اچ اس۲۵۶(c: ادعاها، secret: رشته): Throws<رشته>
امضا با HS256.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Sign.salam

امضای اچ اس۳۸۴ SignHS384

تابع امضای اچ اس۳۸۴(c: ادعاها، secret: رشته): Throws<رشته>
امضا با HS384.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Algorithms.salam

امضای اچ اس۵۱۲ SignHS512

تابع امضای اچ اس۵۱۲(c: ادعاها، secret: رشته): Throws<رشته>
امضا با HS512.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Algorithms.salam

ادعاهای جدید NewClaims

تابع ادعاهای جدید(): ادعاها
ادعاهای خالی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Sign.salam

تنظیم رشته SetStr

تابع تنظیم رشته(c &: ادعاها، key: رشته، value: رشته)
ادعای رشته‌ای می‌افزاید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Sign.salam

تنظیم عدد SetInt

تابع تنظیم عدد(c &: ادعاها، key: رشته، value: صحیح۶۴)
ادعای عددی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Sign.salam

تنظیم منطقی SetBool

تابع تنظیم منطقی(c &: ادعاها، key: رشته، value: منطقی)
ادعای بولی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Sign.salam

تنظیم خام SetRaw

تابع تنظیم خام(c &: ادعاها، key: رشته، raw: رشته)
ادعا با متن جیسون آماده، مثل آرایه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Sign.salam

انقضا در ExpiresIn

تابع انقضا در(c &: ادعاها، seconds: صحیح۶۴)
انقضا را این قدر ثانیه پس از اکنون می‌گذارد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Algorithms.salam

معتبر نه پیش از NotBeforeIn

تابع معتبر نه پیش از(c &: ادعاها، seconds: صحیح۶۴)
زمان آغاز اعتبار را این قدر ثانیه پس از اکنون می‌گذارد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Algorithms.salam

جیسون ادعاها ClaimsJSON

تابع جیسون ادعاها(c: ادعاها): رشته
ادعاها به شکل متن جیسون.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Sign.salam

گزینه های پیش فرض DefaultOptions

تابع گزینه های پیش فرض(): گزینه ها
گزینه‌های پیش‌فرض: HS256، بدون مهلت اضافه و بدون هیچ ادعای الزامی، حتی exp.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Sign.salam

گزینه ها برای OptionsFor

تابع گزینه ها برای(alg: رشته): گزینه ها
گزینه‌های پیش‌فرض با الگوریتم دیگر.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Algorithms.salam

کدگشایی Decode

تابع کدگشایی(token: رشته): Throws<توکن>
توکن را بدون بررسی امضا کدگشایی می‌کند؛ فقط برای دیدن محتوا، نه برای اعتماد. اگر خواندنی نباشد jwt.malformed، jwt.bad_base64 یا jwt.bad_json پرتاب می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Sign.salam

تایید Verify

تابع تایید(token: رشته، secret: رشته، opts: گزینه ها): Throws<توکن>
امضا، الگوریتم، زمان‌ها و ادعاهایی را که گزینه‌ها خواسته‌اند بررسی می‌کند و توکن را با معتبر روشن برمی‌گرداند. در نخستین شکست یک خطا با کد jwt.* پرتاب می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Sign.salam

تایید اچ اس۲۵۶ VerifyHS256

تابع تایید اچ اس۲۵۶(token: رشته، secret: رشته): Throws<توکن>
بررسی با HS256 و گزینه‌های پیش‌فرض؛ مثل تایید خطا پرتاب می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Algorithms.salam

معتبر است IsValid

تابع معتبر است(token: رشته، secret: رشته، opts: گزینه ها): منطقی
توکن معتبر است؛ همان تایید بدون خطا، برای پاسخ ساده‌ی آری یا نه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: jwt-Sign.salam