管理员角色
本课属于 Coddy Node.js 学习旅程的“身份验证与安全”单元。第 19 课,共 24 课。
GET /admin 只检查是否有人已登录,所以每个成员都能看到它。存储在用户上的角色,例如 'member' 或 'admin',说明用户可以做什么。中间件工厂,也就是返回中间件的函数,会为每个路由检查一个角色:
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会设置这个值。
服务器启动时已经会创建一个管理员账户。用户名是 admin,密码是 admin-pass-for-tests,它来自 ADMIN_PASSWORD 环境变量。
试试看:按“运行”。发送 GET /admin:状态码为 401,响应为 {"error": "Log in first"}。现在,名叫 mallory 的用户试图让自己成为管理员。发送 POST /signup,并附上 {"username": "mallory", "password": "correct horse", "role": "admin"},然后发送 POST /login,并附上 {"username": "mallory", "password": "correct horse"}。发送 GET /admin:状态码为 403,响应为 {"error": "Not allowed"},因为额外字段并没有让她成为管理员。发送 POST /login,并附上 {"username": "admin", "password": "admin-pass-for-tests"},然后发送 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 在线编辑器