Cách sử dụng Middleware để kiểm tra API Key và phân quyền trong Express
Bài toán
Giả sử bạn đang làm một hệ thống bán hàng trực tuyến và API của bạn có nhiều chức năng như: xem sản phẩm, thêm sản phẩm, xóa mã giảm giá, ... Thì tất nhiên không phải người dùng nào cũng có quyền sử dụng được tất cả các chức năng trong hệ thống. Vì vậy khi mỗi request được gửi tới hệ thống thì phải đảm bảo trả lời được 2 câu hỏi sau:
- Người gửi request có phải là người dùng hợp lệ không? ( authentication )
- Người gửi request có được phép làm việc này không? ( authorization )
Middleware là gì ?
Middleware là một hàm trung gian nằm giữa request và controller. Nó nhận ba tham số req, res, và next:
-
Nếu hợp lệ: Gọi next() để chuyển request đi tiếp.
-
Nếu không hợp lệ: Phản hồi ngay lập tức bằng res.status(...).json(...) và dừng request lại.
Request → [Middleware 1] → [Middleware 2] → Controller → Response
Middleware 1: Kiểm tra API Key
Key được gửi qua header x-api-key. Middleware sẽ làm 3 việc sau:
- Không có key → trả 403 "API Key is missing".
- Có key nhưng tìm kiếm trong DB không thấy (hoặc
statuslàfalse) → trả 401 "Invalid API Key". - Key hợp lệ → gắn thông tin key vào
req.objKeyrồi gọinext().
Lưu ý ở bước 3: các middleware sau có thể đọc req.objKey để biết key nào đang gọi và key nào được phép làm gì.
Ví dụ, một app bên thứ ba dùng key thì req.objKey đại diện cho app đó.
Middleware 2: Kiểm tra quyền (permission)
Hàm permission bản thân không phải là middleware, mà là một hàm tạo middleware (factory function). Bạn truyền tên quyền vào, hàm sẽ trả về một middleware được cấu hình riêng cho quyền đó:
const permission = (permission) => {
return (req, res, next) => {
if (!req.objKey.permissions.includes(permission)) {
return res.status(403).json({ message: 'Forbidden: No permission' })
}
return next()
}
}
Cách này giúp tái sử dụng một hàm duy nhất cho nhiều quyền khác nhau:
permission('READ') // Middleware kiểm tra quyền đọc
permission('WRITE') // Middleware kiểm tra quyền ghi
Cách sử dụng trong Express
Bước 1: Tạo các hàm Middleware
Bạn định nghĩa hàm apiKey và hàm tạo permission tại đây:
// Middleware kiểm tra API Key
const apiKey = (req, res, next) => {
const key = req.headers['x-api-key'];
if (!key) {
return res.status(401).json({ message: 'Unauthorized: Missing API Key' });
}
// Giả sử sau khi kiểm tra DB, ta gắn thông tin vào req.objKey
req.objKey = {
key: key,
permissions: ['READ', 'WRITE'] // Ví dụ key này có quyền đọc và ghi
};
next(); // Cho phép đi tiếp
};
// Hàm factory tạo middleware kiểm tra quyền
const permission = (requiredPermission) => {
return (req, res, next) => {
// Kiểm tra xem req.objKey.permissions có chứa quyền yêu cầu không
if (!req.objKey || !req.objKey.permissions.includes(requiredPermission)) {
return res.status(403).json({ message: 'Forbidden: No permission' });
}
return next();
};
};
module.exports = { apiKey, permission };
Bước 2: Gắn vào Router
const express = require('express');
const router = express.Router();
const { apiKey, permission } = require('../middlewares/auth.middleware');
// --- 1. ROUTE PUBLIC (Không cần qua middleware bảo vệ) ---
router.get('/public/welcome', (req, res) => {
res.json({ message: 'Chào mừng bạn đến SHOP!' });
});
// --- 2. ÁP DỤNG MIDDLEWARE CHO CÁC ROUTE PHÍA DƯỚI ---
router.use(apiKey); // Mọi route dưới đây bắt buộc phải có API Key hợp lệ
router.use(permission('READ')); // Mọi route dưới đây bắt buộc phải có quyền READ
// --- 3. ROUTE PRIVATE (Yêu cầu phải vượt qua các middleware ở trên) ---
router.get('/v1/api/product', (req, res) => {
res.json({ message: 'Lấy danh sách sản phẩm thành công (Cần quyền READ)' });
});
// Nếu muốn route này cần thêm quyền WRITE, bạn phải gắn trực tiếp middleware riêng cho nó:
router.post('/v1/api/product', permission('WRITE'), (req, res) => {
res.json({ message: 'Tạo sản phẩm thành công (Cần cả READ và WRITE)' });
});
module.exports = router;
All Rights Reserved