JSPM

secure-auth

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2
  • Score
    100M100P100Q14938F
  • License MIT

A plug-and-play authentication & authorization library for Node.js apps.

Package Exports

  • secure-auth
  • secure-auth/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (secure-auth) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Secure Auth 🔐

A plug-and-play authentication & authorization library for Node.js apps.

Installation

npm install secure-auth

Usage

const SecureAuth = require('secure-auth');

const auth = new SecureAuth({ secret: 'supersecretkey' });

// Generate JWT
const token = auth.generateToken({ username: 'testuser' });
console.log('Generated JWT:', token);

// Verify JWT
try {
  const decoded = auth.verifyToken(token);
  console.log('Decoded JWT:', decoded);
} catch (err) {
  console.error('JWT verification failed:', err.message);
}

// Generate OAuth Token
const oauthToken = auth.generateOAuthToken('clientId', 'clientSecret');
console.log('Generated OAuth Token:', oauthToken);

// Verify OAuth Token
const isOAuthValid = auth.verifyOAuthToken(oauthToken);
console.log('Is OAuth Token valid?', isOAuthValid);

// Generate API Key
const apiKey = auth.generateApiKey();
console.log('Generated API Key:', apiKey);

// Verify API Key
const isApiKeyValid = auth.verifyApiKey(apiKey);
console.log('Is API Key valid?', isApiKeyValid);

// Add Role and User
auth.addRole('admin', ['read', 'write', 'delete']);
auth.addUser('adminUser', 'admin');

// Check Permission
const hasPermission = auth.checkPermission('adminUser', 'write');
console.log('Does adminUser have write permission?', hasPermission);

// Generate MFA Code
const mfaCode = auth.generateMfaCode();
console.log('Generated MFA Code:', mfaCode);

// Verify MFA Code
const isMfaValid = auth.verifyMfaCode(mfaCode, mfaCode);
console.log('Is MFA Code valid?', isMfaValid);

Features

✅ JWT generation and verification
✅ OAuth token generation and verification
✅ API key generation and verification
✅ Role-based access control (RBAC)
✅ Multi-factor authentication (MFA)

API

new SecureAuth(options)

Creates a new instance of SecureAuth.

Option Type Default Description
secret string Secret key for signing JWTs
tokenExpiry string '1h' JWT token expiry time

generateToken(payload)

Generates a JWT.

Parameter Type Description
payload object The payload to sign

verifyToken(token)

Verifies a JWT.

Parameter Type Description
token string The JWT to verify

generateOAuthToken(clientId, clientSecret)

Generates an OAuth token.

Parameter Type Description
clientId string The client ID
clientSecret string The client secret

verifyOAuthToken(token)

Verifies an OAuth token.

Parameter Type Description
token string The OAuth token to verify

generateApiKey()

Generates an API key.

verifyApiKey(apiKey)

Verifies an API key.

Parameter Type Description
apiKey string The API key to verify

addUser(username, role)

Adds a user with a role.

Parameter Type Description
username string The username
role string The role

addRole(role, permissions)

Adds a role with permissions.

Parameter Type Description
role string The role
permissions string[] The permissions for the role

checkPermission(username, permission)

Checks if a user has a specific permission.

Parameter Type Description
username string The username
permission string The permission to check

generateMfaCode()

Generates a multi-factor authentication (MFA) code.

verifyMfaCode(code, userCode)

Verifies an MFA code.

Parameter Type Description
code string The generated MFA code
userCode string The user-provided MFA code

Running Tests

This package includes test cases to ensure functionality. Run tests with:

npm test

License

This project is licensed under the MIT License - see the LICENSE file for details.


This version includes:
✅ Detailed API documentation
✅ Installation & usage examples
✅ Testing instructions
✅ Contributing section