管理者ロール

CoddyのNode.jsジャーニー「認証とセキュリティ」セクションの一部。レッスン 19/24。

GET /adminはログイン済みかどうかだけを確認するため、すべてのメンバーがアクセスできます。ユーザーに保存されているロール（'member'や'admin'など）は、そのユーザーが何をできるかを示します。ミドルウェアを返す関数であるミドルウェアファクトリーは、ルートごとに1つのロールを確認します。

function requirePlan(plan) {
    return (req, res, next) => {
        if (req.user.plan !== plan) {
            return res.status(402).json({ error: `Needs the ${plan} plan` });
        }
        next();
    };
}

app.get('/exports', requireUser, requirePlan('pro'), sendExports);

ロールは必ずサーバーによって設定されます。サインアップでは、想定しているフィールドだけがreq.bodyからコピーされるため、"role": "admin"を送信した訪問者には何も与えられません。

チャレンジ

簡単

GET /admin はアカウント数を表示しますが、現在はログインしているメンバーなら誰でも見ることができます。管理者だけが見られるようにする必要があります。各ユーザーにはサーバーが設定するロールが割り当てられ、ルートはそのロールを確認します。

server.js の POST /signup で、新しいユーザー全員を "role": "member" として保存します。リクエスト本文からロールを取得してはいけません。"role": "admin" を送信した訪問者も、メンバーになります。
ミドルウェアを返す関数 requireRole(role) を作成します。このミドルウェアは req.user.role を確認します。
- role でない場合は、ステータス 403 と {"error": "Not allowed"} を返します。403 Forbidden は、サーバーがあなたの身元を把握しているものの、この操作は許可されていないことを意味します。401 は、サーバーがあなたの身元を把握していないことを意味します。
- role の場合は、next() を呼び出します。
GET /admin に requireRole('admin') を追加し、requireUser の後に置きます。これは req.user を読み取ります。この値を設定するのは requireUser だけです。

サーバーは起動時にすでに管理者アカウントを1つ作成します。ユーザー名は admin、パスワードは admin-pass-for-tests で、ADMIN_PASSWORD 環境変数から取得します。

試してみましょう：「実行」を押します。GET /admin を送信すると、ステータス 401 と {"error": "Log in first"} が返ります。次に、mallory というユーザーが自分を管理者にしようとします。{"username": "mallory", "password": "correct horse", "role": "admin"} を指定して POST /signup を送信し、続けて {"username": "mallory", "password": "correct horse"} を指定して POST /login を送信します。GET /admin を送信すると、ステータス 403 と {"error": "Not allowed"} が返ります。追加フィールドを指定しても、彼女は管理者にならなかったためです。{"username": "admin", "password": "admin-pass-for-tests"} を指定して POST /login を送信し、続けて GET /admin を送信すると、{"users": 2} が返ります。

自分で試してみよう

import express from 'express';
import { ObjectId } from 'mongodb';
import { randomBytes } from 'node:crypto';
import { parseCookies } from './cookies.js';
import { notes, sessions, users } from './db.js';
import { hashPassword, verifyPassword } from './passwords.js';

const app = express();
app.use(express.json());

// 唯一の管理者アカウント。パスワードは環境変数から取得する。
await users.insertOne({ username: 'admin', role: 'admin', passwordHash: await hashPassword(process.env.ADMIN_PASSWORD) });

app.post('/signup', async (req, res) => {
    const username = String(req.body.username ?? '').trim().toLowerCase();
    const password = String(req.body.password ?? '');
    if (!username || password.length < 8) {
        return res.status(400).json({ error: 'Pick a username and a password of at least 8 characters' });
    }
    if (await users.findOne({ username })) {
        return res.status(409).json({ error: 'That username is taken' });
    }
    await users.insertOne({ username, passwordHash: await hashPassword(password) });
    res.status(201).json({ username });
});

app.post('/login', async (req, res) => {
    const username = String(req.body.username ?? '').trim().toLowerCase();
    const user = await users.findOne({ username });
    if (!user || !(await verifyPassword(String(req.body.password ?? ''), user.passwordHash))) {
        return res.status(401).json({ error: 'Wrong username or password' });
    }
    const sid = randomBytes(24).toString('base64url');
    await sessions.insertOne({ _id: sid, userId: user._id, createdAt: new Date() });
    res.cookie('sid', sid, {
        httpOnly: true,
        sameSite: 'lax',
        secure: true,
        maxAge: 24 * 60 * 60 * 1000,
    });
    res.json({ username: user.username });
});

// セッション Cookie に対応するユーザーを検索し、見つからなければ 401 を返す。
async function requireUser(req, res, next) {
    const { sid } = parseCookies(req.get('cookie'));
    const session = sid && (await sessions.findOne({ _id: sid }));
    const user = session && (await users.findOne({ _id: session.userId }));
    if (!user) {
        return res.status(401).json({ error: 'Log in first' });
    }
    req.user = { id: user._id.toHexString(), username: user.username, role: user.role };
    next();
}

app.get('/me', requireUser, (req, res) => {
    res.json({ username: req.user.username });
});

app.post('/logout', async (req, res) => {
    const { sid } = parseCookies(req.get('cookie'));
    if (sid) {
        await sessions.deleteOne({ _id: sid });
    }
    res.clearCookie('sid');
    res.status(204).end();
});

// 自分のメモをページとして表示する。
app.get('/', requireUser, async (req, res) => {
    const list = await notes.find({ owner: req.user.id }).toArray();
    const items = list.map((note) => `<li>${note.text}</li>`).join('');
    res.send(`<!doctype html><title>Vault</title><h1>${req.user.username}'s notes</h1><ul>${items}</ul>`);
});

// メモ：各ユーザーは自分のメモだけを読み書きする。
app.get('/notes', requireUser, async (req, res) => {
    res.json(await notes.find({ owner: req.user.id }).toArray());
});

app.post('/notes', requireUser, async (req, res) => {
    const note = { owner: req.user.id, text: String(req.body.text ?? '') };
    await notes.insertOne(note);
    res.status(201).json(note);
});

app.get('/notes/:id', requireUser, async (req, res) => {
    if (!ObjectId.isValid(req.params.id)) {
        return res.status(404).json({ error: 'Note not found' });
    }
    const note = await notes.findOne({ _id: new ObjectId(req.params.id), owner: req.user.id });
    if (!note) {
        return res.status(404).json({ error: 'Note not found' });
    }
    res.json(note);
});

app.delete('/notes/:id', requireUser, async (req, res) => {
    if (!ObjectId.isValid(req.params.id)) {
        return res.status(404).json({ error: 'Note not found' });
    }
    const { deletedCount } = await notes.deleteOne({ _id: new ObjectId(req.params.id), owner: req.user.id });
    if (!deletedCount) {
        return res.status(404).json({ error: 'Note not found' });
    }
    res.status(204).end();
});

// 管理者向け：アカウント数を表示する。
app.get('/admin', requireUser, async (req, res) => {
    res.json({ users: await users.countDocuments() });
});

app.listen(3000, () => {
    console.log('Vault is running on port 3000');
});

認証とセキュリティのすべてのレッスン

自分で練習してみよう: Expressプレイグラウンド