mirror of
https://github.com/keepassxreboot/keepassxc.git
synced 2025-03-10 08:09:23 -04:00
03855fc411
* Closes #11467 - Describe default search fields * Closes #11468 - Fix lock database shortcut * Closes #8259 - Add a note about 1Password OPVault specifics * Closes #9794 - Add section anchors for easy linking * Closes #10316 - Show how to setup managed Edge on macOS * Closes #7805 - Document entry url handling * Closes #9143 - Document database merge behavior * Closes #10876 - Correct wording in browser and passkey sections Update outdated images of the user interface. Improve wording and flow of entire documentation. Fill in missing pieces based on user feedback. Add mention about URL wildcards
147 lines
5.8 KiB
Plaintext
147 lines
5.8 KiB
Plaintext
= KeePassXC – Reference
|
||
include::.sharedheader[]
|
||
:imagesdir: ../images
|
||
|
||
// tag::content[]
|
||
== Reference
|
||
This section contains full details on advanced features available in KeePassXC.
|
||
|
||
=== Entry Placeholders
|
||
[grid=rows, frame=none, width=90%]
|
||
|===
|
||
|Placeholder |Description
|
||
|
||
|{TITLE} |Entry Title
|
||
|{USERNAME} |Username
|
||
|{PASSWORD} |Password
|
||
|{URL} |URL
|
||
|{NOTES} |Notes
|
||
|{TOTP} |Current TOTP value (if configured)
|
||
|{S:<ATTRIBUTE_NAME>} |Value for the given attribute (case sensitive)
|
||
|{T-CONV:/<PLACEHOLDER>/<METHOD>/} |Text conversion for resolved placeholder (eg, {USERNAME}) using the following methods: UPPER, LOWER, BASE64, HEX, URI, URI-DEC
|
||
|{T-REPLACE-RX:/<PLACEHOLDER>/<REGEX>/<REPLACE>/} |Use a regular expression to find and replace data from a resolved placeholder (eg, {USERNAME}). Refer to match groups using $1, $2, etc.
|
||
|{URL:RMVSCM} |URL without scheme (e.g., https)
|
||
|{URL:WITHOUTSCHEME} |URL without scheme
|
||
|{URL:SCM} |URL Scheme
|
||
|{URL:SCHEME} |URL Scheme
|
||
|{URL:HOST} |URL Host (e.g., example.com)
|
||
|{URL:PORT} |URL Port
|
||
|{URL:PATH} |URL Path (e.g., /path/to/page.html)
|
||
|{URL:QUERY} |URL Query String
|
||
|{URL:FRAGMENT} |URL Fragment
|
||
|{URL:USERINFO} |URL Username:Password
|
||
|{URL:USERNAME} |URL Username
|
||
|{URL:PASSWORD} |URL Password
|
||
|{DT_SIMPLE} |Current Date-Time (yyyyMMddhhmmss)
|
||
|{DT_YEAR} |Current Year (yyyy)
|
||
|{DT_MONTH} |Current Month (MM)
|
||
|{DT_DAY} |Current Day (dd)
|
||
|{DT_HOUR} |Current Hour (hh)
|
||
|{DT_MINUTE} |Current Minutes (mm)
|
||
|{DT_SECOND} |Current Seconds (ss)
|
||
|{DT_UTC_SIMPLE} |Current UTC Date-Time (yyyyMMddhhmmss)
|
||
|{DT_UTC_YEAR} |Current UTC Year (yyyy)
|
||
|{DT_UTC_MONTH} |Current UTC Month (MM)
|
||
|{DT_UTC_DAY} |Current UTC Day (dd)
|
||
|{DT_UTC_HOUR} |Current UTC Hour (hh)
|
||
|{DT_UTC_MINUTE} |Current UTC Minutes (mm)
|
||
|{DT_UTC_SECOND} |Current UTC Seconds (ss)
|
||
|{DB_DIR} |Absolute directory path of database file
|
||
|===
|
||
|
||
=== Entry Cross-Reference
|
||
A reference to another entry's field is possible using the shorthand syntax:
|
||
`{REF:<FIELD>@<SEARCH_IN>:<SEARCH_TEXT>}`
|
||
|
||
`<FIELD>` and `<SEARCH_IN>` can be one of following:
|
||
|
||
* T – Title
|
||
* U – Username
|
||
* P – Password
|
||
* A – URL
|
||
* N – Notes
|
||
* I – UUID (found on entry properties page)
|
||
* O – Custom Attribute _(SEARCH_IN only)_
|
||
|
||
Examples: +
|
||
`{REF:U@I:033054D445C648C59092CC1D661B1B71}` +
|
||
`{REF:P@T:Other Entry}` +
|
||
`{REF:A@O:Attribute 1}`
|
||
|
||
=== Auto-Type Actions
|
||
[grid=rows, frame=none, width=90%]
|
||
|===
|
||
|Action Code |Description
|
||
|
||
|{TAB}, {ENTER}, {SPACE}, {INSERT}, {DELETE}, {HOME}, {END}, {PGUP}, {PGDN}, {BACKSPACE}, {CAPSLOCK}, {ESC}
|
||
|Press the corresponding keyboard key
|
||
|
||
|{UP}, {DOWN}, {LEFT}, {RIGHT} |Press the corresponding arrow key
|
||
|{F1}, {F2}, ..., {F16} |Press F1, F2, etc.
|
||
|{LEFTBRACE}, {RIGHTBRACE} |Press `{` or `}`, respectively
|
||
|{<KEY> X} |Repeat <KEY> X times (e.g., {SPACE 5} inserts five spaces)
|
||
|{DELAY=X} |Set delay between key presses to X milliseconds
|
||
|{DELAY X} |Pause typing for X milliseconds
|
||
|{CLEARFIELD} |Clear the input field
|
||
|{PICKCHARS} |Pick specific password characters from a dialog
|
||
|===
|
||
|
||
[grid=rows, frame=none, width=90%]
|
||
|===
|
||
|Modifier |Description
|
||
|
||
|+ |SHIFT
|
||
|^ |CTRL
|
||
|% |ALT
|
||
|# |WIN/CMD
|
||
|===
|
||
*Text Conversions:*
|
||
|
||
`{T-CONV:/<PLACEHOLDER>/<METHOD>/}` +
|
||
Convert resolved placeholder (e.g., {USERNAME}, {PASSWORD}, etc.) using the following methods: UPPER, LOWER, BASE64, HEX, URI, URI-DEC.
|
||
|
||
`{T-REPLACE-RX:/<PLACEHOLDER>/<SEARCH>/<REPLACE>/}` +
|
||
Use regular expressions to find and replace data from a resolved placeholder. Refer to match groups using $1, $2, etc.
|
||
|
||
=== Backup Path Placeholders
|
||
[grid=rows, frame=none, width=90%]
|
||
|===
|
||
|Database Backup Path Placeholder |Description
|
||
|
||
|{DB_FILENAME} |The database's filename without extension
|
||
|{TIME} |The current time formatted as dd_MM_yyyy_hh-mm-ss.
|
||
|{TIME:<format>} |The current time formatted according to the format string specified by <format>. See https://doc.qt.io/qt-5/qtime.html#toString for a list of available placeholders.
|
||
|===
|
||
|
||
[grid=rows, frame=none, width=90%]
|
||
|===
|
||
|Backup path example |Location of backup(s)
|
||
|
||
|`{DB_FILENAME}-{TIME}.bak.kdbx` |`C:\Users\MyUsername\MyDatabase-02_01_2022_03-04-05.bak.kdbx` +
|
||
`C:\Users\MyUsername\MyDatabase-05_01_2022_12-10-00.bak.kdbx`
|
||
|`backups\\{DB_FILENAME}.bak.kdbx` |`C:\Users\MyUsername\backups\MyDatabase.bak.kdbx`
|
||
|`C:\Backups\{TIME:dd.MM.yyyy}\\{DB_FILENAME}.kdbx` |`C:\Backups\02.01.2022\MyDatabase.kdbx` +
|
||
`C:\Backups\05.01.2022\MyDatabase.kdbx`
|
||
|`C:\Backups\\{DB_FILENAME}\{TIME:MM-dd-yyyy}.kdbx` |`C:\Backups\MyDatabase\01-02-2022.kdbx` +
|
||
`C:\Backups\MyDatabase\01-05-2022.kdbx`
|
||
|===
|
||
|
||
=== Creating a YubiKey backup
|
||
It is advisable to have a backup replica YubiKey In case your main YubiKey gets damaged, lost, or stolen. The same HMAC key will need to be written to both keys. To do this you can either use the YubiKey Personalization Tool GUI or the ykpersonalize CLI tool. The steps for the CLI tool are shown:
|
||
|
||
1. Create a 20 byte HMAC key:
|
||
+
|
||
```
|
||
dd status=none if=/dev/random bs=20 count=1 | xxd -p -c 40
|
||
```
|
||
|
||
2. Write the HMAC key to slot 2 _(Set through the first switch. Out of the box the YubiKey OTP resides in slot 1)_:
|
||
+
|
||
```
|
||
ykpersonalize -2 -a -ochal-resp -ochal-hmac -ohmac-lt64 -oserial-api-visible -oallow-update
|
||
```
|
||
|
||
You will be asked to enter the HMAC key you created earlier, copy/paste they key output in the first step. Repeat step 2 for your second YubiKey using the same HMAC key from before. We recommend storing your HMAC key in a safe place (e.g., printed on paper) in case you need to recreate another key.
|
||
|
||
// end::content[]
|