https://github.com/zaproxy/browser-extension

https://github.com/zaproxy/browser-extension

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/zaproxy/browser-extension
• Owner: zaproxy
• License: apache-2.0
• Created: 2022-05-20T16:47:48.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-21T10:05:03.000Z (5 months ago)
• Last Synced: 2024-11-09T02:02:45.493Z (3 months ago)
• Language: TypeScript
• Size: 4.16 MB
• Stars: 28
• Watchers: 8
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• WebHackersWeapons - ZAP Browser Extension - extension/?label=%20)|[`browser-record`](/categorize/tags/browser-record.md)|[](/categorize/langs/TypeScript.md)| (Weapons / Browser Addons)

README

        
# ZAP Browser Extension

A browser extension which allows [ZAP](https://www.zaproxy.org) to interact directly with the browser.

[![ZAP Chat: Modern Apps Part 1](https://img.youtube.com/vi/Rq_d7OLmMfw/0.jpg)](https://www.youtube.com/watch?v=Rq_d7OLmMfw)

Works in both Firefox and Chrome but does not provide any useful functionality unless it is used with ZAP.

Initially generated from https://github.com/abhijithvijayan/web-extension-starter/tree/react-typescript

Only Firefox and Chrome have been tested - Opera may or may not work :wink:

The latest published extensions are also available via the relevant stores:

* Firefox [ZAP Browser Extension](https://addons.mozilla.org/en-GB/firefox/addon/zap-browser-extension/)

* Chrome [ZAP Browser Extension](https://chrome.google.com/webstore/detail/zap-browser-extension/emeijcecholonbcbehmjpfbfbdoahcjg)

## Quick Start

Ensure you have

- [Node.js](https://nodejs.org) 16 or later installed

- [Yarn](https://yarnpkg.com) v1 or v2 installed

Then run the following:

- `yarn install` to install dependencies.

- `yarn run dev:chrome` to start the development server for chrome extension

- `yarn run dev:firefox` to start the development server for firefox addon

- `yarn run dev:opera` to start the development server for opera extension

- `yarn run build:chrome` to build chrome extension

- `yarn run build:firefox` to build firefox addon

- `yarn run build:opera` to build opera extension

- `yarn run build` builds and packs extensions all at once to extension/ directory

- `yarn run lint` to lint the code

- `yarn run test` to run the test suite (you should not have anything listening on port 8080)

  - Note that individual tests can be run like `yarn run test -t "Should report forms"`

### Development

- `yarn install` to install dependencies.

- To watch file changes in development

  - Chrome

    - `yarn run dev:chrome`

  - Firefox

    - `yarn run dev:firefox`

  - Opera

    - `yarn run dev:opera`

- **Load extension in browser**

- ### Chrome

  - Go to the browser address bar and type `chrome://extensions`

  - Check the `Developer Mode` button to enable it.

  - Click on the `Load Unpacked Extension…` button.

  - Select your browsers folder in `extension/`.

- ### Firefox

  - Load the Add-on via `about:debugging` as temporary Add-on.

  - Choose the `manifest.json` file in the extracted directory

- ### Opera

  - Load the extension via `opera:extensions`

  - Check the `Developer Mode` and load as unpacked from extension’s extracted directory.

### Production

- `yarn run build` builds the extension for all the browsers to `extension/BROWSER` directory respectively.

### Linting & TypeScript Config

- Shared Eslint & Prettier Configuration - [`@abhijithvijayan/eslint-config`](https://www.npmjs.com/package/@abhijithvijayan/eslint-config)

- Shared TypeScript Configuration - [`@abhijithvijayan/tsconfig`](https://www.npmjs.com/package/@abhijithvijayan/tsconfig)

## Licenses

### ZAP Code

All of the ZAP specific code is licensed under ApacheV2 © The ZAP Core Team

### Web Extension Starter

The Web Extension Starter is licensed under MIT © [Abhijith Vijayan](https://abhijithvijayan.in)