Add open command, interactive CLI session support

[sjamesr]

Type of change

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

Description and Context

This change adds an interactive mode to keepassxc-cli. For example:

$ ./src/cli/keepassxc-cli open ~/Downloads/passwords.kdbx
Insert password to unlock /home/whoever/Downloads/passwords.kdbx: <password>
Downloads/passwords.kdbx> ls /
General/
Windows/
Network/
Internet/
eMail/
Homebanking/
Recycle Bin/
Banking/
Downloads/passwords.kdbx> ls /Internet
Facebook
Twitter
Downloads/passwords.kdbx> show /Internet/Facebook
Title: Facebook
...

This change adds the following command: open. If open is invoked, the keepassxc-cli program attempts to open the database, then drops into interactive mode.

Interactive mode uses readline (falls back to just reading stdin if readline is not available). Each user command causes processing much like keepassxc-cli does today, except the command being invoked already has a database present, meaning the command should not attempt to open any database. I've changed the List and Show commands as examples.

Fixes #3224.

Screenshots

Testing strategy

Checklist:

• ✅ I have read the CONTRIBUTING document. [REQUIRED]
• ✅ All new and existing tests passed. [REQUIRED]

[louib]

Thanks for the PR @sjamesr , I'm glad to see such a major contribution to the CLI!

Out of curiosity, have you thought about a session based approach, were the process with the unlocked (or partially unlocked) database would be spawned first, and then the next commands would be piped/sent to that running process?

I think we would need tests specifically for the 2 new commands, including tests to commands with a current database.

Also, don't forget to update the man page cli/keepassxc-cli.1 and the CHANGELOG!

[phoerious]

Thank you, this looks like a great new feature. Here's my review.

[droidmonkey]

This is great, but a couple of minor changes (while in the "open" terminal prompt only) will make it even better:

• Disable the extract command, it just dumps XML to the view and doesn't let you write to a file
• Add exit and quit keywords that closes the session and returns to bash
• Add close keyword that closes the current database and returns to the interactive prompt (currently bareword open does this as well)
• Instead of list the relative path to the database file, just show the database file name (if present) or filename if not.
• Check if the database file exists (using Canonical File Path) prior to requesting unlock password

[droidmonkey]

NOTE: we will have to add libreadline.dylib to the MacOS App Bundle fixups. I don't have the full pathname handy right now.

[sjamesr]

I added the improvements you requested, with the exception of disabling the extract command. Currently there's no way to have a command enabled only in non-interactive mode. Can we add this in a later change?

[droidmonkey]

I wasn't intending for you to make "close", "quit" and "exit" actual commands. Just keywords that would be intercepted in the while loop before the Command::getCommand() call. You can do the same thing with "extract" by intercepting that and telling the user that it is disabled in interactive mode.

[sjamesr]

Ok, I can revert that part. Kind of nice to have entries in the generated help though.

…

On Wed, Sep 4, 2019, 7:46 PM Jonathan White ***@***.***> wrote: I wasn't intending for you to make "close", "quit" and "exit" actual commands. Just keywords that would be intercepted in the while loop. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#3426?email_source=notifications&email_token=ABDNGA3HIMM7U3724TGLXLTQIBXH5A5CNFSM4IJPMBT2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD55UL4Y#issuecomment-528172531>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABDNGA2P6LW4IAKWUYJLFGDQIBXH5ANCNFSM4IJPMBTQ> .

[droidmonkey]

Oh good point, let me think about it a little

[droidmonkey]

I don't like that we populate the command list with interactive mode only commands. In the populateCommands() function, can we only add close, quit, and exit if we are in interactive mode? This would also let you remove extract while in interactive mode.

[sjamesr]

@droidmonkey I added a separate "Commands" class that has the set of commands that we're using, please take a look. help now only displays commands relevant to the current mode (batch or interactive). Using a command from the other mode will result in an "unknown command" error.

[droidmonkey]

Very nice fix, this is now ready for merge

[droidmonkey]

I updated how we handle commands, batch vs interactive, to comply with our coding standards. Need to add the readline dylib path conversion and this will be ready.

[droidmonkey]

I've confirmed that the macOS build uses built-in libraries for the readline so no need to worry about the name tool fixes.