When starting with role-based access control (RBAC) in Express.js, you’re taking a solid step to bolster your application’s security. Think of it like adding a virtual bouncer at the door, letting in only the folks with the right credentials. It’s all about making sure users can only see and do what they’re supposed to.
RBAC isn’t really complicated once you get the hang of it. Essentially, you’re assigning roles to users. Each role has a set of permissions. For instance, in a blogging app, you’ve got a Reader who can only read stuff, a Writer who can create and edit articles, and an Admin who has the power to manage users and their roles. Rather than doling out permissions one by one to every user, just toss them into a specific role. Want a new user to write articles? Slap on that Writer role, and you’re good to go.
To kick off this RBAC thing in Express.js, you need Node.js and Express installed. Begin by setting up your project. It’s pretty straightforward, just a few commands in the terminal:
mkdir my-rbac-app
cd my-rbac-app
npm init -y
npm install express
Now let’s get a basic Express server up and running. Here’s a simple setup to get you started:
const express = require('express');
const app = express();
const port = 3000;
app.use(express.json());
app.listen(port, () => {
console.log(`Server is running on port ${port}`);
});
Great, the server is up. The next step is designing the RBAC model, which involves defining roles and permissions. Imagine you’ve got three roles: Reader, Writer, and Admin. Each has specific permissions. Here’s how it could look in code:
const roles = {
Reader: ['read'],
Writer: ['read', 'create', 'edit', 'delete'],
Admin: ['read', 'create', 'edit', 'delete', 'manageUsers'],
};
const permissions = {
articles: {
read: ['Reader', 'Writer', 'Admin'],
create: ['Writer', 'Admin'],
edit: ['Writer', 'Admin'],
delete: ['Writer', 'Admin'],
},
};
With roles and permissions defined, it’s time to create middleware functions. This code will check a user’s role and permissions before allowing access to certain routes. First, write middleware to authenticate users and verify their permissions:
const authenticate = async (req, res, next) => {
// Assume you have a function to get the user's role from the request
const userRole = getUserRole(req);
if (!userRole) {
return res.status(401).send('Unauthorized');
}
req.userRole = userRole;
next();
};
const authorize = (permission) => {
return async (req, res, next) => {
const { userRole } = req;
if (!permissions.articles[permission].includes(userRole)) {
return res.status(403).send('Forbidden');
}
next();
};
};
With these middleware functions ready, you can now apply them to your routes to enforce RBAC. This makes sure only properly authenticated and authorized users can access certain endpoints:
app.get('/articles', authenticate, authorize('read'), (req, res) => {
res.send('List of articles');
});
app.post('/articles', authenticate, authorize('create'), (req, res) => {
res.send('Article created');
});
app.put('/articles/:id', authenticate, authorize('edit'), (req, res) => {
res.send('Article updated');
});
app.delete('/articles/:id', authenticate, authorize('delete'), (req, res) => {
res.send('Article deleted');
});
There are a bunch of libraries out there to make RBAC implementation smoother, like the rbac
library. This library simplifies interfacing with RBAC functions. Check this out for an example:
const { RBAC } = require('rbac');
const policy = new RBAC({
roles: ['Reader', 'Writer', 'Admin'],
permissions: {
articles: ['read', 'create', 'edit', 'delete'],
},
grants: {
Reader: ['read_articles'],
Writer: ['read_articles', 'create_articles', 'edit_articles', 'delete_articles'],
Admin: ['read_articles', 'create_articles', 'edit_articles', 'delete_articles', 'manageUsers'],
},
});
const hasPermission = (action) => {
return async (req, res, next) => {
const { user } = req.body;
const { asset } = req.params;
const userRoles = resolveUserRoles(user);
const allowed = await userRoles.reduce(async (perms, role) => {
const acc = await perms;
if (acc) return true;
const can = await policy.can(role, action, asset);
if (can) return true;
}, false);
allowed ? next() : res.status(403).send('Forbidden').end();
};
};
Permify also provides a way to implement RBAC with fine-grained control. It’s quite handy when you need scalable access controls:
const permify = require('@permify/permify-node');
const client = new permify.grpc.newClient({
endpoint: 'localhost:3478',
});
const checkPermissions = (permissionType) => {
return async (req, res, next) => {
try {
const checkRes = await client.permission.check({
tenantId: 't1',
metadata: {
schemaVersion: '',
snapToken: '',
depth: 20,
},
entity: {
type: 'organization',
id: '1',
},
permission: String(permissionType),
subject: {
type: 'user',
id: req.params.id,
},
});
if (checkRes.can === 1) {
req.authorized = 'authorized';
next();
} else {
req.authorized = 'not authorized';
next();
}
} catch (err) {
console.error('Error checking permissions:', err.message);
res.status(500).send(err.message);
}
};
};
Another popular choice is Auth0. It’s a robust solution for RBAC, requiring some setup in the Auth0 dashboard. Here’s how to configure and use it:
-
Enable RBAC in the Auth0 Dashboard:
- Go to the APIs section, select your API, then head to the “Settings” tab and flip the “Enable RBAC” and “Add Permissions in the Access Token” switches to on.
-
Create Permissions and Roles:
- For example, you could create a permission called
read:admin-messages
. - Then, create a role called
messages-admin
and assign the relevant permissions to it.
- For example, you could create a permission called
-
Set Up Middleware for Checking Permissions:
const jwt = require('express-jwt'); const checkJwt = jwt({ secret: 'your-secret-key', algorithms: ['HS256'], }); app.get('/api/messages/admin', checkJwt, (req, res) => { if (req.auth.permissions.includes('read:admin-messages')) { res.send('Admin messages'); } else { res.status(403).send('Forbidden'); } });
Implementing RBAC in your Express.js app is a solid move for managing user access in a secure and efficient manner. By leveraging libraries like rbac
or external services like Permify and Auth0, you can create a scalable and maintainable RBAC system tailored to your needs. Always keep the structure clean and your code well-documented, making it easier to manage your access control mechanisms as your application grows.