easy-auth-module
Advanced tools
Readme
easy-auth-module is a flexible and easy-to-use authentication module for Node.js applications, designed to handle user authentication, authorization, and related tasks with minimal setup.
Note: This package is primarily intended for personal usage. Feel free to try it out, but be aware that it might not be suitable for all production scenarios.
Install the package via npm:
npm install easy-auth-module
import fastify from "fastify";
import Authenticator from "easy-auth-module";
import db from "./db";
import path from "path";
const app = fastify({ logger: true });
const authModule = new Authenticator({
prefix: "/api/v1/auth",
http: { type: "fastify", adapter: app },
auth: {
identityField: "email",
credentialsField: "password",
findUserByIdentifier: (identifier) => db.findOne({ email: identifier }),
createUser: (data) => db.create(data),
updateUserPassword: (identifier, password) =>
db.update({ set: { password }, where: { email: identifier } }),
verifyUser: (identifier) =>
db.update({ set: { verified: true }, where: { email: identifier } }),
refreshTokenConfig: {
secret: "refreshtokensecret",
expirationInSeconds: 60 * 60,
property: "refreshToken",
},
accessTokenConfig: {
secret: "accesstokensecret",
expirationInSeconds: 5 * 60,
property: "accessToken",
},
},
mailOptions: {
host: "mail.example.com",
port: 25,
auth: {
user: "example@example.com",
pass: "mysupersecretpassword",
},
tls: {
rejectUnauthorized: false,
},
secure: false,
verification: {
disabled: false,
ttl: 60 * 60 * 24,
template: path.join(__dirname, "templates", "verify.ejs"),
from: "example@example.com",
subject: "Verify your account",
baseUrl: "https://www.my-ui-app.com/verify-my-account",
},
forgotPassword: {
disabled: false,
ttl: 60 * 60 * 24,
template: path.join(__dirname, "templates", "forgot-password.ejs"),
from: "example@example.com",
subject: "Reset your password",
baseUrl: "https://www.my-ui-app.com/reset-password",
},
},
});
app.get(
"/protected",
{ preHandler: authModule.isAuthenticated() },
async (req: any, res: any) => {
return { message: `Hi ${req.authContext.email}` };
}
);
app.listen({ host: "localhost", port: 8000 });
import express from "express";
import Authenticator from "easy-auth-module";
import db from "./db";
import path from "path";
import bodyParser from "body-parser";
const app = express();
app.use(bodyParser.json());
const authModule = new Authenticator({
prefix: "/api/v1/auth",
http: { type: "express", adapter: app },
auth: {
identityField: "email",
credentialsField: "password",
findUserByIdentifier: (identifier) => db.findOne({ email: identifier }),
createUser: (data) => db.create(data),
updateUserPassword: (identifier, password) =>
db.update({ set: { password }, where: { email: identifier } }),
verifyUser: (identifier) =>
db.update({ set: { verified: true }, where: { email: identifier } }),
refreshTokenConfig: {
secret: "refreshtokensecret",
expirationInSeconds: 60 * 60,
property: "refreshToken",
},
accessTokenConfig: {
secret: "accesstokensecret",
expirationInSeconds: 5 * 60,
property: "accessToken",
},
},
});
app.get("/protected", authModule.isAuthenticated(), async (req, res) => {
return res.json({ message: `Hi ${req.authContext.email}` });
});
app.listen(8000, () => {
console.log("Server is running on port 8000");
});
The /protected route is protected by the isAuthenticated middleware provided by authModule. If the user is not authenticated, it respondes with an unauthorized error. You can access the authenticated user's data by req.authContext anywhere you use authModule.isAuthenticated() middleware.
AuthenticatorAuthenticator(options): Constructor function to create a new instance of the Authenticator.prefix: The base URL prefix for authentication routes.http: Configuration for HTTP server integration (supports Fastify).auth: Configuration options for authentication behavior.mailOptions: Configuration options for email communication, including verification and password reset emails.For the forgotPassword and verification features, you can customize the email templates (providing their path in the config).Below you can see example payloads enhanced with forgotPassword as well as verification properties. Ensure that your email templates are .ejs files.
// Example of template data for forgotPassword feature:
{
"email": "user@example.com",
"name": "John Doe",
"forgotPassword": {
"url": "https://www.my-ui-app.com/reset-password?token=resetToken123"
}
}
// Example of template data for verification feature:
{
"email": "user@example.com",
"name": "John Doe",
"verification": {
"url": "https://www.my-ui-app.com/verify-account?token=verificationToken123"
}
}
GET {prefix}Get the authenticated user
Authorization (string, required): Bearer token containing the access token.
POST {prefix}/registerRegisters a new user with the provided credentials.
email (string, required): The email address of the user (it has to match the identifyField in config).password (string, required): The password for the user account (it has to match the credentialsField in config)....: anything else that you can handle in the createUser callbackPOST {prefix}/loginLogs in a user with the provided credentials and returns access and refresh tokens.
email (string, required): The email address of the user (it should match the identifyField in config).password (string, required): The password for the user account (it should match the credentialsField in config).POST {prefix}/refresh-tokenRefreshes the access token using the provided refresh token.
refreshToken (string, required): it should match the property field inside refrshTokenConfig.GET {prefix}/verify/:tokenVerifies the user's account using the verification token.
token (string, required): The verification token sent to the user's email address.POST {prefix}/verifyRetry sending a verification email. This operation will fail if there is already an active token that didn't expired (ttl field in mailOptions.verification)
email (string, required)POST {prefix}/forgot-passwordInitiates the password reset process by sending a reset link to the user's email address.
email (string, required): The email address of the user.POST {prefix}/forgot-password/:tokenResets the user's password using the reset token and the new password.
token (string, required): The reset token sent to the user's email address.password (string, required): The new password for the user account.verifyPassword (string, required): has to match the password field.POST {prefix}/change-passwordResets an authenticated user's password.
Authorization (string, required): Bearer token containing the access token.
oldPassword (string, required): The user's old password.password (string, required): The new password for the user account.verifyPassword (string, required): has to match the password field.FAQs
Personal auth api module using jwt for express/fastify
We found that easy-auth-module demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.