{"id":13762851,"url":"https://github.com/zaproxy/browser-extension","last_synced_at":"2025-05-10T15:32:05.027Z","repository":{"id":167277588,"uuid":"494540825","full_name":"zaproxy/browser-extension","owner":"zaproxy","description":null,"archived":false,"fork":false,"pushed_at":"2025-05-05T14:13:12.000Z","size":4716,"stargazers_count":30,"open_issues_count":4,"forks_count":11,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-05-07T17:05:43.128Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zaproxy.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"custom":["https://www.zaproxy.org/sponsor/"]}},"created_at":"2022-05-20T16:47:48.000Z","updated_at":"2025-05-05T11:17:52.000Z","dependencies_parsed_at":"2025-02-12T19:29:08.945Z","dependency_job_id":"74219b3a-4649-445f-ae8b-5eeab4d8ebe7","html_url":"https://github.com/zaproxy/browser-extension","commit_stats":null,"previous_names":["zaproxy/browser-extension"],"tags_count":8,"template":false,"template_full_name":"abhijithvijayan/web-extension-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zaproxy%2Fbrowser-extension","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zaproxy%2Fbrowser-extension/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zaproxy%2Fbrowser-extension/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zaproxy%2Fbrowser-extension/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zaproxy","download_url":"https://codeload.github.com/zaproxy/browser-extension/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253436681,"owners_count":21908386,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T14:00:59.100Z","updated_at":"2025-05-10T15:32:05.015Z","avatar_url":"https://github.com/zaproxy.png","language":"TypeScript","funding_links":["https://www.zaproxy.org/sponsor/"],"categories":["Weapons"],"sub_categories":["Browser Addons"],"readme":"# ZAP Browser Extensions\n\nThis repo defines 2 related ZAP browser extensions.\n\n## The 'Full' Extension\n\nA browser extension which allows [ZAP](https://www.zaproxy.org) to interact directly with the browser.\nIt also allows you to record whatever you do in a browser as [Zest](https://github.com/zaproxy/zest) scripts.\nThese can be used to handle complicated authentication flows or sequences of related actions.\n\n[![ZAP Chat: Modern Apps Part 1](https://img.youtube.com/vi/Rq_d7OLmMfw/0.jpg)](https://www.youtube.com/watch?v=Rq_d7OLmMfw)\n\nWorks in both Firefox and Chrome.\n\nInitially generated from https://github.com/abhijithvijayan/web-extension-starter/tree/react-typescript\n\nOnly Firefox and Chrome have been tested - Opera may or may not work :wink:\n\nThis extension is bundled in the ZAP [Client Side Integration](https://www.zaproxy.org/docs/desktop/addons/client-side-integration/)\nadd-on, so you typically do not need to install it manually.\n\n\nThe latest published extensions are still available via the relevant stores:\n\n* Firefox [ZAP by Checkmarx Browser Extension](https://addons.mozilla.org/en-GB/firefox/addon/zap-browser-extension/)\n* Chrome [ZAP by Checkmarx Browser Extension](https://chromewebstore.google.com/detail/zap-by-checkmarx-browser/cgkggmillbmmpokepnicllalaohphffo)\n\n## The Recorder Extension\n\nThis extension only allows you to record [Zest](https://github.com/zaproxy/zest) scripts in the browser.\nIt will not interact with ZAP, even if you have it running.\n\nYou can use this extension to record Zest scripts on a system on which ZAP is not running.\n\nThe latest published extensions will be available via the relevant stores:\n\n* Firefox - [ZAP by Checkmarx Recorder](https://addons.mozilla.org/en-GB/firefox/addon/zap-by-checkmarx-recorder/)\n* Chrome - ZAP by Checkmarx Recorder TBA\n\n## Quick Start\n\nEnsure you have\n\n- [Node.js](https://nodejs.org) 16 or later installed\n- [Yarn](https://yarnpkg.com) v1 or v2 installed\n\nThen run the following:\n\n- `yarn install` to install dependencies.\n- `yarn run dev:chrome` to start the development server for the full chrome extension\n- `yarn run dev:firefox` to start the development server for the full firefox addon\n- `yarn run dev:opera` to start the development server for the full opera extension\n- `yarn run build:ext:chrome` to build the full chrome extension\n- `yarn run build:ext:firefox` to build the full firefox addon\n- `yarn run build:ext:opera` to build the full opera extension\n- `yarn run build:ext` builds and packs the full extensions all at once to extension/ directory\n- `yarn run build:rec:chrome` to build the recorder chrome extension\n- `yarn run build:rec:firefox` to build the recorder firefox addon\n- `yarn run build:rec:opera` to build the recorder opera extension\n- `yarn run build:rec` builds and packs the recorder extensions all at once to extension/ directory\n- `yarn run build` builds and packs both the full and recorder extensions all at once to extension/ directory\n- `yarn run lint` to lint the code\n- `yarn run lint --fix` to fix any lint errors\n- `yarn run test` to run the test suite (you should not have anything listening on port 8080)\n  - Note that individual tests can be run like `yarn run test -t \"Should report forms\"`\n\n\n### Development\n\n- `yarn install` to install dependencies.\n- To watch file changes in development\n\n  - Chrome\n    - `yarn run dev:chrome`\n  - Firefox\n    - `yarn run dev:firefox`\n  - Opera\n    - `yarn run dev:opera`\n\n- **Load extension in browser**\n\n- ### Chrome\n\n  - Go to the browser address bar and type `chrome://extensions`\n  - Check the `Developer Mode` button to enable it.\n  - Click on the `Load Unpacked Extension…` button.\n  - Select your browsers folder in `extension/`.\n\n- ### Firefox\n\n  - Load the Add-on via `about:debugging` as temporary Add-on.\n  - Choose the `manifest.json` file in the extracted directory\n\n- ### Opera\n\n  - Load the extension via `opera:extensions`\n  - Check the `Developer Mode` and load as unpacked from extension’s extracted directory.\n\n### Production\n\n- `yarn run build` builds the extension for all the browsers to `extension/BROWSER` directory respectively.\n\n\n### Linting \u0026 TypeScript Config\n\n- Shared Eslint \u0026 Prettier Configuration - [`@abhijithvijayan/eslint-config`](https://www.npmjs.com/package/@abhijithvijayan/eslint-config)\n- Shared TypeScript Configuration - [`@abhijithvijayan/tsconfig`](https://www.npmjs.com/package/@abhijithvijayan/tsconfig)\n\n## Licenses\n\n### ZAP Code\n\nAll of the ZAP specific code is licensed under ApacheV2 © The ZAP Core Team\n\n### Web Extension Starter\n\nThe Web Extension Starter is licensed under MIT © [Abhijith Vijayan](https://abhijithvijayan.in)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzaproxy%2Fbrowser-extension","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzaproxy%2Fbrowser-extension","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzaproxy%2Fbrowser-extension/lists"}