Feature : keepassxc CLI by louib · Pull Request #254 · keepassxreboot/keepassxc

louib · 2017-02-02T22:57:08Z

Adding a single point of entry for the command line interface. I still need to add the available commands when calling the program without a command name. The other utils could also be migrated to the new directory.

Also fixes 2 things:

The programs were not exiting if the Crypto::init() call was failing.
The merge program was returning 1 even though it succeeded.

Motivation and Context

Addresses #201

How Has This Been Tested?

Locally, by testing the 2 programs migrated.

Screenshots (if appropriate):

$ src/cli/keepassxc-cli extract
Usage: keepassxc-cli extract database
Extract and print a KeePassXC database file.

Arguments:
  database path of the database to extract.

$ src/cli/keepassxc-cli merge
Usage: keepassxc-cli merge [options] database1 database2
Merge 2 KeePassXC database files.

Options:
  -s, --same-password  use the same password for both database files.

Arguments:
  database1            path of the database to merge into.
  database2            path of the database to merge from.

$ src/cli/keepassxc-cli
Usage: src/cli/keepassxc-cli [options] command
KeepassXC command line interface.

Options:
  -h, --help     Displays this help.
  -v, --version  Displays version information.

Arguments:
  command        Name of the command to execute.

$ src/cli/keepassxc-cli -v
keepassxc-cli 2.1.0

$ src/cli/keepassxc-cli -h
Usage: src/cli/keepassxc-cli [options] command
KeepassXC command line interface.

Options:
  -h, --help     Displays this help.
  -v, --version  Displays version information.

Arguments:
  command        Name of the command to execute.

$ src/cli/keepassxc-cli fdsfsd
Invalid command fdsfsd.
Usage: src/cli/keepassxc-cli [options] command
KeepassXC command line interface.

Options:
  -h, --help     Displays this help.
  -v, --version  Displays version information.

Arguments:
  command        Name of the command to execute.

Types of changes

✅ New feature (non-breaking change which adds functionality)
✅ Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

✅ I have read the CONTRIBUTING document.
✅ My code follows the code style of this project.
✅ All new and existing tests passed.
X My change requires a change to the documentation and I have updated it accordingly.

louib · 2017-02-03T18:21:22Z

src/cli/CMakeLists.txt

-target_link_libraries(entropy-meter zxcvbn)
+install(TARGETS keepassxc-cli
+        BUNDLE DESTINATION . COMPONENT Runtime
+        RUNTIME DESTINATION ${BIN_INSTALL_DIR} COMPONENT Runtime)


Right now this is installing the binary in the /Applications folder on MacOs. I'll have to find a way to copy it to /usr/local/bin instead.

You set the destination to ${BIN_INSTALL_DIR} "declared" here https://github.com/keepassxreboot/keepassxc/blob/develop/CMakeLists.txt#L148
that is set to . and when executing make install goes to /Application

You can instead use

include(GNUInstallDirs) ${CMAKE_INSTALL_BINDIR}

Or eventually hard code the /usr/local/bin path

louib · 2017-02-04T19:54:24Z

@TheZ3ro added the install path for MacOs. Really not sure this is the way to go, and I still have to determine the path for cli executables on windows.

TheZ3ro · 2017-02-04T20:40:04Z

@louib 👍
For windows is fine every path that is in user's PATH. IDK what's the best but I think we should ship it in . along with the KeePassXC.exe

rockihack · 2017-02-04T23:26:00Z

src/cli/keepassxc-cli.cpp

+
+    QString commandName = argv[1];
+
+    for (int i = 1; i < argc - 1; ++i) {


What is the purpose of this loop?
You might want to use ++argv; instead?

Good call. I added a comment and removed the loop in favor of ++argv!

louib · 2017-02-05T18:32:46Z

@TheZ3ro I tested that the executable installs correctly on Linux. At some point we might want to list the available commands when calling keepassxc-cli alone, but I think this is good enough for a first version of the CLI.

louib · 2017-02-16T02:09:34Z

@TheZ3ro Added the list command and the available commands.

Root/
  entry2 18f5af788ef856d2113fd1a9fe770325
  entry1 2c6a330e70d2709fead56db22a2aec8c
  entry3 d63adb99abda1a76160dc81157cdc8c2

Usage: ./src/cli/keepassxc-cli [options] command
KeePassXC command line interface.

Available commands:
  extract	Extract and print the content of a database.
  entropy-meter	Calculate password entropy.
  list		List database entries.
  merge		Merge 2 databases.

Options:
  -h, --help     Displays this help.
  -v, --version  Displays version information.

Arguments:
  command        Name of the command to execute.

I'd leave that as is for a first version of the CLI, so that we can clarify the scope of this feature.

TheZ3ro · 2017-02-16T11:30:00Z

I was planning of implementing the list option by myself but you already did it! Nice 😄
I agree that this can be a fair initial version

TheZ3ro · 2017-02-16T19:28:36Z

Maybe we can put the inserting password code in a different file. It's repeated a lot

TheZ3ro · 2017-02-28T19:17:01Z

Any news here?

louib · 2017-02-28T19:21:07Z

@TheZ3ro I think the last command remaining before a first version would be keepassxc show, so that we can actually retrieve a password from the command line. Otherwise, we might want to extract the password code to a different file before merging.

TheZ3ro · 2017-02-28T19:30:15Z

@louib Ok I think we can wait for the merge until the show feature is implemented.

louib · 2017-03-12T18:21:48Z

@TheZ3ro added a basic show command. for now it only handles finding the entry with the uuid. I also extracted the common code for opening a database from a filename, and placed it in the Database class.
I'd say this one is ready for merging (after code review, of course)!

TheZ3ro · 2017-03-12T19:23:57Z

Ok I will review this in the next few days. Can you rebase on develop?

louib · 2017-03-12T19:50:40Z

@TheZ3ro done!

TheZ3ro · 2017-03-15T19:10:31Z

I forgot to approve and merge this, @louib can you rebase on develop again? Thanks

louib · 2017-03-15T20:36:44Z

@TheZ3ro done!

TheZ3ro · 2017-03-16T09:10:39Z

@louib argh, one more time since #394 was merged before I read this

louib · 2017-03-16T14:10:13Z

@TheZ3ro done!

phoerious · 2017-03-16T14:17:10Z

src/cli/keepassxc-cli.cpp

+
+    qCritical("Invalid command %s.", qPrintable(commandName));
+    parser.showHelp();
+    return EXIT_FAILURE;


You should add the lsan stuff I added to src/main.cpp to avoid a huge dump of memory leak errors when compiling with our new -DWITH_ASAN=ON option.

droidmonkey · 2017-03-17T00:14:26Z

Fantastic work on this guys!

- Added YubiKey 2FA integration for unlocking databases [#127] - Added TOTP support [#519] - Added CSV import tool [#146, #490] - Added KeePassXC CLI tool [#254] - Added diceware password generator [#373] - Added support for entry references [#370, #378] - Added support for Twofish encryption [#167] - Enabled DEP and ASLR for in-memory protection [#371] - Enabled single instance mode [#510] - Enabled portable mode [#645] - Enabled database lock on screensaver and session lock [#545] - Redesigned welcome screen with common features and recent databases [#292] - Multiple updates to search behavior [#168, #213, #374, #471, #603, #654] - Added auto-type fields {CLEARFIELD}, {SPACE}, {{}, {}} [#267, #427, #480] - Fixed auto-type errors on Linux [#550] - Prompt user prior to executing a cmd:// URL [#235] - Entry attributes can be protected (hidden) [#220] - Added extended ascii to password generator [#538] - Added new database icon to toolbar [#289] - Added context menu entry to empty recycle bin in databases [#520] - Added "apply" button to entry and group edit windows [#624] - Added macOS tray icon and enabled minimize on close [#583] - Fixed issues with unclean shutdowns [#170, #580] - Changed keyboard shortcut to create new database to CTRL+SHIFT+N [#515] - Compare window title to entry URLs [#556] - Implemented inline error messages [#162] - Ignore group expansion and other minor changes when making database "dirty" [#464] - Updated license and copyright information on souce files [#632] - Added contributors list to about dialog [#629]

noplanman · 2017-06-26T21:45:31Z

Maybe a silly question, but how do I get this CLI on a Mac?
I checked on brew but didn't find anything.

Does it need to be compiled?

phoerious · 2017-06-26T22:17:01Z

You need to compile it. It's not part of the DMG as it only has a single entry point. We probably need some sort of bootstrap feature in the future to start the CLI from single-entry point binary such as the DMG or the Linux AppImage and Snap packages.

tristan-k · 2017-06-27T10:48:18Z

How do I compile keepassxc-cli from source? I would prefer a brew formula.

tristan-k · 2017-06-27T11:08:43Z

After doing brew install qt5 and run cmake -DWITH_TESTS=OFF .. -DCMAKE_PREFIX_PATH=/usr/local/Cellar/qt/5.9.0_1 I succeeded in compiling keepassxc-cli for Mac. Here's a copy of the binary.

louib mentioned this pull request Feb 2, 2017

Add first keepassxc-cli version. #251

Closed

louib commented Feb 3, 2017

View reviewed changes

rockihack reviewed Feb 4, 2017

View reviewed changes

louib force-pushed the feature/keepassxc-cli branch from c36d9e4 to cf05b53 Compare February 7, 2017 23:24

louib force-pushed the feature/keepassxc-cli branch from 9d72ae4 to 3aa27cc Compare February 16, 2017 02:07

droidmonkey added this to the v2.2.0 milestone Feb 20, 2017

droidmonkey added the new feature label Feb 20, 2017

louib force-pushed the feature/keepassxc-cli branch from e07e08b to e49e8e3 Compare March 12, 2017 19:50

louib force-pushed the feature/keepassxc-cli branch from e49e8e3 to 0be1f87 Compare March 15, 2017 20:36

Louis-Bertrand Varin and others added 6 commits March 16, 2017 10:09

Add first keepassxc-cli version.

52991f3

Disable core dumps (keepassxc-cli).

9cfc862

Add dependency + adjust styling.

bf9b235

Use EXIT_FAILURE/SUCCESS

9b92e7f

Migrate entropy-meter to keepassxc-cli

992d8a9

Missing zxcvbn dependency.

342d49d

Louis-Bertrand Varin and others added 14 commits March 16, 2017 10:09

Keepass -> KeePass.

b859415

Remove unused imports.

7636a55

Add list to keepassxc-cli

7ca475f

Adding available commands.

64dfada

Change cli commands description.

f579345

Fixed indentation.

98911af

text for inserting password

e01e971

Adding the show command.

15c2727

Handling entry not found.

db1bf88

Extracting openDatabaseFile.

993f90c

Using openDatabaseFile in Merge.

780e233

Using openDatabaseFile in List.

cf23343

Adding second prompt for merge.

fd9d372

Adding group uuid to list.

a661c17

louib force-pushed the feature/keepassxc-cli branch from 0be1f87 to a661c17 Compare March 16, 2017 14:09

phoerious reviewed Mar 16, 2017

View reviewed changes

Add ASAN to keepassxc-cli

558c75a

TheZ3ro approved these changes Mar 16, 2017

View reviewed changes

TheZ3ro merged commit 4cccf28 into develop Mar 16, 2017

TheZ3ro deleted the feature/keepassxc-cli branch March 16, 2017 18:01

omern1 mentioned this pull request Apr 21, 2017

Add PR #254 to a release #521

Closed

phoerious added pr: new feature Pull request adds a new feature and removed new feature labels Nov 22, 2024


		QString commandName = argv[1];

		for (int i = 1; i < argc - 1; ++i) {

Uh oh!

Conversation

louib commented Feb 2, 2017

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Uh oh!

louib Feb 3, 2017

Choose a reason for hiding this comment

Uh oh!

TheZ3ro Feb 3, 2017

Choose a reason for hiding this comment

Uh oh!

louib commented Feb 4, 2017

Uh oh!

TheZ3ro commented Feb 4, 2017

Uh oh!

rockihack Feb 4, 2017

Choose a reason for hiding this comment

Uh oh!

louib Feb 5, 2017

Choose a reason for hiding this comment

Uh oh!

louib commented Feb 5, 2017

Uh oh!

louib commented Feb 16, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TheZ3ro commented Feb 16, 2017

Uh oh!

TheZ3ro commented Feb 16, 2017

Uh oh!

TheZ3ro commented Feb 28, 2017

Uh oh!

louib commented Feb 28, 2017

Uh oh!

TheZ3ro commented Feb 28, 2017

Uh oh!

louib commented Mar 12, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TheZ3ro commented Mar 12, 2017

Uh oh!

louib commented Mar 12, 2017

Uh oh!

TheZ3ro commented Mar 15, 2017

Uh oh!

louib commented Mar 15, 2017

Uh oh!

TheZ3ro commented Mar 16, 2017

Uh oh!

louib commented Mar 16, 2017

Uh oh!

phoerious Mar 16, 2017

Choose a reason for hiding this comment

Uh oh!

droidmonkey commented Mar 17, 2017

Uh oh!

noplanman commented Jun 26, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

phoerious commented Jun 26, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tristan-k commented Jun 27, 2017

Uh oh!

tristan-k commented Jun 27, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

louib commented Feb 16, 2017 •

edited

Loading

louib commented Mar 12, 2017 •

edited

Loading

noplanman commented Jun 26, 2017 •

edited

Loading

phoerious commented Jun 26, 2017 •

edited

Loading