UTILITIES

A set of application utilities that will come in useful in Node.js

Install

npm install @siraglovale/utils

Usage

This module should be imported into your entry point, this will then setup global functions that can be used within your project.

Application Functions

utils.setApplication(_application_)

Sets the application specific information within the node project

• _application_: <Object>
  • name: <string>
  • version: <string>

Global Functions

log(_message_)

Log to stdout a message with a timestamp and information about the application

• _message_: <any>

error(_message_)

Log to stderr a message with a timestamp and information about the application

• _message_: <any>

Encoding Functions

utils.asciitoB64(_ascii_)

Converts an ascii string to a base64 string

• _ascii_: <string>

utils.asciitoHex(_ascii_)

Converts an ascii string to a hex string

• _ascii_: <string>

utils.asciitoUTF8(_ascii_)

Converts an ascii string to a utf-8 string

• _ascii_: <string>

utils.b64toUTF16LE(_ascii_)

Converts an ascii string to a utf-16 little endian string

• _ascii_: <string>

utils.b64toAscii(_base64_)

Converts a base64 string to an ascii string

• _base64_: <string>

utils.b64toHex(_base64_)

Converts a base64 string to a hex string

• _base64_: <string>

utils.b64toUTF8(_base64_)

Converts a base64 string to a utf-8 string

• _base64_: <string>

utils.b64toUTF16LE(_base64_)

Converts a base64 string to a utf-16 little endian string

• _base64_: <string>

utils.hextoAscii(_hex_)

Converts a hex string to an ascii string

• _hex_: <string>

utils.hextoB64(_hex_)

Converts a hex string to a base64 string

• _hex_: <string>

utils.hextoUTF8(_hex_)

Converts a hex string to a utf-8 string

• _hex_: <string>

utils.hextoUTF16LE(_hex_)

Converts a hex string to a utf-16 little endian string

• _hex_: <string>

utils.utf8toAscii(_utf8_)

Converts a utf8 string to an ascii string

• _utf8_: <string>

utils.utf8toB64(_utf8_)

Converts a utf8 string to a base64 string

• _utf8_: <string>

utils.utf8toHex(_utf8_)

Converts a utf8 string to a hex string

• _utf8_: <string>

utils.utf8toUTF16LE(_utf8_)

Converts a utf8 string to a utf-16 little endian string

• _utf8_: <string>

Password Functions

utils.hashPassword(password, secret)

Hash your password with a pseudo-randomly generated salt.

• password: <string>
• secret: <string> CONSTANT

utils.hashPasswordWithBcrypt(password, saltRounds)

Hash a password with bcrypt

• password: <string>
• saltRounds: <number>

utils.hashPasswordWithBcryptSync(password, saltRounds)

Hash a password with bcrypt synchronously

• password: <string>
• saltRounds: <number>

utils.validatePassword(password, hash, secret)

Validate a submitted password against a hash stored in your database

• password: <string>
• hash: <string>
• secret: <string> CONSTANT

utils.verifyBcryptPassword(password, hash)

Validates a bcrypt password

• password: <string>
• hash: <string>

utils.verifyBcryptPasswordSync(password, hash)

Validates a bcrypt password synchronously

• password: <string>
• hash: <string>

2 Factor Authentication Functions

utils.genSecret(_email)

Generate a secret for use in 2 Factor Authentication, this is used to generate the TOTP

• _email: <string>

utils.genQR(_email, _secret)

Generate a QR Code for the user based of the secret generated using genSecret, to use in conjunction with Google Authenticator, Authy or similar

• _email: <string>
• _secret: <string>

utils.verifyTFA(_token, _secret)

Returns an object that the token relates to, and, verifies the user

• _token: <string>
• _secret: <string>

Demo

Example

let utils = require("@siraglovale/utils"); // require module

utils.setApplication({
  name: "application_1",
  version: "0.1.0"
});

log("Hello World!");
// stdout
// [email protected][Thu Sep 14 2017 22:41:48 GMT+0100 (GMT Summer Time)] -> Hello World!

error("error");
// stderr
// [email protected][Thu Sep 14 2017 22:41:48 GMT+0100 (GMT Summer Time)] -> error