Git-Mirrors/keepassxc
1
0
Fork 0
mirror of https://github.com/keepassxreboot/keepassxc.git synced 2024-10-01 01:26:01 -04:00
Code Issues Packages Projects Releases Wiki Activity
ab95690043
keepassxc/tests/TestPasswordGenerator.cpp

284 lines
14 KiB
C++
Raw Normal View History

Add CLI tests and improve coding style and i18n The CLI module was lacking unit test coverage and showed some severe coding style violations, which this patch addresses. In addition, all uses of qCritical() with untranslatble raw char* sequences were removed in favor of proper locale strings. These are written to STDERR through QTextStreams and support output redirection for testing purposes. With this change, error messages don't depend on the global Qt logging settings and targets anymore and go directly to the terminal or into a file if needed. This patch also fixes a bug discovered during unit test development, where the extract command would just dump the raw XML contents without decrypting embedded Salsa20-protected values first, making the XML export mostly useless, since passwords are scrambled. Lastly, all CLI commands received a dedicated -h/--help option.
2018-09-29 13:00:47 -04:00
/*
* 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 "TestPasswordGenerator.h"
#include "crypto/Crypto.h"
#include <QRegularExpression>
Restore correct formatting Many lines were not conformant with the project's formatting rules. This patch should fix all formatting and whitespace issues in the code base. A clang-format directive was put around the connect() calls containing SIGNALs and SLOTs whose signatures would be denormalized because of the formatting rules.
2018-10-31 23:27:38 -04:00
#include <QTest>
Add CLI tests and improve coding style and i18n The CLI module was lacking unit test coverage and showed some severe coding style violations, which this patch addresses. In addition, all uses of qCritical() with untranslatble raw char* sequences were removed in favor of proper locale strings. These are written to STDERR through QTextStreams and support output redirection for testing purposes. With this change, error messages don't depend on the global Qt logging settings and targets anymore and go directly to the terminal or into a file if needed. This patch also fixes a bug discovered during unit test development, where the extract command would just dump the raw XML contents without decrypting embedded Salsa20-protected values first, making the XML export mostly useless, since passwords are scrambled. Lastly, all CLI commands received a dedicated -h/--help option.
2018-09-29 13:00:47 -04:00
QTEST_GUILESS_MAIN(TestPasswordGenerator)
Add -i/--include option to "generate" CLI command. (#7112)
2021-12-07 23:40:09 -05:00
Q_DECLARE_METATYPE(PasswordGenerator::CharClasses)
Q_DECLARE_METATYPE(PasswordGenerator::GeneratorFlags)
namespace
{
PasswordGenerator::CharClasses to_flags(PasswordGenerator::CharClass x)
{
return x;
}
PasswordGenerator::GeneratorFlags to_flags(PasswordGenerator::GeneratorFlag x)
{
return x;
}
} // namespace
Add CLI tests and improve coding style and i18n The CLI module was lacking unit test coverage and showed some severe coding style violations, which this patch addresses. In addition, all uses of qCritical() with untranslatble raw char* sequences were removed in favor of proper locale strings. These are written to STDERR through QTextStreams and support output redirection for testing purposes. With this change, error messages don't depend on the global Qt logging settings and targets anymore and go directly to the terminal or into a file if needed. This patch also fixes a bug discovered during unit test development, where the extract command would just dump the raw XML contents without decrypting embedded Salsa20-protected values first, making the XML export mostly useless, since passwords are scrambled. Lastly, all CLI commands received a dedicated -h/--help option.
2018-09-29 13:00:47 -04:00
void TestPasswordGenerator::initTestCase()
{
QVERIFY(Crypto::init());
}
Add -i/--include option to "generate" CLI command. (#7112)
2021-12-07 23:40:09 -05:00
void TestPasswordGenerator::init()
{
m_generator.reset();
}
void TestPasswordGenerator::testCustomCharacterSet_data()
Allow defining additional characters for the password generator See issue #3271 for a motivation of this feature. This patch adds an additional text input to the advanced view of the password generator. All characters of this input field (if not empty) will be added as another group to the password generator. The characters from the excluded field have precedence over the characters from this new field, meaning any character added to both fields will *not* appear in any generated password. As the characters from this new field will be added as their own group to the password generator, checking the 'Include characters from every group' checkbox will force at least character to be chosen from the new input field. The `PasswordGenerator` class has also been changed so that the `isValid` method returns `true` if only characters from the new input field would be used. There is a new, simple test that covers the new feature. While the test only uses ASCII characters, any Unicode characters can be used with the new feature.
2019-11-16 11:51:56 -05:00
{
Add -i/--include option to "generate" CLI command. (#7112)
2021-12-07 23:40:09 -05:00
QTest::addColumn<PasswordGenerator::CharClasses>("activeCharacterClasses");
QTest::addColumn<QString>("customCharacterSet");
QTest::addColumn<QRegularExpression>("expected");
QTest::addRow("With active classes") << to_flags(PasswordGenerator::CharClass::UpperLetters) << "abc"
<< QRegularExpression("^[abcA-Z]{2000}$");
QTest::addRow("Without any active class")
<< to_flags(PasswordGenerator::CharClass::NoClass) << "abc" << QRegularExpression("^[abc]{2000}$");
}
void TestPasswordGenerator::testCustomCharacterSet()
{
QFETCH(PasswordGenerator::CharClasses, activeCharacterClasses);
QFETCH(QString, customCharacterSet);
QFETCH(QRegularExpression, expected);
m_generator.setCharClasses(activeCharacterClasses);
m_generator.setCustomCharacterSet(customCharacterSet);
m_generator.setLength(2000);
QVERIFY(m_generator.isValid());
QString password = m_generator.generatePassword();
Allow defining additional characters for the password generator See issue #3271 for a motivation of this feature. This patch adds an additional text input to the advanced view of the password generator. All characters of this input field (if not empty) will be added as another group to the password generator. The characters from the excluded field have precedence over the characters from this new field, meaning any character added to both fields will *not* appear in any generated password. As the characters from this new field will be added as their own group to the password generator, checking the 'Include characters from every group' checkbox will force at least character to be chosen from the new input field. The `PasswordGenerator` class has also been changed so that the `isValid` method returns `true` if only characters from the new input field would be used. There is a new, simple test that covers the new feature. While the test only uses ASCII characters, any Unicode characters can be used with the new feature.
2019-11-16 11:51:56 -05:00
QCOMPARE(password.size(), 2000);
Add -i/--include option to "generate" CLI command. (#7112)
2021-12-07 23:40:09 -05:00
QVERIFY(expected.match(password).hasMatch());
}
void TestPasswordGenerator::testCharClasses_data()
{
QTest::addColumn<PasswordGenerator::CharClasses>("activeCharacterClasses");
QTest::addColumn<QRegularExpression>("expected");
QTest::addRow("Lower Letters") << to_flags(PasswordGenerator::CharClass::LowerLetters)
<< QRegularExpression(R"(^[a-z]{2000}$)");
QTest::addRow("Upper Letters") << to_flags(PasswordGenerator::CharClass::UpperLetters)
<< QRegularExpression(R"(^[A-Z]{2000}$)");
QTest::addRow("Numbers") << to_flags(PasswordGenerator::CharClass::Numbers) << QRegularExpression(R"(^\d{2000}$)");
QTest::addRow("Braces") << to_flags(PasswordGenerator::CharClass::Braces)
<< QRegularExpression(R"(^[\(\)\[\]\{\}]{2000}$)");
QTest::addRow("Punctuation") << to_flags(PasswordGenerator::CharClass::Punctuation)
<< QRegularExpression(R"(^[\.,:;]{2000}$)");
QTest::addRow("Quotes") << to_flags(PasswordGenerator::CharClass::Quotes) << QRegularExpression(R"(^["']{2000}$)");
QTest::addRow("Dashes") << to_flags(PasswordGenerator::CharClass::Dashes)
<< QRegularExpression(R"(^[\-/\\_|]{2000}$)");
QTest::addRow("Math") << to_flags(PasswordGenerator::CharClass::Math) << QRegularExpression(R"(^[!\*\+\-<=>\?]+$)");
QTest::addRow("Logograms") << to_flags(PasswordGenerator::CharClass::Logograms)
<< QRegularExpression(R"(^[#`~%&^$@]{2000}$)");
QTest::addRow("Extended ASCII") << to_flags(PasswordGenerator::CharClass::EASCII)
<< QRegularExpression(R"(^[^a-zA-Z0-9\.,:;"'\-/\\_|!\*\+\-<=>\?#`~%&^$@]{2000}$)");
QTest::addRow("Combinations 1") << (PasswordGenerator::CharClass::LowerLetters
| PasswordGenerator::CharClass::UpperLetters
| PasswordGenerator::CharClass::Braces)
<< QRegularExpression(R"(^[a-zA-Z\(\)\[\]\{\}]{2000}$)");
QTest::addRow("Combinations 2") << (PasswordGenerator::CharClass::Quotes | PasswordGenerator::CharClass::Numbers
| PasswordGenerator::CharClass::Dashes)
<< QRegularExpression(R"(^["'\d\-/\\_|]{2000}$)");
Allow defining additional characters for the password generator See issue #3271 for a motivation of this feature. This patch adds an additional text input to the advanced view of the password generator. All characters of this input field (if not empty) will be added as another group to the password generator. The characters from the excluded field have precedence over the characters from this new field, meaning any character added to both fields will *not* appear in any generated password. As the characters from this new field will be added as their own group to the password generator, checking the 'Include characters from every group' checkbox will force at least character to be chosen from the new input field. The `PasswordGenerator` class has also been changed so that the `isValid` method returns `true` if only characters from the new input field would be used. There is a new, simple test that covers the new feature. While the test only uses ASCII characters, any Unicode characters can be used with the new feature.
2019-11-16 11:51:56 -05:00
}
Add CLI tests and improve coding style and i18n The CLI module was lacking unit test coverage and showed some severe coding style violations, which this patch addresses. In addition, all uses of qCritical() with untranslatble raw char* sequences were removed in favor of proper locale strings. These are written to STDERR through QTextStreams and support output redirection for testing purposes. With this change, error messages don't depend on the global Qt logging settings and targets anymore and go directly to the terminal or into a file if needed. This patch also fixes a bug discovered during unit test development, where the extract command would just dump the raw XML contents without decrypting embedded Salsa20-protected values first, making the XML export mostly useless, since passwords are scrambled. Lastly, all CLI commands received a dedicated -h/--help option.
2018-09-29 13:00:47 -04:00
void TestPasswordGenerator::testCharClasses()
{
Add -i/--include option to "generate" CLI command. (#7112)
2021-12-07 23:40:09 -05:00
QFETCH(PasswordGenerator::CharClasses, activeCharacterClasses);
QFETCH(QRegularExpression, expected);
m_generator.setCharClasses(activeCharacterClasses);
m_generator.setLength(2000);
QVERIFY(m_generator.isValid());
QString password = m_generator.generatePassword();
Add CLI tests and improve coding style and i18n The CLI module was lacking unit test coverage and showed some severe coding style violations, which this patch addresses. In addition, all uses of qCritical() with untranslatble raw char* sequences were removed in favor of proper locale strings. These are written to STDERR through QTextStreams and support output redirection for testing purposes. With this change, error messages don't depend on the global Qt logging settings and targets anymore and go directly to the terminal or into a file if needed. This patch also fixes a bug discovered during unit test development, where the extract command would just dump the raw XML contents without decrypting embedded Salsa20-protected values first, making the XML export mostly useless, since passwords are scrambled. Lastly, all CLI commands received a dedicated -h/--help option.
2018-09-29 13:00:47 -04:00
QCOMPARE(password.size(), 2000);
Add -i/--include option to "generate" CLI command. (#7112)
2021-12-07 23:40:09 -05:00
QVERIFY(expected.match(password).hasMatch());
}
void TestPasswordGenerator::testLookalikeExclusion_data()
{
QTest::addColumn<PasswordGenerator::CharClasses>("activeCharacterClasses");
QTest::addColumn<QRegularExpression>("expected");
QTest::addRow("Upper Letters") << (PasswordGenerator::CharClass::LowerLetters
| PasswordGenerator::CharClass::UpperLetters)
<< QRegularExpression("^[^lBGIO]{2000}$");
QTest::addRow("Letters and Numbers") << (PasswordGenerator::CharClass::LowerLetters
| PasswordGenerator::CharClass::UpperLetters
| PasswordGenerator::CharClass::Numbers)
<< QRegularExpression("^[^lBGIO0168]{2000}$");
QTest::addRow("Letters, Numbers and extended ASCII")
<< (PasswordGenerator::CharClass::LowerLetters | PasswordGenerator::CharClass::UpperLetters
| PasswordGenerator::CharClass::Numbers | PasswordGenerator::CharClass::EASCII)
<< QRegularExpression("^[^lBGIO0168﹒]{2000}$");
Add CLI tests and improve coding style and i18n The CLI module was lacking unit test coverage and showed some severe coding style violations, which this patch addresses. In addition, all uses of qCritical() with untranslatble raw char* sequences were removed in favor of proper locale strings. These are written to STDERR through QTextStreams and support output redirection for testing purposes. With this change, error messages don't depend on the global Qt logging settings and targets anymore and go directly to the terminal or into a file if needed. This patch also fixes a bug discovered during unit test development, where the extract command would just dump the raw XML contents without decrypting embedded Salsa20-protected values first, making the XML export mostly useless, since passwords are scrambled. Lastly, all CLI commands received a dedicated -h/--help option.
2018-09-29 13:00:47 -04:00
}
void TestPasswordGenerator::testLookalikeExclusion()
{
Add -i/--include option to "generate" CLI command. (#7112)
2021-12-07 23:40:09 -05:00
QFETCH(PasswordGenerator::CharClasses, activeCharacterClasses);
QFETCH(QRegularExpression, expected);
m_generator.setFlags(PasswordGenerator::ExcludeLookAlike);
m_generator.setCharClasses(activeCharacterClasses);
m_generator.setLength(2000);
QVERIFY(m_generator.isValid());
QString password = m_generator.generatePassword();
Add CLI tests and improve coding style and i18n The CLI module was lacking unit test coverage and showed some severe coding style violations, which this patch addresses. In addition, all uses of qCritical() with untranslatble raw char* sequences were removed in favor of proper locale strings. These are written to STDERR through QTextStreams and support output redirection for testing purposes. With this change, error messages don't depend on the global Qt logging settings and targets anymore and go directly to the terminal or into a file if needed. This patch also fixes a bug discovered during unit test development, where the extract command would just dump the raw XML contents without decrypting embedded Salsa20-protected values first, making the XML export mostly useless, since passwords are scrambled. Lastly, all CLI commands received a dedicated -h/--help option.
2018-09-29 13:00:47 -04:00
QCOMPARE(password.size(), 2000);
Add -i/--include option to "generate" CLI command. (#7112)
2021-12-07 23:40:09 -05:00
QVERIFY(expected.match(password).hasMatch());
}
void TestPasswordGenerator::testValidity_data()
{
QTest::addColumn<PasswordGenerator::CharClasses>("activeCharacterClasses");
QTest::addColumn<PasswordGenerator::GeneratorFlags>("generatorFlags");
QTest::addColumn<QString>("customCharacterSet");
QTest::addColumn<QString>("excludedCharacters");
QTest::addColumn<int>("length");
QTest::addColumn<bool>("isValid");
QTest::addRow("No active class") << to_flags(PasswordGenerator::CharClass::NoClass)
<< PasswordGenerator::GeneratorFlags() << QString() << QString()
<< PasswordGenerator::DefaultLength << false;
QTest::addRow("0 length") << to_flags(PasswordGenerator::CharClass::DefaultCharset)
<< PasswordGenerator::GeneratorFlags() << QString() << QString() << 0 << false;
QTest::addRow("All active classes excluded")
<< to_flags(PasswordGenerator::CharClass::Numbers) << PasswordGenerator::GeneratorFlags() << QString()
<< QString("0123456789") << PasswordGenerator::DefaultLength << false;
QTest::addRow("All active classes excluded")
<< to_flags(PasswordGenerator::CharClass::NoClass) << PasswordGenerator::GeneratorFlags() << QString()
<< QString("0123456789") << PasswordGenerator::DefaultLength << false;
QTest::addRow("One from every class with too few classes")
<< (PasswordGenerator::CharClass::LowerLetters | PasswordGenerator::CharClass::UpperLetters)
<< to_flags(PasswordGenerator::GeneratorFlag::CharFromEveryGroup) << QString() << QString() << 1 << false;
QTest::addRow("One from every class with excluded classes")
<< (PasswordGenerator::CharClass::LowerLetters | PasswordGenerator::CharClass::UpperLetters
| PasswordGenerator::CharClass::Numbers)
<< to_flags(PasswordGenerator::GeneratorFlag::CharFromEveryGroup) << QString() << QString("0123456789") << 2
<< true;
QTest::addRow("Defaults valid") << to_flags(PasswordGenerator::CharClass::DefaultCharset)
<< to_flags(PasswordGenerator::GeneratorFlag::DefaultFlags)
<< PasswordGenerator::DefaultCustomCharacterSet
<< PasswordGenerator::DefaultExcludedChars << PasswordGenerator::DefaultLength
<< true;
QTest::addRow("No active classes but custom charset")
<< to_flags(PasswordGenerator::CharClass::NoClass) << to_flags(PasswordGenerator::GeneratorFlag::DefaultFlags)
<< QString("a") << QString() << 1 << true;
}
void TestPasswordGenerator::testValidity()
{
QFETCH(PasswordGenerator::CharClasses, activeCharacterClasses);
QFETCH(PasswordGenerator::GeneratorFlags, generatorFlags);
QFETCH(QString, customCharacterSet);
QFETCH(QString, excludedCharacters);
QFETCH(int, length);
QFETCH(bool, isValid);
m_generator.setCharClasses(activeCharacterClasses);
m_generator.setFlags(generatorFlags);
m_generator.setCustomCharacterSet(customCharacterSet);
m_generator.setExcludedCharacterSet(excludedCharacters);
m_generator.setLength(length);
QCOMPARE(m_generator.isValid(), isValid);
}
void TestPasswordGenerator::testMinLength_data()
{
QTest::addColumn<PasswordGenerator::CharClasses>("activeCharacterClasses");
QTest::addColumn<PasswordGenerator::GeneratorFlags>("generatorFlags");
QTest::addColumn<QString>("customCharacterSet");
QTest::addColumn<QString>("excludedCharacters");
QTest::addColumn<int>("expectedMinLength");
QTest::addRow("No restriction without charsFromEveryGroup")
<< to_flags(PasswordGenerator::CharClass::Numbers)
<< to_flags(PasswordGenerator::GeneratorFlag::CharFromEveryGroup)
<< PasswordGenerator::DefaultCustomCharacterSet << PasswordGenerator::DefaultExcludedChars << 1;
QTest::addRow("Min length should equal number of active classes")
<< (PasswordGenerator::CharClass::LowerLetters | PasswordGenerator::CharClass::UpperLetters
| PasswordGenerator::CharClass::Numbers)
<< to_flags(PasswordGenerator::GeneratorFlag::CharFromEveryGroup) << QString() << QString() << 3;
QTest::addRow("Classes fully excluded by excluded characters do not count towards min length")
<< (PasswordGenerator::CharClass::Numbers | PasswordGenerator::LowerLetters
| PasswordGenerator::CharClass::UpperLetters)
<< to_flags(PasswordGenerator::GeneratorFlag::CharFromEveryGroup) << QString() << QString("0123456789") << 2;
QTest::addRow("Custom charset counts as class")
<< to_flags(PasswordGenerator::CharClass::UpperLetters)
<< to_flags(PasswordGenerator::GeneratorFlag::CharFromEveryGroup) << QString("a") << QString() << 2;
QTest::addRow("Custom characters count even if included by an active class already")
<< (PasswordGenerator::CharClass::LowerLetters | PasswordGenerator::CharClass::UpperLetters
| PasswordGenerator::CharClass::Numbers)
<< to_flags(PasswordGenerator::GeneratorFlag::CharFromEveryGroup) << QString("012345") << QString() << 4;
}
void TestPasswordGenerator::testMinLength()
{
QFETCH(PasswordGenerator::CharClasses, activeCharacterClasses);
QFETCH(PasswordGenerator::GeneratorFlags, generatorFlags);
QFETCH(QString, customCharacterSet);
QFETCH(QString, excludedCharacters);
QFETCH(int, expectedMinLength);
m_generator.setCharClasses(activeCharacterClasses);
m_generator.setFlags(generatorFlags);
m_generator.setCustomCharacterSet(customCharacterSet);
m_generator.setExcludedCharacterSet(excludedCharacters);
QCOMPARE(m_generator.getMinLength(), expectedMinLength);
}
void TestPasswordGenerator::testReset()
{
PasswordGenerator default_generator;
// Modify generator
m_generator.setCharClasses(PasswordGenerator::CharClass::NoClass);
m_generator.setFlags(PasswordGenerator::GeneratorFlag::NoFlags);
m_generator.setCustomCharacterSet("avc");
m_generator.setExcludedCharacterSet("asdv");
m_generator.setLength(m_generator.getLength() + 1);
Q_ASSERT(m_generator.getActiveClasses() != default_generator.getActiveClasses());
Q_ASSERT(m_generator.getFlags() != default_generator.getFlags());
Q_ASSERT(m_generator.getCustomCharacterSet() != default_generator.getCustomCharacterSet());
Q_ASSERT(m_generator.getExcludedCharacterSet() != default_generator.getExcludedCharacterSet());
Add CLI tests and improve coding style and i18n The CLI module was lacking unit test coverage and showed some severe coding style violations, which this patch addresses. In addition, all uses of qCritical() with untranslatble raw char* sequences were removed in favor of proper locale strings. These are written to STDERR through QTextStreams and support output redirection for testing purposes. With this change, error messages don't depend on the global Qt logging settings and targets anymore and go directly to the terminal or into a file if needed. This patch also fixes a bug discovered during unit test development, where the extract command would just dump the raw XML contents without decrypting embedded Salsa20-protected values first, making the XML export mostly useless, since passwords are scrambled. Lastly, all CLI commands received a dedicated -h/--help option.
2018-09-29 13:00:47 -04:00
Add -i/--include option to "generate" CLI command. (#7112)
2021-12-07 23:40:09 -05:00
m_generator.reset();
QCOMPARE(m_generator.getActiveClasses(), default_generator.getActiveClasses());
QCOMPARE(m_generator.getFlags(), default_generator.getFlags());
QCOMPARE(m_generator.getCustomCharacterSet(), default_generator.getCustomCharacterSet());
QCOMPARE(m_generator.getExcludedCharacterSet(), default_generator.getExcludedCharacterSet());
QCOMPARE(m_generator.getLength(), default_generator.getLength());
Add CLI tests and improve coding style and i18n The CLI module was lacking unit test coverage and showed some severe coding style violations, which this patch addresses. In addition, all uses of qCritical() with untranslatble raw char* sequences were removed in favor of proper locale strings. These are written to STDERR through QTextStreams and support output redirection for testing purposes. With this change, error messages don't depend on the global Qt logging settings and targets anymore and go directly to the terminal or into a file if needed. This patch also fixes a bug discovered during unit test development, where the extract command would just dump the raw XML contents without decrypting embedded Salsa20-protected values first, making the XML export mostly useless, since passwords are scrambled. Lastly, all CLI commands received a dedicated -h/--help option.
2018-09-29 13:00:47 -04:00
}
Reference in New Issue Copy Permalink