git-credential-keepassxc

git-credential-keepassxc is a Git credential helper that allows Git to get/store logins from/to KeePassXC.

It communicates with KeePassXC using keepassxc-protocol which is originally designed for browser extensions.

How to install

  1. Install Rust compiler via rustup or your favourite package manager
  2. Run cargo install git-credential-keepassxc (or cargo install --git https://github.com/Frederick888/git-credential-keepassxc.git for the latest development version)

Note: Make sure $CARGO_INSTALL_ROOT is in your search path.

Configuration

Similar as the browser extensions, git-credential-keepassxc needs to be associated with KeePassXC first.

Run:

sh $ git-credential-keepassxc configure $ git config --global credential.helper keepassxc

A group (by default Git) will be created to store new logins.

Limit callers

git-credential-keepassxc allows you to limit callers (though you should probably have a look at some MAC systems to properly achieve this), for instance:

```sh

don't forget to add yourself first

$ git-credential-keepassxc callers add --uid "$(id -u)" --gid "$(id -g)" "$(readlink -f "$0")"

then allow Git to access KeePassXC when sending emails via SMTP

$ git-credential-keepassxc callers add --uid "$(id -u)" --gid "$(id -g)" "$(command -v git)"

also add other Git executables if you want to e.g. clone via HTTPS

$ git-credential-keepassxc callers add --uid "$(id -u)" --gid "$(id -g)" /usr/lib/git-core/git-remote-http

$ sh -c 'printf "url=https://example.com\nusername=foo\n" | git-credential-keepassxc get' May 10 12:51:56.108 ERRO You are not allowed to use this program, Caused by: N/A, Message: You are not allowed to use this program $ printf 'url=https://example.com\nusername=foo\n' | git credential fill May 10 12:52:53.995 WARN Request get-logins failed. Error: No logins found, Error Code: 15 May 10 12:52:53.995 ERRO Request get-logins failed, Caused by: N/A, Message: Request get-logins failed

disable this function

$ git-credential-keepassxc callers clear ```

Tip

Although currently it's not possible to return entries only from the Git group, you may still want to hide specific ones from Git (for instance GitLab allows only access tokens to clone over HTTPS when 2FA is enabled, so your password may conflict with the token). This can be done by adding a magic attribute to those entries.

  1. In KeePassXC, go to Tools -> Settings -> Browser Integration -> Advanced, enable 'Return advanced string fields which start with "KPH: "' (this is enabled by default)
  2. Open the entry you'd like to hide
  3. Go to Advanced
  4. Add an additional attribute "KPH: git" (without quotes, the space after colon is necessary) of which the value is "false" (without quotes)