📮

Postmanで使うJWT(JSON Web Token)を自動で更新する

2023/02/10に公開・約4,000字

JWT

Postman

tech

概要

Postman を使って、JWT(JSON Web Token)の認証のあるAPIをテストするときに、自動でJWTを更新する仕組みをつくったので、そのメモ

手順

1. Collectionを作成する

Collectionsのタブから、Collectionを新規作成します。

create new collection

Collectionの作成は省略しても問題がありませんが、pre-request scriptsを再利用したいため、ここではCollectionを新規作成しています。https://learning.postman.com/docs/writing-scripts/pre-request-scripts/#re-using-pre-request-scripts

2. Pre-request Script を作成する

Collectionの Pre-request Script タブを選択し、JWTの取得と設定をするスクリプトを追加します。

スクリプトには次の内容を追加します。

/**
 * JWTをパースする関数
 * @param {string} token - JWT
 * @returns {Object} JWTのペイロード
 */
function parseJwt (token) {
    const base64Url = token.split('.')[1];
    const base64 = base64Url.replace(/-/g, '+').replace(/_/g, '/');
    const jsonPayload = decodeURIComponent(atob(base64).split('').map((c) => {
        return '%' + ('00' + c.charCodeAt(0).toString(16)).slice(-2);
    }).join(''));
    return JSON.parse(jsonPayload);
};

/**
 * JWTが有効かどうかを判定する関数
 * @param {string} token - JWT
 * @returns {boolean} 有効なJWTの場合Trueを返す。失効している場合はFalseを返す。
 */
function isValidToken(token) {
    if (!token) return false;
    const { exp } = parseJwt(token);
    if (!exp) return false;
    return new Date().getTime() < new Date(exp * 1000).getTime();
}

/**
 * トークンを環境変数に設定する関数
 * @callback setTokenCallback
 * @param {string} token - JWT
 * @returns {void}
 */

/**
 * 最新のJWTを取得する関数
 * @callback refreshCallback
 * @param {setTokenCallback} setToken - トークンを環境変数に設定するコールバック関数
 * @returns {void}
 */

/**
 * JWTを環境変数に設定する関数。
 * 環境変数に設定されたJWTが失効していた場合は、トークンを更新して再設定する
 * @param {string} envKey - 環境変数名
 * @param {refreshCallback} refreshFunc - JWTが失効していた場合に呼ばれる、トークンを更新するコールバック関数
 */
function setJwtEnv(envKey, refreshFunc) {
    if (!envKey || !refreshFunc) return console.error("Argument is required");
    const latestToken = pm.environment.get(envKey);
    if (!isValidToken(latestToken)) {
        refreshFunc((token) => pm.environment.set(envKey, token));
    }
}

/* -- 以下、認証プロバイダに合わせて適宜変更する -- */

// トークン更新するリクエストの内容
const req = {
    url: '[your-token-provider-url]',
    method: 'POST',
    header: {
        'Content-Type': 'application/json',
    },
    body: {
        mode: 'raw',
        raw: JSON.stringify({ email: pm.environment.get("email"), password: pm.environment.get("password") })
    },
};
// トークンを更新する
setJwtEnv("token", (setToken) => {
    pm.sendRequest(req, (error, response) => {
        if (error) return console.error(error);
        if (response.code !== 200) return console.error(response);
        const { idToken } = response.json();
        if (idToken) {
            setToken(idToken);
        }
    });
});