Git-Mirrors/keepassxc
1
0
Fork 0
mirror of https://github.com/keepassxreboot/keepassxc.git synced 2025-04-05 04:45:57 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fix stdin/stdout encoding on Windows. (#2425)

Browse Source 
QTextStream uses the system default locale, but this breaks in
various situations: (1) It does not work on the native Windows shell
(cmd.exe, Powershell), since the default Windows locale is Windows-1252,
but the shell uses Windows-850. (2) It also breaks on *nix systems where
the locale is Latin1 or C, which is the case for most CI systems or
build servers.

We allow overriding the detected codec by setting the ENCODING_OVERRIDE
environment variable, but otherwise prefer Windows-850 on Windows and
UTF-8 on any other system, even if LANG is set to something else.

This resolves #2413
This commit is contained in:
Janek Bevendorff 2018-10-28 19:55:00 +01:00 committed by GitHub
parent c9cab250c7
commit 7263dcddfe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
19 changed files with 180 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/CMakeLists.txt
View File

@ -70,10 +70,9 @@ set(keepassx_SOURCES
core/Clock.cpp
core/Tools.cpp
core/Translator.cpp
core/Base32.h
core/Base32.cpp
cli/Utils.cpp
cli/Utils.h
cli/TextStream.cpp
crypto/Crypto.cpp
crypto/CryptoHash.cpp
crypto/Random.cpp

8
src/cli/Add.cpp
View File

@ -21,8 +21,8 @@
#include "Add.h"
#include <QCommandLineParser>
#include <QTextStream>
#include "cli/TextStream.h"
#include "cli/Utils.h"
#include "core/Database.h"
#include "core/Entry.h"
@ -41,9 +41,9 @@ Add::~Add()
int Add::execute(const QStringList& arguments)
{
QTextStream inputTextStream(Utils::STDIN, QIODevice::ReadOnly);
QTextStream outputTextStream(Utils::STDOUT, QIODevice::WriteOnly);
QTextStream errorTextStream(Utils::STDERR, QIODevice::WriteOnly);
TextStream inputTextStream(Utils::STDIN, QIODevice::ReadOnly);
TextStream outputTextStream(Utils::STDOUT, QIODevice::WriteOnly);
TextStream errorTextStream(Utils::STDERR, QIODevice::WriteOnly);
QCommandLineParser parser;
parser.setApplicationDescription(description);

8
src/cli/Clip.cpp
View File

@ -23,8 +23,8 @@
#include "Clip.h"
#include <QCommandLineParser>
#include <QTextStream>
#include "cli/TextStream.h"
#include "cli/Utils.h"
#include "core/Database.h"
#include "core/Entry.h"
@ -42,7 +42,7 @@ Clip::~Clip()
int Clip::execute(const QStringList& arguments)
{
QTextStream out(Utils::STDOUT);
TextStream out(Utils::STDOUT);
QCommandLineParser parser;
parser.setApplicationDescription(description);
@ -73,7 +73,7 @@ int Clip::execute(const QStringList& arguments)
int Clip::clipEntry(Database* database, QString entryPath, QString timeout)
{
QTextStream err(Utils::STDERR);
TextStream err(Utils::STDERR);
int timeoutSeconds = 0;
if (!timeout.isEmpty() && !timeout.toInt()) {
@ -83,7 +83,7 @@ int Clip::clipEntry(Database* database, QString entryPath, QString timeout)
timeoutSeconds = timeout.toInt();
}
QTextStream outputTextStream(Utils::STDOUT, QIODevice::WriteOnly);
TextStream outputTextStream(Utils::STDOUT, QIODevice::WriteOnly);
Entry* entry = database->rootGroup()->findEntry(entryPath);
if (!entry) {
err << QObject::tr("Entry %1 not found.").arg(entryPath) << endl;

6
src/cli/Diceware.cpp
View File

@ -21,8 +21,8 @@
#include "Diceware.h"
#include <QCommandLineParser>
#include <QTextStream>
#include "cli/TextStream.h"
#include "core/PassphraseGenerator.h"
#include "Utils.h"
@ -38,8 +38,8 @@ Diceware::~Diceware()
int Diceware::execute(const QStringList& arguments)
{
QTextStream in(Utils::STDIN, QIODevice::ReadOnly);
QTextStream out(Utils::STDOUT, QIODevice::WriteOnly);
TextStream in(Utils::STDIN, QIODevice::ReadOnly);
TextStream out(Utils::STDOUT, QIODevice::WriteOnly);
QCommandLineParser parser;
parser.setApplicationDescription(description);

8
src/cli/Edit.cpp
View File

@ -21,8 +21,8 @@
#include "Edit.h"
#include <QCommandLineParser>
#include <QTextStream>
#include "cli/TextStream.h"
#include "cli/Utils.h"
#include "core/Database.h"
#include "core/Entry.h"
@ -41,9 +41,9 @@ Edit::~Edit()
int Edit::execute(const QStringList& arguments)
{
QTextStream in(Utils::STDIN, QIODevice::ReadOnly);
QTextStream out(Utils::STDOUT, QIODevice::WriteOnly);
QTextStream err(Utils::STDERR, QIODevice::WriteOnly);
TextStream in(Utils::STDIN, QIODevice::ReadOnly);
TextStream out(Utils::STDOUT, QIODevice::WriteOnly);
TextStream err(Utils::STDERR, QIODevice::WriteOnly);
QCommandLineParser parser;
parser.setApplicationDescription(description);

8
src/cli/Estimate.cpp
View File

@ -19,8 +19,8 @@
#include "cli/Utils.h"
#include <QCommandLineParser>
#include <QTextStream>
#include "cli/TextStream.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
@ -45,7 +45,7 @@ Estimate::~Estimate()
static void estimate(const char* pwd, bool advanced)
{
QTextStream out(Utils::STDOUT, QIODevice::WriteOnly);
TextStream out(Utils::STDOUT, QIODevice::WriteOnly);
double e = 0.0;
int len = static_cast<int>(strlen(pwd));
@ -150,8 +150,8 @@ static void estimate(const char* pwd, bool advanced)
int Estimate::execute(const QStringList& arguments)
{
QTextStream in(Utils::STDIN, QIODevice::ReadOnly);
QTextStream out(Utils::STDOUT, QIODevice::WriteOnly);
TextStream in(Utils::STDIN, QIODevice::ReadOnly);
TextStream out(Utils::STDOUT, QIODevice::WriteOnly);
QCommandLineParser parser;
parser.setApplicationDescription(description);

6
src/cli/Extract.cpp
View File

@ -22,8 +22,8 @@
#include <QCommandLineParser>
#include <QFile>
#include <QTextStream>
#include "cli/TextStream.h"
#include "cli/Utils.h"
#include "core/Database.h"
#include "format/KeePass2Reader.h"
@ -43,8 +43,8 @@ Extract::~Extract()
int Extract::execute(const QStringList& arguments)
{
QTextStream out(Utils::STDOUT, QIODevice::WriteOnly);
QTextStream err(Utils::STDERR, QIODevice::WriteOnly);
TextStream out(Utils::STDOUT, QIODevice::WriteOnly);
TextStream err(Utils::STDERR, QIODevice::WriteOnly);
QCommandLineParser parser;
parser.setApplicationDescription(description);

10
src/cli/Generate.cpp
View File

@ -22,8 +22,8 @@
#include "cli/Utils.h"
#include <QCommandLineParser>
#include <QTextStream>
#include "cli/TextStream.h"
#include "core/PasswordGenerator.h"
Generate::Generate()
@ -38,9 +38,8 @@ Generate::~Generate()
int Generate::execute(const QStringList& arguments)
{
QTextStream in(Utils::STDIN, QIODevice::ReadOnly);
QTextStream out(Utils::STDOUT, QIODevice::WriteOnly);
out.setCodec("UTF-8"); // force UTF-8 to prevent ??? characters in extended-ASCII passwords
TextStream in(Utils::STDIN, QIODevice::ReadOnly);
TextStream out(Utils::STDOUT, QIODevice::WriteOnly);
QCommandLineParser parser;
parser.setApplicationDescription(description);
@ -87,8 +86,7 @@ int Generate::execute(const QStringList& arguments)
if (parser.value(len).isEmpty()) {
passwordGenerator.setLength(PasswordGenerator::DefaultLength);
} else {
int length = parser.value(len).toInt();
passwordGenerator.setLength(static_cast<size_t>(length));
passwordGenerator.setLength(parser.value(len).toInt());
}
PasswordGenerator::CharClasses classes = 0x0;

8
src/cli/List.cpp
View File

@ -22,8 +22,8 @@
#include "cli/Utils.h"
#include <QCommandLineParser>
#include <QTextStream>
#include "cli/TextStream.h"
#include "core/Database.h"
#include "core/Entry.h"
#include "core/Group.h"
@ -40,7 +40,7 @@ List::~List()
int List::execute(const QStringList& arguments)
{
QTextStream out(Utils::STDOUT);
TextStream out(Utils::STDOUT);
QCommandLineParser parser;
parser.setApplicationDescription(description);
@ -77,8 +77,8 @@ int List::execute(const QStringList& arguments)
int List::listGroup(Database* database, bool recursive, const QString& groupPath)
{
QTextStream out(Utils::STDOUT, QIODevice::WriteOnly);
QTextStream err(Utils::STDERR, QIODevice::WriteOnly);
TextStream out(Utils::STDOUT, QIODevice::WriteOnly);
TextStream err(Utils::STDERR, QIODevice::WriteOnly);
if (groupPath.isEmpty()) {
out << database->rootGroup()->print(recursive) << flush;

10
src/cli/Locate.cpp
View File

@ -1,5 +1,3 @@
#include <utility>
/*
* Copyright (C) 2017 KeePassXC Team <team@keepassxc.org>
*
@ -24,8 +22,8 @@
#include <QCommandLineParser>
#include <QStringList>
#include <QTextStream>
#include "cli/TextStream.h"
#include "cli/Utils.h"
#include "core/Global.h"
#include "core/Database.h"
@ -44,7 +42,7 @@ Locate::~Locate()
int Locate::execute(const QStringList& arguments)
{
QTextStream out(Utils::STDOUT, QIODevice::WriteOnly);
TextStream out(Utils::STDOUT, QIODevice::WriteOnly);
QCommandLineParser parser;
parser.setApplicationDescription(description);
@ -73,8 +71,8 @@ int Locate::execute(const QStringList& arguments)
int Locate::locateEntry(Database* database, const QString& searchTerm)
{
QTextStream out(Utils::STDOUT, QIODevice::WriteOnly);
QTextStream err(Utils::STDERR, QIODevice::WriteOnly);
TextStream out(Utils::STDOUT, QIODevice::WriteOnly);
TextStream err(Utils::STDERR, QIODevice::WriteOnly);
QStringList results = database->rootGroup()->locate(searchTerm);
if (results.isEmpty()) {

6
src/cli/Merge.cpp
View File

@ -18,8 +18,8 @@
#include "Merge.h"
#include <QCommandLineParser>
#include <QTextStream>
#include "cli/TextStream.h"
#include "core/Database.h"
#include "core/Merger.h"
#include "cli/Utils.h"
@ -38,8 +38,8 @@ Merge::~Merge()
int Merge::execute(const QStringList& arguments)
{
QTextStream out(Utils::STDOUT, QIODevice::WriteOnly);
QTextStream err(Utils::STDERR, QIODevice::WriteOnly);
TextStream out(Utils::STDOUT, QIODevice::WriteOnly);
TextStream err(Utils::STDERR, QIODevice::WriteOnly);
QCommandLineParser parser;
parser.setApplicationDescription(description);

8
src/cli/Remove.cpp
View File

@ -23,8 +23,8 @@
#include <QCommandLineParser>
#include <QCoreApplication>
#include <QStringList>
#include <QTextStream>
#include "cli/TextStream.h"
#include "cli/Utils.h"
#include "core/Database.h"
#include "core/Entry.h"
@ -44,7 +44,7 @@ Remove::~Remove()
int Remove::execute(const QStringList& arguments)
{
QTextStream out(Utils::STDERR, QIODevice::WriteOnly);
TextStream out(Utils::STDERR, QIODevice::WriteOnly);
QCommandLineParser parser;
parser.setApplicationDescription(QCoreApplication::tr("main", "Remove an entry from the database."));
@ -73,8 +73,8 @@ int Remove::execute(const QStringList& arguments)
int Remove::removeEntry(Database* database, const QString& databasePath, const QString& entryPath)
{
QTextStream out(Utils::STDOUT, QIODevice::WriteOnly);
QTextStream err(Utils::STDERR, QIODevice::WriteOnly);
TextStream out(Utils::STDOUT, QIODevice::WriteOnly);
TextStream err(Utils::STDERR, QIODevice::WriteOnly);
QPointer<Entry> entry = database->rootGroup()->findEntryByPath(entryPath);
if (!entry) {

10
src/cli/Show.cpp
View File

@ -21,8 +21,8 @@
#include <stdio.h>
#include <QCommandLineParser>
#include <QTextStream>
#include "cli/TextStream.h"
#include "core/Database.h"
#include "core/Entry.h"
#include "core/Group.h"
@ -41,7 +41,7 @@ Show::~Show()
int Show::execute(const QStringList& arguments)
{
QTextStream out(Utils::STDOUT);
TextStream out(Utils::STDOUT);
QCommandLineParser parser;
parser.setApplicationDescription(description);
@ -78,9 +78,9 @@ int Show::execute(const QStringList& arguments)
int Show::showEntry(Database* database, QStringList attributes, const QString& entryPath)
{
QTextStream in(Utils::STDIN, QIODevice::ReadOnly);
QTextStream out(Utils::STDOUT, QIODevice::WriteOnly);
QTextStream err(Utils::STDERR, QIODevice::WriteOnly);
TextStream in(Utils::STDIN, QIODevice::ReadOnly);
TextStream out(Utils::STDOUT, QIODevice::WriteOnly);
TextStream err(Utils::STDERR, QIODevice::WriteOnly);
Entry* entry = database->rootGroup()->findEntry(entryPath);
if (!entry) {

73
src/cli/TextStream.cpp Normal file
View File

@ -0,0 +1,73 @@
/*
* Copyright (C) 2018 KeePassXC Team <team@keepassxc.org>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 or (at your option)
* version 3 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "TextStream.h"
#include <QProcessEnvironment>
#include <QTextCodec>
TextStream::TextStream()
{
detectCodec();
}
TextStream::TextStream(QIODevice* device)
: QTextStream(device)
{
detectCodec();
}
TextStream::TextStream(FILE* fileHandle, QIODevice::OpenMode openMode)
: QTextStream(fileHandle, openMode)
{
detectCodec();
}
TextStream::TextStream(QString* string, QIODevice::OpenMode openMode)
: QTextStream(string, openMode)
{
detectCodec();
}
TextStream::TextStream(QByteArray* array, QIODevice::OpenMode openMode)
: QTextStream(array, openMode)
{
detectCodec();
}
TextStream::TextStream(const QByteArray& array, QIODevice::OpenMode openMode)
: QTextStream(array, openMode)
{
detectCodec();
}
void TextStream::detectCodec()
{
QString codecName = "UTF-8";
auto env = QProcessEnvironment::systemEnvironment();
#ifdef Q_OS_WIN
if (!env.contains("SHELL")) {
// native shell (no Msys or cygwin)
codecName = "Windows-850";
}
#endif
codecName = env.value("ENCODING_OVERRIDE", codecName);
auto* codec = QTextCodec::codecForName(codecName.toLatin1());
if (codec) {
setCodec(codec);
}
}

50
src/cli/TextStream.h Normal file
View File

@ -0,0 +1,50 @@
/*
* Copyright (C) 2018 KeePassXC Team <team@keepassxc.org>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 or (at your option)
* version 3 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef KEEPASSXC_TEXTSTREAM_H
#define KEEPASSXC_TEXTSTREAM_H
#include <QTextStream>
/**
* QTextStream with codec fixes for the Windows command line.
*
* QTextStream uses the system default locale, but this breaks in various
* situations: (1) It does not work on the native Windows shell (cmd.exe, Powershell),
* since the default Windows locale is Windows-1252, but the shell uses Windows-850.
* (2) It also breaks on *nix systems where the locale is Latin1 or C, which
* is the case for most CI systems or build servers.
*
* We allow overriding the detected codec by setting the ENCODING_OVERRIDE
* environment variable, but otherwise prefer Windows-850 on Windows and UTF-8
* on any other system, even if LANG is set to something else.
*/
class TextStream : public QTextStream
{
public:
TextStream();
explicit TextStream(QIODevice* device);
explicit TextStream(FILE* fileHandle, QIODevice::OpenMode openMode = QIODevice::ReadWrite);
explicit TextStream(QString* string, QIODevice::OpenMode openMode = QIODevice::ReadWrite);
explicit TextStream(QByteArray* array, QIODevice::OpenMode openMode = QIODevice::ReadWrite);
explicit TextStream(const QByteArray& array, QIODevice::OpenMode openMode = QIODevice::ReadOnly);
private:
void detectCodec();
};
#endif //KEEPASSXC_TEXTSTREAM_H

6
src/cli/Utils.cpp
View File

@ -97,7 +97,7 @@ void setNextPassword(const QString& password)
*/
QString getPassword()
{
QTextStream out(STDOUT, QIODevice::WriteOnly);
TextStream out(STDOUT, QIODevice::WriteOnly);
// return preset password if one is set
if (!Test::nextPasswords.isEmpty()) {
@ -107,7 +107,7 @@ QString getPassword()
return password;
}
QTextStream in(STDIN, QIODevice::ReadOnly);
TextStream in(STDIN, QIODevice::ReadOnly);
setStdinEcho(false);
QString line = in.readLine();
@ -123,7 +123,7 @@ QString getPassword()
*/
int clipText(const QString& text)
{
QTextStream err(Utils::STDERR);
TextStream err(Utils::STDERR);
QString programName = "";
QStringList arguments;

2
src/cli/Utils.h
View File

@ -19,7 +19,7 @@
#define KEEPASSXC_UTILS_H
#include <QtCore/qglobal.h>
#include <QTextStream>
#include "cli/TextStream.h"
namespace Utils
{

4
src/cli/keepassxc-cli.cpp
View File

@ -20,8 +20,8 @@
#include <QCommandLineParser>
#include <QCoreApplication>
#include <QStringList>
#include <QTextStream>
#include "cli/TextStream.h"
#include <cli/Command.h>
#include "config-keepassx.h"
@ -46,7 +46,7 @@ int main(int argc, char** argv)
Bootstrap::bootstrapApplication();
#endif
QTextStream out(stdout);
TextStream out(stdout);
QStringList arguments;
for (int i = 0; i < argc; ++i) {
arguments << QString(argv[i]);

7
tests/TestCli.cpp
View File

@ -455,12 +455,13 @@ void TestCli::testGenerate()
qint64 pos = 0;
// run multiple times to make accidental passes unlikely
TextStream stream(m_stdoutFile.data());
for (int i = 0; i < 10; ++i) {
generateCmd.execute(parameters);
m_stdoutFile->seek(pos);
stream.seek(pos);
QRegularExpression regex(pattern);
QString password = QString::fromUtf8(m_stdoutFile->readLine());
pos = m_stdoutFile->pos();
QString password = stream.readLine();
pos = stream.pos();
QVERIFY2(regex.match(password).hasMatch(), qPrintable("Password " + password + " does not match pattern " + pattern));
}
}