Authentication

Password Hashing

Securely hash and verify passwords in TypeScript and Node.js with AxilJS using the memory-hard scrypt algorithm, unique salts, and constant-time comparison.

2 min readUpdated DocumentationEdit this page
On this page5

AxilJS provides hashPassword() and verifyPassword() for securely hashing and verifying passwords in TypeScript and Node.js applications.

The implementation uses Node.js's built-in scrypt algorithm, providing memory-hard password hashing without requiring an external bcrypt dependency.

Hash a Password

Use hashPassword() to generate a secure password hash.

TypeScript
TS
1import {
2  hashPassword,
3  verifyPassword
4} from '@axiljs/auth'
5
6const hashed = await hashPassword('password123')

The original password should not be stored in your database. Store the generated hash instead.

Verify a Password

Use verifyPassword() to compare a plaintext password against a previously generated hash.

TypeScript
TS
1const valid = await verifyPassword(
2  'password123',
3  hashed
4)

The function returns whether the supplied password matches the stored password hash.

A typical authentication flow is:

User Password
hashPassword()
Password Hash
Database
Registration: hash the password and store only the hash.
Login Attempt
verifyPassword()
Valid / Invalid
Login: verify the submitted password against the stored hash.

scrypt Password Hashing

AxilJS uses Node.js's built-in scrypt implementation for password hashing.

The hashing configuration includes:

  • scrypt — memory-hard password derivation algorithm.
  • 32-byte salt — a unique salt used during password hashing.
  • 64-byte derived key — the generated password key length.
  • Constant-time comparison — used when verifying password hashes.

The stored value has the format saltHex:hashHex. Use isHashed() to check whether a string already has that shape:

TypeScript
TS
import { isHashed } from '@axiljs/auth'

isHashed(hashed) // true

hashPassword('') throws, and verifyPassword() returns false (it never throws) for a malformed stored hash.

These properties make the password hashing implementation suitable for protecting stored user credentials.

Why scrypt?

scrypt is designed to be computationally and memory intensive, making large-scale password guessing more expensive.

Because AxilJS uses Node.js's built-in scrypt implementation, you do not need to add a separate bcrypt package just to hash and verify passwords.

TypeScript
TS
1const hashed = await hashPassword('password123')
2
3const valid = await verifyPassword(
4  'password123',
5  hashed
6)
7
8if (valid) {
9  // Password is valid
10}

Password Security

Never store plaintext passwords in your database.

Store the value returned by hashPassword() and use verifyPassword() during authentication.

Do not log passwords or expose password hashes through API responses.

The password verification process uses constant-time comparison to reduce timing-attack risks.

Warning

Never store or log plaintext passwords. Store the generated password hash and verify credentials with verifyPassword().

Was this page helpful?

Help improve the documentation

AxilJS is open source and documentation improvements are welcome.

AxilJS DocumentationMIT License · Built by SyntaxilitY