@leismore/token

Token Class

The authentication Token class for NodeJS.

Donation

Buy me a coffee via

Motivation

Define a universal authentication token class for LMOS NodeJS project.

Installation

npm install @leismore/token

Test

npm test

Example

import {Token} from '@leismore/token';

Token.create().then(token=>{
  console.log(String(token));
});

API

class Token
{
  public token:      string;         // Random string
  public generated:  number;         // Unix timestamp (milliseconds)
  public expiry:     (number|null);  // Unix timestamp (milliseconds)

  /**
   * Create a Token instance
   * @param     {int}             [bitSize=TOKEN_DEFAULT_BITSIZE]     - Token bit-length (multiple of 8)
   * @param     {string}          [baseEncoding=UIDGenerator.BASE58]  - Token baseEncoding
   * @param     {int|null}        [expiry=now+30min]                  - Token expiry Unix-timestamp (millisecond)
   * @return    {Promise<Token>}                                      - A Token instance
   * @throw     {Error}                                               - invalid_bitSize | invalid_baseEncoding | invalid_expiry
   */
  public static async create
  (
    bitSize:      number           = TOKEN_DEFAULT_BITSIZE,
    baseEncoding: string           = UIDGenerator.BASE58,
    expiry:       (number|null)    = ( Date.now() + TOKEN_DEFAULT_EXPIRY * 60 * 1000 )
  ):Promise<Token>

  /**
   * @param {TokenData} token
   * @throw {Error}     - invalid_token | invalid_generated | invalid_expiry
   */
  public constructor(token: TokenData)

  public verify(token:string):boolean

  public toString():string
}

type TokenData = {
  token:     string,           // Random string
  generated: number,           // Unix timestamp (milliseconds)
  expiry:    (number|null)     // Unix timestamp (milliseconds)
};

const TOKEN_MIN_SIZE        = 6;   // Characters
const TOKEN_MIN_BITSIZE     = 32;  // Bit-length
const TOKEN_DEFAULT_BITSIZE = 128; // Bit-length
const TOKEN_DEFAULT_EXPIRY  = 30;  // Minutes

License

GNU Affero General Public License v3.0

Authors

• Kyle Chine (Initial Author / July 20, 2019)

Credit

• This package is based on uid-generator at NPM