CLI: Add Import XML command (#3572)

The CLI now contains an "import" command that creates a new database from the specified XML export. The new database is in kdbx 4 format, and does not currently accept a keyfile in database creation. This change is required to create new databases from XML backups. Fixes #2458
2025-11-30 03:16:42 -05:00 · 2019-10-14 08:37:26 -04:00 · 2019-10-14 08:37:26 -04:00 · dbe15d32e5
commit dbe15d32e5
parent 82cfedfa43
14 changed files with 2127 additions and 1904 deletions
--- a/src/cli/Import.cpp
+++ b/src/cli/Import.cpp
@ -0,0 +1,100 @@
+/*
+ *  Copyright (C) 2019 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 <cstdlib>
+#include <stdio.h>
+
+#include <QFileInfo>
+#include <QString>
+#include <QTextStream>
+
+#include "Import.h"
+
+#include "cli/TextStream.h"
+#include "cli/Utils.h"
+#include "core/Database.h"
+#include "keys/CompositeKey.h"
+#include "keys/Key.h"
+
+/**
+ * Create a database file from an XML export of another database.
+ * A password can be specified to encrypt the database.
+ * If none is specified the function will fail.
+ *
+ * If the database is being saved in a non existant directory, the
+ * function will fail.
+ *
+ * @return EXIT_SUCCESS on success, or EXIT_FAILURE on failure
+ */
+Import::Import()
+{
+    name = QString("import");
+    description = QObject::tr("Import the contents of an XML database.");
+    positionalArguments.append({QString("xml"), QObject::tr("Path of the XML database export."), QString("")});
+    positionalArguments.append({QString("database"), QObject::tr("Path of the new database."), QString("")});
+}
+
+int Import::execute(const QStringList& arguments)
+{
+    QSharedPointer<QCommandLineParser> parser = getCommandLineParser(arguments);
+    if (parser.isNull()) {
+        return EXIT_FAILURE;
+    }
+
+    TextStream outputTextStream(parser->isSet(Command::QuietOption) ? Utils::DEVNULL : Utils::STDOUT,
+                                QIODevice::WriteOnly);
+    TextStream errorTextStream(Utils::STDERR, QIODevice::WriteOnly);
+
+    const QStringList args = parser->positionalArguments();
+    const QString xmlExportPath = args.at(0);
+    const QString dbPath = args.at(1);
+
+    if (QFileInfo::exists(dbPath)) {
+        errorTextStream << QObject::tr("File %1 already exists.").arg(dbPath) << endl;
+        return EXIT_FAILURE;
+    }
+
+    auto key = QSharedPointer<CompositeKey>::create();
+
+    auto password = Utils::getPasswordFromStdin();
+    if (!password.isNull()) {
+        key->addKey(password);
+    }
+
+    if (key->isEmpty()) {
+        errorTextStream << QObject::tr("No key is set. Aborting database creation.") << endl;
+        return EXIT_FAILURE;
+    }
+
+    QString errorMessage;
+    Database db;
+    db.setKdf(KeePass2::uuidToKdf(KeePass2::KDF_ARGON2));
+    db.setKey(key);
+
+    if (!db.import(xmlExportPath, &errorMessage)) {
+        errorTextStream << QObject::tr("Unable to import XML database export %1").arg(errorMessage) << endl;
+        return EXIT_FAILURE;
+    }
+
+    if (!db.save(dbPath, &errorMessage, true, false)) {
+        errorTextStream << QObject::tr("Failed to save the database: %1.").arg(errorMessage) << endl;
+        return EXIT_FAILURE;
+    }
+
+    outputTextStream << QObject::tr("Successfully imported database.") << endl;
+    return EXIT_SUCCESS;
+}