Logo

Documentation

For Developers (Help Wanted!)

As AuntieTuna is in alpha stage, there is a lot of polish and work to be done to get the extension to a usable state for the everyday user.

running and debugging the developer version

You can run the latest development version by cloning the git repository, and running the extension using web-ext: the run.sh provides a wrapper around web-ext with lots of useful configuration defaults (e.g., opening a browser console, etc.) and a temporary profile that’s deleted on exit.

See additional instructions on getting up and running in the README

In the AuntieTuna’s options page, you can also enable “Debug mode”: this will run the hashing and detection on every site, ignoring the whitelist.

unordered list of things to do

In addition to general bug reporting, here’s what we need help with:

  • Porting to Google Chrome / Chromium: most of the code was written with Firefox in mind, but should be relatively portable to Chromium-based browsers. There is a polyfill library that “backports” some of the WebExtension features—we need to understand if that’s needed or not.
  • TODO

Please check out the code on GitHub and submit issues or pull requests!

less descriptive list of things to do

This is a rough, unordered list of things to do and things that have been done:

[x] auntietuna: update dexie to 3.0.0-beta.1 -> 0.0.4.2
[x] auntietuna: test auto-update `extensions.update.interval`: set to 120, restart -> 0.0.4.2
[x] auntietuna/popup: move 'download hashes' to debug mode -> 0.0.4.3
[x] auntietuna: use consistent names ("hashes" -> "known-good") -> 0.0.4.3
[x] auntietuna: print browser + version info in debug -> 0.0.4.3
[x] auntietuna/hashes: delete individual known-good entries -> 0.0.4.3
[x] auntietuna/hashes: imported lists can be one entry or many entries -> 0.0.4.3

[ ] auntietuna: button to "disable temporarily"
[ ] auntietuna/hashes: "asset viewer" for each known-good -> codemirror
[ ] auntietuna/hashes: store assets in "bundles" or categories

[ ] auntietuna/content-script: load at `document_start`, then use a DOM watcher?
    <https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver>?
    or a [timer](https://stackoverflow.com/a/13917682)

## chromium

[x] auntietuna/chrome: check [apis](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Browser_support_for_JavaScript_APIs)
[x] auntietuna/chrome: port to chromium (requires polyfill?) -> 0.0.4.3
  <https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Chrome_incompatibilities>
[x] auntietuna/chrome: sideload instructions? -> 0.0.4.3
[x] auntietuna/chrome: publish to chrome store <https://developer.chrome.com/webstore/publish> -> 0.0.4.3

code layout

TODO: A guide on the inner workings of the extension. For now, the research paper is still an accurate representation of the underlying code for AuntieTuna.

Otherwise, the Git repository should be relatively straightforward to navigate through.