Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Global Consent Manager

This public repository is used to publish a Firefox web extension.

This extension streamlines the user's consent experience while on GDPR-regulated websites.

Our list of currently supported websites can be found in this file

Installation: Firefox add-on

  1. Navigate to the GCM add-on page at:
    https://addons.mozilla.org/en-US/firefox/addon/global-consent-manager/?src=search
  2. Click "add" and enjoy Global Consent Manager!

Installation: npm (development)

  1. Download this repository to a location of your choice.

  2. Install Web-Ext from Mozilla's Github Repository here: https://github.com/mozilla/web-ext

  3. Install Global-Consent-Manager in its directory:

npm install
  1. After the installation, you can run the program with the following command:
npm start

This will also launch Web-Ext.

If you want to test your code for validity, use this command:

npm test

How to use this Web Extension

Global Consent Manager will do almost all of the work for you. Your consent is managed on every supported website.

Supported Sites

If the domain you are on is registered by Global Consent Manager, it will not show consent dialogs on first visit.
If so, you can toggle the button labeled "Block Consent Dialog" to hide or show consent dialogs on this page.
-If the toggle switch status is "ON", supported sites will proceed normally.
-If the toggle switch status is "OFF", supported sites will not provide consent dialogs.

Unsupported Sites

If you see a consent dialog on first visit, the site is probably not registered by Global Consent Manager.
In this case, please click the button labeled "Report Missing Site..." and present an issue on GitHub.
This will be automatically populated, but feel free to customize it.

Note: The button will change its label depending on the domain.

If you are ready to contribute to Global Consent Manager, a simple process will have a new site added to the extension. Here are the steps to contribute support for a new site to GCM.

Adding a Supported Site, Part 1: Cookies

  1. Open the site in web-ext and manually decline consent. You should stop seeing the consent dialog.
  2. In Developer Tools, remove the cookies set by the site, and reload the page.
  3. If removing a cookie brings back the dialog, you have found the consent cookie! Add an entry in sites.js:
    {
       // Working 3/26/2019 (M)
       domain: "thelocal.es",
       name: "euconsent",
       value: "BOTRKYzOTRKYzABABBENBdAAAAAgWAAA",
   },

Adding a Supported Site, Part 2: Selectors

  1. Open the file sites.js
  2. Navigate to the website you would like to add to GCM
  3. Right click on the consent dialog and choose Inspect Element
  4. Find the highest level class or ID that holds the consent dialog, but doesn't affect the page if it is gone.
  5. Add the consent dialog to the site list in sites.js with the following formats:
   {
       // Working THEDATE (NAME)
       domain: "WEBSITE.URL",
       selector: ".CLASS_I_FOUND",
   },
   {
       // Working THEDATE (NAME)
       domain: "WEBSITE.URL",
       selector: "#ID_I_FOUND",
   },

This process may require some trial and error or multiple targets so it is best to use developer tools like web-ext listed above.
      6. Finally, submit a pull request to this repository and it will be reviewed and tested.

Licensing and Copyright

All source code copyright is retained by the contributors. All contriubtions and source code are licensed under the MIT license.

Copyright (c) 2018 Global-Consent-Manager Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contributions

Javascript WebExtension APIs used for the project are (c) Mozilla MDN.
This content is dedicated to the Public Domain. http://creativecommons.org/publicdomain/zero/1.0/
Source: https://developer.mozilla.org/en-US/Add-ons/WebExtensions/API
WebExtension API packages currently used:
-cookies
-storage
-tabs

The technical specifications and framework that this project depends on are (c) 2018 IAB Technology Laboratory. This content is used under the terms of the MIT License.
Source: https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework

About

Global Consent Manager Project

Resources

License

Releases

No releases published

Packages

No packages published