Socket
Socket
Sign inDemoInstall

avert

Package Overview
Dependencies
8
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

avert

HapiJS request sanitizer.


Version published
Maintainers
1
Weekly downloads
1,640
increased by19.88%

Weekly downloads

Readme

Source

Avert

Coverage Status Build Status

A Hapi v17+ plugin to sanitize a route query, payload and params. This was heavily inspired by Disinfect (https://github.com/genediazjr/disinfect). Motivation for this plugin came about as Disinfect was not v17+ compatible.

The plugin can be used:

  • at server level.
  • at route level.
  • disabled at route level.

Usage:

await server.register({ 
  plugin: require('avert'), 
  options: {
    // boolean parameters
    removeWhitespace: true,
    removeNonExistent: true,
    removeDollarSign: true,
    escapeDollarSign: false,
    removeCurlyBracket: false,
    escapeCurlyBracket: true,

    avertQuery: true,
    avertParams: true,
    avertPayload: true,

    // function parameters
    genericCustomSanitizer: function() {},
    queryCustomSanitizer: function() {},
    paramCustomSanitizer: function() {},
    payloadCustomSanitizer: function() {}
  } 
});

Any of the options can be disregarded. Also, we can either '''removeDollarSign''' or '''escapeDollarSign'''. Not both. If both are set to true, then "remove" takes precedence. Same logic applies for Curly Brackets.

Order of action:

request object -> sanitize -> generic sanitizer function -> query, params and/or payload specific sanitizer function -> (if true) remove white space -> (if true) remove null -> (if true) remove dollar sign OR escape dollar sign -> (if true) remove curly or escape curly brackets -> sanitized object returned.

Custom sanitizer function(s) needs to return a sanitized object as final result.

To disable on a specific route:

  server.route({
      method: 'GET',
      path: '/disabled',
      handler: (request, h) => {

          return request.query;
      },
      options: {
          plugins: {
              avert: false
          }
      }
  });
  

To use the plugin on a specific route:

  server.route({
      method: 'GET',
      path: '/queryTestPerRoute',
      handler: (request, h) => {

          return request.query;
      },
      options: {
          plugins: {
              avert: {
                  removeNonExistent: true
              }
          }
      }
  });
  

Contribution:

  • Please include 100% test coverage.
  • Please follow Hapi coding conventions.
  • Submit an issue first for signiticant changes.

Inspiration:

Keywords

FAQs

Last updated on 14 May 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc