ts-framework-signing

A minimalistic framework for typescript based applications, with async/await and decorators support.

This plugin extends the Server for handling safe signing using Headers.

# Install using yarn
yarn add git:https://github.com/nxtep-io/ts-framework-signing.git#master

# Install using NPM
npm install --save git:https://github.com/nxtep-io/ts-framework-signing.git#master

Getting Started (TS-Framework)

Add the module as a Server middleware overriding the router registration method.

import Server from 'ts-framework';
import { Signing } from 'ts-framework-signing';

class MyServer extends Server {
  constructor() {
    super({
      port: process.env.PORT as any || 3333,
      routes: {
        get: { '/': (req, res) => res.success({ test: 'ok' }) }
      },
    })
  }

  public async onMount() {
    // Initialize the request signing middleware
    this.app.use(Signing.middleware({
      /* 
        You can pass a constant secret string for signing 
        or a function returning a promised string 
      */
      secret: async (req) => req.user.secret,
    }));

    // Continue with the router initialization
    return super.onMount();
  }
}

Getting Started (Express)

This module is also compatible with an Express server.

const express = require('express');
const { Signing } = require('ts-framework-signing');

const app = express();

app.use(Signing.middleware({
  /* The secret can also be a constant string */
  secret: 'test'
}));

app.listen(3000, () => console.log('Server listening on port: 3000'));

Options

• options.secret (required): A constant string or an async function to get the secret to sign this request with.

• options.logger: The signing middleware logger instance, for verbose and debugging.

• options.maxTimeout: The max timeout between the signed timestamp and the time of verification, in ms. Defaults to 30000 ms.

• signedBodyMethods: The list of HTTP Methods with full body signing verification. Defaults to ['POST', 'PUT'].

License

The project is licensed under the MIT License.