pbkhrv / ulauncher-keepassxc

Ulauncher extension to quickly search a KeePassXC password manager database

ulauncher-keepassxc

A Ulauncher extension to search your KeePassXC password manager database and copy passwords to the clipboard.

Features

• Quickly search through the database entries by name, and copy passwords/usernames/URLs to the clipboard
• Work with any file (.kdbx etc) that can be accessed by the KeePassXC itself via the keepassxc-cli command line tool
• Support files locked with a passphrase. The extension asks for the passphrase and stores it in memory for a configurable amount of time
• Doesn't require the KeePassXC app to be running

Requirements

• Install a recent version of KeePassXC (tested with 2.4.3, 2.5.0 and 2.6.6)
• Make sure you can execute keepassxc-cli in a terminal without errors

Installation

Open Ulauncher preferences window -> Extensions -> "Add extension" and paste the following url:

https://github.com/pbkhrv/ulauncher-keepassxc

Configuration

• Password database location: path to the password database file that you want to access through Ulauncher. This is the only preference that you need to set before you can use the extension.

• Inactivity lock timeout: forces you to re-enter the passphrase after you haven't used the extension for a while. By default it's set to 600 seconds (10 minutes). If you'd rather not re-enter it, you can set the value to 0, but that's probably not a great idea. NOTE: The cached passphrase is only stored in memory, so you'll need to re-enter it if you reboot your computer or restart Ulauncher.

Usage

Open Ulauncher and type in "kp " to start the extension. If your password database is locked with a passphrase, it'll ask you to enter it:

Once unlocked, search the database for Github logins:

Look at the Github work entry:

Troubleshooting

Why doesn't the passphrase window come to the foreground when it's asking me to unlock the database?

Please install wmctrl - it's a utility that ulauncher-keepassxc calls to "activate" the passphrase window and bring it to the top:

Ubuntu and Debian

sudo apt-get install wmctrl

Development

I use the following tools while working on this extension:

• Black code formatter
• pytest
• pylint with the flake8 plugin
• mypy static type checker

You can install them in one shot (except for Black - that's up to you) by running:

pip install -r scripts/requirements.txt

Check PEP8 compliance, perform static type analysis and run unit tests:

make test

Backup the "production" version of the extension and symlink the development version into Ulauncher's extension directory:

make symlink

Quit Ulauncher. Then run it in debug mode:

make run_ul

Run extension in the terminal, connect it to Ulauncher in debug mode:

make run

(if that doesn't work, check the connection string URL printed out by Ulauncher and modify the Makefile accordingly.)

Unlink the development version of the extension from Ulauncher and replace it with whatever was there before:

make unlink

Contributions

Issues and pull requests are welcome!

Inspiration and thanks

I loved Alfred on MacOS, and now I love Ulauncher on Linux. The Python API is a joy to work with.

Thanks to pass-ulauncher for the overall structure and for teaching me a few things about the API. I aaaalmost switched away from KeePassXC to pass: the standard unix password manager because of it.

The Noun Project for the icons - there's nothing else quite like it.

Finally, thanks to KeePassXC on Linux and KyPass on iOS.

License

MIT license. See LICENSE file for details.

ulauncher-keepassxc's Issues

make "recent active entries" list size configurable

Return to the search term if backspace is pressed after selecting an entry

unlocking the db doesnt work

...because path expansion fix...

Support TOTP passwords

Please upvote if you'd like this feature.

speedup get_entry_details with single call to cli

right now cli is called for every entry attribute. Call it once with a bunch of attributes as a list and parse results. ("Notes" should be the last one because multiline)

Configurable title format / Allow showing username with title

Use case:
I have some websites with multiple accounts and the entries all appear the same, so I don't know which account I am selecting.

Support yubikey for unlocking the database

Please upvote if you would like this feature.

Ability to generate and save a new password

Simplest workflow:

• User enters "kp new entry title"
• Ext displays search results and "Generate and save password / Create 'new entry title'"
• User selects "Generate..." and presses Enter
• Ext runs keepassxc-cli add -g database_path "new entry title"
• Ext copies the new password to the clipboard

(Password length and generation options can be made configurable, passed as CLI options)

One downside of this approach is that there's not a straightforward way to specify username or URL for the new entry. There might be a ulauncher-centric solution for that, need to think about it.

Multiple databases

It would be great to be able to handle multiple databases (maybe each of them which a dedicated search string configured).

Use fuzzy search instead of whatever "keepasxc-cli locate" does

Doing our own searching of entry names requires having fast access to the full list of entries stored in a particular database. How?

• Option 1: run "keepassxc-cli ls" every time, parse the output, run regex on it
• Option 2: run "keepassxc-cli ls" periodically, maintain the entry list in memory and search through that instead

The Plan:

• Implement and test option 1 for speed and responsiveness
• IF option 1 proves to be too slow, implement option 2

Option 2 implementation:

• Run "ls" when database is unlocked
• Run "ls" whenever database file changes - launch a separate monitor thread when extension starts up and use pyinotify to watch the database file for changes
• Compile a regex based on query, then call .search on it: "gith wor" -> r"gith.*?wor"

Support for key file to unlock the database

Show database path when asking user to unlock database

The "Unlock KeePassXC database" message should show the database file path in the description

Passphrase entry window not on top after being instantiated for the 2nd+ time

add "Return to search results" item to the bottom of the active entry item list

should restore the query arg, just like we do around "check_and_reset_search_restore"

use a nice back-arrow icon from nounproject

speed up search results by caching for short amount of time

Search results show up slow-ish, which is especially visible when you select an entry, then press backspace to return to search results

a cache of about 60 seconds should be enough?

error searching keepass database

In the last few days I started having a problem searching my keepass database using the keepass search extension. I attached a screenshot of the error message. The error is resolved after changing "locate" to "search" on line 127 of keepassxc_db.py file.
I apologize for not using the proper formatting, as I'm not a coder. Just want to let the creator know so the change can be made if needed

.

Show database path when unable to find the file

The "Cannot find the database file" item should show the database file path in the description

show "recently accessed entries" instead of no results if query is empty

• Every time an entry is "activated", add it to the top of "recently accessed entries" list. Dedup the list.
• when no query arg is specified AND database is unlocked, show recently accessed entries

Passphrase entry window name/icon is confusing

dont highlight "copy ... to clipboard" actions

Make keepassxc-cli name/path configurable

error in searching keepassxc database

ulauncher-keepassxc/keepassxc/keepassxc_db.py

Line 127 in 11309e2

(err, out) = self.run_cli("locate", "-q", self.path, query)

I attached a screenshot of the error I am getting in the last few days when trying to search my keepass database. The error is resolved by changing the word "locate" to "search" in the referenced line

.

Forget passphrase when database-path preference updated

Handle preference update event and un-initialize the database object.

Display notes more gracefully

test with the KeePassXC 2.5 CLI and fix possible issues

https://keepassxc.org/blog/2019-10-26-2.5.0-released/

Can't find the database file, no matter what

I've tried moving my kdbx, I've tried renaming it, I've tried creating a symlink with the default name. No matter what I do, I get "cannot find the database file."

We could troubleshoot this, but it seems more sensible to suggest a file chooser.