security-txt-node-parser
TypeScript icon, indicating that this package has built-in type declarations

1.0.4 • Public • Published

security.txt Node Parser

parsing security.txt documents, zero dependencies, based on draft-foudil-securitytxt-09

Installing

npm install security-txt-node-parser

Example

const parseSecurityTxt = require('security-txt-node-parser').default
 
const securityTxt = await fetch('https://securitytxt.org/.well-known/security.txt')
    .then(resp => resp.text())
    .then(text => parseSecurityTxt(text))
 
console.log(securityTxt.contact[0]) // https://hackerone.com/ed

Options

These options are avaliable

parseSecurityTxt(document, {
    strict: true,
    parseUrls: true,
    parseDates: true
})
property default description
strict false if strict is true, an error will be thrown if the document is invalid
parseUrls false if parseUrls is true, any urls will be wrapped in the URL object
parseDates false if parseDates is true, any dates will be wrapped in the Date object

Licence

This project is licensed under the MIT License - see the LICENSE file for details

Package Sidebar

Install

npm i security-txt-node-parser

Weekly Downloads

17

Version

1.0.4

License

MIT

Unpacked Size

15.3 kB

Total Files

8

Last publish

Collaborators

  • movitz-s