Skip to content
This repository has been archived by the owner on Jun 22, 2020. It is now read-only.

Latest commit

 

History

History
78 lines (61 loc) · 3.13 KB

README.md

File metadata and controls

78 lines (61 loc) · 3.13 KB
Raw

kpxch

KeePassXC Helper

Provides command-line access to KeePassXC using NaCl and keepassxc-proxy.

Currently it can retrieve passwords, usernames and other fields (custom fields must be prefixed with KPH: (with a space after a colon) to be visible to kpxch).

Other parts of the protocol (link above) can also be implemented (I don't really plan to use them so I didn't add CLI args for them).

usage: kpxch [-h] [-e] [-u] [-p] [-s] [-i] [-f] [-l] [-j] [--shell-escape]
             [--format F] [--fields-format F] [--client ID] [--state FILE]
             [--socket PATH] [-d]
             url [url ...]

Command-line access to KeePassXC using NaCl and keepassxc-proxy.

positional arguments:
  url                  url(s) to print credentials for

optional arguments:
  -h, --help           show this help message and exit
  -e, --entry          print entry name
  -u, --username       print username
  -p, --password       print password (default)
  -s, --string-fields  print string fields
  -i, --uuid           print entry uuid
  -f, --full           print all entry fields
  -l, --list-all       print all matched entries, not just the first one
  -j, --json           print response in json format
  --shell-escape       escape quotes, spaces, variables
  --format F           set format for entry fields. Example: 'index:
                       {index}\nname: {name}\nlogin: {login}\npass:
                       {password}\nuuid: {uuid}\n'. Don't forget the final
                       newline (if you need it).
  --fields-format F    set format for entry string fields. Example:
                       '{key}:{value}\n'
  --client ID          set client id string used for association. defaults to
                       'kpxch'
  --state FILE         set saved association state path. defaults to
                       '${HOME}/.local/share/kpxch/kpxch.state'. if client id
                       is set and this argument isn't used, filename defaults
                       to ${clientId}.state
  --socket PATH        set socket path. defaults to
                       '/run/user/1000/kpxc_server'
  -d, --debug          print debug info

Examples

Get sudo by hostname:

kpxch "kpxch://sudo-$(hostname)" | sudo -S true

Where kpxch://sudo-$(hostname) is an URL of your choice for the entry (kpxch:// doesn't matter, entries can have https:// or anything else for the protocol. Entries without a protocol in the URL may not work).

I recommend putting all relevant info that's needed to identify the entry into the path part and not the protocol because protocol part can be ignored if you set a checkbox in the KeePassXC settings.

Get borg repository password and path:

credentials=$(kpxch -u -p "kpxch://borg-$(hostname)")
BORG_REPO=$(echo "$credentials" | sed '1q;d')         # get first line
BORG_PASSPHRASE=$(echo "$credentials" | sed '2q;d')   # second line

Perhaps, a better way (using process substitution):

{
  read -r user
  read -r password
  echo "User: $user  Pass: $password"
} < <(kpxch -u -p "https://something.com")