houdin

houdin

Route-level file type validation for hapi parsed in-memory multipart/form-data request payloads. Also works as a standalone module.

Table of Contents

• Installation
• Usage
  • validate(payload, options, fn)
    • Hapi
    • Standalone
• Supported File Types

Installation

Install via NPM.

$ npm install houdin

Usage

validate(payload, options, fn)

Validates all Buffer values in a payload given a whitelist of file types provided in the options. Results in a joi-like ValidationError if some file type is not allowed or unknown otherwise it returns the original parsed payload to account for additional custom validation.

Hapi

const Hapi = require('hapi');
const Houdin = require('houdin');

const server = new Hapi.Server();

server.connection({
    routes: {
        validate: {
            options: {
                whitelist: ['image/png']
            }
        }
    }
});

server.route({
    config: {
        validate: {
            payload: Houdin.validate
        },
        payload: {
            output: 'data',
            parse: true
        }
    }
});

Standalone

const Houdin = require('houdin');

const options = { whitelist: ['image/png'] };
const png = Buffer.from('89504e47', 'hex');

Houdin.validate({ file: png }, options, (err, value) => {

    console.log(err); // null
    console.log(value); // { file: <Buffer 89 50 4e 47> }
});

const Houdin = require('houdin');

const options = { whitelist: ['image/png'] };
const gif = Buffer.from('47494638', 'hex');

Houdin.validate({ file: gif }, options, (err, value) => {

    console.log(err); // [ValidationError: child "file" fails because ["file" type is not allowed]]
    console.log(value); // undefined
});

Supported File Types

The same as file-type.

Changelog

v3.0.0 (2017-06-06)

Full Changelog

Implemented enhancements:

• Add support to handle undefined whitelists #30 (ruiquelhas)