Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

retire

2.2.1 • Public • Published

Command line scanner looking for use of known vulnerable js files and node modules in web projects and/or node projects.

Install

npm install -g retire

Usage

Usage: retire [options]

Options:

  -h, --help               output usage information
  -V, --version            output the version number

  -p, --package            limit node scan to packages where parent is mentioned in package.json (ignore node_modules)
  -n, --node               Run node dependency scan only
  -j, --js                 Run scan of JavaScript files only
  -v, --verbose            Show identified files (by default only vulnerable files are shown)
  -x, --dropexternal       Don't include project provided vulnerability repository
  -c, --nocache            Don't use local cache

  --jspath <path>          Folder to scan for javascript files
  --nodepath <path>        Folder to scan for node files
  --path <path>            Folder to scan for both
  --jsrepo <path|url>      Local or internal version of repo
  --noderepo <path|url>    Local or internal version of repo
  --cachedir <path>        Path to use for local cache instead of /tmp/.retire-cache
  --proxy <url>            Proxy url (http://some.sever:8080)
  --outputformat <format>  Valid formats: text, json, jsonsimple, depcheck (experimental) and cyclonedx
  --outputpath <path>      File to which output should be written
  --ignore <paths>         Comma delimited list of paths to ignore
  --ignorefile <path>      Custom ignore file, defaults to .retireignore / .retireignore.json
  --severity <level>       Specify the bug severity level from which the process fails. Allowed levels none, low, medium, high, critical. Default: none
  --exitwith <code>        Custom exit code (default: 13) when vulnerabilities are found
  --colors                 Enable color output (console output only)
  --insecure               Enable fetching remote jsrepo/noderepo files from hosts using an insecure or self-signed SSL (TLS) certificate
  --cacert <path>          Use the specified certificate file to verify the peer used for fetching remote jsrepo/noderepo files

The depcheck output format mimics the output of OWASP Dependency Check, but lacks some information compared to OWASP Dependency Check, because that information is not in the repo. The cyclonedx output format is based on based on the https://github.com/CycloneDX spec.

.retireignore

@qs                                                             # ignore this module regardless of location
node_modules/connect/node_modules/body-parser/node_modules/qs   # ignore specific path

Due to a bug in ignore resolving, please upgrade to >= 1.1.3

.retireignore.json

[
    {
        "component": "jquery",
        "identifiers" : { "issue": "2432"},
        "justification" : "We dont call external resources with jQuery"
    },
    {
        "component": "jquery",
        "version" : "2.1.4",
        "justification" : "We dont call external resources with jQuery"
    },
    {
        "path" : "node_modules",
        "justification" : "The node modules are only used for building - client side dependencies are using bower"
    }

]

Source code / Reporting an issue

The source code and issue tracker can be found at https://github.com/RetireJS/retire.js

Keywords

none

Install

npm i retire

DownloadsWeekly Downloads

32,101

Version

2.2.1

License

Apache-2.0

Unpacked Size

41.3 kB

Total Files

14

Last publish

Collaborators

  • avatar
  • avatar