mirrors/keepassxc
1
0
Fork 0
mirror of https://github.com/keepassxreboot/keepassxc.git synced 2025-04-05 13:37:43 +03:00
Code Issues Projects Releases Packages Wiki Activity

CLI: Use stderr for password prompt

Browse source 
Fixes #3398.

Convert to QTextStream for all CLI IO and greatly improve CLI tests

* Completely overhaul CLI tests to be much more streamlined and easy to read. Removed unnecessary code blocks by using existing functions.

Co-authored-by: Emma Brooks <me@pluvano.com>
This commit is contained in:
Jonathan White 2020-05-11 07:31:29 -04:00
parent 612f8d2e5b
commit 485852c9db
30 changed files with 938 additions and 1407 deletions
Download patch file Download diff file Expand all files Collapse all files

118
src/cli/Utils.cpp
View file

@ -30,29 +30,33 @@
namespace Utils
{
/**
* STDOUT file handle for the CLI.
*/
FILE* STDOUT = stdout;
QTextStream STDOUT;
QTextStream STDERR;
QTextStream STDIN;
QTextStream DEVNULL;
/**
* STDERR file handle for the CLI.
*/
FILE* STDERR = stderr;
void setDefaultTextStreams()
{
auto fd = new QFile();
fd->open(stdout, QIODevice::WriteOnly);
STDOUT.setDevice(fd);
/**
* STDIN file handle for the CLI.
*/
FILE* STDIN = stdin;
fd = new QFile();
fd->open(stderr, QIODevice::WriteOnly);
STDERR.setDevice(fd);
/**
* DEVNULL file handle for the CLI.
*/
fd = new QFile();
fd->open(stdin, QIODevice::ReadOnly);
STDIN.setDevice(fd);
fd = new QFile();
#ifdef Q_OS_WIN
FILE* DEVNULL = fopen("nul", "w");
fd->open(fopen("nul", "w"), QIODevice::WriteOnly);
#else
FILE* DEVNULL = fopen("/dev/null", "w");
fd->open(fopen("/dev/null", "w"), QIODevice::WriteOnly);
#endif
DEVNULL.setDevice(fd);
}
void setStdinEcho(bool enable = true)
{
@ -82,36 +86,14 @@ namespace Utils
#endif
}
namespace Test
{
QStringList nextPasswords = {};
/**
* Set the next password returned by \link getPassword() instead of reading it from STDIN.
* Multiple calls to this method will fill a queue of passwords.
* This function is intended for testing purposes.
*
* @param password password to return next
*/
void setNextPassword(const QString& password, bool repeat)
{
nextPasswords.append(password);
if (repeat) {
nextPasswords.append(password);
}
}
} // namespace Test
QSharedPointer<Database> unlockDatabase(const QString& databaseFilename,
const bool isPasswordProtected,
const QString& keyFilename,
const QString& yubiKeySlot,
FILE* outputDescriptor,
FILE* errorDescriptor)
bool quiet)
{
auto& err = quiet ? DEVNULL : STDERR;
auto compositeKey = QSharedPointer<CompositeKey>::create();
TextStream out(outputDescriptor);
TextStream err(errorDescriptor);
QFileInfo dbFileInfo(databaseFilename);
if (dbFileInfo.canonicalFilePath().isEmpty()) {
@ -130,8 +112,8 @@ namespace Utils
}
if (isPasswordProtected) {
out << QObject::tr("Enter password to unlock %1: ").arg(databaseFilename) << flush;
QString line = Utils::getPassword(outputDescriptor);
err << QObject::tr("Enter password to unlock %1: ").arg(databaseFilename) << flush;
QString line = Utils::getPassword(quiet);
auto passwordKey = QSharedPointer<PasswordKey>::create();
passwordKey->setPassword(line);
compositeKey->addKey(passwordKey);
@ -177,7 +159,7 @@ namespace Utils
slot,
blocking,
QObject::tr("Please touch the button on your YubiKey to unlock %1").arg(databaseFilename),
outputDescriptor));
err.device()));
compositeKey->addChallengeResponseKey(key);
}
#else
@ -200,19 +182,10 @@ namespace Utils
*
* @return the password
*/
QString getPassword(FILE* outputDescriptor)
QString getPassword(bool quiet)
{
TextStream out(outputDescriptor, QIODevice::WriteOnly);
// return preset password if one is set
if (!Test::nextPasswords.isEmpty()) {
auto password = Test::nextPasswords.takeFirst();
// simulate user entering newline
out << endl;
return password;
}
static TextStream in(STDIN, QIODevice::ReadOnly);
auto& in = STDIN;
auto& out = quiet ? DEVNULL : STDERR;
setStdinEcho(false);
QString line = in.readLine();
@ -228,37 +201,34 @@ namespace Utils
* @return Pointer to the PasswordKey or null if passwordkey is skipped
* by user
*/
QSharedPointer<PasswordKey> getPasswordFromStdin()
QSharedPointer<PasswordKey> getConfirmedPassword()
{
QSharedPointer<PasswordKey> passwordKey;
QTextStream out(Utils::STDOUT, QIODevice::WriteOnly);
auto& err = STDERR;
auto& in = STDIN;
out << QObject::tr("Enter password to encrypt database (optional): ");
out.flush();
QSharedPointer<PasswordKey> passwordKey;
err << QObject::tr("Enter password to encrypt database (optional): ");
err.flush();
auto password = Utils::getPassword();
if (password.isEmpty()) {
out << QObject::tr("Do you want to create a database with an empty password? [y/N]: ");
out.flush();
TextStream ts(STDIN, QIODevice::ReadOnly);
if (!ts.device()->isSequential()) {
// This is required for testing on macOS
ts.seek(0);
}
auto ans = ts.readLine();
err << QObject::tr("Do you want to create a database with an empty password? [y/N]: ");
err.flush();
auto ans = in.readLine();
if (ans.toLower().startsWith("y")) {
passwordKey = QSharedPointer<PasswordKey>::create("");
}
out << endl;
err << endl;
} else {
out << QObject::tr("Repeat password: ");
out.flush();
err << QObject::tr("Repeat password: ");
err.flush();
auto repeat = Utils::getPassword();
if (password == repeat) {
passwordKey = QSharedPointer<PasswordKey>::create(password);
} else {
out << QObject::tr("Error: Passwords do not match.") << endl;
err << QObject::tr("Error: Passwords do not match.") << endl;
}
}
@ -271,7 +241,7 @@ namespace Utils
*/
int clipText(const QString& text)
{
TextStream err(Utils::STDERR);
auto& err = STDERR;
// List of programs and their arguments
QList<QPair<QString, QString>> clipPrograms;