Passwords

Every application must store passwords using a cryptographic technique. FoalTS provides two functions to hash and verify passwords.

The hashPassword function

The hashPassword utility uses the PBKDF2 algorithm with a SHA256 hash. It takes as parameters the password in plain text and an optional options object. It returns a promise which value is a password hash.

Note: In previous versions of FoalTS (<v1.0.0), this function was named encryptPassword.

Parameters

Name

Type

Default value

plainTextPassword

string

options

{ legacy?: boolean }

{}

Return type

Promise<string>

The verifyPassword function

The verifyPassword takes three arguments:

  • the password to check in plain text,

  • the password hash (usually fetched from the database),

  • and an optional options object (see below).

Parameters

Name

Type

Default value

plainTextPassword

string

passwordHash

string

options

{ legacy?: boolean }

{}

Return type

Promise<boolean>

If you used the parsePassword function in previous versions of Foal (<0.7.0), you must pass the legacy: true option to verifyPassword and hashPassword.