Miss any of our Open RFC calls?Watch the recordings here! »

express-request-audit

1.0.3 • Public • Published

NPM Version Build Status Test Coverage NPM Downloads MIT License

express-request-audit

Middleware for auditing request/responses in Express apps.

This work is derivated from express-requests-logger.

Supported features

  • Auditing request
  • Auditing response
  • Mask request body fields
  • Exclude request body fields
  • Exclude request specific headers
  • Mask response body fields
  • Exclude response body fields
  • Exclude response specific headers
  • Exclude specific URLs from logging
  • Supported by Node v8 and above.

Installation

This is a Node.js module available through the npm registry. Installation is done using the npm install command:

$ npm install express-request-audit

API

var audit = require('express-request-audit')

audit(options)

Create an audit middleware with ther given options.

options

the express-request-audit accepts the following properties in the options object.

auditor

The auditor function that will act as s sink for the request/response stream of events.

doubleAudit

true - log once the request arrives (request details), and log after response is sent (both request and response). - Useful if there is a concern that the server will crash during the request and there is a need to log the request before it's processed.

false - log only after the response is sent.

excludeURLs

Array of strings - if the request url matches one of the values in the array, the request/response won't be logged. For example: if there is a path /v1/health that we do not want to log, add:

excludeURLs: ['health']

request

Specific configuration for requests

audit

Boolean - true - include request in audit, false - don't.

excludeBody

Array of strings - pass the fields you wish to exclude in the body of the requests (sensitive data like passwords, credit cards numbers etc..). * field - exclude all body

maskBody

Array of strings - pass the fields you wish to mask in the body of the requests (sensitive data like passwords, credit cards numbers etc..).

maskQuery

Array of strings - pass the fields you wish to mask in the query of the requests (sensitive data like passwords, credit cards numbers etc..).

excludeHeaders

Array of strings - pass the header names you wish to exclude from the audit (senstitive data like authorization headers etc..). * field - exclude all headers

maskHeaders

Array of strings - pass the fields you wish to mask in the headers of the requests (senstitive data like authorization headers etc..).

##### maxBodyLength

Restrict request body's logged content length (inputs other than positive integers will be ignored).

customMaskBodyFunc

Additional to mask options, you can add your own functionality to mask request body. This function will execute as a masking function before the package functions. The custom function gets the full express request and should return the masked body.

response

Specific configuration for responses

Doesn't print headers for Node below v6.9.2

Non JSON responses are not masked, and are logged as is. This is deducted from the response header content-type

audit

Boolean - true - include response in audit, false - don't.

excludeBody

Array of strings - pass the fields you wish to exclude in the body of the responses (sensitive data like passwords, credit cards numbers etc..). * field - exclude all body

maskBody

Array of strings - pass the fields you wish to mask in the body of the responses (sensitive data like passwords, credit cards numbers etc..).

excludeHeaders

Array of strings - pass the header names you wish to exclude from the audit (senstitive data like authorization headers etc..). * field - exclude all headers

maskHeaders

Array of strings - pass the fields you wish to mask in the headers of the responses (senstitive data like authorization headers etc..).

##### maxBodyLength

Restrict response body's logged content length (inputs other than positive integers will be ignored).

Example

app.use(audit({
    auditor: function(event) {
        foo.doSomethingWith(event);
    }, 
    excludeURLs: [‘health’, ‘metrics’], // Exclude paths which enclude 'health' & 'metrics'
    request: {
        maskBody: [‘password’], // Mask 'password' field in incoming requests
        excludeHeaders: [‘authorization’], // Exclude 'authorization' header from requests
        excludeBody: [‘creditCard’], // Exclude 'creditCard' field from requests body
        maskHeaders: [‘header1’], // Mask 'header1' header in incoming requests
        maxBodyLength: 50 // limit length to 50 chars + '...'
    },
    response: {
        maskBody: [‘session_token’] // Mask 'session_token' field in response body
        excludeHeaders: [*], // Exclude all headers from responses,
        excludeBody: [*], // Exclude all body from responses
        maskHeaders: [‘header1’], // Mask 'header1' header in incoming requests
        maxBodyLength: 50 // limit length to 50 chars + '...'
    }
}));

Install

npm i express-request-audit

DownloadsWeekly Downloads

9

Version

1.0.3

License

Apache-2.0

Unpacked Size

93.1 kB

Total Files

12

Last publish

Collaborators

  • avatar