prehistoric-systems/keepassxc-browser
1
0
Fork 0
mirror of https://github.com/keepassxreboot/keepassxc-browser.git synced 2026-03-11 08:54:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
KeePassXC Browser Extension
944 commits 22 branches 132 tags 16 MiB
JavaScript 74.3%
HTML 17.3%
CSS 6.1%
TypeScript 2.3%
Find a file
varjolintu 98eb4ab0a9
Use native KeePassXC password generator (2.7.0+)
2021-10-16 21:21:58 -04:00
.github Update KeePassXC-Browser Patreon page to FUNDING.yml 2020-08-09 22:59:56 +03:00
.tx Improve the build script 2019-04-10 14:43:50 +03:00
keepassxc-browser Use native KeePassXC password generator (2.7.0+) 2021-10-16 21:21:58 -04:00
tests Support for triggering Global Auto-Type 2021-10-10 14:52:43 +03:00
.editorconfig Add editorconfig 2020-02-28 14:03:53 +01:00
.eslintrc Ignore Auto-Submit option for Site Preferences 2021-03-24 08:33:58 +02:00
.gitignore No jQuery 2019-04-09 08:06:48 +03:00
build.js Update version number. Delete unsupported parameter from Firefox build. 2020-07-09 17:52:16 +03:00
CHANGELOG Update changelog 2021-03-30 17:03:11 +03:00
keepassxc-protocol.md Use native KeePassXC password generator (2.7.0+) 2021-10-16 21:21:58 -04:00
LICENSE Initial commit 2017-03-27 07:28:17 +03:00
package-lock.json Update package JSON scripts 2021-09-26 21:24:27 +03:00
package.json Update package JSON scripts 2021-09-26 21:24:27 +03:00
README.md Update README.md with current setup URL (#1056) 2020-10-21 17:01:55 +02:00
run_tests.js Content script tests 2020-12-20 17:57:34 +02:00

README.md

KeePassXC-Browser

Browser extension for KeePassXC with Native Messaging.

Based on pfn's chromeIPass. Some changes merged also from smorks' KeePassHttp-Connector.

Download and use

This browser extension was first supported in KeePassXC 2.3.0 (release end of 2017). In general it is advised to only use the latest available release.

Get the extension for Firefox or Chrome/Chromium or Microsoft Edge (requires KeePassXC 2.5.3 or newer).

Please see this document for instructions how to configure KeePassXC in order to connect the database correctly.

How it works

KeePassXC-Browser communicates with KeePassXC through keepassxc-proxy. The proxy handles listening to STDIN/STDOUT and transfers these messages through Unix domain sockets / named pipes to KeePassXC. This means KeePassXC can be used and started normally without inteference from Native Messaging API. KeePassXC-Browser starts only the proxy application and there's no risk of shutting down KeePassXC or losing any unsaved changes. You don't need to install keepassxc-proxy separately. It is included in the KeePassXC application package. Alternatively you can use keepassxc-proxy-rust as a proxy if you prefer a non-Qt solution.

Requested permissions

KeePassXC-Browser extension requests the following permissions:

Name Reason
activeTab To get URL of the current tab
contextMenus To show context menu items
clipboardWrite Allows password to be copied from password generator to clipboard
nativeMessaging Allows communication with KeePassXC application
notifications To show browser notifications
storage For storing extension settings to localStorage
tabs To request tab URL's and other info
webNavigation To show browser notifications on install or update
webRequest For handling HTTP Basic Auth
webRequestBlocking For handling HTTP Basic Auth
http://*/* To allow using KeePassXC-Browser on all websites
https://*/* To allow using KeePassXC-Browser on all websites
https://api.github.com/ For checking the latest KeePassXC version from GitHub

Protocol

The details about the messaging protocol used with the browser extension and KeePassXC can be found here.

Translations

Translations are managed on Transifex which offers a web interface. Please join an existing language team or request a new one if there is none.

Development and testing

See wiki.