KeePassXC

https://keepassxc.org/docs
Admin
KeePassXC is a modern, secure, and open-source password manager that stores and manages passwords...
Tokens:15,141
Snippets:229
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Enable and Start OpenSSH Authentication Agent on Windows

Source: https://keepassxc.org/docs/KeePassXC_UserGuide

Use PowerShell to set the OpenSSH Authentication Agent service to start automatically and then start the service.

```powershell
PS C:\Users\user> Get-Service ssh-agent | Set-Service -StartupType Automatic
PS C:\Users\user> Start-Service ssh-agent
```

--------------------------------

### Unattended Windows Installation

Source: https://keepassxc.org/docs/KeePassXC_GettingStarted

This command demonstrates how to perform an unattended installation of KeePassXC on Windows, disabling the auto-start program feature.

```bash
msiexec.exe /q /i KeePassXC-Y.Y.Y-WinZZ.msi AUTOSTARTPROGRAM=0
```

--------------------------------

### Wildcard URL Examples for Browser Integration

Source: https://keepassxc.org/docs/KeePassXC_UserGuide

These examples demonstrate how to use wildcards in URLs for advanced browser integration settings, allowing for flexible matching of web addresses. Supported from KeePassXC version 2.7.10 onwards.

```plaintext
https://*.example.com
https://example.com/*/path
https://sub.*.example.com/path/*
```

--------------------------------

### Allow Screen Capture via Command Line

Source: https://keepassxc.org/docs/KeePassXC_GettingStarted

Starts KeePassXC with screen capture enabled using a command line flag. This overrides the default behavior that prevents recordings and screenshots.

```bash
--allow-screencapture
```

--------------------------------

### Auto-Type Sequence with Modifiers

Source: https://keepassxc.org/docs/KeePassXC_UserGuide

Example of using modifiers to simulate key combinations. This sequence types CTRL+SHIFT+D, which can be useful for activating specific program actions.

```plaintext
^+d
```

--------------------------------

### Run KeePassXC CLI from AppImage

Source: https://keepassxc.org/docs

Starting from version 2.2.2, you can access the KeePassXC command-line interface (CLI) tool directly from the AppImage by appending the 'cli' argument.

```bash
./KeePassXC-*.AppImage cli
```

--------------------------------

### Set PATH for Git Bash SSH

Source: https://keepassxc.org/docs

Prepend the path to Windows OpenSSH to the PATH variable within Git Bash to ensure Git uses the correct SSH binary. This is an alternative if Windows OpenSSH was not selected during Git installation.

```bash
export PATH="/c/Windows/System32/OpenSSH:$HOME/bin:$PATH"
```

--------------------------------

### Make AppImage Executable

Source: https://keepassxc.org/docs

To run an AppImage, you need to grant it execute permissions. This command sets the execute permission for the downloaded AppImage file.

```bash
chmod +x ./KeePassXC-*.AppImage
```

--------------------------------

### KeePassXC Command-Line Options

Source: https://keepassxc.org/docs/KeePassXC_UserGuide

Lists available command-line options for running KeePassXC. These options allow for customization of application behavior and database handling.

```bash
Usage: keepassxc.exe [options] [filename(s)]
KeePassXC – cross-platform password manager

Options:
  -?, -h, --help               Displays help on commandline options.
  --help-all                   Displays help including Qt specific options.
  -v, --version                Displays version information.
  --config <config>            path to a custom config file
  --localconfig <localconfig>  path to a custom local config file
  --lock                       lock all open databases
  --keyfile <keyfile>          key file of the database
  --pw-stdin                   read password of the database from stdin
  --debug-info                 Displays debugging information.
  --allow-screencapture        Allow screen recording and screenshots

Arguments:
  filename(s)                  filenames of the password databases to open (*.kdbx)
```

--------------------------------

### List Generated SSH Key Files on Linux or macOS

Source: https://keepassxc.org/docs/KeePassXC_UserGuide

Lists the generated private and public SSH key files.

```bash
$ ls -l keepassxc*
-rw------- 1 user group 2.6K Apr  5 07:36 keepassxc
-rw-r--r-- 1 user group  569 Apr  5 07:36 keepassxc.pub
```

--------------------------------

### Connect YubiKey Raw USB Interface for Snap

Source: https://keepassxc.org/docs

To use a YubiKey with the KeePassXC Snap package, you must manually connect the 'raw-usb' interface. This command establishes the necessary connection between the KeePassXC snap and the system's USB devices.

```bash
sudo snap connect "keepassxc:raw-usb" "core:raw-usb"
```

--------------------------------

### Write HMAC Key to YubiKey Slot 2

Source: https://keepassxc.org/docs/KeePassXC_UserGuide

Configure your YubiKey to use HMAC-based challenge-response authentication in slot 2. This command sets up the necessary parameters for the YubiKey.

```bash
ykpersonalize -2 -a -ochal-resp -ochal-hmac -ohmac-lt64 -oserial-api-visible -oallow-update
```

--------------------------------

### List Generated SSH Key Files on Windows

Source: https://keepassxc.org/docs/KeePassXC_UserGuide

Lists the generated private and public SSH key files in the current directory.

```powershell
PS C:\Users\user> dir keepassxc*

Directory C:\Users\user

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a----         9/19/2021  12:08 PM           2655 keepassxc
-a----         9/19/2021  12:08 PM            570 keepassxc.pub
```

--------------------------------

### Wildcard Window Title Matching

Source: https://keepassxc.org/docs/KeePassXC_UserGuide

Using an asterisk (*) as a wildcard in window titles allows for flexible matching. Setting the title to '*' matches all windows.

```plaintext
*

```

--------------------------------

### Generate HMAC Key

Source: https://keepassxc.org/docs/KeePassXC_UserGuide

Use this command to create a 20-byte HMAC key from random data. This key is essential for YubiKey backups.

```bash
dd status=none if=/dev/random bs=20 count=1 | xxd -p -c 40
```

--------------------------------

### Enable Double-Click Copy in KeePassXC

Source: https://keepassxc.org/docs/KeePassXC_GettingStarted

Instructions to enable copying entry usernames and passwords by double-clicking in KeePassXC version 2.7.0 and later.

```text
1. Open **KeePassXC** , and navigate to **Tools** → **Settings**.
2. In the left sidebar, select **General**.
3. Under **Entry Management** , check the box for _"Copy data on double clicking field in entry view"_.
```

--------------------------------

### Microsoft Edge Native Messaging Host Configuration (Windows)

Source: https://keepassxc.org/docs/KeePassXC_UserGuide

This JSON file configures the native messaging host for KeePassXC integration with Microsoft Edge on Windows. It specifies allowed origins, description, name, path to the executable, and type.

```json
{
    "allowed_origins": [
        "chrome-extension://pdffhmdngciaglkoonimfcmckehcpafo/"
    ],
    "description": "KeePassXC integration with native messaging support",
    "name": "org.keepassxc.keepassxc_browser",
    "path": "C:\\Program Files\\KeePassXC\\keepassxc-proxy.exe",
    "type": "stdio"
}
```

--------------------------------

### Check SSH Agent Status on Linux

Source: https://keepassxc.org/docs/KeePassXC_UserGuide

Use this command to check if the SSH agent is running and if any keys are loaded. If you receive an error about not being able to connect, the agent may not be running or configured correctly.

```bash
$ ssh-add -l
The agent has no identities.
```

--------------------------------

### Enable KeePassXC as Secret Service Provider

Source: https://keepassxc.org/docs/KeePassXC_UserGuide

This shell snippet configures KeePassXC to act as a Secret Service provider over DBus. It creates the necessary D-BUS service file. You may need to restart your session for changes to take effect.

```shell
mkdir -p "${XDG_DATA_HOME:-${HOME}/.local/share}/dbus-1/services"
cat > "${XDG_DATA_HOME:-${HOME}/.local/share}/dbus-1/services/org.freedesktop.secrets.service" <<EOF
[D-BUS Service]
Name=org.freedesktop.secrets
Exec=/usr/bin/keepassxc
EOF
```

--------------------------------

### Generate SSH Key Pair on Linux or macOS

Source: https://keepassxc.org/docs/KeePassXC_UserGuide

Generates a standard RSA key pair in OpenSSH format. The generated files are named 'keepassxc' (private key) and 'keepassxc.pub' (public key).

```bash
$ ssh-keygen -o -f keepassxc -C johndoe@example
Generating public/private rsa key pair.
Enter passphrase (empty for no passphrase):
Enter same passphrase again:
Your identification has been saved in keepassxc
Your public key has been saved in keepassxc.pub
The key fingerprint is:
SHA256:pN+o5AqUmijYBDUrFV/caMus9oIR61+MiWLa8fcsVYI johndoe@example
The key's randomart image is:
+---[RSA 3072]----+
|  =. ..o         |
| o + .+ .        |
|o . .+ o.        |
| o..  Eo. .      |
|  +o .. So       |
|o*o.o+ ..o       |
|Bo=+o.+.o .      |
|+oo+.++o         |
|. ..++ooo        |
+----[SHA256]-----+
```

--------------------------------

### Generate SSH Key Pair on Windows using ssh-keygen

Source: https://keepassxc.org/docs/KeePassXC_UserGuide

Generates a standard RSA key pair in OpenSSH format using ssh-keygen. The generated files are named 'keepassxc' (private key) and 'keepassxc.pub' (public key).

```powershell
PS C:\Users\user> ssh-keygen.exe -o -f keepassxc -C johndoe@example
Generating public/private rsa key pair.
Enter passphrase (empty for no passphrase):
Enter same passphrase again:
Your identification has been saved in keepassxc
Your public key has been saved in keepassxc.pub
The key fingerprint is:
SHA256:pN+o5AqUmijYBDUrFV/caMus9oIR61+MiWLa8fcsVYI johndoe@example
The key's randomart image is:
+---[RSA 3072]----+
|  =. ..o         |
| o + .+ .        |
|o . .+ o.        |
| o..  Eo. .      |
|  +o .. So       |
|o*o.o+ ..o       |
|Bo=+o.+.o .      |
|+oo+.++o         |
|. ..++ooo        |
+----[SHA256]-----+
```

--------------------------------

### Microsoft Edge GPO Configuration (Windows)

Source: https://keepassxc.org/docs/KeePassXC_UserGuide

This .reg file configures Group Policy Objects for Microsoft Edge to allowlist the KeePassXC native messaging host and extension. It sets the path to the JSON configuration file and enables native messaging.

```reg
Windows Registry Editor Version 5.00

[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Edge\NativeMessagingHosts\org.keepassxc.keepassxc_browser]
@="C:\\ProgramData\\KeepassXC\\org.keepassxc.keepassxc_browser_edge.json"

[HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Edge]
"NativeMessagingUserLevelHosts"=dword:00000000

[HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Edge\ExtensionInstallAllowlist]
"1"="pdffhmdngciaglkoonimfcmckehcpafo"

[HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Edge\NativeMessagingAllowlist]
"1"="org.keepassxc.keepassxc_browser"
```

--------------------------------

### Regular Expression Window Title Matching

Source: https://keepassxc.org/docs/KeePassXC_UserGuide

To use regular expressions for window title matching, the title must be enclosed by two forward slashes. This allows for complex pattern matching.

```plaintext
//^Secure Login - .*$//
```

--------------------------------

### Default Auto-Type Sequence

Source: https://keepassxc.org/docs/KeePassXC_UserGuide

The default Auto-Type sequence used by KeePassXC. This sequence types the username, presses Tab, types the password, and then presses Enter.

```plaintext
{USERNAME}{TAB}{PASSWORD}{ENTER}
```
Tokens:
Raw