diff --git a/autotests/classifytest.cpp b/autotests/classifytest.cpp index 4b4bff0d4..9b221c348 100644 --- a/autotests/classifytest.cpp +++ b/autotests/classifytest.cpp @@ -1,103 +1,121 @@ /* This file is part of libkleopatra's test suite. SPDX-FileCopyrightText: 2023 g10 Code GmbH SPDX-FileContributor: Carl Schwan SPDX-License-Identifier: LGPL-2.0-or-later */ #include #include #include #include class ClassifyTest : public QObject { Q_OBJECT private Q_SLOTS: void initTestCase() { } void cleanupTestCase() { } void identifyFileName() { QTemporaryDir dir; const auto fileName = dir.filePath(QStringLiteral("msg.asc")); const auto fileName1 = dir.filePath(QStringLiteral("msg(1).asc")); { QFile asc(fileName); QVERIFY(asc.open(QIODevice::WriteOnly)); QFile asc1(fileName1); QVERIFY(asc1.open(QIODevice::WriteOnly)); } QVERIFY(Kleo::isMimeFile(Kleo::classify(fileName))); QVERIFY(Kleo::isMimeFile(fileName1)); } void identifyMimeFileExtensionTest() { QTemporaryFile mbox; mbox.setFileTemplate("XXXXXX.mbox"); QVERIFY(mbox.open()); QVERIFY(Kleo::mayBeMimeFile(Kleo::classify(mbox.fileName()))); QTemporaryFile eml; eml.setFileTemplate("XXXXXX.eml"); QVERIFY(eml.open()); QVERIFY(Kleo::mayBeMimeFile(eml.fileName())); QCOMPARE(QStringLiteral("Ascii, MimeFile"), Kleo::printableClassification(Kleo::classify(eml.fileName()))); } void identifyCertificateStoreExtensionTest() { QTemporaryFile crl; crl.setFileTemplate("XXXXXX.crl"); QVERIFY(crl.open()); QVERIFY(Kleo::isCertificateRevocationList(crl.fileName())); } void findSignaturesTest() { QTemporaryFile sig; sig.setFileTemplate("XXXXXX.sig"); QVERIFY(sig.open()); QFileInfo fi(sig.fileName()); const auto signatures = Kleo::findSignatures(fi.baseName()); QCOMPARE(1, signatures.count()); QCOMPARE(fi.baseName() + QStringLiteral(".sig"), signatures[0]); } void findOutputFileNameNotFoundTest() { QTemporaryFile unknown; unknown.setFileTemplate("XXXXXX.unknown"); QVERIFY(unknown.open()); QCOMPARE(unknown.fileName() + QStringLiteral(".out"), Kleo::outputFileName(unknown.fileName())); } void findOutputFileNameTest() { QTemporaryFile sig; sig.setFileTemplate("XXXXXX.sig"); QVERIFY(sig.open()); QFileInfo fi(sig.fileName()); QCOMPARE(fi.path() + QLatin1Char('/') + fi.baseName(), Kleo::outputFileName(sig.fileName())); } + + void test_outputFileExtension() + { + QCOMPARE(Kleo::outputFileExtension(Kleo::Class::OpenPGP | Kleo::Class::CipherText | Kleo::Class::Binary, false), QStringLiteral("gpg")); + QCOMPARE(Kleo::outputFileExtension(Kleo::Class::OpenPGP | Kleo::Class::CipherText | Kleo::Class::Binary, true), QStringLiteral("pgp")); + QCOMPARE(Kleo::outputFileExtension(Kleo::Class::OpenPGP | Kleo::Class::CipherText | Kleo::Class::Ascii, false), QStringLiteral("asc")); + QCOMPARE(Kleo::outputFileExtension(Kleo::Class::OpenPGP | Kleo::Class::CipherText | Kleo::Class::Ascii, true), QStringLiteral("asc")); + + QCOMPARE(Kleo::outputFileExtension(Kleo::Class::OpenPGP | Kleo::Class::DetachedSignature | Kleo::Class::Binary, false), QStringLiteral("sig")); + QCOMPARE(Kleo::outputFileExtension(Kleo::Class::OpenPGP | Kleo::Class::DetachedSignature | Kleo::Class::Binary, true), QStringLiteral("pgp")); + QCOMPARE(Kleo::outputFileExtension(Kleo::Class::OpenPGP | Kleo::Class::DetachedSignature | Kleo::Class::Ascii, false), QStringLiteral("asc")); + QCOMPARE(Kleo::outputFileExtension(Kleo::Class::OpenPGP | Kleo::Class::DetachedSignature | Kleo::Class::Ascii, true), QStringLiteral("asc")); + + QCOMPARE(Kleo::outputFileExtension(Kleo::Class::CMS | Kleo::Class::CipherText | Kleo::Class::Binary, false), QStringLiteral("p7m")); + QCOMPARE(Kleo::outputFileExtension(Kleo::Class::CMS | Kleo::Class::CipherText | Kleo::Class::Ascii, false), QStringLiteral("p7m")); + QCOMPARE(Kleo::outputFileExtension(Kleo::Class::CMS | Kleo::Class::DetachedSignature | Kleo::Class::Binary, false), QStringLiteral("p7s")); + QCOMPARE(Kleo::outputFileExtension(Kleo::Class::CMS | Kleo::Class::DetachedSignature | Kleo::Class::Ascii, false), QStringLiteral("p7s")); + } }; QTEST_MAIN(ClassifyTest) #include "classifytest.moc" diff --git a/src/utils/classify.cpp b/src/utils/classify.cpp index 3bb95ae3f..e451bad93 100644 --- a/src/utils/classify.cpp +++ b/src/utils/classify.cpp @@ -1,348 +1,348 @@ /* -*- mode: c++; c-basic-offset:4 -*- utils/classify.cpp This file is part of Kleopatra, the KDE keymanager SPDX-FileCopyrightText: 2007 Klarälvdalens Datakonsult AB SPDX-License-Identifier: GPL-2.0-or-later */ #include #include "classify.h" #include "algorithm.h" #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace Kleo::Class; namespace { const unsigned int ExamineContentHint = 0x8000; -static const QHash classifications{ - // ordered by extension +static const QMap classifications{ + // using QMap to keep ordering by extension which incidentally is also the prioritized order for outputFileExtension() {QStringLiteral("arl"), Kleo::Class::CMS | Binary | CertificateRevocationList}, {QStringLiteral("asc"), Kleo::Class::OpenPGP | Ascii | OpaqueSignature | DetachedSignature | CipherText | AnyCertStoreType | ExamineContentHint}, {QStringLiteral("cer"), Kleo::Class::CMS | Binary | Certificate}, {QStringLiteral("crl"), Kleo::Class::CMS | Binary | CertificateRevocationList}, {QStringLiteral("crt"), Kleo::Class::CMS | Binary | Certificate}, {QStringLiteral("der"), Kleo::Class::CMS | Binary | Certificate | CertificateRevocationList}, {QStringLiteral("eml"), Kleo::Class::MimeFile | Ascii}, {QStringLiteral("gpg"), Kleo::Class::OpenPGP | Binary | OpaqueSignature | CipherText | AnyCertStoreType | ExamineContentHint}, {QStringLiteral("mim"), Kleo::Class::MimeFile | Ascii}, {QStringLiteral("mime"), Kleo::Class::MimeFile | Ascii}, {QStringLiteral("mbox"), Kleo::Class::MimeFile | Ascii}, {QStringLiteral("p10"), Kleo::Class::CMS | Ascii | CertificateRequest}, {QStringLiteral("p12"), Kleo::Class::CMS | Binary | ExportedPSM}, {QStringLiteral("p7c"), Kleo::Class::CMS | Binary | Certificate}, {QStringLiteral("p7m"), Kleo::Class::CMS | AnyFormat | CipherText}, {QStringLiteral("p7s"), Kleo::Class::CMS | AnyFormat | AnySignature}, {QStringLiteral("pem"), Kleo::Class::CMS | Ascii | AnyType | ExamineContentHint}, {QStringLiteral("pfx"), Kleo::Class::CMS | Binary | Certificate}, {QStringLiteral("pgp"), Kleo::Class::OpenPGP | Binary | OpaqueSignature | CipherText | AnyCertStoreType | ExamineContentHint}, {QStringLiteral("sig"), Kleo::Class::OpenPGP | AnyFormat | DetachedSignature}, }; static const QHash gpgmeTypeMap{ // clang-format off {GpgME::Data::PGPSigned, Kleo::Class::OpenPGP | OpaqueSignature }, /* PGPOther might be just an unencrypted unsigned pgp message. Decrypt * would yield the plaintext anyway so for us this is CipherText. */ {GpgME::Data::PGPOther, Kleo::Class::OpenPGP | CipherText }, {GpgME::Data::PGPKey, Kleo::Class::OpenPGP | Certificate }, {GpgME::Data::CMSSigned, Kleo::Class::CMS | AnySignature }, {GpgME::Data::CMSEncrypted, Kleo::Class::CMS | CipherText }, /* See PGPOther */ {GpgME::Data::CMSOther, Kleo::Class::CMS | CipherText }, {GpgME::Data::X509Cert, Kleo::Class::CMS | Certificate }, {GpgME::Data::PKCS12, Kleo::Class::CMS | Binary | ExportedPSM }, {GpgME::Data::PGPEncrypted, Kleo::Class::OpenPGP | CipherText }, {GpgME::Data::PGPSignature, Kleo::Class::OpenPGP | DetachedSignature}, // clang-format on }; static const QSet mimeFileNames{ QStringLiteral("msg.asc"), QStringLiteral("smime.p7m"), QStringLiteral("OpenPGP_encrypted_message.asc"), QStringLiteral("OpenPGP_encrypted_message.mim"), }; static const unsigned int defaultClassification = NoClass; template class asKeyValueRange { public: asKeyValueRange(T &data) : m_data{data} { } auto begin() { return m_data.keyValueBegin(); } auto end() { return m_data.keyValueEnd(); } private: T &m_data; }; } unsigned int Kleo::classify(const QStringList &fileNames) { if (fileNames.empty()) { return 0; } unsigned int result = classify(fileNames.front()); for (const QString &fileName : fileNames) { result &= classify(fileName); } return result; } static unsigned int classifyFileName(const QFileInfo &fi) { static const QRegularExpression attachmentNumbering{QStringLiteral(R"(\([0-9]+\))")}; const auto fileName = fi.fileName().remove(attachmentNumbering); if (mimeFileNames.contains(fileName)) { return Kleo::Class::MimeFile | Ascii; } return defaultClassification; } static unsigned int classifyExtension(const QFileInfo &fi) { return classifications.value(fi.suffix(), defaultClassification); } unsigned int Kleo::classify(const QString &filename) { const QFileInfo fi(filename); if (!fi.exists()) { return 0; } const unsigned int fileNameClass = classifyFileName(fi); if (fileNameClass != defaultClassification) { return fileNameClass; } QFile file(filename); /* The least reliable but always available classification */ const unsigned int extClass = classifyExtension(fi); if (!file.open(QIODevice::ReadOnly)) { qCDebug(LIBKLEO_LOG) << "Failed to open file: " << filename << " for classification."; return extClass; } /* More reliable */ const unsigned int contentClass = classifyContent(file.read(4096)); if (contentClass != defaultClassification) { qCDebug(LIBKLEO_LOG) << "Classified based on content as:" << contentClass; return contentClass; } /* Probably some X509 Stuff that GpgME in its wisdom does not handle. Again * file extension is probably more reliable as the last resort. */ qCDebug(LIBKLEO_LOG) << "No classification based on content."; return extClass; } unsigned int Kleo::classifyContent(const QByteArray &data) { QGpgME::QByteArrayDataProvider dp(data); GpgME::Data gpgmeData(&dp); GpgME::Data::Type type = gpgmeData.type(); return gpgmeTypeMap.value(type, defaultClassification); } QString Kleo::printableClassification(unsigned int classification) { QStringList parts; if (classification & Kleo::Class::CMS) { parts.push_back(QStringLiteral("CMS")); } if (classification & Kleo::Class::OpenPGP) { parts.push_back(QStringLiteral("OpenPGP")); } if (classification & Kleo::Class::Binary) { parts.push_back(QStringLiteral("Binary")); } if (classification & Kleo::Class::Ascii) { parts.push_back(QStringLiteral("Ascii")); } if (classification & Kleo::Class::DetachedSignature) { parts.push_back(QStringLiteral("DetachedSignature")); } if (classification & Kleo::Class::OpaqueSignature) { parts.push_back(QStringLiteral("OpaqueSignature")); } if (classification & Kleo::Class::ClearsignedMessage) { parts.push_back(QStringLiteral("ClearsignedMessage")); } if (classification & Kleo::Class::CipherText) { parts.push_back(QStringLiteral("CipherText")); } if (classification & Kleo::Class::Certificate) { parts.push_back(QStringLiteral("Certificate")); } if (classification & Kleo::Class::ExportedPSM) { parts.push_back(QStringLiteral("ExportedPSM")); } if (classification & Kleo::Class::CertificateRequest) { parts.push_back(QStringLiteral("CertificateRequest")); } if (classification & Kleo::Class::MimeFile) { parts.push_back(QStringLiteral("MimeFile")); } return parts.join(QLatin1String(", ")); } /*! \return the data file that corresponds to the signature file \a signatureFileName, or QString(), if no such file can be found. */ QString Kleo::findSignedData(const QString &signatureFileName) { if (!mayBeDetachedSignature(signatureFileName)) { return QString(); } const QFileInfo fi{signatureFileName}; const QString baseName = signatureFileName.chopped(fi.suffix().size() + 1); return QFile::exists(baseName) ? baseName : QString(); } /*! \return all (existing) candidate signature files for \a signedDataFileName Note that there can very well be more than one such file, e.g. if the same data file was signed by both CMS and OpenPGP certificates. */ QStringList Kleo::findSignatures(const QString &signedDataFileName) { QStringList result; for (const auto &[extension, classification] : asKeyValueRange(classifications)) { if (classification & DetachedSignature) { const QString candidate = signedDataFileName + QLatin1Char('.') + extension; if (QFile::exists(candidate)) { result.push_back(candidate); } } } return result; } #ifdef Q_OS_WIN static QString stripOutlookAttachmentNumbering(const QString &s) { static const QRegularExpression attachmentNumbering{QStringLiteral(R"(\s\([0-9]+\)$)")}; return QString{s}.remove(attachmentNumbering); } #endif /*! \return the (likely) output filename for \a inputFileName, or "inputFileName.out" if none can be determined. */ QString Kleo::outputFileName(const QString &inputFileName) { const QFileInfo fi(inputFileName); const QString suffix = fi.suffix(); if (classifications.find(suffix) == std::cend(classifications)) { return inputFileName + QLatin1String(".out"); } else { #ifdef Q_OS_WIN return stripOutlookAttachmentNumbering(inputFileName.chopped(suffix.size() + 1)); #else return inputFileName.chopped(suffix.size() + 1); #endif } } /*! \return the commonly used extension for files of type \a classification, or NULL if none such exists. */ QString Kleo::outputFileExtension(unsigned int classification, bool usePGPFileExt) { if (usePGPFileExt && (classification & Class::OpenPGP) && (classification & Class::Binary)) { return QStringLiteral("pgp"); } - for (const auto &[extension, classification] : asKeyValueRange(classifications)) { - if ((classification & classification) == classification) { + for (const auto &[extension, classification_] : asKeyValueRange(classifications)) { + if ((classification_ & classification) == classification) { return extension; } } return {}; } bool Kleo::isFingerprint(const QString &fpr) { static QRegularExpression fprRegex(QStringLiteral("[0-9a-fA-F]{40}")); return fprRegex.match(fpr).hasMatch(); } bool Kleo::isChecksumFile(const QString &file) { static bool initialized; static QList patterns; const QFileInfo fi(file); if (!fi.exists()) { return false; } if (!initialized) { const auto getChecksumDefinitions = ChecksumDefinition::getChecksumDefinitions(); for (const std::shared_ptr &cd : getChecksumDefinitions) { if (cd) { const auto patternsList = cd->patterns(); for (const QString &pattern : patternsList) { #ifdef Q_OS_WIN patterns << QRegExp(pattern, Qt::CaseInsensitive); #else patterns << QRegExp(pattern, Qt::CaseSensitive); #endif } } } initialized = true; } const QString fileName = fi.fileName(); for (const QRegExp &pattern : std::as_const(patterns)) { if (pattern.exactMatch(fileName)) { return true; } } return false; }