express-security-txt

Express Security Txt

Express middleware that implements a security.txt path and policy

References:

• security.txt rfc
• security.txt project on github

Installation

yarn add express-security-txt

Usage

Define an options object with the proper fields that make up a valid security.txt policy, and use it as a middleware for an express app.

const securityTxt = require('express-security-txt')

const options = {
  contact: '[e-mail]',
  encryption: 'https://www.mykey.com/pgp-key.txt',
  acknowledgement: 'thank you'
}

app.use(securityTxt.setup(options))

Tests

Project tests:

yarn run test

Project linting:

yarn run lint

Coverage

yarn run test:coverage

Contributing

Commit Guidelines

The project uses the commitizen tool for standardizing changelog style commit messages so you should follow it as so:

git add .           # add files to staging
yarn run commit      # use the wizard for the commit message