Add support for CLI XML import #3572

jsachs · 2019-09-24T19:21:21Z

Type of change

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

Description and Context

The CLI now contains an "import" command that creates a new database from the specified XML export. The new database is in kdbx 4 format, and does not currently accept a keyfile in database creation.

This change is required to create new databases from XML backups.

Fixes #2458

Testing strategy

CLI unit tests akin to the export tests

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.

louib · 2019-09-25T15:34:07Z

@jsachs I think there was a problem with the rebase and new newly merged YubiKey CLI option. See the build logs for details.

src/core/Database.h

src/cli/Import.cpp

tests/TestCli.cpp

jsachs · 2019-09-27T15:25:09Z

@droidmonkey any idea what is causing the Ubuntu build issues? It seems to be manifesting in other feature PRs as well.

droidmonkey · 2019-09-27T16:33:14Z

Weird, looks like the CI cannot open a temporary file.

louib

This one will need a rebase now that the open command's PR was merged

tests/TestCli.cpp

louib · 2019-09-30T18:29:26Z

tests/TestCli.cpp

+    pos = m_stdoutFile->pos();
+    Utils::Test::setNextPassword("a");
+    importCmd.execute({"import", "-q", m_xmlFile->fileName(), databaseFilenameQuiet});
+    m_stdoutFile->seek(pos);


@jsachs here we're not actually testing that there was no output on stdout with the quiet option. And it would probably fail since it doesn't seem to be implemented.

Should be fairly easy, you just have to defined the output stream as

TextStream outputTextStream(parser->isSet(Command::QuietOption) ? Utils::DEVNULL : Utils::STDOUT, QIODevice::WriteOnly);

louib · 2019-10-01T14:09:10Z

@jsachs for some reason the tests are still failing

Actual   (m_stdoutFile->readAll())                                                           : "Insert password to encrypt database (Press enter to leave blank): \nSuccessfully imported database.\n"
Expected (QByteArray("Insert password to encrypt database (Press enter to leave blank): \n")): "Insert password to encrypt database (Press enter to leave blank): \n"
Loc: [/Users/kpxc/keepassxc/38351/tests/TestCli.cpp(1048)]

⁉️

I'd approve this one otherwise

jsachs · 2019-10-01T15:42:08Z

@louib any idea why the -q option would fail in a test? I can confirm that this works correctly when running the CLI manually.

louib · 2019-10-01T15:57:26Z

src/cli/Import.h

+
+#include "Command.h"
+
+#include "keys/PasswordKey.h"


@jsachs I don't think you need that import anymore.

louib · 2019-10-01T16:00:56Z

@jsachs I have no clue tbh 😬

louib

@jsachs thanks for the PR!
@droidmonkey all yours

The CLI now contains an "import" command that creates a new database from the specified XML export. The new database is in kdbx 4 format, and does not currently accept a keyfile in database creation. This change is required to create new databases from XML backups. Fixes keepassxreboot#2458

droidmonkey · 2019-10-14T13:09:15Z

Squashed all the commits and bumped up the default KDF to Argon2 to save as KDBX4

Added - Add 'Paper Backup' aka 'Export to HTML file' to the 'Database' menu [[#3277](#3277)] - Add statistics panel with information about the database (number of entries, number of unique passwords, etc.) to the Database Settings dialog [[#2034](#2034)] - Add offline user manual accessible via the 'Help' menu [[#3274](#3274)] - Add support for importing 1Password OpVault files [[#2292](#2292)] - Implement Freedesktop.org secret storage DBus protocol so that KeePassXC can be used as a vault service by libsecret [[#2726](#2726)] - Add support for OnlyKey as an alternative to YubiKeys (requires yubikey-personalization >= 1.20.0) [[#3352](#3352)] - Add group sorting feature [[#3282](#3282)] - Add feature to download favicons for all entries at once [[#3169](#3169)] - Add word case option to passphrase generator [[#3172](#3172)] - Add support for RFC6238-compliant TOTP hashes [[#2972](#2972)] - Add UNIX man page for main program [[#3665](#3665)] - Add 'Monospaced font' option to the notes field [[#3321](#3321)] - Add support for key files in auto open [[#3504](#3504)] - Add search field for filtering entries in Auto-Type dialog [[#2955](#2955)] - Complete usernames based on known usernames from other entries [[#3300](#3300)] - Parse hyperlinks in the notes field of the entry preview pane [[#3596](#3596)] - Allow abbreviation of field names in entry search [[#3440](#3440)] - Allow setting group icons recursively [[#3273](#3273)] - Add copy context menu for username and password in Auto-Type dialog [[#3038](#3038)] - Drop to background after copying a password to the clipboard [[#3253](#3253)] - Add 'Lock databases' entry to tray icon menu [[#2896](#2896)] - Add option to minimize window after unlocking [[#3439](#3439)] - Add option to minimize window after opening a URL [[#3302](#3302)] - Request accessibility permissions for Auto-Type on macOS [[#3624](#3624)] - Browser: Add initial support for multiple URLs [[#3558](#3558)] - Browser: Add entry-specific browser integration settings [[#3444](#3444)] - CLI: Add offline HIBP checker (requires a downloaded HIBP dump) [[#2707](#2707)] - CLI: Add 'flatten' option to the 'ls' command [[#3276](#3276)] - CLI: Add password generation options to `Add` and `Edit` commands [[#3275](#3275)] - CLI: Add XML import [[#3572](#3572)] - CLI: Add CSV export to the 'export' command [[#3278](#3278)] - CLI: Add `-y --yubikey` option for YubiKey [[#3416](#3416)] - CLI: Add `--dry-run` option for merging databases [[#3254](#3254)] - CLI: Add group commands (mv, mkdir and rmdir) [[#3313](#3313)]. - CLI: Add interactive shell mode command `open` [[#3224](#3224)] Changed - Redesign database unlock dialog [ [#3287](#3287)] - Rework the entry preview panel [ [#3306](#3306)] - Move notes to General tab on Group Preview Panel [[#3336](#3336)] - Enable entry actions when editing an entry and cleanup entry context menu [[#3641](#3641)] - Improve detection of external database changes [[#2389](#2389)] - Warn if user is trying to use a KDBX file as a key file [[#3625](#3625)] - Add option to disable KeePassHTTP settings migrations prompt [[#3349](#3349), [#3344](#3344)] - Re-enabled Wayland support (no Auto-Type yet) [[#3520](#3520), [#3341](#3341)] - Add icon to 'Toggle Window' action in tray icon menu [[3244](#3244)] - Merge custom data between databases only when necessary [[#3475](#3475)] - Improve various file-handling related issues when picking files using the system's file dialog [[#3473](#3473)] - Add 'New Entry' context menu when no entries are selected [[#3671](#3671)] - Reduce default Argon2 settings from 128 MiB and one thread per CPU core to 64 MiB and two threads to account for lower-spec mobile hardware [ [#3672](#3672)] - Browser: Remove unused 'Remember' checkbox for HTTP Basic Auth [[#3371](#3371)] - Browser: Show database name when pairing with a new browser [[#3638](#3638)] - Browser: Show URL in allow access dialog [[#3639](#3639)] - CLI: The password length option `-l` for the CLI commands `Add` and `Edit` is now `-L` [[#3275](#3275)] - CLI: The `-u` shorthand for the `--upper` password generation option has been renamed to `-U` [[#3275](#3275)] - CLI: Rename command `extract` to `export`. [[#3277](#3277)] Fixed - Improve accessibility for assistive technologies [[#3409](#3409)] - Correctly unlock all databases if `--pw-stdin` is provided [[#2916](#2916)] - Fix password generator issues with special characters [[#3303](#3303)] - Fix KeePassXC interrupting shutdown procedure [[#3666](#3666)] - Fix password visibility toggle button state on unlock dialog [[#3312](#3312)] - Fix potential data loss if database is reloaded while user is editing an entry [[#3656](#3656)] - Fix hard-coded background color in search help popup [[#3001](#3001)] - Fix font choice for password preview [[#3425](#3425)] - Fix handling of read-only files when autosave is enabled [[#3408](#3408)] - Handle symlinks correctly when atomic saves are disabled [[#3463](#3463)] - Enable HighDPI icon scaling on Linux [[#3332](#3332)] - Make Auto-Type on macOS more robust and remove old Carbon API calls [[#3634](#3634), [[#3347](#3347))] - Hide Share tab if KeePassXC is compiled without KeeShare support and other minor KeeShare improvements [[#3654](#3654), [[#3291](#3291), [#3029](#3029), [#3031](#3031), [#3236](#3236)] - Correctly bring window to the front when clicking tray icon on macOS [[#3576](#3576)] - Correct application shortcut created by MSI Installer on Windows [[#3296](#3296)] - Fix crash when removing custom data [[#3508](#3508)] - Fix placeholder resolution in URLs [[#3281](#3281)] - Fix various inconsistencies and platform-dependent compilation bugs [[#3664](#3664), [#3662](#3662), [#3660](#3660), [#3655](#3655), [#3649](#3649), [#3417](#3417), [#3357](#3357), [#3319](#3319), [#3318](#3318), [#3304](#3304)] - Browser: Fix potential leaking of entries through the browser integration API if multiple databases are opened [[#3480](#3480)] - Browser: Fix password entropy calculation [[#3107](#3107)] - Browser: Fix Windows registry settings for portable installation [[#3603](#3603)]

The CLI now contains an "import" command that creates a new database from the specified XML export. The new database is in kdbx 4 format, and does not currently accept a keyfile in database creation. This change is required to create new databases from XML backups. Fixes keepassxreboot#2458

jsachs marked this pull request as ready for review September 25, 2019 03:40

louib added the feature: CLI label Sep 25, 2019

louib reviewed Sep 25, 2019

View reviewed changes

src/core/Database.h Show resolved Hide resolved

src/cli/Import.cpp Outdated Show resolved Hide resolved

tests/TestCli.cpp Outdated Show resolved Hide resolved

louib reviewed Sep 28, 2019

View reviewed changes

tests/TestCli.cpp Show resolved Hide resolved

louib requested changes Sep 30, 2019

View reviewed changes

louib reviewed Oct 1, 2019

View reviewed changes

src/cli/Import.h Outdated

#include "Command.h"

#include "keys/PasswordKey.h"

Copy link

Member

louib Oct 1, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jsachs I don't think you need that import anymore.

louib approved these changes Oct 2, 2019

View reviewed changes

louib requested a review from droidmonkey October 2, 2019 19:40

droidmonkey force-pushed the feature/js-cli-import branch from bdddab9 to c79706d Compare October 14, 2019 12:57

droidmonkey force-pushed the feature/js-cli-import branch from c79706d to cca4b2a Compare October 14, 2019 13:09

droidmonkey added this to the v2.5.0 milestone Oct 16, 2019

droidmonkey merged commit dbe15d3 into keepassxreboot:develop Oct 16, 2019

louib mentioned this pull request Nov 1, 2019

CLI : import from XML format #2341

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for CLI XML import #3572

Add support for CLI XML import #3572

jsachs commented Sep 24, 2019

louib commented Sep 25, 2019 •

edited

Loading

jsachs commented Sep 27, 2019

droidmonkey commented Sep 27, 2019

louib left a comment

louib Sep 30, 2019

louib commented Oct 1, 2019

jsachs commented Oct 1, 2019 •

edited

Loading

louib Oct 1, 2019

louib commented Oct 1, 2019

louib left a comment

droidmonkey commented Oct 14, 2019

Add support for CLI XML import #3572

Add support for CLI XML import #3572

Conversation

jsachs commented Sep 24, 2019

Type of change

Description and Context

Testing strategy

Checklist:

louib commented Sep 25, 2019 • edited Loading

jsachs commented Sep 27, 2019

droidmonkey commented Sep 27, 2019

louib left a comment

Choose a reason for hiding this comment

louib Sep 30, 2019

Choose a reason for hiding this comment

louib commented Oct 1, 2019

jsachs commented Oct 1, 2019 • edited Loading

louib Oct 1, 2019

Choose a reason for hiding this comment

louib commented Oct 1, 2019

louib left a comment

Choose a reason for hiding this comment

droidmonkey commented Oct 14, 2019

louib commented Sep 25, 2019 •

edited

Loading

jsachs commented Oct 1, 2019 •

edited

Loading