secure-auth-utils

SecureAuth is a comprehensive Node.js package that provides easy-to-use utilities for authentication and security-related tasks. It includes functions for generating and verifying JWT tokens, hashing passwords securely, and refreshing authentication tokens. With SecureAuth, developers can quickly implement secure authentication mechanisms in their Node.js applications, ensuring the integrity and confidentiality of user data.

Installation

You can install this package via npm:

1npm install secure-auth-utils jsonwebtoken

1yarn add secure-auth-utils jsonwebtoken

Usage

Generating a Token

1const { generateToken } = require('secure-auth-utils');
2
3// Generate a token
4const token = generateToken({
5  data: { userId: 123 },
6  tokenSecret: 'your-secret-key'
7});
8console.log('Generated Token:', token);

Decoding a Token

1const { decodedToken } = require('secure-auth-utils');
2
3// Decode a token
4const decodedData = decodedToken({
5  token: 'your-encoded-token',
6  tokenSecret: 'your-secret-key'
7});
8console.log('Decoded Data:', decodedData);

Refreshing a Token

expiresIn : Eg: 60, "2 days", "10h", "7d"

1const { refreshTokenEncoded } = require('secure-auth-utils');
2
3// Refresh a token with hashed password
4const refreshedToken = refreshTokenEncoded({
5  hashedPass: 'your-hashed-password',
6  data: { userId: 123 },
7  expiresIn: '7 days',
8  tokenSecret: 'your-secret-key'
9});
10console.log('Refreshed Token:', refreshedToken);

1const getRefreshToken = refreshTokenEncoded({
2  data:{email:"test@test.com", role: 'user',},
3  hashedPass: hashedPass,
4  expiresIn: '7 days',
5  tokenSecret: 'your-secret-key'
6})

NB: Recommend you use hashedPass (hash) for extra security . 🤫🤐🔐..

1const tokenDecode = await decodedToken({
2  token: ref_tkn,
3  tokenSecret: process.env.USER_REFRESH_TOKEN
4});
5
6  if (tokenDecode.success) {
7    const { data, sessionToken, role } = tokenDecode?.data
8    // if use hashedPass then you get sessionToken;
9    const getSalt = sessionToken?.split('####')?.[0];
10    const getHash = sessionToken?.split('####')?.[1];
11    //check hashed 
12    // make sure encoding, algorithm are same
13    const check = passwordHashing({salt: getSalt,hash: hashedPass}).hash == getHash;
14    // code execute
15  }
16  else{
17    // code execute
18  }

Hashing a Password

1const { passwordHashing } = require('secure-auth-utils');
2
3// Hash a password
4const hashedPassword = passwordHashing({
5  password: 'your-password',
6  salt: 'your-salt',
7  algorithm: 'sha256',
8  encoding: 'base64'
9});
10console.log('Hashed Password:', hashedPassword.hash);

Checking Password

1const { checkPassword } = require('secure-auth-utils');
2
3// Check if password matches hash
4const isMatch = checkPassword({
5  salt: 'your-salt',
6  hash: 'your-hashed-password',
7  password: 'your-password'
8});
9console.log('Password Match:', isMatch);

API Reference

generateToken(options)

Generates a JWT token.

• options (object):
  • data (object): The data payload to be included in the token.
  • tokenSecret (string): The secret key used for token generation.
  • expiresIn (string): The expiration time for the token (optional, defaults to '24h').
  • algorithm (string): The signing algorithm to be used (optional, defaults to "HS256").

Returns an object containing the generated token and success status.

decodedToken(options)

Decodes a JWT token.

• options (object):
  • tokenSecret (string): The secret key used for token verification.
  • token (string): The JWT token to be decoded.

Returns an object containing the decoded data and success status.

refreshTokenEncoded(options)

Refreshes a token encoded.

• options (object):
  • hashedPass (string): The hashed password (optional).
  • data (object): Additional data to be included in the token.
  • expiresIn (string): The expiration time for the token (optional).
  • tokenSecret (string): The secret key used for token generation.

Returns the refreshed token or null if hashedPass is not provided.

passwordHashing(options)

Hashes a password.

• options (object):
  • salt (string): The salt used for hashing (optional, autogenerated if not provided).
  • password (string): The password to be hashed.
  • algorithm (string): The hashing algorithm to be used (optional, defaults to SHA256).
  • encoding (string): The encoding format for the hash (optional, defaults to 'base64').

Returns an object containing the salt, success status, and hashed password.

checkPassword(options)

Checks if a password matches the hashed value.

• options (object):
  • salt (string): The salt used for hashing.
  • hash (string): The hashed password to be checked.
  • password (string): The password to be validated.

Returns true if the password matches the hash, false otherwise.

Replace Your Package Name with the actual name of your package and secure-auth-utils with the npm package name. Also, make sure to update the function examples with relevant data and keys.