2017-03-12 13:34:56 -04:00
|
|
|
/*
|
2019-06-01 17:53:40 -04:00
|
|
|
* Copyright (C) 2019 KeePassXC Team <team@keepassxc.org>
|
2017-03-12 13:34:56 -04:00
|
|
|
*
|
|
|
|
* 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/>.
|
|
|
|
*/
|
|
|
|
|
2018-09-29 13:00:47 -04:00
|
|
|
#include "Show.h"
|
|
|
|
|
2018-11-28 11:24:12 -05:00
|
|
|
#include "Utils.h"
|
|
|
|
#include "core/Group.h"
|
2021-11-03 23:29:44 -04:00
|
|
|
#include "core/Tools.h"
|
2017-07-17 15:16:53 -04:00
|
|
|
|
2021-07-11 22:10:29 -04:00
|
|
|
#include <QCommandLineParser>
|
|
|
|
|
2019-06-01 17:53:40 -04:00
|
|
|
const QCommandLineOption Show::TotpOption = QCommandLineOption(QStringList() << "t"
|
|
|
|
<< "totp",
|
|
|
|
QObject::tr("Show the entry's current TOTP."));
|
|
|
|
|
2019-10-28 13:27:29 -04:00
|
|
|
const QCommandLineOption Show::ProtectedAttributesOption =
|
|
|
|
QCommandLineOption(QStringList() << "s"
|
|
|
|
<< "show-protected",
|
|
|
|
QObject::tr("Show the protected attributes in clear text."));
|
|
|
|
|
2021-11-03 23:29:44 -04:00
|
|
|
const QCommandLineOption Show::AttachmentsOption =
|
|
|
|
QCommandLineOption(QStringList() << "show-attachments", QObject::tr("Show the attachments of the entry."));
|
|
|
|
|
2019-06-01 17:53:40 -04:00
|
|
|
const QCommandLineOption Show::AttributesOption = QCommandLineOption(
|
|
|
|
QStringList() << "a"
|
|
|
|
<< "attributes",
|
|
|
|
QObject::tr(
|
|
|
|
"Names of the attributes to show. "
|
|
|
|
"This option can be specified more than once, with each attribute shown one-per-line in the given order. "
|
|
|
|
"If no attributes are specified, a summary of the default attributes is given."),
|
|
|
|
QObject::tr("attribute"));
|
|
|
|
|
2017-07-17 15:16:53 -04:00
|
|
|
Show::Show()
|
|
|
|
{
|
2018-02-05 19:17:36 -05:00
|
|
|
name = QString("show");
|
|
|
|
description = QObject::tr("Show an entry's information.");
|
2019-06-01 17:53:40 -04:00
|
|
|
options.append(Show::TotpOption);
|
|
|
|
options.append(Show::AttributesOption);
|
2019-10-28 13:27:29 -04:00
|
|
|
options.append(Show::ProtectedAttributesOption);
|
2021-11-03 23:29:44 -04:00
|
|
|
options.append(Show::AttachmentsOption);
|
2019-06-01 17:53:40 -04:00
|
|
|
positionalArguments.append({QString("entry"), QObject::tr("Name of the entry to show."), QString("")});
|
2017-07-17 15:16:53 -04:00
|
|
|
}
|
|
|
|
|
2019-06-01 17:53:40 -04:00
|
|
|
int Show::executeWithDatabase(QSharedPointer<Database> database, QSharedPointer<QCommandLineParser> parser)
|
2017-07-17 15:16:53 -04:00
|
|
|
{
|
2020-05-11 07:31:29 -04:00
|
|
|
auto& out = Utils::STDOUT;
|
|
|
|
auto& err = Utils::STDERR;
|
2017-07-17 15:16:53 -04:00
|
|
|
|
2019-06-01 17:53:40 -04:00
|
|
|
const QStringList args = parser->positionalArguments();
|
|
|
|
const QString& entryPath = args.at(1);
|
|
|
|
bool showTotp = parser->isSet(Show::TotpOption);
|
2019-10-28 13:27:29 -04:00
|
|
|
bool showProtectedAttributes = parser->isSet(Show::ProtectedAttributesOption);
|
2019-06-01 17:53:40 -04:00
|
|
|
QStringList attributes = parser->values(Show::AttributesOption);
|
|
|
|
|
2018-10-30 08:42:35 -04:00
|
|
|
Entry* entry = database->rootGroup()->findEntryByPath(entryPath);
|
2017-05-19 14:04:11 -04:00
|
|
|
if (!entry) {
|
2020-05-11 07:31:29 -04:00
|
|
|
err << QObject::tr("Could not find entry with path %1.").arg(entryPath) << endl;
|
2017-03-12 13:37:20 -04:00
|
|
|
return EXIT_FAILURE;
|
|
|
|
}
|
|
|
|
|
2018-11-09 21:58:42 -05:00
|
|
|
if (showTotp && !entry->hasTotp()) {
|
2020-05-11 07:31:29 -04:00
|
|
|
err << QObject::tr("Entry with path %1 has no TOTP set up.").arg(entryPath) << endl;
|
2018-11-09 21:58:42 -05:00
|
|
|
return EXIT_FAILURE;
|
|
|
|
}
|
|
|
|
|
2017-12-16 19:14:39 -05:00
|
|
|
// If no attributes specified, output the default attribute set.
|
2020-01-23 20:54:36 -05:00
|
|
|
bool showDefaultAttributes = attributes.isEmpty() && !showTotp;
|
2020-01-30 15:46:48 -05:00
|
|
|
if (showDefaultAttributes) {
|
2017-12-16 19:14:39 -05:00
|
|
|
attributes = EntryAttributes::DefaultAttributes;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Iterate over the attributes and output them line-by-line.
|
2020-01-30 15:46:48 -05:00
|
|
|
bool encounteredError = false;
|
2019-10-28 13:27:29 -04:00
|
|
|
for (const QString& attributeName : asConst(attributes)) {
|
2020-01-30 15:46:48 -05:00
|
|
|
QStringList attrs = Utils::findAttributes(*entry->attributes(), attributeName);
|
|
|
|
if (attrs.isEmpty()) {
|
|
|
|
encounteredError = true;
|
2020-05-11 07:31:29 -04:00
|
|
|
err << QObject::tr("ERROR: unknown attribute %1.").arg(attributeName) << endl;
|
2017-12-16 19:14:39 -05:00
|
|
|
continue;
|
2020-01-30 15:46:48 -05:00
|
|
|
} else if (attrs.size() > 1) {
|
|
|
|
encounteredError = true;
|
2020-05-11 07:31:29 -04:00
|
|
|
err << QObject::tr("ERROR: attribute %1 is ambiguous, it matches %2.")
|
|
|
|
.arg(attributeName, QLocale().createSeparatedList(attrs))
|
|
|
|
<< endl;
|
2020-01-30 15:46:48 -05:00
|
|
|
continue;
|
2017-12-16 19:14:39 -05:00
|
|
|
}
|
2020-01-30 15:46:48 -05:00
|
|
|
QString canonicalName = attrs[0];
|
2020-01-23 20:54:36 -05:00
|
|
|
if (showDefaultAttributes) {
|
2020-05-11 07:31:29 -04:00
|
|
|
out << canonicalName << ": ";
|
2019-10-28 13:27:29 -04:00
|
|
|
}
|
2020-01-30 15:46:48 -05:00
|
|
|
if (entry->attributes()->isProtected(canonicalName) && showDefaultAttributes && !showProtectedAttributes) {
|
2020-05-11 07:31:29 -04:00
|
|
|
out << "PROTECTED" << endl;
|
2019-10-28 13:27:29 -04:00
|
|
|
} else {
|
2020-05-11 07:31:29 -04:00
|
|
|
out << entry->resolveMultiplePlaceholders(entry->attributes()->value(canonicalName)) << endl;
|
2017-12-16 19:14:39 -05:00
|
|
|
}
|
|
|
|
}
|
2018-11-09 21:58:42 -05:00
|
|
|
|
2021-11-03 23:29:44 -04:00
|
|
|
if (parser->isSet(Show::AttachmentsOption)) {
|
|
|
|
// Separate attachment output from attributes output via a newline.
|
|
|
|
out << endl;
|
|
|
|
|
|
|
|
EntryAttachments* attachments = entry->attachments();
|
|
|
|
if (attachments->isEmpty()) {
|
|
|
|
out << QObject::tr("No attachments present.") << endl;
|
|
|
|
} else {
|
|
|
|
out << QObject::tr("Attachments:") << endl;
|
|
|
|
|
|
|
|
// Iterate over the attachments and output their names and size line-by-line, indented.
|
|
|
|
for (const QString& attachmentName : attachments->keys()) {
|
|
|
|
// TODO: use QLocale::formattedDataSize when >= Qt 5.10
|
|
|
|
QString attachmentSize = Tools::humanReadableFileSize(attachments->value(attachmentName).size(), 1);
|
|
|
|
out << " " << attachmentName << " (" << attachmentSize << ")" << endl;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-11-09 21:58:42 -05:00
|
|
|
if (showTotp) {
|
2020-05-11 07:31:29 -04:00
|
|
|
out << entry->totp() << endl;
|
2018-11-09 21:58:42 -05:00
|
|
|
}
|
|
|
|
|
2020-01-30 15:46:48 -05:00
|
|
|
return encounteredError ? EXIT_FAILURE : EXIT_SUCCESS;
|
2017-03-12 13:34:56 -04:00
|
|
|
}
|