retire.js - scanner detecting the use of JavaScript libraries

项目说明

Retire.js

What you require you must also retire

There is a vast ecosystem of Ja libraries a for both web and Node.js applications. While these libraries significantly accelerate de, they also require ongoing maintenance to ensure security are addressed promptly. In 2013, “Using Components with Known ” was added to the OWASP Top 10 list of critical security risks, highlighting the serious threat that outdated or insecure dependencies can pose to web applications. Retire.js was created to help de identify Ja library with known , especially those that are not in package manifests, but simply downloaded and put in source control.

Retire.js can be used in many ways:

1. As command line scanner
2. As a Chrome extension - Not officially a in the Chrome web store
3. As a Burp Extension or OWASP ZAP Add-on
4. As a Firefox extension - Deprecated Let us know if you want to maintain and undeprecate it.
5. A headless web site scanner
6. As a grunt plugin (deprecated)
7. As a gulp task (deprecated)

Command line scanner

Scan a web app or node app for use of Ja libraries and/or Node.JS modules. If you haven't already, you need to install node/npm first. In the source code folder of the application folder run:

SBOM generation

retire.js can generate SBOMs in the CycloneDX-format:

cyclonedx produces CycloneDX 1.4 XML. For JSON, and for newer spec , use cyclonedxJSON (1.4), cyclonedxJSON1_6 or
cyclonedxJSON1_7. The cyclonedxJSON1_6_VEX and cyclonedxJSON1_7_VEX also include a section.

By default retire.js will exit with code 13 if it finds . This can be o with --exitwith 0.

Chrome and firefox extensions

Scans sites for references to insecure libraries, and puts warnings in the de console. An icon on the address bar displays will also indicate if libraries were loaded.

Burp Extension and OWASP ZAP Add-on

has adapted Retire.js as a plugin for the penetration testing tools Burp and OWASP ZAP.

The OWASP ZAP team officially supports a Retire.js add-on which is a via the ZAP Marketplace and is included by default in the ZAP weekly releases:

Headless site scanner

The retire-site-scanner can be used to scan a web site in headless mode (as opposed to using the chrome/firefox extensions)

Grunt plugin (deprecated)

A Grunt task for running Retire.js as part of your application's build routine, or some other automated workflow.

Gulp task (deprecated)

An example of a Gulp task which can be used in your gulpfile to watch and scan your project files automatically. You can modify the watch patterns and (optional) Retire.js options as you like.

Donate

<a href=" src="

Donations will be used to fund the maintainance of the tool and repo.

项目信息

开发语言：JavaScript

Star 数：4180

技术要点

该项目属于安全软件方向的开源资源，代码结构清晰，适合安全研究人员学习参考。项目围绕scanner detecting the use of JavaScript libraries with known vulnerabilities. Can also generate an SBOM of the libraries it finds.展开，提供了可运行的实现，对理解相关安全机制、工具原理与攻防技术具有较高的研究价值。

从技术实现角度看，此类项目的核心在于对底层原理的深入理解与工程化落地。开发者在研究过程中可以结合官方文档与社区讨论，梳理项目的初始化流程、核心模块职责与数据流转，逐步掌握其中的技术细节与设计思路。

使用与学习建议

1. 下载源码压缩包，解压到本地环境。

2. 根据项目类型准备对应的运行环境与依赖。

3. 按照 README 中的步骤完成配置与部署。

4. 在隔离的测试环境中运行验证，避免影响生产系统。

免责声明

本资源来源于开源社区，仅供安全研究、技术学习与合法授权范围内的攻防演练使用，请勿用于任何非法或侵害他人权益的用途。使用本项目产生的一切后果由使用者自行承担。