joaquin6 / tusk

🐘 🔒 KeePass-compatible browser extension for filling passwords.

Tusk

A modern, clean keepass browser extension built with Vue.js and kdbxweb. Rebooted from perfectapi/CKP

Installation

Firefox: https://addons.mozilla.org/en-GB/firefox/addon/keepass-tusk/

Chrome: https://chrome.google.com/webstore/detail/fmhmiaejopepamlcjkncpgpdjichnecm

User Guide

This section provides how-to instructions for various features of Tusk.

• WebDAV Support - Support for WebDAV file servers.
• Custom Fields - list of custom fields that Tusk supports.
• Warnings and Errors - An explanation of the messages you may encounter.

How it works: Implementation Details

This section provides in-depth information about how tusk works under the hood. We aim to provide better transparency and give users peace-of-mind. Tusk may not be perfect, but it's better than proprietary black-box applications that hide design flaws from the community.

• Credential Cache Memory - How Tusk can optionally keep your master password cached.
• Sensitive Data - How Tusk handles sensitive data like KeePass databases and keyfiles.

Build Setup

Tusk requires:

• node
• npm
• yarn

# install dependencies
yarn install

# build static DLL resources (optional)
yarn build-dll

# build for production with minification
yarn build

# run the packer script targeted for 'chrome' and 'firefox' after build.
# this step generates the zip archives submitted to Chrome/Firefox addon marketplaces.
yarn bundle

# static reload with file watch for tests
yarn dev-tests

For detailed explanation on how things work, consult the docs for vue-loader.

Running tests

To run tests, first build them with yarn build-tests or yarn watch-tests then open tests/test.html in a browser.

Browser Permissions

Tusk requires cross-origin permissions in order to inject credentials and query the storage backends on the user's behalf.

In chrome, these permissions requests are always prompted to the user upon first use.

Because of Firefox's implementation of browser.permissions, it was necessary to request all permissions at install time to avoid code rot. A deeper explanation of the firefox permissions can be found on stackoverflow

FAQ

Why is it called Tusk?!

I originally wanted to call it Elephant, as in An elephant never forgets. I tried this name on a couple of friends and they were unimpressed. I wanted to find a name that was more concise but keep the elephant imagery. Ergo, tusk.

What happened to CKPX?

This is it! CKPX has been rebranded as Tusk to mark its Firefox release. The C in CKPX stood for 'Chrome'.

Can I donate money?

I don't want your money. Take whatever you would have given me and find a local charity -- a food bank, a women's shelter or an animal shelter, for example. Enjoy your free software.

So how can I support Tusk?

If you ❤️ Tusk, please consider leaving a positive review on the Firefox Add-on store or the Chrome webstore - I'll be eternally grateful.

Who made that awesome logo?

A super cool artist and graphic designer named Gabriel Garcia! Thanks for our logo!