jwt decodeダウンロード - jwt decodeソースコードダウンロード

jwt decode

その他のソースコード

v4.0.0

ダウンロード

重要:このライブラリはトークンを検証しません。整形式の JWT であればデコードできます。 Express-jwt、koa-jwt、Microsoft.AspNetCore.Authentication.JwtBearer などを使用して、サーバー側ロジックでトークンを検証する必要があります。

ドキュメント - はじめに - フィードバック

ドキュメント

ドキュメントサイト - ドキュメントサイトを参照して、Auth0 について詳しく学習してください。

はじめる

インストール

NPM または Yarn を使用してインストールします。

npm install jwt-decodeまたはyarn add jwt-decodeを実行してライブラリをインストールします。

使用法

 import { jwtDecode } from "jwt-decode" ;

const token = "eyJ0eXAiO.../// jwt token" ;
const decoded = jwtDecode ( token ) ;

console . log ( decoded ) ;

/* prints:
 * { 
 *   foo: "bar",
 *   exp: 1393286893,
 *   iat: 1393268893  
 * }
 */

// decode header by passing in options (useful for when you need `kid` to verify a JWT):
const decodedHeader = jwtDecode ( token , { header : true } ) ;
console . log ( decodedHeader ) ;

/* prints:
 * { 
 *   typ: "JWT",
 *   alg: "HS256" 
 * }
 */

注:偽りのトークンまたは不正な形式のトークンは、 InvalidTokenErrorエラーをスローします。特定のエラーの詳細については、以下を参照してください。

atob のポリフィル

このライブラリはatob()に依存しています。これは、すべての最新のブラウザーおよびサポートされているすべてのノード環境で使用できるグローバル関数です。

atob()にアクセスできない環境 (React Native など) でjwt-decode使用するには、 core-js/stable/atob使用してアプリケーションで対応するポリフィルを必ず提供してください。

 import "core-js/stable/atob" ;

あるいは、 base-64とポリフィルglobal.atob自分で使用することもできます。

 import { decode } from "base-64" ;
global . atob = decode ;

エラー

このライブラリは有効な JSON Web トークンで動作します。これらのトークンの基本形式は次のとおりです。

 [part1].[part2].[part3]

すべての部分は、有効な Base64 (URL) エンコードされた JSON である必要があります。 { header: <option> }オプションに応じて、パート 1 (header: true が指定されている場合のみ) またはパート 2 (デフォルト) をデコードします。

形式に従わないと、次のいずれかのメッセージが表示されるInvalidTokenErrorが発生します。

Invalid token specified: must be a string => 渡されたトークンは文字列ではありません。このライブラリは文字列に対してのみ機能します。
Invalid token specified: missing part # => これはおそらく、トークンにドット ( . ) が欠落していることを意味します
Invalid token specified: invalid base64 for part # => パーツを Base64 デコードできませんでした (メッセージには、Base64 デコーダーが与えたエラーが含まれている必要があります)
Invalid token specified: invalid json for part # => パートは正しく Base64 デコードされましたが、デコードされた値は有効な JSON ではありませんでした (メッセージには JSON パーサーが与えたエラーが含まれているはずです)

TypeScript で使用する

jwtDecode関数の戻り値の型は、2 番目の引数として渡されたオブジェクトのheaderプロパティによって決まります。省略した場合 (または false に設定した場合)、 JwtPayloadが使用され、 true の場合はJwtHeaderが使用されます。必要に応じて、型引数をjwtDecode関数に渡すことで、期待される戻り値の型を指定できます。

JwtHeaderとJwtPayload両方を拡張して、非標準のクレームまたはプロパティを含めることができます。

 import { jwtDecode } from "jwt-decode" ;

const token = "eyJhsw5c" ;
const decoded = jwtDecode < JwtPayload > ( token ) ; // Returns with the JwtPayload type

CommonJS パッケージとして使用する

 const { jwtDecode } = require ( 'jwt-decode' ) ;
...

scriptタグで含める

ファイルjwt-decode.js build/esmフォルダーのルートからプロジェクトのどこかにコピーし、 type="module"でマークされた script タグ内にそこからjwtDecodeインポートします。

 < script type =" module " >
  import { jwtDecode } from "/path/to/jwt-decode.js" ;

  const token = "eyJhsw5c" ;
  const decoded = jwtDecode ( token ) ;
</ script >