mozilla / openwpm-webext-instrumentation

OpenWPM instrumentation library for WebExtensions. Merged into the main OpenWPM repository, thus archived

OpenWPM instrumentation library for WebExtensions

Allows WebExtensions to track and monitor privacy-related browsing behavior

Installation

This package is yet to be published to npm, but can be installed directly from Github as follows:

npm install --save mozilla/openwpm-webext-instrumentation

Instrumentation

The instrumentation leverages the available JavaScript APIs for WebExtensions and listens to navigation, web requests, cookie modifications and access to certain javascript API:s, as described in the main OpenWPM project README under the following bullet points:

• HTTP Request and Response Headers, redirects, and POST request bodies
• Javascript Calls
• Response body content
• Cookie Access (Experimental)

More specifically, all packets sent by the instrumentation conform to these interfaces.

Usage

The instrumentation is designed to invoke a dataReceiver object whenever a packet or log entry is available.

Pending proper documentation, the best way to see how this library is used is to check how the instrumentation is incorporated into the following projects:

• https://github.com/citp/OpenWPM/tree/develop
• https://github.com/motin/jestr-pioneer-shield-study

openwpm-webext-instrumentation's Issues

CODE_OF_CONDUCT.md file missing

As of January 1 2019, Mozilla requires that all GitHub projects include this CODE_OF_CONDUCT.md file in the project root. The file has two parts:

1. Required Text - All text under the headings Community Participation Guidelines and How to Report, are required, and should not be altered.
2. Optional Text - The Project Specific Etiquette heading provides a space to speak more specifically about ways people can work effectively and inclusively together. Some examples of those can be found on the Firefox Debugger project, and Common Voice. (The optional part is commented out in the raw template file, and will not be visible until you modify and uncomment that part.)

If you have any questions about this file, or Code of Conduct policies and procedures, please see Mozilla-GitHub-Standards or email [email protected].

(Message COC001)

Wiki changes

FYI: The following changes were made to this repository's wiki:

• defacing spam has been removed

• Restricting write access to contributors is strongly encouraged. Please make that change (documentation).

These were made as the result of a recent automated defacement of publically writeable wikis.