Support --key-file in `keepassxc-cli extract` by yan12125 · Pull Request #824 · keepassxreboot/keepassxc

yan12125 · 2017-07-28T06:11:29Z

Description

Continuation of #816, support --key-file in keepassxc-cli extract

Motivation and context

All other database manipulation sub-commands in CLI supports --key-file. I want extract to be among them.
I use extract from time to time. This may help #544, too.

How has this been tested?

Only manually tested. I need to run tests on different platforms later.

Screenshots (if appropriate):

$ ./src/cli/keepassxc-cli extract -k ~/does_not_exist ~/foo.kdbx             
Failed to load file key /home/yen/does_not_exist: No such file or directory

$ ./src/cli/keepassxc-cli extract -k ~/var/cdic2 ~/Dropbox/document/keepass/main2.kdbx
Insert the database password
> 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<KeePassFile>
<!--my top secrets-->
</KeePassFile>

Types of changes

✅ New feature (non-breaking change which adds functionality)

Checklist:

✅ I have read the CONTRIBUTING document. [REQUIRED]
✅ My code follows the code style of this project. [REQUIRED]
All new and existing tests passed. [REQUIRED]
I have compiled and verified my code with -DWITH_ASAN=ON. [REQUIRED]
My change requires a change to the documentation and I have updated it accordingly.
I have added tests to cover my changes.

I'll do more tests later.

louib · 2017-07-28T15:08:51Z

src/cli/Extract.cpp

+        qCritical("Failed to load file key %s: %s",
+                  qPrintable(keyFilePath), qPrintable(errorMsg));
+        return EXIT_FAILURE;
+    }


@yan12125 shouldn't all that code be executed only if the key-file option was used?

if (!parser.value(keyFile).isEmpty()) { ... }

Otherwise you're enforcing the use of a key file.

the compositeKey.addKey(fileKey); line could also be moved in the if

louib · 2017-07-28T15:45:25Z

src/cli/Extract.cpp

+    FileKey fileKey;
+    QString errorMsg;
+    if (!fileKey.load(keyFilePath, &errorMsg)) {
+        qCritical("Failed to load file key %s: %s",


@yan12125 file key or key file?

yan12125 · 2017-07-28T16:34:44Z

Thanks for the comments. I've updated it.

louib · 2017-07-28T17:10:14Z

@yan12125 good job, and thanks for the contribution!

TheZ3ro · 2017-07-28T20:06:03Z

src/cli/Extract.cpp

+        FileKey fileKey;
+        QString errorMsg;
+        if (!fileKey.load(keyFilePath, &errorMsg)) {
+            qCritical("Failed to load key file %s: %s",


This string should be translatable

louib · 2017-07-31T21:12:01Z

@yan12125 you can take a look at this to add QObject::tr to the strings. This PR will also need a rebase after.

yan12125 · 2017-08-01T13:55:17Z

Thanks for the tip. I added tr() and tried to use get translations work but failed. Seems CLI tools does not support translations?

louib · 2017-08-01T21:00:05Z

I'm not sure, I have to admit I've never tried the translations in the CLI 😕

- Add support for KDBX 4.0, Argon2 and ChaCha20 [#148, #1179, #1230, #1494] - Add SSH Agent feature [#1098, #1450, #1463] - Add preview panel with details of the selected entry [#879, #1338] - Add more and configurable columns to entry table and allow copying of values by double click [#1305] - Add KeePassXC-Browser API as a replacement for KeePassHTTP [#608] - Deprecate KeePassHTTP [#1392] - Add support for Steam one-time passwords [#1206] - Add support for multiple Auto-Type sequences for a single entry [#1390] - Adjust YubiKey HMAC-SHA1 challenge-response key generation for KDBX 4.0 [#1060] - Replace qHttp with cURL for website icon downloads [#1460] - Remove lock file [#1231] - Add option to create backup file before saving [#1385] - Ask to save a generated password before closing the entry password generator [#1499] - Resolve placeholders recursively [#1078] - Add Auto-Type button to the toolbar [#1056] - Improve window focus handling for Auto-Type dialogs [#1204, #1490] - Auto-Type dialog and password generator can now be exited with ESC [#1252, #1412] - Add optional dark tray icon [#1154] - Add new "Unsafe saving" option to work around saving problems with file sync services [#1385] - Add IBus support to AppImage and additional image formats to Windows builds [#1534, #1537] - Add diceware password generator to CLI [#1406] - Add --key-file option to CLI [#816, #824] - Add DBus interface for opening and closing KeePassXC databases [#283] - Add KDBX compression options to database settings [#1419] - Discourage use of old fixed-length key files in favor of arbitrary files [#1326, #1327] - Correct reference resolution in entry fields [#1486] - Fix window state and recent databases not being remembered on exit [#1453] - Correct history item generation when configuring TOTP for an entry [#1446] - Correct multiple TOTP bugs [#1414] - Automatic saving after every change is now a default [#279] - Allow creation of new entries during search [#1398] - Correct menu issues on macOS [#1335] - Allow compilation on OpenBSD [#1328] - Improve entry attachments view [#1139, #1298] - Fix auto lock for Gnome and Xfce [#910, #1249] - Don't remember key files in file dialogs when the setting is disabled [#1188] - Improve database merging and conflict resolution [#807, #1165] - Fix macOS pasteboard issues [#1202] - Improve startup times on some platforms [#1205] - Hide the notes field by default [#1124] - Toggle main window by clicking tray icon with the middle mouse button [#992] - Fix custom icons not copied over when databases are merged [#1008] - Allow use of DEL key to delete entries [#914] - Correct intermittent crash due to stale history items [#1527] - Sanitize newline characters in title, username and URL fields [#1502] - Reopen previously opened databases in correct order [#774] - Use system's zxcvbn library if available [#701] - Implement various i18n improvements [#690, #875, #1436]

louib reviewed Jul 28, 2017

View reviewed changes

louib mentioned this pull request Jul 28, 2017

Handle FileKey::load errors (--key-file) #825

Merged

louib approved these changes Jul 28, 2017

View reviewed changes

TheZ3ro reviewed Jul 28, 2017

View reviewed changes

louib added the feature: CLI label Jul 30, 2017

Support --key-file in keepassxc-cli extract

a3ab8c2

louib merged commit 23b818f into keepassxreboot:develop Aug 1, 2017

phoerious added this to the v2.3.0 milestone Oct 12, 2017

yan12125 deleted the extract-keyfile branch January 19, 2018 05:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Support --key-file in `keepassxc-cli extract`#824

Support --key-file in `keepassxc-cli extract`#824
louib merged 1 commit intokeepassxreboot:developfrom
yan12125:extract-keyfile

yan12125 commented Jul 28, 2017

Uh oh!

louib Jul 28, 2017

Uh oh!

louib Jul 28, 2017

Uh oh!

yan12125 commented Jul 28, 2017

Uh oh!

louib commented Jul 28, 2017

Uh oh!

TheZ3ro Jul 28, 2017

Uh oh!

louib commented Jul 31, 2017

Uh oh!

yan12125 commented Aug 1, 2017

Uh oh!

louib commented Aug 1, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

yan12125 commented Jul 28, 2017

Description

Motivation and context

How has this been tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Uh oh!

louib Jul 28, 2017

Choose a reason for hiding this comment

Uh oh!

louib Jul 28, 2017

Choose a reason for hiding this comment

Uh oh!

yan12125 commented Jul 28, 2017

Uh oh!

louib commented Jul 28, 2017

Uh oh!

TheZ3ro Jul 28, 2017

Choose a reason for hiding this comment

Uh oh!

louib commented Jul 31, 2017

Uh oh!

yan12125 commented Aug 1, 2017

Uh oh!

louib commented Aug 1, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants